54 |
56 | All Packages
55 |Package Summary
57 |
58 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 | Package
59 | Description
60 |
61 | 
21 |
22 | xBRZ upscaling provides crisp edges and reconstructed detail. Images are
23 | upscaled to an integral factor producing a resultion ≥ target resolution. They
24 | may be then downscaled to the exact target resolution as necessary using a
25 | smooth interpolation.
26 |
27 | 
28 |
29 | One may notice downscaling a hires base image using a smooth algorithm (bilinear, bicubic) generally produces better, more detailed results vs. upscaling a lores
30 | base image. Having a source hires variant could make xBRZ unnecessary.
31 |
32 | ## License
33 |
34 | Except for [xbrz-core](xbrz-core), this project, source code and
35 | documentation is released under
36 | [BSD Zero Clause License](https://spdx.org/licenses/0BSD).
37 | See [LICENSE](LICENSE.md).
38 |
--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
1 | ## Core Usage
2 |
3 | ```java
4 | import io.github.stanio.xbrz.Xbrz;
5 | import java.awt.image.BufferedImage;
6 |
7 | BufferedImage source = ...;
8 | int srcWidth = source.getWidth();
9 | int srcHeight = source.getHeight();
10 | int[] srcPixels = source.getRGB(0, 0, srcWidth, srcHeight, null, 0, srcWidth);
11 |
12 | int factor = 2;
13 | int destWidth = srcWidth * factor;
14 | int destHeight = srcHeight * factor;
15 | boolean hasAlpha = source.getColorModel().hasAlpha();
16 | int[] destPixels = Xbrz.scaleImage(factor, hasAlpha, srcPixels, null, srcWidth, srcHeight);
17 |
18 | BufferedImage scaled = new BufferedImage(destWidth, destHeight,
19 | hasAlpha ? BufferedImage.TYPE_INT_ARGB
20 | : BufferedImage.TYPE_INT_RGB);
21 | scaled.setRGB(0, 0, destWidth, destHeight, destPixels, 0, destWidth);
22 | ```
23 |
24 | The given example uses Java AWT `BufferedImage` source just to demonstrate the
25 | input to and the output from the
26 | [`Xbrz`](apidocs/io.github.stanio.xbrz.core/io/github/stanio/xbrz/Xbrz.html)
27 | scaler is 32-bit packed ARGB
28 | pixels. The scaler itself is not dependent on any particular graphics toolkit.
29 |
30 | ## AWT and Swing
31 |
32 | Using [`XbrzImage`](apidocs/io.github.stanio.xbrz.awt/io/github/stanio/xbrz/awt/XbrzImage.html)
33 | one may derive a [`MultiResolutionImage`](https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/image/MultiResolutionImage.html)
34 | from an `Image` source:
35 |
36 | ```java
37 | import java.awt.Image;
38 | import io.github.stanio.xbrz.awt.XbrzImage;
39 |
40 | Image loResImage;
41 | ...
42 | Image xbrzImage = XbrzImage.mrImage(loResImage);
43 | ```
44 |
45 | and/or apply directly to an
46 | [`ImageIcon`](https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/ImageIcon.html):
47 |
48 | ```java
49 | import javax.swing.ImageIcon;
50 | import io.github.stanio.xbrz.awt.XbrzImage;
51 |
52 | ImageIcon icon;
53 | ...
54 | XbrzImage.apply(icon);
55 | ```
56 |
57 | See the full [API-docs](apidocs).
58 |
--------------------------------------------------------------------------------
/docs/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-slate
--------------------------------------------------------------------------------
/docs/apidocs/allpackages-index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | xBRZ Java port by Stanio.
57 | 58 |See Also:
59 |Xbrz.MultiResolutionImage implementation...MultiResolutionImage that caches resolution variants as they
82 | get produced.The help page provides an introduction to the scope and syntax of JavaDoc search.
59 |You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.
60 |The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.
61 | link 62 |63 | 64 |
65 |Loading search index...
67 | 71 |xBRZ Java port by Stanio.
9 | 10 |See Also:
11 |80 | * Note, the returned data may indicate {@code animated == true} in which case 81 | * the instance doesn't contain pixel data and can't be used as argument to 82 | * methods that otherwise accept image-data as input.
83 | * 84 | * @param image source image to obtain image-data from 85 | * @return image-data of the given source, or {@code null} if error occurs 86 | * @see #isAnimated() 87 | */ 88 | public static ImageData get(Image image) { 89 | if (image instanceof BufferedImage) { 90 | return new ImageData((BufferedImage) image); 91 | } 92 | 93 | AtomicReference24 | * This filter also registers weak {@code ImageConsumer} proxies with the 25 | * original producer, so they may get discarded/unregistered automatically 26 | * when not reachable from other sources.
27 | */ 28 | class SuspendableFilteredSource implements ImageProducer { 29 | 30 | final ImageProducer imageSource; 31 | final ImageFilter filterFactory; 32 | 33 | final WeakHashMap19 | * {@code new ImageIcon(...)} → {@code XbrzImage.apply(new ImageIcon(...))}
20 | */ 21 | public final class XbrzImage { 22 | 23 | private XbrzImage() {/* no instances */} 24 | 25 | /** 26 | * Sets up the given icon with a {@code MultiResolutionImage} deriving 27 | * resolution variants by applying xBRZ to the icon's current image. 28 | * Replaces the given icon's image with a multi-resolution one that uses 29 | * the current icon's image to produce resolution variants as requested. 30 | * 31 | * @param icon image icon to set up 32 | * @return The given {@code ImageIcon} with image updated to a 33 | * {@code MultiResolutionImage} deriving resolution variants by 34 | * applying xBRZ to the icon's current image 35 | */ 36 | public static ImageIcon apply(ImageIcon icon) { 37 | Image baseImage = Objects.requireNonNull(icon.getImage(), "icon.image"); 38 | ImageData imageData = ImageData.get(baseImage); 39 | Image mrImage; 40 | if (imageData.isAnimated()) { 41 | mrImage = new AnimatedMultiResolutionImage(baseImage); 42 | } else { 43 | mrImage = MultiResolutionCachedImage 44 | .withProducer(icon.getIconWidth(), icon.getIconHeight(), 45 | (w, h) -> AwtXbrz.scaleImage(imageData, null, w, h)); 46 | } 47 | icon.setImage(mrImage); 48 | return icon; 49 | } 50 | 51 | /** 52 | * Creates a {@code MultiResolutionImage} deriving resolution variants by 53 | * applying xBRZ to the given image. 54 | * 55 | * @param24 | * REVISIT:
25 | *