korge-core/korlibs.image.bitmap

Package-level declarations

Types

typealias BaseBmpSlice = RectSlice<out Bitmap>

abstract class Bitmap(val width: Int, val height: Int, val bpp: Int, premultiplied: Boolean, val backingArray: Any?) : SizeableInt, Extra

Bitmap1

class Bitmap1(val width: Int, val height: Int, data: ByteArray = ByteArray((width * height) divCeil 8), var palette: RgbaArray = RgbaArray(intArrayOf(Colors.TRANSPARENT.value, Colors.WHITE.value))) : BitmapIndexed

Bitmap16

class Bitmap16(val width: Int, val height: Int, val data: ShortArray = ShortArray(width * height), val format: ColorFormat = RGBA_4444, premultiplied: Boolean = false) : Bitmap

Bitmap2

class Bitmap2(val width: Int, val height: Int, data: ByteArray = ByteArray((width * height) divCeil 4), var palette: RgbaArray = RgbaArray(4)) : BitmapIndexed

Bitmap32

class Bitmap32(val width: Int, val height: Int, val ints: IntArray = IntArray(width * height), premultiplied: Boolean = true) : Bitmap, Iterable<RGBA>

Bitmap4

class Bitmap4(val width: Int, val height: Int, data: ByteArray = ByteArray(width * height / 2), var palette: RgbaArray = RgbaArray(16)) : BitmapIndexed

Bitmap8

class Bitmap8(val width: Int, val height: Int, data: ByteArray = ByteArray(width * height), var palette: RgbaArray = RgbaArray(0x100)) : BitmapIndexed

BitmapChannel

enum BitmapChannel : Enum<BitmapChannel>

BitmapCoords

typealias BitmapCoords = SliceCoordsWithBase<out Bitmap>

BitmapIndexed

abstract class BitmapIndexed(val bpp: Int, val width: Int, val height: Int, var bytes: ByteArray = ByteArray(width * height / (8 / bpp)), var palette: RgbaArray = RgbaArray(1 shl bpp)) : Bitmap

Bitmaps

object Bitmaps

BitmapSlice

typealias BitmapSlice<T> = RectSlice<T>

BitmapWithHotspot

data class BitmapWithHotspot<T : Bitmap>(val bitmap: T, val hotspot: Vector2I)

BmpCoords

typealias BmpCoords = SliceCoords

BmpSlice

typealias BmpSlice = RectSlice<out Bitmap>

BmpSlice32

typealias BmpSlice32 = RectSlice<out Bitmap32>

DistanceBitmap

class DistanceBitmap(val width: Int, val height: Int, val d: FloatArray = FloatArray(width * height), val px: IntArray = IntArray(width * height), val py: IntArray = IntArray(width * height))

FloatBitmap32

class FloatBitmap32(val width: Int, val height: Int, val data: FloatArray = FloatArray(width * height * 4), premultiplied: Boolean = false) : Bitmap

ForcedTexId

interface ForcedTexId

ForcedTexNativeImage

abstract class ForcedTexNativeImage(val width: Int, val height: Int, premultiplied: Boolean = true) : NativeImage, ForcedTexId

ImageOrientation

typealias ImageOrientation = SliceOrientation

ImageRotation

typealias ImageRotation = SliceRotation

MultiBitmap

open class MultiBitmap(val width: Int, val height: Int, val bitmaps: List<Bitmap>, premultiplied: Boolean = true) : Bitmap

NativeImage

abstract class NativeImage(val width: Int, val height: Int, val data: Any?, premultiplied: Boolean) : Bitmap

NinePatchBitmap32

typealias NinePatchBitmap32 = NinePatchBmpSlice

NinePatchBmpSlice

open class NinePatchBmpSlice(val content: BmpSlice, val info: NinePatchInfo, val bmpSlice: BmpSlice = content)

NinePatchInfo

class NinePatchInfo(val xranges: List<Pair<Boolean, IntRange>>, val yranges: List<Pair<Boolean, IntRange>>, val width: Int, val height: Int, val content: BmpSlice? = null)

NullBitmap

open class NullBitmap(val width: Int, val height: Int, premultiplied: Boolean = true) : Bitmap

Palette

open class Palette(val colors: RgbaArray, val names: Array<String?>? = null, val changeStart: Int = 0, val changeEnd: Int = 0)

PSNR

object PSNR

SDFBitmap

typealias SDFBitmap = DistanceBitmap

Properties

val BitmapChannel.Companion.A: BitmapChannel

baseMipmapLevel

var Bitmap.baseMipmapLevel: Int?

bmp

val <T : Bitmap> RectSlice<T>.bmp: T

bounds

val <T : SizeableInt> RectSlice<T>.bounds: RectangleInt

val BitmapChannel.Companion.Cb: BitmapChannel

container

val <T : SizeableInt> SliceCoordsWithBase<T>.container: T

val BitmapChannel.Companion.Cr: BitmapChannel

maxMipmapLevel

var Bitmap.maxMipmapLevel: Int?

val BitmapChannel.Companion.Y: BitmapChannel

Functions

asNinePatch

fun Bitmap.asNinePatch(): NinePatchBmpSlice

fun BmpSlice.asNinePatch(): NinePatchBmpSlice

asNinePatchSimple

fun Bitmap.asNinePatchSimple(left: Int, top: Int, right: Int, bottom: Int): NinePatchBmpSlice

fun BmpSlice.asNinePatchSimple(left: Int, top: Int, right: Int, bottom: Int): NinePatchBmpSlice

asNinePatchSimpleRatio

fun BmpSlice.asNinePatchSimpleRatio(left: Double, top: Double, right: Double, bottom: Double): NinePatchBmpSlice

fun BmpSlice.asNinePatchSimpleRatio(left: Float, top: Float, right: Float, bottom: Float): NinePatchBmpSlice

asumePremultiplied

fun <T : Bitmap> T.asumePremultiplied(): T

Bitmap32Context2d

fun Bitmap32Context2d(width: Int, height: Int, antialiased: Boolean = true, block: Context2d.() -> Unit): Bitmap32

checkMatchDimensions

fun <T : Bitmap> T.checkMatchDimensions(other: T): T

clamp

fun FloatArray2.clamp(min: Float, max: Float)

computePsnr

fun Bitmap32.Companion.computePsnr(a: Bitmap32, b: Bitmap32): Double

context2d

inline fun <T : Bitmap> T.context2d(antialiased: Boolean = true, doLock: Boolean = true, callback: Context2d.() -> Unit): T

convertRange

fun FloatArray2.convertRange(minSrc: Float, maxSrc: Float, minDst: Float = 0.0f, maxDst: Float = 1.0f)

createWithThisFormatTyped

fun <T : Bitmap> T.createWithThisFormatTyped(width: Int, height: Int): T

distanceMap

fun Bitmap.distanceMap(out: DistanceBitmap = DistanceBitmap(width, height), thresold: Double = 0.5): DistanceBitmap

ensureNative

fun Bitmap.ensureNative(): NativeImage

expandBorder

fun Bitmap32.expandBorder(area: RectangleInt, border: Int)

fun Bitmap32.expandBorder(areaTop: Int, areaLeft: Int, areaBottom: Int, areaRight: Int, border: Int)

extract

fun <T : Bitmap> RectSlice<T>.extract(): T

Extract pixels in the same Bitmap format as the RectSlice.container, having into account RectSlice.padding and RectSlice.orientation

fun <T : Bitmap> T.extract(x: Int, y: Int, width: Int, height: Int): T

extractUntransformed

fun <T : Bitmap> RectSlice<T>.extractUntransformed(): T

Extract pixels in the same Bitmap format as the RectSlice.container, without having into account RectSlice.padding nor RectSlice.orientation

forEachValue

inline fun FloatArray2.forEachValue(block: (x: Int, y: Int, v: Float) -> Unit)

getMinMax

fun FloatArray2.getMinMax(out: FloatArray = FloatArray(2)): FloatArray

getRgba

fun BmpSlice.getRgba(x: Int, y: Int): RGBA

Gets a pixel in RGBA from the slice in x and y WITHOUT having into account orientation and padding

getRgbaOriented

fun BmpSlice.getRgbaOriented(x: Int, y: Int): RGBA

getRgbaRawUnsafe

fun BmpSlice.getRgbaRawUnsafe(x: Int, y: Int): RGBA

Same as getRgba but ignoring premultiplication and bound checks

isFullyTransparent

fun BmpSlice32.isFullyTransparent(): Boolean

matchContents

fun Bitmap.matchContents(that: Bitmap): Boolean

matchContentsDistinctCount

fun Bitmap.matchContentsDistinctCount(that: Bitmap): Int

mipmap

fun Bitmap.mipmap(levels: Int): NativeImage

mipmaps

fun <T : Bitmap> T.mipmaps(enable: Boolean = true): T

Enable or disable mipmap generation for this Bitmap

NativeImage

fun NativeImage(d: SizedDrawable, scaleX: Double = 1.0, scaleY: Double = scaleX): NativeImage

fun NativeImage(width: Int, height: Int, pixels: RgbaArray): NativeImage

fun NativeImage(width: Int, height: Int, pixels: RgbaPremultipliedArray): NativeImage

fun NativeImage(width: Int, height: Int, premultiplied: Boolean? = null): NativeImage

fun NativeImage(width: Int, height: Int, pixels: IntArray, premultiplied: Boolean? = null): NativeImage

fun NativeImage(width: Int, height: Int, d: Drawable, scaleX: Double = 1.0, scaleY: Double = scaleX): NativeImage

NativeImageContext2d

fun NativeImageContext2d(width: Int, height: Int, antialiased: Boolean = true, block: Context2d.() -> Unit): NativeImage

NativeImageOrBitmap32

fun NativeImageOrBitmap32(width: Int, height: Int, native: Boolean = true, premultiplied: Boolean? = null): Bitmap

NativeImageOrBitmap32Context2d

fun NativeImageOrBitmap32Context2d(width: Int, height: Int, antialiased: Boolean = true, native: Boolean = true, block: Context2d.() -> Unit): Bitmap

normalize

fun FloatArray2.normalize()

normalizeUniform

fun FloatArray2.normalizeUniform()

posterize

fun Bitmap32.posterize(nbits: Int = 4): Bitmap32

posterizeInplace

fun Bitmap32.posterizeInplace(nbits: Int = 4): Bitmap32

psnrDiffTo

fun Bitmap32.psnrDiffTo(that: Bitmap32): Double

putSliceWithBorder

fun Bitmap.putSliceWithBorder(x: Int, y: Int, bmp: BmpSlice, border: Int = 1)

putWithBorder

fun <T : Bitmap> T.putWithBorder(x: Int, y: Int, bmp: T, border: Int = 1)

raster

fun SizedDrawable.raster(scaleX: Double = 1.0, scaleY: Double = scaleX): NativeImage

readNinePatch

suspend fun VfsFile.readNinePatch(props: ImageDecodingProps = ImageDecodingProps.DEFAULT): NinePatchBmpSlice

suspend fun VfsFile.readNinePatch(format: ImageFormat): NinePatchBmpSlice

readPixels

fun BmpSlice.readPixels(x: Int, y: Int, width: Int, height: Int, out: RgbaArray = RgbaArray(width * height), offset: Int = 0): RgbaArray

Reads pixels in region without having into account RectSlice.orientation or RectSlice.padding

readPixelsUnsafe

fun Bitmap.readPixelsUnsafe(x: Int, y: Int, width: Int, height: Int): IntArray

fun BmpSlice.readPixelsUnsafe(x: Int, y: Int, width: Int, height: Int, out: IntArray = IntArray(width * height), offset: Int = 0): IntArray

Sets a pixel in RGBA from the slice in x and y with the color RectSlice.value WITHOUT having into account RectSlice.orientation and RectSlice.padding

resized

fun Bitmap.resized(out: Bitmap, scale: ScaleMode, anchor: Anchor): Bitmap

fun Bitmap.resized(width: Int, height: Int, scale: ScaleMode, anchor: Anchor, native: Boolean = true): Bitmap

resizedUpTo

fun Bitmap.resizedUpTo(width: Int, height: Int, native: Boolean = true): Bitmap

scale

fun FloatArray2.scale(scale: Float = 1.0f)

sdf

fun Bitmap.sdf(out: DistanceBitmap = DistanceBitmap(width, height), thresold: Double = 0.5): DistanceBitmap

setAlpha

fun Bitmap32.setAlpha(value: Int)

setRgba

fun BmpSlice.setRgba(x: Int, y: Int, value: RGBA)

Sets a pixel in RGBA from the slice in x and y with the color value WITHOUT having into account orientation and padding

setRgbaOriented

fun BmpSlice.setRgbaOriented(x: Int, y: Int, value: RGBA)

setRgbaRawUnsafe

fun BmpSlice.setRgbaRawUnsafe(x: Int, y: Int, value: RGBA)

Same as setRgba but ignoring premultiplication and bound checks

slice

fun <T : Bitmap> T.slice(bounds: RectangleInt = RectangleInt(0, 0, width, height), name: String? = null, orientation: ImageOrientation = ImageOrientation.ROTATE_0, padding: MarginInt = MarginInt.ZERO): RectSlice<T>

fun <T : SizeableInt> SliceCoordsWithBase<T>.slice(bounds: RectangleInt = RectangleInt(0, 0, width, height), name: String? = null, orientation: ImageOrientation = ImageOrientation.ROTATE_0, padding: MarginInt = MarginInt.ZERO): RectSlice<T>

sliceWithBounds

fun <T : Bitmap> T.sliceWithBounds(left: Int, top: Int, right: Int, bottom: Int, name: String? = null, orientation: ImageOrientation = ImageOrientation.ROTATE_0, padding: MarginInt = MarginInt.ZERO): RectSlice<T>

sliceWithSize

fun <T : Bitmap> T.sliceWithSize(x: Int, y: Int, width: Int, height: Int, name: String? = null, orientation: ImageOrientation = ImageOrientation.ROTATE_0, padding: MarginInt = MarginInt.ZERO): RectSlice<T>

toBitmap

fun <T : Bitmap> RectSlice<T>.toBitmap(): T

toBitmap1

inline fun Bitmap32.toBitmap1(): Bitmap1

inline fun Bitmap32.toBitmap1(func: (value: RGBA) -> Boolean): Bitmap1

toBMP32

fun FloatArray2.toBMP32(block: (Float) -> RGBA): Bitmap32

toFloatBMP32

fun Bitmap.toFloatBMP32(out: FloatBitmap32 = FloatBitmap32(width, height, premultiplied = premultiplied)): FloatBitmap32

toStringYCbCr

fun BitmapChannel.toStringYCbCr(): String

toUri

fun Bitmap.toUri(): String

tryToExactBitmap8

fun Bitmap.tryToExactBitmap8(): Bitmap8?

updateValues

inline fun FloatArray2.updateValues(block: (x: Int, y: Int, value: Float) -> Float)