korlibs-image/korlibs.image.format/ImageFormat

ImageFormat

abstract class ImageFormat(exts: String, val mimeType: String = "image/") : BaseImageDecodingProps, ImageFormatEncoderDecoder

Inheritors

Constructors

ImageFormat

constructor(vararg exts: String, mimeType: String = "image/")

Properties

decodingProps

override val decodingProps: ImageDecodingProps

extensions

val extensions: Set<String>

mimeType

val mimeType: String

Functions

check

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

decode

suspend fun decode(file: VfsFile): Bitmap

suspend override fun decode(file: VfsFile, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): 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 fun decodeHeader(s: SyncStream, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): ImageInfo?

decodeHeaderSuspend

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

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

decodeSuspend

suspend override fun decodeSuspend(data: ByteArray, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): 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

suspend override fun encodeSuspend(image: ImageDataContainer, props: ImageEncodingProps = ImageEncodingProps("unknown")): 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

readImage

fun readImage(s: SyncStream, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): ImageData

readImageContainer

abstract fun readImageContainer(s: SyncStream, props: ImageDecodingProps = ImageDecodingProps.DEFAULT): ImageDataContainer

toProps

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

toString

open override fun toString(): String

writeImage

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

writeImageContainer

open fun writeImageContainer(image: ImageDataContainer, s: SyncStream, props: ImageEncodingProps)