Package org.eclipse.swt.graphics
Class PaletteData
java.lang.Object
org.eclipse.swt.graphics.PaletteData
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:
-
Field Summary
Modifier and TypeFieldDescriptionint
the blue mask for a direct paletteint
the blue shift for a direct paletteRGB[]
the RGB values for an indexed palette, where the indices of the array correspond to pixel valuesint
the green mask for a direct paletteint
the green shift for a direct paletteboolean
true if the receiver is a direct palette, and false otherwiseint
the red mask for a direct paletteint
the red shift for a direct palette -
Constructor Summary
ConstructorDescriptionPaletteData
(int redMask, int greenMask, int blueMask) Constructs a new direct palette given the red, green and blue masks.PaletteData
(RGB... colors) Constructs a new indexed palette given an array of RGB values. -
Method Summary
-
Field Details
-
isDirect
public boolean isDirecttrue if the receiver is a direct palette, and false otherwise -
colors
the RGB values for an indexed palette, where the indices of the array correspond to pixel values -
redMask
public int redMaskthe red mask for a direct palette -
greenMask
public int greenMaskthe green mask for a direct palette -
blueMask
public int blueMaskthe blue mask for a direct palette -
redShift
public int redShiftthe red shift for a direct palette -
greenShift
public int greenShiftthe green shift for a direct palette -
blueShift
public int blueShiftthe blue shift for a direct palette
-
-
Constructor Details
-
PaletteData
Constructs a new indexed palette given an array of RGB values.- Parameters:
colors
- the array ofRGB
s for the palette- Throws:
IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if the argument is null
-
PaletteData
public PaletteData(int redMask, int greenMask, int blueMask) Constructs a new direct palette given the red, green and blue masks.- Parameters:
redMask
- the red maskgreenMask
- the green maskblueMask
- the blue mask
-
-
Method Details
-
getPixel
Returns the pixel value corresponding to the givenRGB
.- Parameters:
rgb
- the RGB to get the pixel value for- Returns:
- the pixel value for the given RGB
- Throws:
IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if the argument is null
- ERROR_INVALID_ARGUMENT - if the RGB is not found in the palette
-
getRGB
Returns anRGB
corresponding to the given pixel value.- Parameters:
pixel
- the pixel to get the RGB value for- Returns:
- the RGB value for the given pixel
- Throws:
IllegalArgumentException
-- ERROR_NULL_ARGUMENT - if the argument is null
- ERROR_INVALID_ARGUMENT - if the pixel does not exist in the palette
-
getRGBs
Returns all the RGB values in the receiver if it is an indexed palette, or null if it is a direct palette.- Returns:
- the
RGB
s for the receiver or null
-