javafx.scene.image

Class WritablePixelFormat.IntArgb

java.lang.Object

javafx.scene.image.PixelFormat<T>

javafx.scene.image.WritablePixelFormat<java.nio.IntBuffer>

javafx.scene.image.WritablePixelFormat.IntArgb

Enclosing class:

WritablePixelFormat<T extends java.nio.Buffer>

static class WritablePixelFormat.IntArgb
extends WritablePixelFormat<java.nio.IntBuffer>

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.image.WritablePixelFormat

WritablePixelFormat.ByteBgra, WritablePixelFormat.ByteBgraPre, WritablePixelFormat.IntArgb, WritablePixelFormat.IntArgbPre

Nested classes/interfaces inherited from class javafx.scene.image.PixelFormat

PixelFormat.ByteRgb, PixelFormat.IndexedPixelFormat, PixelFormat.Type

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static WritablePixelFormat.IntArgb	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor and Description
private	IntArgb()

Method Summary

Modifier and Type	Method and Description
int	getArgb(java.nio.IntBuffer buf, int x, int y, int scanlineStride) Reads pixel data from the buffer at the specified coordinates and converts it to a 32-bit integer representation of the color in the INT_ARGB format.
boolean	isPremultiplied() Returns true iff the color components decoded (or encoded) by this format are pre-multiplied by the alpha component for more efficient blending calculations.
void	setArgb(java.nio.IntBuffer buf, int x, int y, int scanlineStride, int argb) Stores the appropriate pixel data that represents the specified 32-bit integer representation of a color in the buffer at the specified coordinates.

Methods inherited from class javafx.scene.image.WritablePixelFormat

isWritable

Methods inherited from class javafx.scene.image.PixelFormat

createByteIndexedInstance, createByteIndexedPremultipliedInstance, getByteBgraInstance, getByteBgraPreInstance, getByteRgbInstance, getIntArgbInstance, getIntArgbPreInstance, getType, NonPretoPre, PretoNonPre

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

static final WritablePixelFormat.IntArgb INSTANCE

Constructor Detail

IntArgb

private IntArgb()

Method Detail

isPremultiplied

public boolean isPremultiplied()

Description copied from class: PixelFormat

Returns true iff the color components decoded (or encoded) by this format are pre-multiplied by the alpha component for more efficient blending calculations.

Specified by:

isPremultiplied in class PixelFormat<java.nio.IntBuffer>

Returns:

true iff the managed color components are premultiplied by alpha

getArgb

public int getArgb(java.nio.IntBuffer buf,
                   int x,
                   int y,
                   int scanlineStride)

Description copied from class: PixelFormat

Reads pixel data from the buffer at the specified coordinates and converts it to a 32-bit integer representation of the color in the INT_ARGB format. The 32-bit integer will contain the 4 color components in separate 8-bit fields in ARGB order from the most significant byte to the least significant byte. The buffer should be positioned to the start of the pixel data such that buf.get(0) would return the pixel information for the pixel at coordinates (0, 0). The scanlineStride parameter defines the distance from the pixel data at the start of one row to the pixel data at the start of the immediately following row at the next higher Y coordinate. Usually, scanlineStride is the same as the width of the image multiplied by the number of data elements per pixel (1 for the case of the integer and indexed formats, or 3 or 4 in the case of the byte formats), but some images may have further padding between rows for alignment or other purposes.

The color components can be extracted from the returned integer using the following sample code:

     int alpha = ((retval >> 24) & 0xff);
     int red   = ((retval >> 16) & 0xff);
     int green = ((retval >>  8) & 0xff);
     int blue  = ((retval      ) & 0xff);
 

Specified by:

getArgb in class PixelFormat<java.nio.IntBuffer>

Parameters:

buf - the buffer of pixel data

x - the X coordinate of the pixel to be read

y - the Y coordinate of the pixel to be read

scanlineStride - the number of buffer elements between the start of adjacent pixel rows in the buffer

Returns:

a 32-bit value with the color of the pixel in a format similar to the INT_ARGB pixel format

setArgb

public void setArgb(java.nio.IntBuffer buf,
                    int x,
                    int y,
                    int scanlineStride,
                    int argb)

Description copied from class: WritablePixelFormat

Stores the appropriate pixel data that represents the specified 32-bit integer representation of a color in the buffer at the specified coordinates. The 32-bit integer will contain the 4 color components in separate 8-bit fields in ARGB order from the most significant byte to the least significant byte. The buffer should be positioned to the start of the pixel data such that buf.get(0) would return the pixel information for the pixel at coordinates (0, 0). The scanlineStride parameter defines the distance from the pixel data at the start of one row to the pixel data at the start of the immediately following row at the next higher Y coordinate. Usually, scanlineStride is the same as the width of the image multiplied by the number of data elements per pixel (1 for the case of the integer and indexed formats, or 3 or 4 in the case of the byte formats), but some images may have further padding between rows for alignment or other purposes.

Color components can be composed into an integer using the following sample code:

     int argb = ((alpha << 24) |
                 (red   << 16) |
                 (green <<  8) |
                 (blue       );
 

Specified by:

setArgb in class WritablePixelFormat<java.nio.IntBuffer>

Parameters:

buf - the buffer of pixel data

x - the X coordinate of the pixel to be read

y - the Y coordinate of the pixel to be read

scanlineStride - the number of buffer elements between the start of adjacent pixel rows in the buffer

argb - a 32-bit value with the color to be stored in the pixel in a format similar to the Type.INT_ARGB pixel format