io.github.humbleui.skija.Image Maven / Gradle / Ivy
package io.github.humbleui.skija;
import java.lang.ref.*;
import java.nio.*;
import org.jetbrains.annotations.*;
import io.github.humbleui.skija.impl.*;
public class Image extends RefCnt implements IHasImageInfo {
static { Library.staticLoad(); }
@ApiStatus.Internal
public ImageInfo _imageInfo = null;
@ApiStatus.Internal
public Image(long ptr) {
super(ptr);
}
/**
* Creates Image from pixels.
*
* Image is returned if pixels are valid. Valid Pixmap parameters include:
*
* - dimensions are greater than zero;
* - each dimension fits in 29 bits;
* - ColorType and AlphaType are valid, and ColorType is not ColorType.UNKNOWN;
* - row bytes are large enough to hold one row of pixels;
* - pixel address is not null.
*
*
* @param imageInfo ImageInfo
* @param bytes pixels array
* @param rowBytes how many bytes in a row
* @return Image
*
* @see https://fiddle.skia.org/c/@Image_MakeRasterCopy
*/
public static Image makeRaster(ImageInfo imageInfo, byte[] bytes, long rowBytes) {
try {
Stats.onNativeCall();
long ptr = _nMakeRaster(imageInfo._width,
imageInfo._height,
imageInfo._colorInfo._colorType.ordinal(),
imageInfo._colorInfo._alphaType.ordinal(),
Native.getPtr(imageInfo._colorInfo._colorSpace),
bytes,
rowBytes);
if (ptr == 0)
throw new RuntimeException("Failed to makeRaster " + imageInfo + " " + bytes + " " + rowBytes);
return new Image(ptr);
} finally {
Reference.reachabilityFence(imageInfo._colorInfo._colorSpace);
}
}
/**
* Creates Image from pixels.
*
* Image is returned if pixels are valid. Valid Pixmap parameters include:
*
* - dimensions are greater than zero;
* - each dimension fits in 29 bits;
* - ColorType and AlphaType are valid, and ColorType is not ColorType.UNKNOWN;
* - row bytes are large enough to hold one row of pixels;
* - pixel address is not null.
*
*
* @param imageInfo ImageInfo
* @param data pixels array
* @param rowBytes how many bytes in a row
* @return Image
*/
public static Image makeRaster(ImageInfo imageInfo, Data data, long rowBytes) {
try {
Stats.onNativeCall();
long ptr = _nMakeRasterData(imageInfo._width,
imageInfo._height,
imageInfo._colorInfo._colorType.ordinal(),
imageInfo._colorInfo._alphaType.ordinal(),
Native.getPtr(imageInfo._colorInfo._colorSpace),
Native.getPtr(data),
rowBytes);
if (ptr == 0)
throw new RuntimeException("Failed to makeRaster " + imageInfo + " " + data + " " + rowBytes);
return new Image(ptr);
} finally {
Reference.reachabilityFence(imageInfo._colorInfo._colorSpace);
Reference.reachabilityFence(data);
}
}
/**
* Creates Image from bitmap, sharing or copying bitmap pixels. If the bitmap
* is marked immutable, and its pixel memory is shareable, it may be shared
* instead of copied.
*
* Image is returned if bitmap is valid. Valid Bitmap parameters include:
*
* - dimensions are greater than zero;
* - each dimension fits in 29 bits;
* - ColorType and AlphaType are valid, and ColorType is not ColorType.UNKNOWN;
* - row bytes are large enough to hold one row of pixels;
* - pixel address is not nullptr.
*
*
* @param bitmap ImageInfo, row bytes, and pixels
* @return created Image
*
* @see https://fiddle.skia.org/c/@Image_MakeFromBitmap
*/
@NotNull @Contract("_ -> new")
public static Image makeFromBitmap(@NotNull Bitmap bitmap) {
try {
assert bitmap != null : "Can’t makeFromBitmap with bitmap == null";
Stats.onNativeCall();
long ptr = _nMakeFromBitmap(Native.getPtr(bitmap));
if (ptr == 0)
throw new RuntimeException("Failed to Image::makeFromBitmap " + bitmap);
return new Image(ptr);
} finally {
Reference.reachabilityFence(bitmap);
}
}
@NotNull @Contract("_ -> new")
public static Image makeFromPixmap(@NotNull Pixmap pixmap) {
try {
assert pixmap != null : "Can’t makeFromPixmap with pixmap == null";
Stats.onNativeCall();
long ptr = _nMakeFromPixmap(Native.getPtr(pixmap));
if (ptr == 0)
throw new RuntimeException("Failed to Image::makeFromRaster " + pixmap);
return new Image(ptr);
} finally {
Reference.reachabilityFence(pixmap);
}
}
@NotNull @Contract("_ -> new")
public static Image makeFromEncoded(byte[] bytes) {
Stats.onNativeCall();
long ptr = _nMakeFromEncoded(bytes);
if (ptr == 0)
throw new IllegalArgumentException("Failed to Image::makeFromEncoded");
return new Image(ptr);
}
/**
* Returns a ImageInfo describing the width, height, color type, alpha type, and color space
* of the Image.
*
* @return image info of Image.
*/
@Override @NotNull
public ImageInfo getImageInfo() {
try {
if (_imageInfo == null) {
synchronized(this) {
if (_imageInfo == null) {
Stats.onNativeCall();
_imageInfo = _nGetImageInfo(_ptr);
}
}
}
return _imageInfo;
} finally {
Reference.reachabilityFence(this);
}
}
/**
* Encodes Image pixels, returning result as Data. Returns existing encoded data
* if present; otherwise, Image is encoded with {@link EncodedImageFormat#PNG}.
*
* Returns null if existing encoded data is missing or invalid, and encoding fails.
*
* @return encoded Image, or null
*
* @see https://fiddle.skia.org/c/@Image_encodeToData_2
*/
@Nullable
public Data encodeToData() {
return encodeToData(EncodedImageFormat.PNG, 100);
}
@Nullable
public Data encodeToData(EncodedImageFormat format) {
return encodeToData(format, 100);
}
/**
* Encodes Image pixels, returning result as Data.
*
* Returns null if encoding fails, or if format is not supported.
*
* On a macOS, encodedImageFormat can additionally be one of:
* {@link EncodedImageFormat#ICO}, {@link EncodedImageFormat#BMP} or {@link EncodedImageFormat#GIF}.
*
* quality is a platform and format specific metric trading off size and encoding
* error. When used, quality equaling 100 encodes with the least error. quality may
* be ignored by the encoder.
*
* @param format one of: {@link EncodedImageFormat#JPEG}, {@link EncodedImageFormat#PNG}, {@link EncodedImageFormat#WEBP}
* @param quality encoder specific metric with 100 equaling best
* @return encoded Image, or null
*
* @see https://fiddle.skia.org/c/@Image_encodeToData
*/
@Nullable
public Data encodeToData(EncodedImageFormat format, int quality) {
try {
Stats.onNativeCall();
long ptr = _nEncodeToData(_ptr, format.ordinal(), quality);
return ptr == 0 ? null : new Data(ptr);
} finally {
Reference.reachabilityFence(this);
}
}
@NotNull
public Shader makeShader() {
return makeShader(FilterTileMode.CLAMP, FilterTileMode.CLAMP, SamplingMode.DEFAULT, null);
}
@NotNull
public Shader makeShader(@Nullable Matrix33 localMatrix) {
return makeShader(FilterTileMode.CLAMP, FilterTileMode.CLAMP, SamplingMode.DEFAULT, localMatrix);
}
@NotNull
public Shader makeShader(@NotNull FilterTileMode tm) {
return makeShader(tm, tm, SamplingMode.DEFAULT, null);
}
@NotNull
public Shader makeShader(@NotNull FilterTileMode tmx, @NotNull FilterTileMode tmy) {
return makeShader(tmx, tmy, SamplingMode.DEFAULT, null);
}
@NotNull
public Shader makeShader(@NotNull FilterTileMode tmx,
@NotNull FilterTileMode tmy,
@Nullable Matrix33 localMatrix) {
return makeShader(tmx, tmy, SamplingMode.DEFAULT, localMatrix);
}
@NotNull
public Shader makeShader(@NotNull FilterTileMode tmx,
@NotNull FilterTileMode tmy,
@NotNull SamplingMode sampling,
@Nullable Matrix33 localMatrix) {
try {
assert tmx != null : "Can’t Bitmap.makeShader with tmx == null";
assert tmy != null : "Can’t Bitmap.makeShader with tmy == null";
assert sampling != null : "Can’t Bitmap.makeShader with sampling == null";
Stats.onNativeCall();
return new Shader(_nMakeShader(_ptr, tmx.ordinal(), tmy.ordinal(), sampling._pack(), localMatrix == null ? null : localMatrix._mat));
} finally {
Reference.reachabilityFence(this);
}
}
/**
* If pixel address is available, return ByteBuffer wrapping it.
* If pixel address is not available, return null.
*
* @return ByteBuffer with direct access to pixels, or null
*
* @see https://fiddle.skia.org/c/@Image_peekPixels
*/
@Nullable
public ByteBuffer peekPixels() {
try {
Stats.onNativeCall();
return _nPeekPixels(_ptr);
} finally {
Reference.reachabilityFence(this);
}
}
public boolean peekPixels(Pixmap pixmap) {
try {
Stats.onNativeCall();
return _nPeekPixelsToPixmap(_ptr, Native.getPtr(pixmap));
} finally {
Reference.reachabilityFence(this);
Reference.reachabilityFence(pixmap);
}
}
public boolean readPixels(@NotNull Bitmap dst) {
return readPixels(null, dst, 0, 0, false);
}
public boolean readPixels(@NotNull Bitmap dst, int srcX, int srcY) {
return readPixels(null, dst, srcX, srcY, false);
}
/**
* Copies Rect of pixels from Image to Bitmap. Copy starts at offset (srcX, srcY),
* and does not exceed Image (getWidth(), getHeight()).
*
* dst specifies width, height, ColorType, AlphaType, and ColorSpace of destination.
*
* Returns true if pixels are copied. Returns false if:
*
* - dst has no pixels allocated.
*
*
* Pixels are copied only if pixel conversion is possible. If Image ColorType is
* ColorType.GRAY_8, or ColorType.ALPHA_8; dst.getColorType() must match.
* If Image ColorType is ColorType.GRAY_8, dst.getColorSpace() must match.
* If Image AlphaType is AlphaType.OPAQUE, dst.getAlphaType() must
* match. If Image ColorSpace is null, dst.getColorSpace() must match. Returns
* false if pixel conversion is not possible.
*
* srcX and srcY may be negative to copy only top or left of source. Returns
* false if getWidth() or getHeight() is zero or negative.
*
* Returns false if abs(srcX) >= Image.getWidth(), or if abs(srcY) >= Image.getHeight().
*
* If cache is true, pixels may be retained locally, otherwise pixels are not added to the local cache.
*
* @param context the DirectContext in play, if it exists
* @param dst destination bitmap
* @param srcX column index whose absolute value is less than getWidth()
* @param srcY row index whose absolute value is less than getHeight()
* @param cache whether the pixels should be cached locally
* @return true if pixels are copied to dstPixels
*/
public boolean readPixels(@Nullable DirectContext context, @NotNull Bitmap dst, int srcX, int srcY, boolean cache) {
try {
assert dst != null : "Can’t readPixels with dst == null";
return _nReadPixelsBitmap(_ptr, Native.getPtr(context), Native.getPtr(dst), srcX, srcY, cache);
} finally {
Reference.reachabilityFence(this);
Reference.reachabilityFence(context);
Reference.reachabilityFence(dst);
}
}
public boolean readPixels(@NotNull Pixmap dst, int srcX, int srcY, boolean cache) {
try {
assert dst != null : "Can’t readPixels with dst == null";
return _nReadPixelsPixmap(_ptr, Native.getPtr(dst), srcX, srcY, cache);
} finally {
Reference.reachabilityFence(this);
Reference.reachabilityFence(dst);
}
}
public boolean scalePixels(@NotNull Pixmap dst, SamplingMode samplingMode, boolean cache) {
try {
assert dst != null : "Can’t scalePixels with dst == null";
return _nScalePixels(_ptr, Native.getPtr(dst), samplingMode._pack(), cache);
} finally {
Reference.reachabilityFence(this);
Reference.reachabilityFence(dst);
}
}
@ApiStatus.Internal public static native long _nMakeRaster(int width, int height, int colorType, int alphaType, long colorSpacePtr, byte[] pixels, long rowBytes);
@ApiStatus.Internal public static native long _nMakeRasterData(int width, int height, int colorType, int alphaType, long colorSpacePtr, long dataPtr, long rowBytes);
@ApiStatus.Internal public static native long _nMakeFromBitmap(long bitmapPtr);
@ApiStatus.Internal public static native long _nMakeFromPixmap(long pixmapPtr);
@ApiStatus.Internal public static native long _nMakeFromEncoded(byte[] bytes);
@ApiStatus.Internal public static native ImageInfo _nGetImageInfo(long ptr);
@ApiStatus.Internal public static native long _nEncodeToData(long ptr, int format, int quality);
@ApiStatus.Internal public static native long _nMakeShader(long ptr, int tmx, int tmy, long samplingMode, float[] localMatrix);
@ApiStatus.Internal public static native ByteBuffer _nPeekPixels(long ptr);
@ApiStatus.Internal public static native boolean _nPeekPixelsToPixmap(long ptr, long pixmapPtr);
@ApiStatus.Internal public static native boolean _nScalePixels(long ptr, long pixmapPtr, long samplingOptions, boolean cache);
@ApiStatus.Internal public static native boolean _nReadPixelsBitmap(long ptr, long contextPtr, long bitmapPtr, int srcX, int srcY, boolean cache);
@ApiStatus.Internal public static native boolean _nReadPixelsPixmap(long ptr, long pixmapPtr, int srcX, int srcY, boolean cache);
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy