glok-core/uk.co.nickthecoder.glok.backend/PartialTexture

PartialTexture

class PartialTexture(val texture: Texture, val srcX: Float, val srcY: Float, val imageWidth: Float, val imageHeight: Float) : Image

Defines a rectangular region of a Texture as an Image. For example, it is common to place many icons in a single .png file, which is loaded as a single Texture. Each icon is then defined using PartialTexture.

NOTE. Ensure that there is at least 1 transparent pixel between each icon, otherwise the colors of the neighbouring icons can 'bleed' this icon when rendered. Google 'opengl texture bleeding' for details.

Constructors

PartialTexture

constructor(texture: Texture, srcX: Float, srcY: Float, imageWidth: Float, imageHeight: Float)

Properties

imageHeight

open override val imageHeight: Float

imageWidth

open override val imageWidth: Float

srcX

val srcX: Float

srcY

val srcY: Float

texture

val texture: Texture

Functions

asImageView

fun Image?.asImageView(): ImageView?

aspectRatio

open fun aspectRatio(): Float

The ratio of the imageWidth to the imageHeight.

batch

open override fun batch(tint: Color?, block: TextureBatch.() -> Unit)

draw

open override fun draw(x: Float, y: Float, tint: Color?)

drawBatched

open override fun drawBatched(batch: TextureBatch, x: Float, y: Float)

drawTo

open override fun drawTo(x: Float, y: Float, destWidth: Float, destHeight: Float, tint: Color?)

drawToBatched

open override fun drawToBatched(batch: TextureBatch, x: Float, y: Float, destWidth: Float, destHeight: Float)

The same as the other drawTo, but using a TextureBatch for efficiency.

partialImage

open override fun partialImage(fromX: Float, fromY: Float, width: Float, height: Float): Image

Takes a rectangular region of this Image, and returns it as an Image. Note, the pixel data is NOT copied

resizable

open fun resizable(sizeProperty: IntProperty): ObservableOptionalImage

Returns an ObservableOptionalImage whose value is a scaled version of this image, scaled such that width and height are at most sizeProperty.value.

scaledBy

open override fun scaledBy(scaleX: Float, scaleY: Float): ScaledPartialTexture

Returns an Image using the same pixel data as this image, but it lies about its actual size.

scaleTo

open fun scaleTo(size: Int): Image

Returns a scaled version of this image, scaled such that width and height are at most size. This is often used for square images, icons in particular.

toString

open override fun toString(): String