open class ImageAnimation(val frames: List<ImageFrame>, val direction: ImageAnimation.Direction, val name: String, val layers: List<ImageLayer> = frames.flatMap { it.layerData }.map { it.layer }.distinct().sortedBy { it.index })

ImageData

open class ImageData(val frames: List<ImageFrame>, val loopCount: Int = 0, val width: Int = frames.firstOrNull()?.width ?: 1, val height: Int = frames.firstOrNull()?.height ?: 1, val layers: List<ImageLayer> = fastArrayListOf(), val animations: List<ImageAnimation> = fastArrayListOf(), val name: String? = null) : Extra

ImageDataContainer

open class ImageDataContainer(val imageDatas: List<ImageData>)

ImageDataWithAtlas

data class ImageDataWithAtlas(val image: ImageData, val atlas: AtlasPacker.Result<ImageFrameLayer>)

ImageDecoderNotFoundException

class ImageDecoderNotFoundException : Exception

ImageDecodingProps

data class ImageDecodingProps(val filename: String = "unknown", val width: Int? = null, val height: Int? = null, val premultiplied: Boolean? = null, val asumePremultiplied: Boolean = false, val requestedMaxSize: Int? = null, val debug: Boolean = false, val preferKotlinDecoder: Boolean = false, val tryNativeDecode: Boolean = true, val format: ImageFormat? = RegisteredImageFormats, val out: Bitmap? = null, var extra: ExtraType = null) : BaseImageDecodingProps, Extra

ImageEncodingProps

data class ImageEncodingProps(val filename: String = "", val quality: Double = 0.81, var extra: ExtraType = null, val depremultiplyIfRequired: Boolean = true, val init: ImageEncodingProps.() -> Unit? = null) : Extra

ImageFormat

abstract class ImageFormat(exts: String) : BaseImageDecodingProps, ImageFormatEncoderDecoder

ImageFormatDecoder

interface ImageFormatDecoder

ImageFormatEncoder

interface ImageFormatEncoder

ImageFormatEncoderDecoder

interface ImageFormatEncoderDecoder : ImageFormatEncoder, ImageFormatDecoder

ImageFormats

open class ImageFormats(formats: Iterable<ImageFormat>) : ImageFormat

ImageFormatsMutable

class ImageFormatsMutable : ImageFormats

ImageFormatSuspend

abstract class ImageFormatSuspend(exts: String) : ImageFormat

ImageFormatWithContainer

abstract class ImageFormatWithContainer(exts: String) : ImageFormat

ImageFrame

open class ImageFrame(val index: Int, val time: TimeSpan = 0.seconds, val layerData: List<ImageFrameLayer> = emptyList()) : Extra

This class defines one frame of a sprite object like e.g. an aseprite image file. It contains info about all layer images which are used in that frame.

ImageFrameLayer

open class ImageFrameLayer(val layer: ImageLayer, slice: BmpSlice, val targetX: Int = 0, val targetY: Int = 0, val main: Boolean = true, val includeInAtlas: Boolean = true, val tilemap: TileMapData? = null)

This class is used to store the layer image from e.g. an aseprite image file.

ImageInfo

open class ImageInfo : Sizeable, Extra

ImageLayer

open class ImageLayer(var index: Int, val name: String?, val type: ImageLayer.Type = Type.NORMAL)

ImageOrientation

typealias ImageOrientation = SliceOrientation

ISOBMFF

open class ISOBMFF(exts: String) : ImageFormatSuspend

JPEGInfo

object JPEGInfo : ImageFormatSuspend

KRA

object KRA : ImageFormat

NativeImageFormatProvider

abstract class NativeImageFormatProvider : ImageFormatEncoderDecoder

NativeImageResult

data class NativeImageResult(val image: NativeImage, val originalWidth: Int = image.width, val originalHeight: Int = image.height)

NodeJsNativeImageFormatProvider

object NodeJsNativeImageFormatProvider : BaseNativeImageFormatProvider

PNG

object PNG : ImageFormat

PSD

object PSD : ImageFormat

QOI

object QOI : ImageFormat

SVG

object SVG : ImageFormat

TGA

object TGA : ImageFormat

UINativeImageFormatProvider

object UINativeImageFormatProvider : CGNativeImageFormatProvider

WEBP

object WEBP : ImageFormat

Properties

area

val Iterable<ImageFrame>.area: Int

imageLoadingLogger

val imageLoadingLogger: Logger

info

var ImageData.info: ImageInfo?

kritaLoadLayers

var ImageDecodingProps.kritaLoadLayers: Boolean

kritaPartialImageLayers

var ImageDecodingProps.kritaPartialImageLayers: Boolean

nativeImageFormatProvider

actual val nativeImageFormatProvider: NativeImageFormatProvider

expect val nativeImageFormatProvider: NativeImageFormatProvider

actual val nativeImageFormatProvider: NativeImageFormatProvider

onlyReadVisibleLayers

var ImageDecodingProps.onlyReadVisibleLayers: Boolean

orientation

var ImageInfo.orientation: ImageOrientation?

orientationSure

val ImageInfo?.orientationSure: ImageOrientation

preAllocatedArrayForQOI

var ImageEncodingProps.preAllocatedArrayForQOI: UByteArrayInt?

RegisteredImageFormats

val RegisteredImageFormats: ImageFormatsMutable

Functions

displayImage

suspend fun displayImage(bmp: Bitmap, kind: Int = 0)

encode

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

encodeSuspend

suspend fun ImageFormatEncoder.encodeSuspend(bitmap: Bitmap, props: ImageEncodingProps = ImageEncodingProps("unknown")): ByteArray

fromAndroidColor

fun RGBA.Companion.fromAndroidColor(color: Int): RGBA

ImageInfo

fun ImageInfo(block: ImageInfo.() -> Unit): ImageInfo

listFormats

fun ImageFormat.listFormats(): Set<ImageFormat>

fun Array<out ImageFormat>.listFormats(): Set<ImageFormat>

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

packInMutableAtlas

fun ImageData.packInMutableAtlas(mutableAtlas: MutableAtlas<Unit>): ImageData

fun ImageDataContainer.packInMutableAtlas(mutableAtlas: MutableAtlas<Unit>): ImageDataContainer

plus

operator fun ImageFormat.plus(format: ImageFormat): ImageFormat

operator fun ImageFormat.plus(formats: List<ImageFormat>): ImageFormat

readBitmap

suspend fun VfsFile.readBitmap(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): Bitmap

suspend fun AsyncInputStream.readBitmap(props: BaseImageDecodingProps = ImageDecodingProps("file.bin")): Bitmap

readBitmapImageData

suspend fun VfsFile.readBitmapImageData(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): ImageData

readBitmapInfo

suspend fun VfsFile.readBitmapInfo(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): ImageInfo?

readBitmapListNoNative

suspend fun VfsFile.readBitmapListNoNative(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): List<Bitmap>

suspend fun AsyncInputStream.readBitmapListNoNative(props: ImageDecodingProps = ImageDecodingProps.DEFAULT): List<Bitmap>

readBitmapNative

suspend fun VfsFile.readBitmapNative(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): Bitmap

readBitmapNoNative

suspend fun VfsFile.readBitmapNoNative(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): Bitmap

readBitmapSlice

suspend fun VfsFile.readBitmapSlice(bprops: BaseImageDecodingProps, name: String? = null, atlas: MutableAtlasUnit? = null): BmpSlice

suspend fun VfsFile.readBitmapSlice(name: String? = null, atlas: MutableAtlasUnit? = null, props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): BmpSlice

readBitmapSliceWithOrientation

suspend fun VfsFile.readBitmapSliceWithOrientation(props: ImageDecodingProps = ImageDecodingProps.DEFAULT, name: String? = null, atlas: MutableAtlasUnit? = null): BmpSlice

readImageData

suspend fun AsyncInputStream.readImageData(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): ImageData

suspend fun VfsFile.readImageData(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT, atlas: MutableAtlas<Unit>? = null): ImageData

readImageDataContainer

suspend fun VfsFile.readImageDataContainer(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT, atlas: MutableAtlas<Unit>? = null): ImageDataContainer

readImageInfo

suspend fun VfsFile.readImageInfo(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): ImageInfo?

readNativeImage

suspend fun VfsFile.readNativeImage(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): NativeImage

suspend fun AsyncInputStream.readNativeImage(props: BaseImageDecodingProps = ImageDecodingProps.DEFAULT): NativeImage

readVectorImage

suspend fun VfsFile.readVectorImage(): SizedDrawable

showImageAndWait

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

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

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

showImagesAndWait

suspend fun ImageData.showImagesAndWait(kind: Int = 0)

suspend fun List<Bitmap>.showImagesAndWait(kind: Int = 0)

toAndroid

fun LineCap.toAndroid(): Paint.Cap

fun LineJoin.toAndroid(): Paint.Join

toAndroidBitmap

fun Bitmap.toAndroidBitmap(): Bitmap

toAndroidColor

fun RGBA.toAndroidColor(): Int

toAtlas

fun BmpSlice.toAtlas(atlas: MutableAtlasUnit): BmpSlice32

fun List<BmpSlice>.toAtlas(atlas: MutableAtlasUnit): List<BmpSlice32>

toHtmlNative

fun Bitmap.toHtmlNative(): HtmlNativeImage

toLike

fun HTMLCanvasElement.toLike(): HTMLCanvasElementLike

toProps

fun ImageFormat.toProps(props: ImageDecodingProps = ImageDecodingProps.DEFAULT): ImageDecodingProps

writeBitmap

suspend fun VfsFile.writeBitmap(bitmap: Bitmap, format: ImageFormat, props: ImageEncodingProps = ImageEncodingProps())

writeTo

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

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