Class PackedColorModel
- All Implemented Interfaces:
- Transparency
- Direct Known Subclasses:
- DirectColorModel
PackedColorModel class is an abstract
 ColorModel class that works with pixel values which represent
 color and alpha information as separate samples and which pack all
 samples for a single pixel into a single int, short, or byte quantity.
 This class can be used with an arbitrary ColorSpace.  The number of
 color samples in the pixel values must be the same as the number of color
 components in the ColorSpace.  There can be a single alpha
 sample.  The array length is always 1 for those methods that use a
 primitive array pixel representation of type transferType.
 The transfer types supported are DataBuffer.TYPE_BYTE,
 DataBuffer.TYPE_USHORT, and DataBuffer.TYPE_INT.
 Color and alpha samples are stored in the single element of the array
 in bits indicated by bit masks.  Each bit mask must be contiguous and
 masks must not overlap.  The same masks apply to the single int
 pixel representation used by other methods.  The correspondence of
 masks and color/alpha samples is as follows:
 -  Masks are identified by indices running from 0 through
 getNumComponents- 1.
-  The first
 getNumColorComponentsindices refer to color samples.
- If an alpha sample is present, it corresponds the last index.
-  The order of the color indices is specified
 by the ColorSpace. Typically, this reflects the name of the color space type (for example, TYPE_RGB), index 0 corresponds to red, index 1 to green, and index 2 to blue.
 The translation from pixel values to color/alpha components for
 display or processing purposes is a one-to-one correspondence of
 samples to components.
 A PackedColorModel is typically used with image data
 that uses masks to define packed samples.  For example, a
 PackedColorModel can be used in conjunction with a
 SinglePixelPackedSampleModel to construct a
 BufferedImage.  Normally the masks used by the
 SampleModel and the ColorModel would be the same.
 However, if they are different, the color interpretation of pixel data is
 done according to the masks of the ColorModel.
 
 A single int pixel representation is valid for all objects
 of this class since it is always possible to represent pixel values
 used with this class in a single int.  Therefore, methods
 that use this representation do not throw an
 IllegalArgumentException due to an invalid pixel value.
 
 A subclass of PackedColorModel is DirectColorModel,
 which is similar to an X11 TrueColor visual.
- See Also:
- 
Field SummaryFields declared in class java.awt.image.ColorModelpixel_bits, transferTypeFields declared in interface java.awt.TransparencyBITMASK, OPAQUE, TRANSLUCENT
- 
Constructor SummaryConstructorsConstructorDescriptionPackedColorModel(ColorSpace space, int bits, int[] colorMaskArray, int alphaMask, boolean isAlphaPremultiplied, int trans, int transferType) Constructs aPackedColorModelfrom a color mask array, which specifies which bits in anintpixel representation contain each of the color samples, and an alpha mask.PackedColorModel(ColorSpace space, int bits, int rmask, int gmask, int bmask, int amask, boolean isAlphaPremultiplied, int trans, int transferType) Constructs aPackedColorModelfrom the specified masks which indicate which bits in anintpixel representation contain the alpha, red, green and blue color samples.
- 
Method SummaryModifier and TypeMethodDescriptioncreateCompatibleSampleModel(int w, int h) Creates aSampleModelwith the specified width and height that has a data layout compatible with thisColorModel.booleanTests if the specifiedObjectis an instance ofPackedColorModeland equals thisPackedColorModel.getAlphaRaster(WritableRaster raster) Returns aWritableRasterrepresenting the alpha channel of an image, extracted from the inputWritableRaster.final intgetMask(int index) Returns the mask indicating which bits in a pixel contain the specified color/alpha sample.final int[]getMasks()Returns a mask array indicating which bits in a pixel contain the color and alpha samples.inthashCode()Returns the hash code for this PackedColorModel.booleanChecks if the specifiedSampleModelis compatible with thisColorModel.Methods declared in class java.awt.image.ColorModelcoerceData, createCompatibleWritableRaster, getAlpha, getAlpha, getBlue, getBlue, getColorSpace, getComponents, getComponents, getComponentSize, getComponentSize, getDataElement, getDataElement, getDataElements, getDataElements, getDataElements, getGreen, getGreen, getNormalizedComponents, getNormalizedComponents, getNumColorComponents, getNumComponents, getPixelSize, getRed, getRed, getRGB, getRGB, getRGBdefault, getTransferType, getTransparency, getUnnormalizedComponents, hasAlpha, isAlphaPremultiplied, isCompatibleRaster, toString
- 
Constructor Details- 
PackedColorModelpublic PackedColorModel(ColorSpace space, int bits, int[] colorMaskArray, int alphaMask, boolean isAlphaPremultiplied, int trans, int transferType) Constructs aPackedColorModelfrom a color mask array, which specifies which bits in anintpixel representation contain each of the color samples, and an alpha mask. Color components are in the specifiedColorSpace. The length ofcolorMaskArrayshould be the number of components in theColorSpace. All of the bits in each mask must be contiguous and fit in the specified number of least significant bits of anintpixel representation. If thealphaMaskis 0, there is no alpha. If there is alpha, theboolean isAlphaPremultipliedspecifies how to interpret color and alpha samples in pixel values. If thebooleanistrue, color samples are assumed to have been multiplied by the alpha sample. The transparency,trans, specifies what alpha values can be represented by this color model. The transfer type is the type of primitive array used to represent pixel values.- Parameters:
- space- the specified- ColorSpace
- bits- the number of bits in the pixel values
- colorMaskArray- array that specifies the masks representing the bits of the pixel values that represent the color components
- alphaMask- specifies the mask representing the bits of the pixel values that represent the alpha component
- isAlphaPremultiplied-- trueif color samples are premultiplied by the alpha sample;- falseotherwise
- trans- specifies the alpha value that can be represented by this color model
- transferType- the type of array used to represent pixel values
- Throws:
- IllegalArgumentException- if- bitsis less than 1 or greater than 32
 
- 
PackedColorModelpublic PackedColorModel(ColorSpace space, int bits, int rmask, int gmask, int bmask, int amask, boolean isAlphaPremultiplied, int trans, int transferType) Constructs aPackedColorModelfrom the specified masks which indicate which bits in anintpixel representation contain the alpha, red, green and blue color samples. Color components are in the specifiedColorSpace, which must be of type ColorSpace.TYPE_RGB. All of the bits in each mask must be contiguous and fit in the specified number of least significant bits of anintpixel representation. Ifamaskis 0, there is no alpha. If there is alpha, theboolean isAlphaPremultipliedspecifies how to interpret color and alpha samples in pixel values. If thebooleanistrue, color samples are assumed to have been multiplied by the alpha sample. The transparency,trans, specifies what alpha values can be represented by this color model. The transfer type is the type of primitive array used to represent pixel values.- Parameters:
- space- the specified- ColorSpace
- bits- the number of bits in the pixel values
- rmask- specifies the mask representing the bits of the pixel values that represent the red color component
- gmask- specifies the mask representing the bits of the pixel values that represent the green color component
- bmask- specifies the mask representing the bits of the pixel values that represent the blue color component
- amask- specifies the mask representing the bits of the pixel values that represent the alpha component
- isAlphaPremultiplied-- trueif color samples are premultiplied by the alpha sample;- falseotherwise
- trans- specifies the alpha value that can be represented by this color model
- transferType- the type of array used to represent pixel values
- Throws:
- IllegalArgumentException- if- spaceis not a TYPE_RGB space
- See Also:
 
 
- 
- 
Method Details- 
getMaskpublic final int getMask(int index) Returns the mask indicating which bits in a pixel contain the specified color/alpha sample. For color samples,indexcorresponds to the placement of color sample names in the color space. Thus, anindexequal to 0 for a CMYK ColorSpace would correspond to Cyan and anindexequal to 1 would correspond to Magenta. If there is alpha, the alphaindexwould be:alphaIndex = numComponents() - 1;- Parameters:
- index- the specified color or alpha sample
- Returns:
- the mask, which indicates which bits of the intpixel representation contain the color or alpha sample specified byindex.
- Throws:
- ArrayIndexOutOfBoundsException- if- indexis greater than the number of components minus 1 in this- PackedColorModelor if- indexis less than zero
 
- 
getMaskspublic final int[] getMasks()Returns a mask array indicating which bits in a pixel contain the color and alpha samples.- Returns:
- the mask array , which indicates which bits of the
         intpixel representation contain the color or alpha samples.
 
- 
createCompatibleSampleModelCreates aSampleModelwith the specified width and height that has a data layout compatible with thisColorModel.- Overrides:
- createCompatibleSampleModelin class- ColorModel
- Parameters:
- w- the width (in pixels) of the region of the image data described
- h- the height (in pixels) of the region of the image data described
- Returns:
- the newly created SampleModel.
- Throws:
- IllegalArgumentException- if- wor- his not greater than 0
- See Also:
 
- 
isCompatibleSampleModelChecks if the specifiedSampleModelis compatible with thisColorModel. Ifsmisnull, this method returnsfalse.- Overrides:
- isCompatibleSampleModelin class- ColorModel
- Parameters:
- sm- the specified- SampleModel, or- null
- Returns:
- trueif the specified- SampleModelis compatible with this- ColorModel;- falseotherwise.
- See Also:
 
- 
getAlphaRasterReturns aWritableRasterrepresenting the alpha channel of an image, extracted from the inputWritableRaster. This method assumes thatWritableRasterobjects associated with thisColorModelstore the alpha band, if present, as the last band of image data. Returnsnullif there is no separate spatial alpha channel associated with thisColorModel. This method creates a newWritableRaster, but shares the data array.- Overrides:
- getAlphaRasterin class- ColorModel
- Parameters:
- raster- a- WritableRastercontaining an image
- Returns:
- a WritableRasterthat represents the alpha channel of the image contained inraster.
 
- 
equalsTests if the specifiedObjectis an instance ofPackedColorModeland equals thisPackedColorModel.- Overrides:
- equalsin class- ColorModel
- Parameters:
- obj- the- Objectto test for equality
- Returns:
- trueif the specified- Objectis an instance of- PackedColorModeland equals this- PackedColorModel;- falseotherwise.
- See Also:
 
- 
hashCodepublic int hashCode()Returns the hash code for this PackedColorModel.- Overrides:
- hashCodein class- ColorModel
- Returns:
- a hash code for this PackedColorModel.
- See Also:
 
 
-