korge-core/korlibs.image.bitmap/Bitmap32

Bitmap32

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

Constructors

Bitmap32

constructor(width: Int, height: Int, value: RGBA)

constructor(width: Int, height: Int, value: RgbaArray)

constructor(width: Int, height: Int, generator: (x: Int, y: Int) -> RGBA)

constructor(width: Int, height: Int, ints: IntArray = IntArray(width * height), premultiplied: Boolean = true)

Types

Companion

object Companion

Properties

allChildren

val Iterable<Xml>.allChildren: Iterable<Xml>

allNodeChildren

val Iterable<Xml>.allNodeChildren: Iterable<Xml>

area

val area: Int

area

val Iterable<ImageFrame>.area: Int

asumePremultiplied

var asumePremultiplied: Boolean

backingArray

val backingArray: Any?

baseMipmapLevel

var Bitmap.baseMipmapLevel: Int?

bitmapName

var bitmapName: String?

bounds

val bounds: RectangleInt

bpp

val bpp: Int

contentVersion

var contentVersion: Int

Version of the content. lock+unlock mutates this version to allow for example to re-upload the bitmap to the GPU when synchronizing bitmaps into textures

dirtyRegion

var dirtyRegion: RectangleInt?

extra

open override var extra: ExtraType

firstText

val Iterable<Xml>.firstText: String?

height

val height: Int

ints

val ints: IntArray

maxMipmapLevel

var Bitmap.maxMipmapLevel: Int?

mipmaps

var mipmaps: Boolean

Specifies whether mipmaps should be created for this Bitmap

premultiplied

var premultiplied: Boolean

rect

val rect: RectangleInt

size

open override val size: SizeInt

stride

val stride: Int

text

val Iterable<Xml>.text: String

width

val width: Int

Functions

_draw

fun _draw(src: BmpSlice32, dx: Int = 0, dy: Int = 0, mix: Boolean)

fun _draw(src: Bitmap32, dx: Int, dy: Int, sleft: Int, stop: Int, sright: Int, sbottom: Int, mix: Boolean)

_drawPut

fun _drawPut(mix: Boolean, other: Bitmap32, _dx: Int = 0, _dy: Int = 0)

_drawUnchecked

fun _drawUnchecked(src: Bitmap32, dx: Int, dy: Int, sleft: Int, stop: Int, sright: Int, sbottom: Int, mix: Boolean)

all

inline fun all(callback: (RGBA) -> Boolean): Boolean

any

inline fun any(callback: (RGBA) -> Boolean): Boolean

applyColorMatrix

fun applyColorMatrix(matrix: Matrix4, x: Int = 0, y: Int = 0, width: Int = this.width - x, height: Int = this.height - y)

applyColorTransform

fun applyColorTransform(ct: ColorTransform, x: Int = 0, y: Int = 0, width: Int = this.width - x, height: Int = this.height - y)

applyEffect

fun Bitmap32.applyEffect(effect: BitmapEffect?): Bitmap32

applyEffectInline

fun Bitmap32.applyEffectInline(effect: BitmapEffect?)

asNinePatch

fun Bitmap.asNinePatch(): NinePatchBmpSlice

asNinePatchSimple

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

blur

fun Bitmap32.blur(r: Int): Bitmap32

blurInplace

fun Bitmap32.blurInplace(r: Int)

border

fun Bitmap32.border(r: Int, color: RGBA = Colors.BLACK): Bitmap32

borderInline

fun Bitmap32.borderInline(r: Int, color: RGBA = Colors.BLACK)

cancel

fun Iterable<Cancellable>.cancel(e: Throwable = CancellationException(""))

cancellable

fun Iterable<Cancellable>.cancellable(): Cancellable

children

fun Iterable<Xml>.children(name: String): Iterable<Xml>

clampHeight

fun clampHeight(y: Int): Int

clampWidth

fun clampWidth(x: Int): Int

clampX

fun clampX(x: Int): Int

clampY

fun clampY(y: Int): Int

clearDirtyRegion

fun clearDirtyRegion()

clone

open override fun clone(): Bitmap32

fun Iterable<Closeable>.close()

closeable

fun Iterable<Closeable>.closeable(): Closeable

contentEquals

open override fun contentEquals(other: Bitmap): Boolean

contentHashCode

open override fun contentHashCode(): Int

copy

fun copy(srcX: Int, srcY: Int, dst: Bitmap, dstX: Int, dstY: Int, width: Int, height: Int)

copySliceWithBounds

fun copySliceWithBounds(left: Int, top: Int, right: Int, bottom: Int): Bitmap32

copySliceWithSize

fun copySliceWithSize(x: Int, y: Int, width: Int, height: Int): Bitmap32

copyTo

fun copyTo(other: Bitmap32): Bitmap32

copyUnchecked

open override fun copyUnchecked(srcX: Int, srcY: Int, dst: Bitmap, dstX: Int, dstY: Int, width: Int, height: Int)

createWithThisFormat

open override fun createWithThisFormat(width: Int, height: Int): Bitmap

depremultiplied

fun depremultiplied(): Bitmap32

depremultipliedIfRequired

fun depremultipliedIfRequired(): Bitmap32

depremultiplyInplaceIfRequired

fun depremultiplyInplaceIfRequired()

distanceMap

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

draw

fun draw(src: Bitmap32, dx: Int = 0, dy: Int = 0)

fun draw(src: BmpSlice32, dx: Int = 0, dy: Int = 0)

drawPixelMixed

fun drawPixelMixed(x: Int, y: Int, c: RGBA)

drawText

fun Bitmap32.drawText(font: BitmapFont, str: String, pos: Point = Point.ZERO, color: RGBA = Colors.WHITE, size: Double = font.fontSize, alignment: TextAlignment = TextAlignment.TOP_LEFT): Bitmap32

drawUnoptimized

fun drawUnoptimized(src: BmpSlice, dx: Int = 0, dy: Int = 0, mix: Boolean = true)

fun drawUnoptimized(src: Bitmap, dx: Int, dy: Int, sleft: Int, stop: Int, sright: Int, sbottom: Int, mix: Boolean)

dropShadow

fun Bitmap32.dropShadow(x: Int, y: Int, r: Int, color: RGBA = Colors.BLACK): Bitmap32

dropShadowInplace

fun Bitmap32.dropShadowInplace(x: Int, y: Int, r: Int, color: RGBA = Colors.BLACK): Bitmap32

encode

suspend fun Bitmap.encode(formats: ImageFormat = RegisteredImageFormats, props: ImageEncodingProps = ImageEncodingProps()): ByteArray

ensureNative

fun Bitmap.ensureNative(): NativeImage

executeAndWaitAnySignal

inline suspend fun <T> Iterable<Signal<T>>.executeAndWaitAnySignal(callback: () -> Unit): Pair<Signal<T>, T>

expandBorder

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

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

extractBytes

fun extractBytes(format: ColorFormat = RGBA): ByteArray

extractChannel

fun extractChannel(channel: BitmapChannel, out: Bitmap8 = Bitmap8(width, height)): Bitmap8

fill

fun fill(color: RGBA, x: Int = 0, y: Int = 0, width: Int = this.width - x, height: Int = this.height - y)

flippedX

fun flippedX(): Bitmap

flippedY

fun flippedY(): Bitmap

flipX

open fun flipX(): Bitmap

Inplace flips

flipY

open fun flipY(): Bitmap

forEach

inline fun forEach(sx: Int = 0, sy: Int = 0, width: Int = this.width - sx, height: Int = this.height - sy, callback: (n: Int, x: Int, y: Int) -> Unit)

get

operator fun get(x: Int, y: Int): RGBA

get

inline fun <T> Iterable<Vfs.Attribute>.get(): T?

operator fun Iterable<Xml>.get(name: String): Iterable<Xml>

getContext2d

open override fun getContext2d(antialiasing: Boolean): Context2d

getInt

open override fun getInt(x: Int, y: Int): Int

UNSAFE: Gets the color in the x, y coordinates in the internal format of this Bitmap

getRgba

open override fun getRgba(x: Int, y: Int): RGBA

Gets the color v in the x, y coordinates in RGBA non-premultiplied

getRgbaAtIndex

fun getRgbaAtIndex(n: Int): RGBA

getRgbaClamped

fun getRgbaClamped(x: Int, y: Int): RGBA

getRgbaClampedBorder

fun getRgbaClampedBorder(x: Int, y: Int): RGBA

getRgbaPremultiplied

open override fun getRgbaPremultiplied(x: Int, y: Int): RGBAPremultiplied

Gets the color v in the x, y coordinates in RGBAPremultiplied

getRgbaPremultipliedAtIndex

fun getRgbaPremultipliedAtIndex(n: Int): RGBAPremultiplied

getRgbaRaw

open override fun getRgbaRaw(x: Int, y: Int): RGBA

UNSAFE: Gets the color v in the x, y coordinates in the internal format of this Bitmap (either premultiplied or not)

getRgbaSampled

fun getRgbaSampled(x: Float, y: Float): RGBA

fun getRgbaSampled(x: Float, y: Float, count: Int, row: RgbaArray)

glow

fun Bitmap32.glow(r: Int, color: RGBA = Colors.BLACK): Bitmap32

glowInplace

fun Bitmap32.glowInplace(r: Int, color: RGBA = Colors.BLACK): Bitmap32

historiogram

fun historiogram(channel: BitmapChannel, out: IntArray = IntArray(256)): IntArray

inBounds

fun inBounds(x: Int, y: Int): Boolean

inBoundsX

fun inBoundsX(x: Int): Boolean

inBoundsY

fun inBoundsY(y: Int): Boolean

index

fun index(x: Int, y: Int): Int

inside

fun inside(x: Int, y: Int): Boolean

invert

fun invert()

inverted

fun inverted(target: Bitmap32 = Bitmap32(width, height, this.premultiplied)): Bitmap32

iterator

open operator override fun iterator(): Iterator<RGBA>

listFormats

fun Iterable<ImageFormat>.listFormats(): Set<ImageFormat>

lock

open fun lock()

inline fun lock(rect: RectangleInt = this.rect, doLock: Boolean = true, block: () -> Unit): Int

matchContents

fun Bitmap.matchContents(that: Bitmap): Boolean

matchContentsDistinctCount

fun Bitmap.matchContentsDistinctCount(that: Bitmap): Int

mipmap

fun mipmap(levels: Int): Bitmap32

mipmap

fun Bitmap.mipmap(levels: Int): NativeImage

oriented

fun oriented(orientation: ImageOrientation): Bitmap

posterize

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

posterizeInplace

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

premultiplied

fun premultiplied(): Bitmap32

premultipliedIfRequired

fun premultipliedIfRequired(): Bitmap32

premultiplyInplaceIfRequired

fun premultiplyInplaceIfRequired()

psnrDiffTo

fun Bitmap32.psnrDiffTo(that: Bitmap32): Double

put

fun put(src: Bitmap32, dx: Int = 0, dy: Int = 0)

fun put(src: BmpSlice32, dx: Int = 0, dy: Int = 0)

putSliceWithBorder

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

readPixelsUnsafe

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

readPixelsUnsafe

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

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

rgbaToYCbCr

fun rgbaToYCbCr(): Bitmap32

rgbaToYCbCrInline

fun rgbaToYCbCrInline()

rotated

fun rotated(rotation: ImageRotation): Bitmap

rotatedLeft

fun rotatedLeft(): Bitmap

rotatedRight

fun rotatedRight(): Bitmap

scaled

@JvmOverloads

fun scaled(width: Int, height: Int, smooth: Boolean = true): Bitmap32

Creates a new Bitmap32 with the specified new dimensions widthxheight scaling the original content. The smooth parameter determines the quality of the interpolation. smooth=false will use a nearest neighborhood implementation.

scaleLinear

fun scaleLinear(sx: Double, sy: Double = sx): Bitmap32

scaleNearest

fun scaleNearest(sx: Int, sy: Int = sx): Bitmap32

sdf

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

set

operator fun set(x: Int, y: Int, color: RGBA)

setAlpha

fun Bitmap32.setAlpha(value: Int)

setEach

inline fun setEach(sx: Int = 0, sy: Int = 0, width: Int = this.width - sx, height: Int = this.height - sy, callback: (x: Int, y: Int) -> RGBA)

setEachPremultiplied

inline fun setEachPremultiplied(sx: Int = 0, sy: Int = 0, width: Int = this.width - sx, height: Int = this.height - sy, callback: (x: Int, y: Int) -> RGBAPremultiplied)

setInt

open override fun setInt(x: Int, y: Int, color: Int)

UNSAFE: Sets the color color in the x, y coordinates in the internal format of this Bitmap

setRgba

open override fun setRgba(x: Int, y: Int, v: RGBA)

Sets the color v in the x, y coordinates in RGBA non-premultiplied

open override fun setRgba(x: Int, y: Int, v: RGBAPremultiplied)

Sets the color v in the x, y coordinates in RGBAPremultiplied

setRgbaAtIndex

fun setRgbaAtIndex(n: Int, color: RGBA)

setRgbaPremultipliedAtIndex

fun setRgbaPremultipliedAtIndex(n: Int, color: RGBAPremultiplied)

setRgbaRaw

open override fun setRgbaRaw(x: Int, y: Int, v: RGBA)

UNSAFE: Sets the color v in the x, y coordinates in the internal format of this Bitmap (either premultiplied or not)

setRow

fun setRow(y: Int, row: IntArray)

setRowChunk

fun setRowChunk(x: Int, y: Int, data: RgbaArray, width: Int, increment: Int)

showImageAndWait

suspend fun Bitmap.showImageAndWait(kind: Int = 0)

str

fun Iterable<Xml>.str(name: String, defaultValue: String = ""): String

swapColumns

open fun swapColumns(x0: Int, x1: Int)

swapRows

open override fun swapRows(y0: Int, y1: Int)

toAndroidBitmap

fun Bitmap.toAndroidBitmap(): Bitmap

toAwt

fun Bitmap.toAwt(out: BufferedImage = BufferedImage( width.coerceAtLeast(1), height.coerceAtLeast(1), if (this.premultiplied) BufferedImage.TYPE_INT_ARGB_PRE else BufferedImage.TYPE_INT_ARGB )): BufferedImage

fun Bitmap32.toAwt(out: BufferedImage = BufferedImage( width.coerceAtLeast(1), height.coerceAtLeast(1), if (this.premultiplied) BufferedImage.TYPE_INT_ARGB_PRE else BufferedImage.TYPE_INT_ARGB )): BufferedImage

toBitmap1

inline fun Bitmap32.toBitmap1(): Bitmap1

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

toBMP32

open override fun toBMP32(): Bitmap32

toBMP32IfRequired

fun toBMP32IfRequired(): Bitmap32

toCGImage

fun Bitmap32.toCGImage(): CGImageRef?

toChannel

suspend fun <T> Iterable<T>.toChannel(): ReceiveChannel<T>

toFloatBMP32

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

toHtmlNative

fun Bitmap.toHtmlNative(): HtmlNativeImage

toPaint

fun Bitmap.toPaint(transform: Matrix = Matrix.IDENTITY, cycleX: CycleMethod = CycleMethod.NO_CYCLE, cycleY: CycleMethod = CycleMethod.NO_CYCLE, smooth: Boolean = true, units: GradientUnits = GradientUnits.OBJECT_BOUNDING_BOX): BitmapPaint

toString

open override fun toString(): String

toUIImage

fun Bitmap.toUIImage(): UIImage

toUri

fun Bitmap.toUri(): String

trace

inline fun Bitmap.trace(): VectorPath

inline fun Bitmap32.trace(): VectorPath

inline fun Bitmap.trace(func: (RGBA) -> Boolean): VectorPath

inline fun Bitmap32.trace(func: (RGBA) -> Boolean): VectorPath

transferTo

fun Bitmap32.transferTo(out: BufferedImage): BufferedImage

transposed

open fun transposed(): Bitmap

Creates a new bitmap with the rows and columns transposed

tryToExactBitmap8

fun Bitmap.tryToExactBitmap8(): Bitmap8?

unlock

open fun unlock(rect: RectangleInt = this.rect): Int

updateColors

inline fun updateColors(sx: Int = 0, sy: Int = 0, width: Int = this.width - sx, height: Int = this.height - sy, callback: (rgba: RGBA) -> RGBA)

updateColorsXY

inline fun updateColorsXY(sx: Int = 0, sy: Int = 0, width: Int = this.width - sx, height: Int = this.height - sy, callback: (x: Int, y: Int, rgba: RGBA) -> RGBA)

waitOne

suspend fun Iterable<Signal<*>>.waitOne(): Any?

withColorTransform

fun withColorTransform(ct: ColorTransform, x: Int = 0, y: Int = 0, width: Int = this.width - x, height: Int = this.height - y): Bitmap32

writeChannel

fun writeChannel(destination: BitmapChannel, input: Bitmap8)

fun writeChannel(destination: BitmapChannel, input: Bitmap32, source: BitmapChannel)

writeDecoded

fun writeDecoded(color: ColorFormat, data: ByteArray, offset: Int = 0, littleEndian: Boolean = true): Bitmap32

writePixelsUnsafe

open fun writePixelsUnsafe(x: Int, y: Int, width: Int, height: Int, out: IntArray, offset: Int = 0)

writeTo

suspend fun Bitmap.writeTo(file: VfsFile, formats: ImageFormat = RegisteredImageFormats, props: ImageEncodingProps = ImageEncodingProps()): Long

xor

fun xor(value: RGBA)

xored

fun xored(value: RGBA, target: Bitmap32 = Bitmap32(width, height, this.premultiplied)): Bitmap32

yCbCrToRgba

fun yCbCrToRgba(): Bitmap32

yCbCrToRgbaInline

fun yCbCrToRgbaInline()