javafx.scene.image

Class PixelFormat<T extends java.nio.Buffer>

java.lang.Object

javafx.scene.image.PixelFormat<T>

Direct Known Subclasses:

WritablePixelFormat

public abstract class PixelFormat<T extends java.nio.Buffer>
extends java.lang.Object

A PixelFormat object defines the layout of data for a pixel of a given format.

Since:

2.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PixelFormat.Type

Method Summary

Methods

Modifier and Type	Method and Description
static PixelFormat<java.nio.ByteBuffer>	createByteIndexedInstance(int[] colors)
static PixelFormat<java.nio.ByteBuffer>	createByteIndexedPremultipliedInstance(int[] colors)
abstract int	getArgb(T buf, int x, int y, int scanlineStride) Reads a 32-bit integer representation of the color from the buffer at the specified coordinates.
static WritablePixelFormat<java.nio.ByteBuffer>	getByteBgraInstance()
static WritablePixelFormat<java.nio.ByteBuffer>	getByteBgraPreInstance()
static PixelFormat<java.nio.ByteBuffer>	getByteRgbInstance()
static WritablePixelFormat<java.nio.IntBuffer>	getIntArgbInstance()
static WritablePixelFormat<java.nio.IntBuffer>	getIntArgbPreInstance()
PixelFormat.Type	getType()
abstract boolean	isPremultiplied()
abstract boolean	isWritable()

Methods inherited from class java.lang.Object

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

Method Detail

getIntArgbInstance

public static WritablePixelFormat<java.nio.IntBuffer> getIntArgbInstance()

getIntArgbPreInstance

public static WritablePixelFormat<java.nio.IntBuffer> getIntArgbPreInstance()

getByteBgraInstance

public static WritablePixelFormat<java.nio.ByteBuffer> getByteBgraInstance()

getByteBgraPreInstance

public static WritablePixelFormat<java.nio.ByteBuffer> getByteBgraPreInstance()

getByteRgbInstance

public static PixelFormat<java.nio.ByteBuffer> getByteRgbInstance()

createByteIndexedPremultipliedInstance

public static PixelFormat<java.nio.ByteBuffer> createByteIndexedPremultipliedInstance(int[] colors)

createByteIndexedInstance

public static PixelFormat<java.nio.ByteBuffer> createByteIndexedInstance(int[] colors)

getType

public PixelFormat.Type getType()

isWritable

public abstract boolean isWritable()

isPremultiplied

public abstract boolean isPremultiplied()

getArgb

public abstract int getArgb(T buf,
          int x,
          int y,
          int scanlineStride)

Reads a 32-bit integer representation of the color from 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.

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 Type.INT_ARGB pixel format