glok-core/uk.co.nickthecoder.glok.scene/Image

Image

interface Image

Inheritors

ScaledPartialTexture

Properties

abstract val imageHeight: Float

abstract val imageWidth: Float

Functions

fun Image?.asImageView(): ImageView?

open fun aspectRatio(): Float

The ratio of the imageWidth to the imageHeight.

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

abstract fun draw(x: Float, y: Float, tint: Color? = null)

abstract fun drawBatched(batch: TextureBatch, x: Float, y: Float)

abstract fun drawTo(x: Float, y: Float, destWidth: Float, destHeight: Float, tint: Color? = null)

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

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

abstract 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

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.

abstract fun scaledBy(scaleX: Float, scaleY: Float = scaleX): Image

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

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.