qoi-kotlin
1.0.1indexedImplements Quite OK Image (QOI) format reading and writing functionality. Utilizes Okio for file system interactions, supporting various input sources and output destinations.
9
Stars
—
Used by
dependents
—
Health
/ 100
qoi-kotlin
A Kotlin Multiplatform implementation of Quite OK Image Format.
This library depends on Okio which provides multiplatform file system APIs.
Maven
<dependency>
<groupId>io.github.mzgreen</groupId>
<artifactId>qoi-kotlin</artifactId>
<version>1.0.1</version>
</dependency>
Gradle
repositories {
// ...
mavenCentral()
}
dependencies {
implementation 'io.github.mzgreen:qoi-kotlin:1.0.1'
}
Usage
Reading QOI images
Use QOIReader to read QOI images from disk:
// Create reader
val qoiReader = QOIReader()
// Read from String path
val qoiImage: QOIImage = qoiReader.read("image.qoi")
// Read from Okio's Path
val path: Path = // ...
val qoiImage: QOIImage = qoiReader.read(path)
// Read from Okio's FileHandle
val fileHandle: FileHandle =
qoiImage: QOIImage = qoiReader.read(fileHandle)
source: Source =
qoiImage: QOIImage = qoiReader.read(source)
Writing QOI images
Use QOIWriter to write QOI images to disk:
val qoiImage: QOIImage = // ...
// Create writer
val qoiWriter = QOIWriter()
// Write to String path
qoiWriter.write(qoiImage, "image.qoi")
// Write to Okio's Path
val path: Path = // ...
qoiWriter.write(qoiImage, path)
// Write to Okio's FileHandle
val fileHandle: FileHandle = // ...
qoiWriter.write(qoiImage, fileHandle)
// Write to Okio's Sink
val sink: Sink =
qoiWriter.write(qoiImage, sink)
Building the project
$ ./gradlew build
License
MIT License