ASE

object ASE : ImageFormatWithContainer

Types

AseBitmapCell

open class AseBitmapCell(val bmp: Bitmap, val x: Int, val y: Int, val opacity: Int) : ASE.AseEntity, ASE.AseCell

AseCell

interface AseCell : ASE.AseEntity

AseEntity

interface AseEntity

AseFrame

open class AseFrame(val index: Int) : ASE.AseEntity

AseImage

open class AseImage : ASE.AseEntity

AseLayer

open class AseLayer(val originalAseIndex: Int, var index: Int, val name: String, val flags: Int, val type: ImageLayer.Type, val childLevel: Int, val blendModeInt: Int, val opacity: Int, val tilesetIndex: Int) : ImageLayer, ASE.AseEntity

AseLayerCell

open class AseLayerCell(val frameIndex: Int, val layer: ASE.AseLayer, val cell: ASE.AseCell) : ASE.AseEntity

AseLinkedCell

open class AseLinkedCell(val linkedCell: ASE.AseCell, val x: Int, val y: Int, val opacity: Int) : ASE.AseEntity, ASE.AseCell

AsePalette

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

AseSlice

open class AseSlice(val name: String, val hasNinePatch: Boolean, val hasPivotInfo: Boolean) : ASE.AseEntity

AseSliceKey

open class AseSliceKey(val frameIndex: Int, val sliceXOrigin: Int, val sliceYOrigin: Int, val sliceWidth: Int, val sliceHeight: Int, val centerXPos: Int, val centerYPos: Int, val centerWidth: Int, val centerHeight: Int, val pivotX: Int, val pivotY: Int)

AseTag

open class AseTag(val fromFrame: Int, val toFrame: Int, val directionByte: Int, val tagColor: RGBA, val tagName: String) : ASE.AseEntity

AseTilemapCell

open class AseTilemapCell(val data: IntArray2, val tileBitmask: Int, val bitmaskXFlip: Int, val bitmaskYFlip: Int, val bitmask90CWFlip: Int, val x: Int, val y: Int, val opacity: Int) : ASE.AseEntity, ASE.AseCell

AseTileset

data class AseTileset(val tilesetId: Int, val ntiles: Int, val tileWidth: Int, val tileHeight: Int, val baseIndex: Int, val tilesetName: String, val tiles: List<BmpSlice>)

Properties

decodingProps

open override val decodingProps: ImageDecodingProps

extensions

val extensions: Set<String>

Functions

check

fun check(s: SyncStream, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): Boolean

decode

suspend fun decode(file: VfsFile): Bitmap

open suspend override fun decode(file: VfsFile, props: ImageDecodingProps): Bitmap

suspend fun decode(s: AsyncStream, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): Bitmap

suspend fun decode(s: AsyncStream, filename: String): Bitmap

fun decode(s: SyncStream, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): Bitmap

fun decode(data: ByteArray, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): Bitmap

Decodes a given data byte array to a bitmap based on the image format with optional extra prop properties.

decodeHeader

open override fun decodeHeader(s: SyncStream, props: ImageDecodingProps): ImageInfo?

decodeHeaderSuspend

suspend fun decodeHeaderSuspend(file: VfsFile, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): ImageInfo?

open suspend fun decodeHeaderSuspend(s: AsyncStream, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): ImageInfo?

decodeSuspend

open suspend override fun decodeSuspend(data: ByteArray, props: ImageDecodingProps): Bitmap

encode

fun encode(bitmap: Bitmap, props: ImageEncodingProps = ImageEncodingProps("unknown")): ByteArray

fun encode(image: ImageData, props: ImageEncodingProps = ImageEncodingProps("unknown")): ByteArray

fun encode(frames: List<ImageFrame>, props: ImageEncodingProps = ImageEncodingProps("unknown")): ByteArray

encodeSuspend

open suspend override fun encodeSuspend(image: ImageDataContainer, props: ImageEncodingProps): ByteArray

encodeSuspend

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

listFormats

fun ImageFormat.listFormats(): Set<ImageFormat>

plus

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

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

read

suspend fun read(file: VfsFile): Bitmap

suspend fun read(file: VfsFile, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): ImageData

fun read(s: SyncStream, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): Bitmap

fun read(s: SyncStream, filename: String = "unknown"): Bitmap

fun read(s: ByteArray, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): Bitmap

fun read(s: ByteArray, filename: String): Bitmap

readAseString

fun SyncStream.readAseString(): String

readFixedLE

fun SyncStream.readFixedLE(): Fixed32

readImage

override fun readImage(s: SyncStream, props: ImageDecodingProps): ImageData

readImageContainer

open override fun readImageContainer(s: SyncStream, props: ImageDecodingProps): ImageDataContainer

This function reads the Aseprite image file, decodes its content and stores selected details into an ImageDataContainer object.

readRGB

fun SyncStream.readRGB(): RGBA

readRGBA

fun SyncStream.readRGBA(): RGBA

toProps

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

toString

open override fun toString(): String

writeImage

open fun writeImage(image: ImageData, s: SyncStream, props: ImageEncodingProps)