JavaFX 25 · javafx.scene.image.WritableImage · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private PixelBuffer<? extends Buffer>	pixelBuffer
private ImageLoader	tkImageLoader
private PixelWriter	writer

Constructor Summary

Access	Constructor and Description
public	WritableImage(int the desired width of the writable image width, int the desired height of the desired image height) Constructs an empty image of the specified dimensions.
public	WritableImage(PixelBuffer<? extends Buffer> the `PixelBuffer` used to construct this image pixelBuffer) Constructs a `WritableImage` using the specified `PixelBuffer`.
public	WritableImage(PixelReader the `PixelReader` to construct from reader, int the desired width of the writable image and the width of the region to be read from the `reader` width, int the desired height of the desired image and the width of the region to be read from the `reader` height) Constructs an image of the specified dimensions, initialized from the indicated `PixelReader`.
public	WritableImage(PixelReader the `PixelReader` to construct from reader, int the X coordinate of the upper left corner of the region to read from the `reader` x, int the Y coordinate of the upper left corner of the region to read from the `reader` y, int the desired width of the writable image and the width of the region to be read from the `reader` width, int the desired height of the desired image and the width of the region to be read from the `reader` height) Constructs an image of the specified dimensions, initialized from the indicated region of the `PixelReader`.

Method Summary

Modifier and Type	Method and Description
pack-priv void	bufferDirty(Rectangle rect)
public final PixelWriter	Returns: the `PixelWriter` for writing pixels to the image getPixelWriter() This method returns a `PixelWriter` that provides access to write the pixels of the image.
private Object	getTkImageLoader()
pack-priv boolean	isAnimation() Overrides javafx.scene.image.Image.isAnimation. Indicates whether image is animated.
private void	loadTkImage(Object loader)
pack-priv boolean	pixelsReadable() Overrides javafx.scene.image.Image.pixelsReadable.
private static PixelBuffer<? extends Buffer>	validatePixelBuffer(PixelBuffer<? extends Buffer> pixelBuffer)

Field Detail

pixelBuffer	back to summary
private PixelBuffer<? extends Buffer> pixelBuffer

tkImageLoader	back to summary
private ImageLoader tkImageLoader

writer	back to summary
private PixelWriter writer

Constructor Detail

WritableImage back to summary

WritableImage	back to summary
public WritableImage(int width, int height) Constructs an empty image of the specified dimensions. The image will initially be filled with transparent pixels. Images constructed this way will always be readable and writable so the corresponding getPixelReader() and getPixelWriter() will always return valid objects. The dimensions must both be positive numbers `(> 0)`. Parameters width:int the desired width of the writable image height:int the desired height of the desired image Exceptions IllegalArgumentException: if either dimension is negative or zero.

public WritableImage(int width, int height)

Constructs an empty image of the specified dimensions. The image will initially be filled with transparent pixels. Images constructed this way will always be readable and writable so the corresponding getPixelReader() and getPixelWriter() will always return valid objects. The dimensions must both be positive numbers (> 0).

Parameters

width:int: the desired width of the writable image
height:int: the desired height of the desired image

Exceptions

IllegalArgumentException:: if either dimension is negative or zero.

WritableImage back to summary

WritableImage	back to summary
public WritableImage(PixelBuffer<? extends Buffer> pixelBuffer) Constructs a `WritableImage` using the specified `PixelBuffer`. The `Buffer` provided by the `PixelBuffer` will be used directly as the pixel data for this image. The `PixelBuffer` can be shared by multiple `WritableImage`s. Images constructed this way are readable using `Image.getPixelReader()`, but are not writable using `WritableImage.getPixelWriter()`. Parameters pixelBuffer:PixelBuffer<? extends Buffer> the `PixelBuffer` used to construct this image Exceptions NullPointerException: if `pixelBuffer` is `null` Since 13

public WritableImage(PixelBuffer<? extends Buffer> pixelBuffer)

Constructs a WritableImage using the specified PixelBuffer. The Buffer provided by the PixelBuffer will be used directly as the pixel data for this image. The PixelBuffer can be shared by multiple WritableImages. Images constructed this way are readable using Image.getPixelReader(), but are not writable using WritableImage.getPixelWriter().

Parameters

pixelBuffer:PixelBuffer<? extends Buffer>: the PixelBuffer used to construct this image

Exceptions

NullPointerException:: if pixelBuffer is null

Since

WritableImage back to summary

WritableImage	back to summary
public WritableImage(PixelReader reader, int width, int height) Constructs an image of the specified dimensions, initialized from the indicated `PixelReader`. The image will initially be filled with data returned from the `PixelReader`. If the `PixelReader` accesses a surface that does not contain the necessary number of pixel rows and columns then an `ArrayIndexOutOfBoundsException` will be thrown. Images constructed this way will always be readable and writable so the corresponding getPixelReader() and getPixelWriter() will always return valid objects. The dimensions must both be positive numbers `(> 0)`. Parameters reader:PixelReader the `PixelReader` to construct from width:int the desired width of the writable image and the width of the region to be read from the `reader` height:int the desired height of the desired image and the width of the region to be read from the `reader` Exceptions ArrayIndexOutOfBoundsException: if the `reader` does not access a surface of at least the requested dimensions IllegalArgumentException: if either dimension is negative or zero.

public WritableImage(PixelReader reader, int width, int height)

Constructs an image of the specified dimensions, initialized from the indicated PixelReader. The image will initially be filled with data returned from the PixelReader. If the PixelReader accesses a surface that does not contain the necessary number of pixel rows and columns then an ArrayIndexOutOfBoundsException will be thrown. Images constructed this way will always be readable and writable so the corresponding getPixelReader() and getPixelWriter() will always return valid objects. The dimensions must both be positive numbers (> 0).

Parameters

reader:PixelReader: the PixelReader to construct from
width:int: the desired width of the writable image and the width of the region to be read from the reader
height:int: the desired height of the desired image and the width of the region to be read from the reader

Exceptions

ArrayIndexOutOfBoundsException:: if the reader does not access a surface of at least the requested dimensions
IllegalArgumentException:: if either dimension is negative or zero.

WritableImage back to summary

WritableImage	back to summary
public WritableImage(PixelReader reader, int x, int y, int width, int height) Constructs an image of the specified dimensions, initialized from the indicated region of the `PixelReader`. The image will initially be filled with data returned from the `PixelReader` for the specified region. If the `PixelReader` accesses a surface that does not contain the necessary number of pixel rows and columns then an `ArrayIndexOutOfBoundsException` will be thrown. Images constructed this way will always be readable and writable so the corresponding getPixelReader() and getPixelWriter() will always return valid objects. The dimensions must both be positive numbers `(> 0)`. Parameters reader:PixelReader the `PixelReader` to construct from x:int the X coordinate of the upper left corner of the region to read from the `reader` y:int the Y coordinate of the upper left corner of the region to read from the `reader` width:int the desired width of the writable image and the width of the region to be read from the `reader` height:int the desired height of the desired image and the width of the region to be read from the `reader` Exceptions ArrayIndexOutOfBoundsException: if the `reader` does not access a surface containing at least the indicated region IllegalArgumentException: if either dimension is negative or zero.

public WritableImage(PixelReader reader, int x, int y, int width, int height)

Constructs an image of the specified dimensions, initialized from the indicated region of the PixelReader. The image will initially be filled with data returned from the PixelReader for the specified region. If the PixelReader accesses a surface that does not contain the necessary number of pixel rows and columns then an ArrayIndexOutOfBoundsException will be thrown. Images constructed this way will always be readable and writable so the corresponding getPixelReader() and getPixelWriter() will always return valid objects. The dimensions must both be positive numbers (> 0).

Parameters

reader:PixelReader: the PixelReader to construct from
x:int: the X coordinate of the upper left corner of the region to read from the reader
y:int: the Y coordinate of the upper left corner of the region to read from the reader
width:int: the desired width of the writable image and the width of the region to be read from the reader
height:int: the desired height of the desired image and the width of the region to be read from the reader

Exceptions

ArrayIndexOutOfBoundsException:: if the reader does not access a surface containing at least the indicated region
IllegalArgumentException:: if either dimension is negative or zero.

Method Detail

bufferDirty	back to summary
pack-priv void bufferDirty(Rectangle rect)

getPixelWriter back to summary

getPixelWriter	back to summary
public final PixelWriter getPixelWriter() This method returns a `PixelWriter` that provides access to write the pixels of the image. This method is not supported for images constructed using a `PixelBuffer`. Returns:PixelWriter the `PixelWriter` for writing pixels to the image Exceptions UnsupportedOperationException: if this image was created using a `PixelBuffer`

public final PixelWriter getPixelWriter()

This method returns a PixelWriter that provides access to write the pixels of the image. This method is not supported for images constructed using a PixelBuffer.

Returns:PixelWriter

the PixelWriter for writing pixels to the image

Exceptions

UnsupportedOperationException:: if this image was created using a PixelBuffer

getTkImageLoader	back to summary
private Object getTkImageLoader()

isAnimation	back to summary
pack-priv boolean isAnimation() Overrides javafx.scene.image.Image.isAnimation. Doc from javafx.scene.image.Image.isAnimation. Indicates whether image is animated. Annotations @Override

isAnimation

back to summary

pack-priv boolean isAnimation()

Overrides javafx.scene.image.Image.isAnimation.

Doc from javafx.scene.image.Image.isAnimation.

Indicates whether image is animated.

Annotations