Release 0.4.0 !

tommyettinger · Jun 9, 2023 · c17b490 · c17b490
1 parent fbdc79a
commit c17b490
Show file tree

Hide file tree

Showing 27 changed files with 379 additions and 147 deletions.
diff --git a/README.md b/README.md
@@ -69,7 +69,7 @@ A typical Gradle dependency on anim8 looks like this (in the core module's depen
 dependencies {
   //... other dependencies are here, like libGDX 1.9.11 or higher
   // libGDX 1.11.0 is recommended currently, but versions as old as 1.9.11 work.
-  api "com.github.tommyettinger:anim8-gdx:0.3.15"
+  api "com.github.tommyettinger:anim8-gdx:0.4.0"
 }
 ```
 
@@ -78,10 +78,10 @@ You can also get a specific commit using JitPack, by following the instructions
 commit, unless you are experiencing problems with one in particular.)
 
 A .gwt.xml file is present in the sources jar, and because GWT needs it, you can depend on the sources jar with
-`implementation "com.github.tommyettinger:anim8-gdx:0.3.15:sources"`. The PNG-related code isn't available on GWT
-because it needs `java.util.zip`, which is unavailable there, but PaletteReducer and AnimatedGif should both work. None
-of the "Fast" classes will work on GWT. The GWT inherits line, which is needed in `GdxDefinition.gwt.xml` if no
-dependencies already have it, is:
+`implementation "com.github.tommyettinger:anim8-gdx:0.4.0:sources"`. The PNG-related code isn't available on GWT
+because it needs `java.util.zip`, which is unavailable there, but PaletteReducer and AnimatedGif should both work,
+as should QualityPalette. None of the "Fast" classes will work on GWT.
+The GWT inherits line, which is needed in `GdxDefinition.gwt.xml` if no dependencies already have it, is:
 ```xml
 <inherits name="com.github.tommyettinger.anim8" />
 ```

diff --git a/docs/apidocs/allclasses-index.html b/docs/apidocs/allclasses-index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>All Classes and Interfaces (anim8-gdx 0.3.15 API)</title>
+<title>All Classes and Interfaces (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="class index">

diff --git a/docs/apidocs/allpackages-index.html b/docs/apidocs/allpackages-index.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>All Packages (anim8-gdx 0.3.15 API)</title>
+<title>All Packages (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="package index">

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/AnimatedGif.html b/docs/apidocs/com/github/tommyettinger/anim8/AnimatedGif.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>AnimatedGif (anim8-gdx 0.3.15 API)</title>
+<title>AnimatedGif (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="declaration: package: com.github.tommyettinger.anim8, class: AnimatedGif">

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/AnimatedPNG.html b/docs/apidocs/com/github/tommyettinger/anim8/AnimatedPNG.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>AnimatedPNG (anim8-gdx 0.3.15 API)</title>
+<title>AnimatedPNG (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="declaration: package: com.github.tommyettinger.anim8, class: AnimatedPNG">

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/AnimationWriter.html b/docs/apidocs/com/github/tommyettinger/anim8/AnimationWriter.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>AnimationWriter (anim8-gdx 0.3.15 API)</title>
+<title>AnimationWriter (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="declaration: package: com.github.tommyettinger.anim8, interface: AnimationWriter">

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/Dithered.DitherAlgorithm.html b/docs/apidocs/com/github/tommyettinger/anim8/Dithered.DitherAlgorithm.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Dithered.DitherAlgorithm (anim8-gdx 0.3.15 API)</title>
+<title>Dithered.DitherAlgorithm (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="declaration: package: com.github.tommyettinger.anim8, interface: Dithered, enum: DitherAlgorithm">
@@ -154,33 +154,37 @@ <h2>Enum Constant Summary</h2>
  parts of an image (which is a potential problem for <a href="#DIFFUSION"><code>DIFFUSION</code></a> and the other error-diffusion
  dithers).</div>
 </div>
-<div class="col-first odd-row-color"><code><a href="#NEUE" class="member-name-link">NEUE</a></code></div>
+<div class="col-first odd-row-color"><code><a href="#LOAF" class="member-name-link">LOAF</a></code></div>
 <div class="col-last odd-row-color">
+<div class="block">An intentionally-low-fidelity ordered dither with obvious repeating 2x2 patterns on a regular grid.</div>
+</div>
+<div class="col-first even-row-color"><code><a href="#NEUE" class="member-name-link">NEUE</a></code></div>
+<div class="col-last even-row-color">
 <div class="block">An error diffusion dither that mixes in ordered noise from a triangular-mapped blue noise texture; this is
  one of the best-behaving dithers here when it comes to smooth gradients.</div>
 </div>
-<div class="col-first even-row-color"><code><a href="#NONE" class="member-name-link">NONE</a></code></div>
-<div class="col-last even-row-color">
+<div class="col-first odd-row-color"><code><a href="#NONE" class="member-name-link">NONE</a></code></div>
+<div class="col-last odd-row-color">
 <div class="block">Doesn't dither at all; this generally looks bad unless the palette matches the colors in the image very
  closely or exactly.</div>
 </div>
-<div class="col-first odd-row-color"><code><a href="#PATTERN" class="member-name-link">PATTERN</a></code></div>
-<div class="col-last odd-row-color">
+<div class="col-first even-row-color"><code><a href="#PATTERN" class="member-name-link">PATTERN</a></code></div>
+<div class="col-last even-row-color">
 <div class="block">Thomas Knoll's Pattern Dither (with a 4x4 matrix), as originally described by Joel Yliluoma in
  <a href="https://bisqwit.iki.fi/story/howto/dither/jy/">this dithering article</a>.</div>
 </div>
-<div class="col-first even-row-color"><code><a href="#ROBERTS" class="member-name-link">ROBERTS</a></code></div>
-<div class="col-last even-row-color">
+<div class="col-first odd-row-color"><code><a href="#ROBERTS" class="member-name-link">ROBERTS</a></code></div>
+<div class="col-last odd-row-color">
 <div class="block">An ordered dither built around the lightness-dispersing R2 point sequence, by Martin Roberts.</div>
 </div>
-<div class="col-first odd-row-color"><code><a href="#SCATTER" class="member-name-link">SCATTER</a></code></div>
-<div class="col-last odd-row-color">
+<div class="col-first even-row-color"><code><a href="#SCATTER" class="member-name-link">SCATTER</a></code></div>
+<div class="col-last even-row-color">
 <div class="block">This tries to subtly alter the more rigidly-defined error-diffusion dither of <a href="#DIFFUSION"><code>DIFFUSION</code></a> with a small
  amount of triangular-distributed blue noise, and unlike <a href="#CHAOTIC_NOISE"><code>CHAOTIC_NOISE</code></a>, it doesn't introduce white
  noise.</div>
 </div>
-<div class="col-first even-row-color"><code><a href="#WOVEN" class="member-name-link">WOVEN</a></code></div>
-<div class="col-last even-row-color">
+<div class="col-first odd-row-color"><code><a href="#WOVEN" class="member-name-link">WOVEN</a></code></div>
+<div class="col-last odd-row-color">
 <div class="block">An error-diffusion dither much like <a href="#NEUE"><code>NEUE</code></a>, except that it adds or subtracts a different error value
  from each RGB channel, and that it uses translated copies of the R2 dither used by <a href="#ROBERTS"><code>ROBERTS</code></a>, instead
  of using blue noise in any way.</div>
@@ -423,6 +427,19 @@ <h3>DODGY</h3>
  become the default algorithm here.</div>
 </section>
 </li>
+<li>
+<section class="detail" id="LOAF">
+<h3>LOAF</h3>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Dithered.DitherAlgorithm.html" title="enum class in com.github.tommyettinger.anim8">Dithered.DitherAlgorithm</a></span>&nbsp;<span class="element-name">LOAF</span></div>
+<div class="block">An intentionally-low-fidelity ordered dither with obvious repeating 2x2 patterns on a regular grid.
+ This is meant for dithering higher-color-count pixel art to produce lower color counts, without using any
+ techniques that are too complex to be used effectively in hand-made pixel art. This may actually look simpler
+ than it would have to be to look hand-made, especially at low dither strength.
+ <br>
+ This is probably closest to <a href="#PATTERN"><code>PATTERN</code></a> in appearance, just because they both use a square grid, but
+ this is much faster to run and looks less intricate. They also use different grids.</div>
+</section>
+</li>
 </ul>
 </section>
 </li>

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/Dithered.html b/docs/apidocs/com/github/tommyettinger/anim8/Dithered.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Dithered (anim8-gdx 0.3.15 API)</title>
+<title>Dithered (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="declaration: package: com.github.tommyettinger.anim8, interface: Dithered">

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/FastAPNG.html b/docs/apidocs/com/github/tommyettinger/anim8/FastAPNG.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>FastAPNG (anim8-gdx 0.3.15 API)</title>
+<title>FastAPNG (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="declaration: package: com.github.tommyettinger.anim8, class: FastAPNG">

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/FastGif.html b/docs/apidocs/com/github/tommyettinger/anim8/FastGif.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>FastGif (anim8-gdx 0.3.15 API)</title>
+<title>FastGif (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="declaration: package: com.github.tommyettinger.anim8, class: FastGif">

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/FastPNG.html b/docs/apidocs/com/github/tommyettinger/anim8/FastPNG.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>FastPNG (anim8-gdx 0.3.15 API)</title>
+<title>FastPNG (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="declaration: package: com.github.tommyettinger.anim8, class: FastPNG">

diff --git a/docs/apidocs/com/github/tommyettinger/anim8/FastPNG8.html b/docs/apidocs/com/github/tommyettinger/anim8/FastPNG8.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>FastPNG8 (anim8-gdx 0.3.15 API)</title>
+<title>FastPNG8 (anim8-gdx 0.4.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta name="description" content="declaration: package: com.github.tommyettinger.anim8, class: FastPNG8">