PixelDataFormat

Inheritance: java.lang.Object

public class PixelDataFormat

The pixel data format. This is an immutable object.

Methods

Method	Description
equals(Object obj)	Determines whether the specified System.Object is equal to this instance.
getBgr(int bitsPerSample)	Gets BGR color with a specified number of bits per sample.
getBgra(int bitsPerSample)	Gets BGRA color with a specified number of bits per sample.
getBitsPerPixel()	Gets the bits per pixel.
getCaption()	Gets the pixel data format caption.
getChannelBits()	Gets the bits count for each channel.
getChannelsCount()	Gets the channels count.
getCieLab(int bitsPerL, int bitsPerA, int bitsPerB)	Gets CIE Lab color with a specified number of bits per sample.
getClass()
getCmyk()	Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the cyan, magenta, yellow and black.
getCmyk(int bitsPerSample)	Gets CMYK color with a specified number of bits per sample.
getCmyk(int bitsPerCyanChannel, int bitsPerMagentaChannel, int bitsPerYellowChannel, int bitsPerKeyChannel)	Gets CMYK color with a specified number of bits per sample.
getCmyk16()	Gets the PixelDataFormat defined for 64 bits per pixel with 16 bits for each of the cyan, magenta, yellow and black.
getCmyka()	Gets the acmyk.
getCmyka(int bitsPerCyanChannel, int bitsPerMagentaChannel, int bitsPerYellowChannel, int bitsPerKeyChannel, int bitsPerAlphaChannel)	Gets CMYKA color with a specified number of bits per sample.
getCmyka16()	Gets the acmyk.
getGrayscale()	Gets the PixelDataFormat defined for 8 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval.
getGrayscale(int bitsPerSample)	Gets Grayscale color with a specified number of bits per sample.
getGrayscaleAlpha()	Gets the PixelDataFormat defined for 16 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval and additional 8 bit alpha component.
getGrayscaleAlpha(int bitsPerSample)	Gets GrayscaleAlpha color with a specified number of bits per sample.
getGrayscaleAlpha(int bitsPerSample, int alphaChannelBits)	Gets GrayscaleAlpha color with a specified number of bits per sample.
getGrayscaleFloat32_internalized()	Gets the PixelDataFormat defined for 32 bits per pixel representing grayscale intensity in floating point format.
getPixelFormat()	Gets the pixel format.
getRgb(int bitsPerSample)	Gets RGB color with a specified number of bits per sample.
getRgb(int bitsPerRedChannel, int bitsPerGreenChannel, int bitsPerBlueChannel)	Gets RGB color with a specified number of bits per sample.
getRgb16Bpp555()	Gets the PixelDataFormat defined for 16 bits per pixel with 5 bits for each of the red, green and blue, alpha is not defined.
getRgb16Bpp565()	Gets the PixelDataFormat defined for 16 bits per pixel with 5 bits for red, 6 bits for green and 5 bits for blue, alpha is not defined.
getRgb24Bpp()	Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.
getRgb24BppPng()	Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.
getRgb32Bpp()	Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.
getRgbIndexed(int bitsPerSample)	Gets BGRA indexed color with a specified number of bits per sample.
getRgbIndexed1Bpp()	Gets the PixelDataFormat defined for indexed 1 bit per color.
getRgbIndexed2Bpp()	Gets the PixelDataFormat defined for indexed 2 bit per color.
getRgbIndexed4Bpp()	Gets the PixelDataFormat defined for indexed 4 bit per color.
getRgbIndexed8Bpp()	Gets the PixelDataFormat defined for indexed 8 bit per color.
getRgba(int bitsPerSample)	Gets RGBA color with a specified number of bits per sample.
getRgba(int bitsPerRedChannel, int bitsPerGreenChannel, int bitsPerBlueChannel, int bitsPerAlphaChannel)	Gets RGBA color with a specified number of bits per sample.
getRgba32Bpp()	Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.
getRgba64Bpp()	Gets the PixelDataFormat defined for 64 bits per pixel with 16 bits for each of the alpha, red, green and blue.
getYCbCr()	Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the luma, blue-difference and red-difference chroma components.
getYCbCr(int bitsPerSample)	Gets YCbCr color with a specified number of bits per sample.
getYCbCr(int bitsPerY, int bitsPerCb, int bitsPerCr)	Gets YCbCr color with a specified number of bits per sample.
getYcck()	Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the luma, blue-difference, red-difference and black chroma components.
getYcck(int bitsPerSample)	Gets YCCK color with a specified number of bits per sample.
hashCode()	Returns a hash code for this instance.
isIndexed_internalized()	Gets a value indicating whether this instance is indexed.
newPixelDataFormat_internalized(int[] channelBits, int pixelFormat, String caption)
notify()
notifyAll()
op_Equality(PixelDataFormat pixelFormat1, PixelDataFormat pixelFormat2)	Returns result of equality for two PixelDataFormat classes.
op_Inequality(PixelDataFormat pixelFormat1, PixelDataFormat pixelFormat2)	Returns result of non-equality for two PixelDataFormat classes.
toString()	Returns a System.String that represents this instance.
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object obj)

public boolean equals(Object obj)

Determines whether the specified System.Object is equal to this instance.

Parameters:

Parameter	Type	Description
obj	java.lang.Object	The System.Object to compare with this instance.

Returns: boolean - true if the specified System.Object is equal to this instance; otherwise, false .

getBgr(int bitsPerSample)

public static PixelDataFormat getBgr(int bitsPerSample)

Gets BGR color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.

Returns: PixelDataFormat - The BGR color.

getBgra(int bitsPerSample)

public static PixelDataFormat getBgra(int bitsPerSample)

Gets BGRA color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.

Returns: PixelDataFormat - The BGRA color.

getBitsPerPixel()

public int getBitsPerPixel()

Gets the bits per pixel.

Returns: int - The bits per pixel.

getCaption()

public String getCaption()

Gets the pixel data format caption.

Returns: java.lang.String

getChannelBits()

public int[] getChannelBits()

Gets the bits count for each channel.

Returns: int[] - The channel bits.

getChannelsCount()

public int getChannelsCount()

Gets the channels count.

Returns: int - The channels count.

getCieLab(int bitsPerL, int bitsPerA, int bitsPerB)

public static PixelDataFormat getCieLab(int bitsPerL, int bitsPerA, int bitsPerB)

Gets CIE Lab color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerL	int	The number of bits per L channel.
bitsPerA	int	The number of bits per A channel.
bitsPerB	int	The number of bits per B channel.

Returns: PixelDataFormat - The CIE Lab color.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCmyk()

public static PixelDataFormat getCmyk()

Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the cyan, magenta, yellow and black.

Returns: PixelDataFormat - The PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the cyan, magenta, yellow and black.

getCmyk(int bitsPerSample)

public static PixelDataFormat getCmyk(int bitsPerSample)

Gets CMYK color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.

Returns: PixelDataFormat - The CMYK color.

getCmyk(int bitsPerCyanChannel, int bitsPerMagentaChannel, int bitsPerYellowChannel, int bitsPerKeyChannel)

public static PixelDataFormat getCmyk(int bitsPerCyanChannel, int bitsPerMagentaChannel, int bitsPerYellowChannel, int bitsPerKeyChannel)

Gets CMYK color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerCyanChannel	int	The number of bits per Cyan channel.
bitsPerMagentaChannel	int	The number of bits per Magenta channel.
bitsPerYellowChannel	int	The number of bits per Yellow channel.
bitsPerKeyChannel	int	The number of bits per Key channel.

Returns: PixelDataFormat - The CMYK color.

getCmyk16()

public static PixelDataFormat getCmyk16()

Gets the PixelDataFormat defined for 64 bits per pixel with 16 bits for each of the cyan, magenta, yellow and black.

Value: The PixelDataFormat defined for 64 bits per pixel with 16 bits for each of the cyan, magenta, yellow and black.

Returns: PixelDataFormat

getCmyka()

public static PixelDataFormat getCmyka()

Gets the acmyk.

Returns: PixelDataFormat - The PixelDataFormat defined for 40 bits per pixel with 8 bits for each of the alpha, cyan, magenta, yellow and black.

getCmyka(int bitsPerCyanChannel, int bitsPerMagentaChannel, int bitsPerYellowChannel, int bitsPerKeyChannel, int bitsPerAlphaChannel)

public static PixelDataFormat getCmyka(int bitsPerCyanChannel, int bitsPerMagentaChannel, int bitsPerYellowChannel, int bitsPerKeyChannel, int bitsPerAlphaChannel)

Gets CMYKA color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerCyanChannel	int	The number of bits per Cyan channel.
bitsPerMagentaChannel	int	The number of bits per Magenta channel.
bitsPerYellowChannel	int	The number of bits per Yellow channel.
bitsPerKeyChannel	int	The number of bits per Key channel.
bitsPerAlphaChannel	int	The number of bits per Alpha channel.

Returns: PixelDataFormat - The CMYK color.

getCmyka16()

public static PixelDataFormat getCmyka16()

Gets the acmyk.

Value: The PixelDataFormat defined for 80 bits per pixel with 16 bits for each of the alpha, cyan, magenta, yellow and black.

Returns: PixelDataFormat

getGrayscale()

public static PixelDataFormat getGrayscale()

Gets the PixelDataFormat defined for 8 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval.

Returns: PixelDataFormat - The PixelDataFormat defined for 8 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval.

getGrayscale(int bitsPerSample)

public static PixelDataFormat getGrayscale(int bitsPerSample)

Gets Grayscale color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.

Returns: PixelDataFormat - The Grayscale color.

getGrayscaleAlpha()

public static PixelDataFormat getGrayscaleAlpha()

Gets the PixelDataFormat defined for 16 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval and additional 8 bit alpha component.

Returns: PixelDataFormat - The PixelDataFormat defined for 16 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval and additional 8 bit alpha component.

getGrayscaleAlpha(int bitsPerSample)

public static PixelDataFormat getGrayscaleAlpha(int bitsPerSample)

Gets GrayscaleAlpha color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.

Returns: PixelDataFormat - The GrayscaleAlpha color.

getGrayscaleAlpha(int bitsPerSample, int alphaChannelBits)

public static PixelDataFormat getGrayscaleAlpha(int bitsPerSample, int alphaChannelBits)

Gets GrayscaleAlpha color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.
alphaChannelBits	int	The number of bits per sample in the alpha channel.

Returns: PixelDataFormat - The GrayscaleAlpha color.

getGrayscaleFloat32_internalized()

public static PixelDataFormat getGrayscaleFloat32_internalized()

Gets the PixelDataFormat defined for 32 bits per pixel representing grayscale intensity in floating point format.

Value: The PixelDataFormat defined for 32 bits per pixel representing grayscale intensity in floating point format

Returns: PixelDataFormat - the PixelDataFormat defined for 32 bits per pixel representing grayscale intensity in floating point format.

getPixelFormat()

public int getPixelFormat()

Gets the pixel format.

Returns: int - The pixel format.

getRgb(int bitsPerSample)

public static PixelDataFormat getRgb(int bitsPerSample)

Gets RGB color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.

Returns: PixelDataFormat - The RGB color.

getRgb(int bitsPerRedChannel, int bitsPerGreenChannel, int bitsPerBlueChannel)

public static PixelDataFormat getRgb(int bitsPerRedChannel, int bitsPerGreenChannel, int bitsPerBlueChannel)

Gets RGB color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerRedChannel	int	The number of bits per Red channel.
bitsPerGreenChannel	int	The number of bits per Green channel.
bitsPerBlueChannel	int	The number of bits per Blue channel.

Returns: PixelDataFormat - The RGB color.

getRgb16Bpp555()

public static PixelDataFormat getRgb16Bpp555()

Gets the PixelDataFormat defined for 16 bits per pixel with 5 bits for each of the red, green and blue, alpha is not defined.

Returns: PixelDataFormat - The PixelDataFormat defined for 16 bits per pixel with 5 bits for each of the red, green and blue, alpha is not defined.

getRgb16Bpp565()

public static PixelDataFormat getRgb16Bpp565()

Gets the PixelDataFormat defined for 16 bits per pixel with 5 bits for red, 6 bits for green and 5 bits for blue, alpha is not defined.

Returns: PixelDataFormat - The PixelDataFormat defined for 16 bits per pixel with 5 bits for red, 6 bits for green and 5 bits for blue, alpha is not defined.

getRgb24Bpp()

public static PixelDataFormat getRgb24Bpp()

Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.

Returns: PixelDataFormat - The PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.

getRgb24BppPng()

public static PixelDataFormat getRgb24BppPng()

Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.

Returns: PixelDataFormat - The PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.

getRgb32Bpp()

public static PixelDataFormat getRgb32Bpp()

Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.

Returns: PixelDataFormat - The PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.

getRgbIndexed(int bitsPerSample)

public static PixelDataFormat getRgbIndexed(int bitsPerSample)

Gets BGRA indexed color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.

Returns: PixelDataFormat - The BGRA color.

getRgbIndexed1Bpp()

public static PixelDataFormat getRgbIndexed1Bpp()

Gets the PixelDataFormat defined for indexed 1 bit per color. The indexed pixel data storage is intended to allow data storage and retrieval everywhere the color palette is used. Use with caution, because may require conversion from one palette to another or from RGBA to indexed color model.

Returns: PixelDataFormat - The PixelDataFormat defined for indexed 1 bit per color.

getRgbIndexed2Bpp()

public static PixelDataFormat getRgbIndexed2Bpp()

Gets the PixelDataFormat defined for indexed 2 bit per color. The indexed pixel data storage is intended to allow data storage and retrieval everywhere the color palette is used. Use with caution, because may require conversion from one palette to another or from RGBA to indexed color model.

Returns: PixelDataFormat - The PixelDataFormat defined for indexed 2 bit per color.

getRgbIndexed4Bpp()

public static PixelDataFormat getRgbIndexed4Bpp()

Gets the PixelDataFormat defined for indexed 4 bit per color. The indexed pixel data storage is intended to allow data storage and retrieval everywhere the color palette is used. Use with caution, because may require conversion from one palette to another or from RGBA to indexed color model.

Returns: PixelDataFormat - The PixelDataFormat defined for indexed 4 bit per color.

getRgbIndexed8Bpp()

public static PixelDataFormat getRgbIndexed8Bpp()

Gets the PixelDataFormat defined for indexed 8 bit per color. The indexed pixel data storage is intended to allow data storage and retrieval everywhere the color palette is used. Use with caution, because may require conversion from one palette to another or from RGBA to indexed color model.

Returns: PixelDataFormat - The PixelDataFormat defined for indexed 8 bit per color.

getRgba(int bitsPerSample)

public static PixelDataFormat getRgba(int bitsPerSample)

Gets RGBA color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.

Returns: PixelDataFormat - The RGBA color.

getRgba(int bitsPerRedChannel, int bitsPerGreenChannel, int bitsPerBlueChannel, int bitsPerAlphaChannel)

public static PixelDataFormat getRgba(int bitsPerRedChannel, int bitsPerGreenChannel, int bitsPerBlueChannel, int bitsPerAlphaChannel)

Gets RGBA color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerRedChannel	int	The number of bits per Red channel.
bitsPerGreenChannel	int	The number of bits per Green channel.
bitsPerBlueChannel	int	The number of bits per Blue channel.
bitsPerAlphaChannel	int	The number of bits per Alpha channel.

Returns: PixelDataFormat - The RGBA color.

getRgba32Bpp()

public static PixelDataFormat getRgba32Bpp()

Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.

Returns: PixelDataFormat - The PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.

getRgba64Bpp()

public static PixelDataFormat getRgba64Bpp()

Gets the PixelDataFormat defined for 64 bits per pixel with 16 bits for each of the alpha, red, green and blue.

Value: The PixelDataFormat defined for 64 bits per pixel with 16 bits for each of the alpha, red, green and blue.

Returns: PixelDataFormat

getYCbCr()

public static PixelDataFormat getYCbCr()

Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the luma, blue-difference and red-difference chroma components.

Returns: PixelDataFormat - The PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the luma, blue-difference and red-difference chroma components.

getYCbCr(int bitsPerSample)

public static PixelDataFormat getYCbCr(int bitsPerSample)

Gets YCbCr color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.

Returns: PixelDataFormat - The YCbCr color.

getYCbCr(int bitsPerY, int bitsPerCb, int bitsPerCr)

public static PixelDataFormat getYCbCr(int bitsPerY, int bitsPerCb, int bitsPerCr)

Gets YCbCr color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerY	int	The number of bits per Y channel.
bitsPerCb	int	The number of bits per Cb channel.
bitsPerCr	int	The number of bits per Cr channel.

Returns: PixelDataFormat - The YCbCr color.

getYcck()

public static PixelDataFormat getYcck()

Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the luma, blue-difference, red-difference and black chroma components.

Returns: PixelDataFormat - The PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the luma, blue-difference, red-difference and black chroma components.

getYcck(int bitsPerSample)

public static PixelDataFormat getYcck(int bitsPerSample)

Gets YCCK color with a specified number of bits per sample.

Parameters:

Parameter	Type	Description
bitsPerSample	int	The number of bits per sample.

Returns: PixelDataFormat - The YCCK color.

hashCode()

public int hashCode()

Returns a hash code for this instance.

Returns: int - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

isIndexed_internalized()

public final boolean isIndexed_internalized()

Gets a value indicating whether this instance is indexed.

Value: true if this instance is indexed; otherwise, false .

Returns: boolean - a value indicating whether this instance is indexed.

newPixelDataFormat_internalized(int[] channelBits, int pixelFormat, String caption)

public static PixelDataFormat newPixelDataFormat_internalized(int[] channelBits, int pixelFormat, String caption)

Parameters:

Parameter	Type	Description
channelBits	int[]
pixelFormat	int
caption	java.lang.String

Returns: PixelDataFormat

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

op_Equality(PixelDataFormat pixelFormat1, PixelDataFormat pixelFormat2)

public static boolean op_Equality(PixelDataFormat pixelFormat1, PixelDataFormat pixelFormat2)

Returns result of equality for two PixelDataFormat classes.

Parameters:

Parameter	Type	Description
pixelFormat1	PixelDataFormat	The first PixelDataFormat to compare.
pixelFormat2	PixelDataFormat	The second PixelDataFormat to compare.

Returns: boolean - True if both pixelFormat1 and pixelFormat2 contain equal data or both parameters are null.

op_Inequality(PixelDataFormat pixelFormat1, PixelDataFormat pixelFormat2)

public static boolean op_Inequality(PixelDataFormat pixelFormat1, PixelDataFormat pixelFormat2)

Returns result of non-equality for two PixelDataFormat classes.

Parameters:

Parameter	Type	Description
pixelFormat1	PixelDataFormat	The first PixelDataFormat to compare.
pixelFormat2	PixelDataFormat	The second PixelDataFormat to compare.

Returns: boolean - True if both pixelFormat1 and pixelFormat2 contain non-equal data or one of the parameters is null.

toString()

public String toString()

Returns a System.String that represents this instance.

Returns: java.lang.String - A System.String that represents this instance.

wait()

public final void wait()

wait(long arg0)

public final void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int