Top Description Fields Constructors Methods
org.eclipse.swt.graphics

public final Class PaletteData

extends Object
Class Inheritance
Imports
org.eclipse.swt.*

Instances of this class describe the color data used by an image.

Depending on the depth of the image, the PaletteData can take one of two forms, indicated by the isDirect field:

isDirect is false
If isDirect is false, this palette is an indexed palette which maps pixel values to RGBs. The actual RGB values may be retrieved by using the getRGBs() method.
isDirect is true
If isDirect is true, this palette is a direct color palette. Instead of containing RGB values, it contains red, green and blue mask and shift information which indicates how the color components may be extracted from a given pixel. This means that the RGB value is actually encoded in the pixel value.

In this case, the shift data is the number of bits required to shift the RGB value to the left in order to align the high bit of the corresponding mask with the high bit of the first byte. This number may be negative, so care must be taken when shifting. For example, with a red mask of 0xFF0000, the red shift would be -16. With a red mask of 0x1F, the red shift would be 3.

See Also
Image, RGB, Sample code and further information

Field Summary

Modifier and TypeField and Description
public int
blueMask

the blue mask for a direct palette

public int
blueShift

the blue shift for a direct palette

public RGB[]
colors

the RGB values for an indexed palette, where the indices of the array correspond to pixel values

public int
greenMask

the green mask for a direct palette

public int
greenShift

the green shift for a direct palette

public boolean
isDirect

true if the receiver is a direct palette, and false otherwise

public int
redMask

the red mask for a direct palette

public int
redShift

the red shift for a direct palette

Constructor Summary

AccessConstructor and Description
public
PaletteData(RGB...
the array of RGBs for the palette
colors
)

Constructs a new indexed palette given an array of RGB values.

public
PaletteData(int
the red mask
redMask
,
int
the green mask
greenMask
,
int
the blue mask
blueMask
)

Constructs a new direct palette given the red, green and blue masks.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the pixel value for the given RGB
getPixel
(RGB
the RGB to get the pixel value for
rgb
)

Returns the pixel value corresponding to the given RGB.

public RGB

Returns:

the RGB value for the given pixel
getRGB
(int
the pixel to get the RGB value for
pixel
)

Returns an RGB corresponding to the given pixel value.

public RGB[]

Returns:

the RGBs for the receiver or null
getRGBs
()

Returns all the RGB values in the receiver if it is an indexed palette, or null if it is a direct palette.

pack-priv int

Returns:

the shift amount
shiftForMask
(int
the mask to compute the shift for
mask
)

Computes the shift value for a given mask.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

blueMaskback to summary
public int blueMask

the blue mask for a direct palette

blueShiftback to summary
public int blueShift

the blue shift for a direct palette

colorsback to summary
public RGB[] colors

the RGB values for an indexed palette, where the indices of the array correspond to pixel values

greenMaskback to summary
public int greenMask

the green mask for a direct palette

greenShiftback to summary
public int greenShift

the green shift for a direct palette

isDirectback to summary
public boolean isDirect

true if the receiver is a direct palette, and false otherwise

redMaskback to summary
public int redMask

the red mask for a direct palette

redShiftback to summary
public int redShift

the red shift for a direct palette

Constructor Detail

PaletteDataback to summary
public PaletteData(RGB... colors)

Constructs a new indexed palette given an array of RGB values.

Parameters
colors:RGB[]

the array of RGBs for the palette

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if the argument is null
PaletteDataback to summary
public PaletteData(int redMask, int greenMask, int blueMask)

Constructs a new direct palette given the red, green and blue masks.

Parameters
redMask:int

the red mask

greenMask:int

the green mask

blueMask:int

the blue mask

Method Detail

getPixelback to summary
public int getPixel(RGB rgb)

Returns the pixel value corresponding to the given RGB.

Parameters
rgb:RGB

the RGB to get the pixel value for

Returns:int

the pixel value for the given RGB

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if the argument is null
  • ERROR_INVALID_ARGUMENT - if the RGB is not found in the palette
getRGBback to summary
public RGB getRGB(int pixel)

Returns an RGB corresponding to the given pixel value.

Parameters
pixel:int

the pixel to get the RGB value for

Returns:RGB

the RGB value for the given pixel

Exceptions
IllegalArgumentException:
  • ERROR_NULL_ARGUMENT - if the argument is null
  • ERROR_INVALID_ARGUMENT - if the pixel does not exist in the palette
getRGBsback to summary
public RGB[] getRGBs()

Returns all the RGB values in the receiver if it is an indexed palette, or null if it is a direct palette.

Returns:RGB[]

the RGBs for the receiver or null

shiftForMaskback to summary
pack-priv int shiftForMask(int mask)

Computes the shift value for a given mask.

Parameters
mask:int

the mask to compute the shift for

Returns:int

the shift amount

See Also
PaletteData