https://github.com/chrynan/imagery
Components and utilities for working with images in Kotlin.
https://github.com/chrynan/imagery
image image-processing kotlin kotlin-library kotlin-multi-platform kotlin-multiplatform kotlin-multiplatform-library
Last synced: 3 months ago
JSON representation
Components and utilities for working with images in Kotlin.
- Host: GitHub
- URL: https://github.com/chrynan/imagery
- Owner: chRyNaN
- License: apache-2.0
- Created: 2021-04-22T01:25:43.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-28T22:57:20.000Z (about 3 years ago)
- Last Synced: 2023-02-27T06:41:52.514Z (almost 3 years ago)
- Topics: image, image-processing, kotlin, kotlin-library, kotlin-multi-platform, kotlin-multiplatform, kotlin-multiplatform-library
- Language: Kotlin
- Homepage:
- Size: 260 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# imagery
Components and utilities for working with images in Kotlin.
## Using the library
The `Image` model contains everything necessary to represent an image and all of its associated data. All the models are
serializable with [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization). To create an instance of
an `Image`, a URI is required that points to the image resource. All other fields are optional.
```kotlin
val image = Image(
uri = "https://example.com/image"
)
```
The `Image` model contains useful optional properties, such as `blurHash` and `focalPoint`.
A [BlurHash](https://blurha.sh/) can be used as a placeholder while the image resource is loading.
A [FocalPoint](https://github.com/jonom/jquery-focuspoint) keeps the most important part of the image visible when the
image is clipped.
A BlurHash for an image can be obtained using a `BlurHashEncoder`:
```kotlin
val encoder = BlurHashEncoder()
val blurHash = encoder.encode(
pixelsArray,
width,
height,
componentX,
componentY,
)
```
When a BlurHash is obtained, it can be rendered to an image array that can be displayed while the image is loading.
```kotlin
val decoder = BlurHashDecoder()
val result = decoder.decode(
blurHash,
width,
height,
punch,
)
// The result.pixels array can be used to create a platform Bitmap object.
result.pixels
```
A `FocalPoint` is created by telling which coordinates in the image array are the most important.
```kotlin
FocalPoint(
imageX,
imageY,
imageWidth,
imageHeight
)
```
A `FocalPoint` can be used to get the area of the image that should be displayed if the view size is smaller than the
image, and the scale type is set to matrix.
```kotlin
val resolver = FocalPointResolver()
val result = resolver.resolve(
viewWidth,
viewHeight,
imageWidth,
imageHeight,
focalPoint,
)
// The result object contains everything needed to create a platform matrix object to scale the image appropriately.
result.scale
result.dx
result.dy
```
### ImageCreator
An `ImageCreator` can be used to create instances of an `Image`, including all of its data, such as the Blur Hash, in a single function call.
```kotlin
val imageCreator = ImageCreator(blurHashEncoder, uriMimeTypeResolver)
val image = imageCreator.create(
uri,
width,
height,
pixels,
blurHashComponentX,
blurHashComponentY,
focalPointX,
focalPointY
)
```
## Building the library
The library is provided through [Repsy.io](https://repsy.io). Checkout
the [releases page](https://github.com/chRyNaN/colors/releases) to get the latest version.
### Repository
```groovy
repositories {
maven { url = "https://repo.repsy.io/mvn/chrynan/public" }
}
```
### Dependencies
**Core:**
```groovy
implementation "com.chrynan.imagery:imagery-core:VERSION"
```
**Android:**
```groovy
implementation "com.chrynan.imagery:imagery-android:VERSION"
```
## Documentation
More detailed documentation is available in the [docs] folder. The entry point to the documentation can be
found [here](docs/index.md).
## License
```
Copyright 2021 chRyNaN
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```