https://github.com/0xd3adcode/aetherjfx-imagedecoder-simplewebp

AetherJFX (JavaFX) image decoding (IIO) WebP plugin in pure Java
https://github.com/0xd3adcode/aetherjfx-imagedecoder-simplewebp

image javafx webp

Last synced: 2 days ago
JSON representation

AetherJFX (JavaFX) image decoding (IIO) WebP plugin in pure Java

• Host: GitHub
• URL: https://github.com/0xd3adcode/aetherjfx-imagedecoder-simplewebp
• Owner: 0xD3ADCODE
• Created: 2024-11-10T19:15:58.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-11T16:06:14.000Z (2 months ago)
• Last Synced: 2024-11-11T17:20:08.617Z (2 months ago)
• Topics: image, javafx, webp
• Language: Java
• Homepage:
• Size: 102 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![AetherJFX](https://img.shields.io/badge/Only%20for:-AetherJFX-blue)](https://github.com/0xD3ADCODE/AetherJFX)

![Java](https://img.shields.io/badge/Java-17-b07219)

# AetherJFX (Simple) WebP Image Decoder Plugin

> [!WARNING]  

> This plugin is designed to be used ONLY with [JavaFX](https://github.com/openjdk/jfx) fork [AetherJFX](https://github.com/0xD3ADCODE/AetherJFX). Attempting to use it with standard JavaFX will lead to an exception!

[WebP](https://developers.google.com/speed/webp) image decoding plugin for [AetherJFX](https://github.com/0xD3ADCODE/AetherJFX)

Based on [SimpleWEBP](https://github.com/burningtnt/SimpleWEBP) and integrates into JavaFX's `ImageIO` (`IIO`) without bytecode manipulations

> [!IMPORTANT]  

> This plugin written in pure Java, don't require any native libraries and DOES NOT support Lossless and Animated WebP!

## Dependency

Define custom Gradle ivy repository in `repositories` block:

```groovy

repositories {

    //...your repositories

    def github = ivy {

        url 'https://github.com/'

        patternLayout {

            artifact '/[organisation]/[module]/releases/download/[revision]/[artifact].[ext]'

        }

        metadataSources { artifact() }

    }

    exclusiveContent {

        forRepositories(github)

        filter { includeGroup("0xD3ADCODE") }

    }

}

```

Add dependency into `dependencies` block:

```groovy

dependencies {

    //...your dependencies

    implementation("0xD3ADCODE:AetherJFX-ImageDecoder-SimpleWebP:{version}") {

        artifact {

            name = 'AetherJFX-ImageDecoder-SimpleWebP-{version}'

            type = 'jar'

        }

    }

}

```

Replace `{version}` with latest [Release](https://github.com/0xD3ADCODE/AetherJFX-ImageDecoder-SimpleWebP/releases) tag (eg, `v1.0`)

## Usage

Register plugin as soon as possible (before JavaFX Toolkit start) with just one line of code:

```java

SimpleWEBPLoader.register();

```

After that all WebP images will be decoded using newly installed decoder directly into JavaFX's `Image`

## Development

To properly build `jar` by yourself, clone repository and create `gradle.properties` file with:

```text

AETHER_JFX_SDK_PATH = 

```

## Credits

[Google](https://developers.google.com) for [WebP](https://developers.google.com/speed/webp) decoder  

[burningtnt](https://github.com/burningtnt/) for [SimpleWEBP](https://github.com/burningtnt/SimpleWEBP) WebP decoder/encoder implementation for Java