Class WritableImage

public class WritableImage
extends Image

• Property Summary

  • Properties inherited from class javafx.scene.image.Image

    error, exception, height, progress, width

• Constructor Summary

  Constructors

  Constructor and Description
  WritableImage(int width, int height) Construct an empty image of the specified dimensions.
  WritableImage(PixelReader reader, int width, int height) Construct an image of the specified dimensions, initialized from the indicated PixelReader.
  WritableImage(PixelReader reader, int x, int y, int width, int height) Construct an image of the specified dimensions, initialized from the indicated region of the PixelReader.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type	Method and Description
  PixelWriter	getPixelWriter() This method returns a PixelWriter that provides access to write the pixels of the image.

  • Methods inherited from class javafx.scene.image.Image

    cancel, errorProperty, exceptionProperty, getException, getHeight, getPixelReader, getProgress, getRequestedHeight, getRequestedWidth, getWidth, heightProperty, isBackgroundLoading, isError, isPreserveRatio, isSmooth, progressProperty, widthProperty

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Detail

  • WritableImage

    public WritableImage(int width,
                         int height)

    Construct 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 - the desired width of the writable image

    Throws:

    IllegalArgumentException - if either dimension is negative or zero.

  • WritableImage

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

    Construct 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:

    width - the desired width of the writable image and the width of the region to be read from the reader

    Throws:

    ArrayIndexOutOfBoundsException - if the reader does not access a surface of at least the requested dimensions

  • WritableImage

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

    Construct 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:

    x - the X coordinate of the upper left corner of the region to read from the reader

    Throws:

    ArrayIndexOutOfBoundsException - if the reader does not access a surface containing at least the indicated region

• Method Detail

  • getPixelWriter

    public final PixelWriter getPixelWriter()

    This method returns a PixelWriter that provides access to write the pixels of the image.

    Returns:

    the PixelWriter for writing pixels to the image