PixelWriter (JavaFX 17)

Module javafx.graphics
Package javafx.scene.image

## Interface PixelWriter

-     public interface PixelWriter

  This interface defines methods for writing the pixel data of a `WritableImage` or other surface containing writable pixels.
  Since:
    JavaFX 2.2

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `PixelFormat` | `getPixelFormat()` | This method returns the `PixelFormat` in which the surface stores its pixels, or a roughly equivalent pixel format from which it can easily convert pixels for purposes of writing them.
    `void` | `setArgb​(int x, int y, int argb)` | Stores pixel data for a color into the specified coordinates of the surface.
    `void` | `setColor​(int x, int y, Color c)` | Stores pixel data for a `Color` into the specified coordinates of the surface.
    `void` | `setPixels​(int x, int y, int w, int h, PixelFormat<ByteBuffer> pixelformat, byte[] buffer, int offset, int scanlineStride)` | Stores pixel data from a byte array into a rectangular region of the surface.
    `void` | `setPixels​(int x, int y, int w, int h, PixelFormat<IntBuffer> pixelformat, int[] buffer, int offset, int scanlineStride)` | Stores pixel data from an int array into a rectangular region of the surface.
    `<T extends Buffer> void` | `setPixels​(int x, int y, int w, int h, PixelFormat<T> pixelformat, T buffer, int scanlineStride)` | Stores pixel data from a buffer into a rectangular region of the surface.
    `void` | `setPixels​(int dstx, int dsty, int w, int h, PixelReader reader, int srcx, int srcy)` | Stores pixel data retrieved from a `PixelReader` instance into a rectangular region of the surface.

- - ### Method Detail

    - #### getPixelFormat

          PixelFormat getPixelFormat()

      This method returns the `PixelFormat` in which the surface stores its pixels, or a roughly equivalent pixel format from which it can easily convert pixels for purposes of writing them.
      Returns:
        the `PixelFormat` that best describes the underlying pixels

    - #### setArgb

          void setArgb​(int x,
                       int y,
                       int argb)

      Stores pixel data for a color into the specified coordinates of the surface. The 32-bit integer `argb` parameter should contain the 4 color components in separate 8-bit fields in ARGB order from the most significant byte to the least significant byte.
      Parameters:
        `x` - the X coordinate of the pixel color to write
        `y` - the Y coordinate of the pixel color to write
        `argb` - the color information to write, specified in the format described by the `INT_ARGB` PixelFormat type.

    - #### setColor

          void setColor​(int x,
                        int y,
                        Color c)

      Stores pixel data for a `Color` into the specified coordinates of the surface.
      Parameters:
        `x` - the X coordinate of the pixel color to write
        `y` - the Y coordinate of the pixel color to write
        `c` - the Color to write or null
      Throws:
        `NullPointerException` - if `color` is `null`

    - #### setPixels

          <T extends Buffer> void setPixels​(int x,
                                            int y,
                                            int w,
                                            int h,
                                            PixelFormat<T> pixelformat,
                                            T buffer,
                                            int scanlineStride)

      Stores pixel data from a buffer into a rectangular region of the surface. The format of the pixels in the buffer is defined by the `PixelFormat` object and pixel format conversions will be performed as needed to store the data into the surface. The buffer is assumed to be positioned to the location where the first pixel data to be stored in the surface pixel at location `(x, y)` is located. Pixel data for a row will be read from adjacent locations within the buffer packed as tightly as possible for increasing X coordinates. Pixel data for adjacent rows will be read offset from each other by the number of buffer data elements defined by `scanlineStride`.
      Type Parameters:
        `T` - the type of the buffer
      Parameters:
        `x` - the X coordinate of the rectangular region to write
        `y` - the Y coordinate of the rectangular region to write
        `w` - the width of the rectangular region to write
        `h` - the height of the rectangular region to write
        `pixelformat` - the `PixelFormat` object defining the format to read the pixels from the buffer
        `buffer` - a buffer of a type appropriate for the indicated `PixelFormat` object
        `scanlineStride` - the distance between the pixel data for the start of one row of data in the buffer to the start of the next row of data.
      Throws:
        `NullPointerException` - if `pixelformat` or `buffer` is `null`

    - #### setPixels

          void setPixels​(int x,
                         int y,
                         int w,
                         int h,
                         PixelFormat<ByteBuffer> pixelformat,
                         byte[] buffer,
                         int offset,
                         int scanlineStride)

      Stores pixel data from a byte array into a rectangular region of the surface. The format of the pixels in the buffer is defined by the `PixelFormat` object and pixel format conversions will be performed as needed to store the data into the surface. The `pixelformat` must be a compatible `PixelFormat<ByteBuffer>` type. The data for the first pixel at location `(x, y)` will be read from the array index specified by the `offset` parameter. Pixel data for a row will be read from adjacent locations within the array packed as tightly as possible for increasing X coordinates. Pixel data for adjacent rows will be read offset from each other by the number of byte array elements defined by `scanlineStride`.
      Parameters:
        `x` - the X coordinate of the rectangular region to write
        `y` - the Y coordinate of the rectangular region to write
        `w` - the width of the rectangular region to write
        `h` - the height of the rectangular region to write
        `pixelformat` - the `PixelFormat<ByteBuffer>` object defining the byte format to read the pixels from buffer
        `buffer` - a byte array containing the pixel data to store
        `offset` - the offset into `buffer` to read the first pixel data
        `scanlineStride` - the distance between the pixel data for the start of one row of data in the buffer to the start of the next row of data
      Throws:
        `NullPointerException` - if `pixelformat` or `buffer` is `null`

    - #### setPixels

          void setPixels​(int x,
                         int y,
                         int w,
                         int h,
                         PixelFormat<IntBuffer> pixelformat,
                         int[] buffer,
                         int offset,
                         int scanlineStride)

      Stores pixel data from an int array into a rectangular region of the surface. The format of the pixels in the buffer is defined by the `PixelFormat` object and pixel format conversions will be performed as needed to store the data into the surface. The `pixelformat` must be a compatible `PixelFormat<IntBuffer>` type. The data for the first pixel at location `(x, y)` will be read from the array index specified by the `offset` parameter. Pixel data for a row will be read from adjacent locations within the array packed as tightly as possible for increasing X coordinates. Pixel data for adjacent rows will be read offset from each other by the number of int array elements defined by `scanlineStride`.
      Parameters:
        `x` - the X coordinate of the rectangular region to write
        `y` - the Y coordinate of the rectangular region to write
        `w` - the width of the rectangular region to write
        `h` - the height of the rectangular region to write
        `pixelformat` - the `PixelFormat<IntBuffer>` object defining the int format to read the pixels from buffer
        `buffer` - an int array to containing the pixel data to store
        `offset` - the offset into `buffer` to read the first pixel data
        `scanlineStride` - the distance between the pixel data for the start of one row of data in the buffer to the start of the next row of data
      Throws:
        `NullPointerException` - if `pixelformat` or `buffer` is `null`

    - #### setPixels

          void setPixels​(int dstx,
                         int dsty,
                         int w,
                         int h,
                         PixelReader reader,
                         int srcx,
                         int srcy)

      Stores pixel data retrieved from a `PixelReader` instance into a rectangular region of the surface. The data for the pixel on the surface at `(dstx, dsty)` will be retrieved from the `reader` from its location `(srcx, srcy)`. This method performs an operation which is semantically equivalent to (though likely much faster than) this pseudo-code:

               for (int y = 0; y < h, y++) {
                   for (int x = 0; x < w; x++) {
                       setArgb(dstx + x, dsty + y,
                               reader.getArgb(srcx + x, srcy + y));
                   }
               }

      Parameters:
        `dstx` - the X coordinate of the rectangular region to write
        `dsty` - the Y coordinate of the rectangular region to write
        `w` - the width of the rectangular region to write
        `h` - the height of the rectangular region to write
        `reader` - the `PixelReader` used to get the pixel data to write
        `srcx` - the X coordinate of the data to read from `reader`
        `srcy` - the Y coordinate of the data to read from `reader`
      Throws:
        `NullPointerException` - if `reader` is `null`