java.lang.Object | ||
↳ | java.awt.image.ColorModel | |
↳ | java.awt.image.IndexColorModel |
The IndexColorModel
class is a ColorModel
class that works with pixel values consisting of a
single sample that is an index into a fixed colormap in the default
sRGB color space. The colormap specifies red, green, blue, and
optional alpha components corresponding to each index. All components
are represented in the colormap as 8-bit unsigned integral values.
Some constructors allow the caller to specify "holes" in the colormap
by indicating which colormap entries are valid and which represent
unusable colors via the bits set in a BigInteger
object.
This color model is similar to an X11 PseudoColor visual.
Some constructors provide a means to specify an alpha component
for each pixel in the colormap, while others either provide no
such means or, in some cases, a flag to indicate whether the
colormap data contains alpha values. If no alpha is supplied to
the constructor, an opaque alpha component (alpha = 1.0) is
assumed for each entry.
An optional transparent pixel value can be supplied that indicates a
pixel to be made completely transparent, regardless of any alpha
component supplied or assumed for that pixel value.
Note that the color components in the colormap of an
IndexColorModel
objects are never pre-multiplied with
the alpha components.
If an IndexColorModel
object has
a transparency value of Transparency.OPAQUE
,
then the hasAlpha
and getNumComponents
methods
(both inherited from ColorModel
)
return false and 3, respectively.
For any other transparency value,
hasAlpha
returns true
and getNumComponents
returns 4.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
java.awt.Transparency
|
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.awt.image.ColorModel
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs an
IndexColorModel from the specified
arrays of red, green, and blue components. | |||||||||||
Constructs an
IndexColorModel from the given arrays
of red, green, and blue components. | |||||||||||
Constructs an
IndexColorModel from the given
arrays of red, green, blue and alpha components. | |||||||||||
Constructs an
IndexColorModel from a single
array of interleaved red, green, blue and optional alpha
components. | |||||||||||
Constructs an
IndexColorModel from a single array of
interleaved red, green, blue and optional alpha components. | |||||||||||
Constructs an
IndexColorModel from an array of
ints where each int is comprised of red, green, blue, and
optional alpha components in the default RGB color model format. | |||||||||||
Constructs an
IndexColorModel from an
int array where each int is
comprised of red, green, blue, and alpha
components in the default RGB color model format. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns a new
BufferedImage of TYPE_INT_ARGB or
TYPE_INT_RGB that has a Raster with pixel data
computed by expanding the indices in the source Raster
using the color/alpha component arrays of this ColorModel . | |||||||||||
Creates a
SampleModel with the specified
width and height that has a data layout compatible with
this ColorModel . | |||||||||||
Creates a
WritableRaster with the specified width
and height that has a data layout (SampleModel )
compatible with this ColorModel . | |||||||||||
Disposes of system resources associated with this
ColorModel once this ColorModel is no
longer referenced. | |||||||||||
Returns the alpha component for the specified pixel, scaled
from 0 to 255.
| |||||||||||
Copies the array of alpha transparency components into the
specified array.
| |||||||||||
Returns the blue color component for the specified pixel, scaled
from 0 to 255 in the default RGB ColorSpace, sRGB.
| |||||||||||
Copies the array of blue color components into the specified array.
| |||||||||||
Returns an array of the number of bits for each color/alpha component.
| |||||||||||
Returns an array of unnormalized color/alpha components for a
specified pixel in this
ColorModel . | |||||||||||
Returns an array of unnormalized color/alpha components for
a specified pixel in this
ColorModel . | |||||||||||
Returns a pixel value represented as an int in this
ColorModel given an array of unnormalized
color/alpha components. | |||||||||||
Returns a data element array representation of a pixel in this
ColorModel given an array of unnormalized color/alpha
components. | |||||||||||
Returns a data element array representation of a pixel in this
ColorModel, given an integer pixel representation in the
default RGB color model.
| |||||||||||
Returns the green color component for the specified pixel, scaled
from 0 to 255 in the default RGB ColorSpace, sRGB.
| |||||||||||
Copies the array of green color components into the specified array.
| |||||||||||
Returns the size of the color/alpha component arrays in this
IndexColorModel . | |||||||||||
Returns the color/alpha components of the pixel in the default
RGB color model format.
| |||||||||||
Converts data for each index from the color and alpha component
arrays to an int in the default RGB ColorModel format and copies
the resulting 32-bit ARGB values into the specified array.
| |||||||||||
Returns the red color component for the specified pixel, scaled
from 0 to 255 in the default RGB ColorSpace, sRGB.
| |||||||||||
Copies the array of red color components into the specified array.
| |||||||||||
Returns the transparency.
| |||||||||||
Returns the index of a transparent pixel in this
IndexColorModel or -1 if there is no pixel
with an alpha value of 0. | |||||||||||
Returns a
BigInteger that indicates the valid/invalid
pixels in the colormap. | |||||||||||
Returns
true if raster is compatible
with this ColorModel or false if it
is not compatible with this ColorModel . | |||||||||||
Checks if the specified
SampleModel is compatible
with this ColorModel . | |||||||||||
Returns whether or not the pixel is valid.
| |||||||||||
Returns whether or not all of the pixels are valid.
| |||||||||||
Returns the
String representation of the contents of
this ColorModel object. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.awt.image.ColorModel
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.awt.Transparency
|
Constructs an IndexColorModel
from the specified
arrays of red, green, and blue components. Pixels described
by this color model all have alpha components of 255
unnormalized (1.0 normalized), which means they
are fully opaque. All of the arrays specifying the color
components must have at least the specified number of entries.
The ColorSpace
is the default sRGB space.
Since there is no alpha information in any of the arguments
to this constructor, the transparency value is always
Transparency.OPAQUE
.
The transfer type is the smallest of DataBuffer.TYPE_BYTE
or DataBuffer.TYPE_USHORT
that can hold a single pixel.
bits | the number of bits each pixel occupies |
---|---|
size | the size of the color component arrays |
r | the array of red color components |
g | the array of green color components |
b | the array of blue color components |
IllegalArgumentException | if bits is less
than 1 or greater than 16 |
---|---|
IllegalArgumentException | if size is less
than 1
|
Constructs an IndexColorModel
from the given arrays
of red, green, and blue components. Pixels described by this color
model all have alpha components of 255 unnormalized
(1.0 normalized), which means they are fully opaque, except
for the indicated pixel to be made transparent. All of the arrays
specifying the color components must have at least the specified
number of entries.
The ColorSpace
is the default sRGB space.
The transparency value may be Transparency.OPAQUE
or
Transparency.BITMASK
depending on the arguments, as
specified in the class description above.
The transfer type is the smallest of DataBuffer.TYPE_BYTE
or DataBuffer.TYPE_USHORT
that can hold a
single pixel.
bits | the number of bits each pixel occupies |
---|---|
size | the size of the color component arrays |
r | the array of red color components |
g | the array of green color components |
b | the array of blue color components |
trans | the index of the transparent pixel |
IllegalArgumentException | if bits is less than
1 or greater than 16 |
---|---|
IllegalArgumentException | if size is less than
1
|
Constructs an IndexColorModel
from the given
arrays of red, green, blue and alpha components. All of the
arrays specifying the components must have at least the specified
number of entries.
The ColorSpace
is the default sRGB space.
The transparency value may be any of Transparency.OPAQUE
,
Transparency.BITMASK
,
or Transparency.TRANSLUCENT
depending on the arguments, as specified
in the class description above.
The transfer type is the smallest of DataBuffer.TYPE_BYTE
or DataBuffer.TYPE_USHORT
that can hold a single pixel.
bits | the number of bits each pixel occupies |
---|---|
size | the size of the color component arrays |
r | the array of red color components |
g | the array of green color components |
b | the array of blue color components |
a | the array of alpha value components |
IllegalArgumentException | if bits is less
than 1 or greater than 16 |
---|---|
IllegalArgumentException | if size is less
than 1
|
Constructs an IndexColorModel
from a single
array of interleaved red, green, blue and optional alpha
components. The array must have enough values in it to
fill all of the needed component arrays of the specified
size. The ColorSpace
is the default sRGB space.
The transparency value may be any of Transparency.OPAQUE
,
Transparency.BITMASK
,
or Transparency.TRANSLUCENT
depending on the arguments, as specified
in the class description above.
The transfer type is the smallest of
DataBuffer.TYPE_BYTE
or DataBuffer.TYPE_USHORT
that can hold a single pixel.
bits | the number of bits each pixel occupies |
---|---|
size | the size of the color component arrays |
cmap | the array of color components |
start | the starting offset of the first color component |
hasalpha | indicates whether alpha values are contained in
the cmap array |
IllegalArgumentException | if bits is less
than 1 or greater than 16 |
---|---|
IllegalArgumentException | if size is less
than 1
|
Constructs an IndexColorModel
from a single array of
interleaved red, green, blue and optional alpha components. The
specified transparent index represents a pixel that is made
entirely transparent regardless of any alpha value specified
for it. The array must have enough values in it to fill all
of the needed component arrays of the specified size.
The ColorSpace
is the default sRGB space.
The transparency value may be any of Transparency.OPAQUE
,
Transparency.BITMASK
,
or Transparency.TRANSLUCENT
depending on the arguments, as specified
in the class description above.
The transfer type is the smallest of
DataBuffer.TYPE_BYTE
or DataBuffer.TYPE_USHORT
that can hold a single pixel.
bits | the number of bits each pixel occupies |
---|---|
size | the size of the color component arrays |
cmap | the array of color components |
start | the starting offset of the first color component |
hasalpha | indicates whether alpha values are contained in
the cmap array |
trans | the index of the fully transparent pixel |
IllegalArgumentException | if bits is less than
1 or greater than 16 |
---|---|
IllegalArgumentException | if size is less than
1
|
Constructs an IndexColorModel
from an array of
ints where each int is comprised of red, green, blue, and
optional alpha components in the default RGB color model format.
The specified transparent index represents a pixel that is made
entirely transparent regardless of any alpha value specified
for it. The array must have enough values in it to fill all
of the needed component arrays of the specified size.
The ColorSpace
is the default sRGB space.
The transparency value may be any of Transparency.OPAQUE
,
Transparency.BITMASK
,
or Transparency.TRANSLUCENT
depending on the arguments, as specified
in the class description above.
bits | the number of bits each pixel occupies |
---|---|
size | the size of the color component arrays |
cmap | the array of color components |
start | the starting offset of the first color component |
hasalpha | indicates whether alpha values are contained in
the cmap array |
trans | the index of the fully transparent pixel |
transferType | the data type of the array used to represent
pixel values. The data type must be either
DataBuffer.TYPE_BYTE or
DataBuffer.TYPE_USHORT . |
IllegalArgumentException | if bits is less
than 1 or greater than 16 |
---|---|
IllegalArgumentException | if size is less
than 1 |
IllegalArgumentException | if transferType is not
one of DataBuffer.TYPE_BYTE or
DataBuffer.TYPE_USHORT
|
Constructs an IndexColorModel
from an
int
array where each int
is
comprised of red, green, blue, and alpha
components in the default RGB color model format.
The array must have enough values in it to fill all
of the needed component arrays of the specified size.
The ColorSpace
is the default sRGB space.
The transparency value may be any of Transparency.OPAQUE
,
Transparency.BITMASK
,
or Transparency.TRANSLUCENT
depending on the arguments, as specified
in the class description above.
The transfer type must be one of DataBuffer.TYPE_BYTE
DataBuffer.TYPE_USHORT
.
The BigInteger
object specifies the valid/invalid pixels
in the cmap
array. A pixel is valid if the
BigInteger
value at that index is set, and is invalid
if the BigInteger
bit at that index is not set.
bits | the number of bits each pixel occupies |
---|---|
size | the size of the color component array |
cmap | the array of color components |
start | the starting offset of the first color component |
transferType | the specified data type |
validBits | a BigInteger object. If a bit is
set in the BigInteger, the pixel at that index is valid.
If a bit is not set, the pixel at that index
is considered invalid. If null, all pixels are valid.
Only bits from 0 to the map size are considered. |
IllegalArgumentException | if bits is less
than 1 or greater than 16 |
---|---|
IllegalArgumentException | if size is less
than 1 |
IllegalArgumentException | if transferType is not
one of DataBuffer.TYPE_BYTE or
DataBuffer.TYPE_USHORT |
Returns a new BufferedImage
of TYPE_INT_ARGB or
TYPE_INT_RGB that has a Raster
with pixel data
computed by expanding the indices in the source Raster
using the color/alpha component arrays of this ColorModel
.
Only the lower n bits of each index value in the source
Raster
, as specified in the
class description above, are used to
compute the color/alpha values in the returned image.
If forceARGB
is true
, a TYPE_INT_ARGB image is
returned regardless of whether or not this ColorModel
has an alpha component array or a transparent pixel.
raster | the specified Raster |
---|---|
forceARGB | if true , the returned
BufferedImage is TYPE_INT_ARGB; otherwise it is
TYPE_INT_RGB |
BufferedImage
created with the specified
Raster
IllegalArgumentException | if the raster argument is not compatible with this IndexColorModel |
---|
Creates a SampleModel
with the specified
width and height that has a data layout compatible with
this ColorModel
.
w | the width to apply to the new SampleModel |
---|---|
h | the height to apply to the new SampleModel |
SampleModel
object with the specified
width and height.IllegalArgumentException | if w or
h is not greater than 0 |
---|
Creates a WritableRaster
with the specified width
and height that has a data layout (SampleModel
)
compatible with this ColorModel
. This method
only works for color models with 16 or fewer bits per pixel.
Since IndexColorModel
can be subclassed, any
subclass that supports greater than 16 bits per pixel must
override this method.
w | the width to apply to the new WritableRaster |
---|---|
h | the height to apply to the new WritableRaster |
WritableRaster
object with the specified
width and height.UnsupportedOperationException | if the number of bits in a pixel is greater than 16 |
---|
Disposes of system resources associated with this
ColorModel
once this ColorModel
is no
longer referenced.
Returns the alpha component for the specified pixel, scaled from 0 to 255. The pixel value is specified as an int. Only the lower n bits of the pixel value, as specified in the class description above, are used to calculate the returned value.
pixel | the specified pixel |
---|
Copies the array of alpha transparency components into the
specified array. Only the initial entries of the array as specified
by getMapSize
are written.
a | the specified array into which the elements of the array of alpha components are copied |
---|
Returns the blue color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB. The pixel value is specified as an int. Only the lower n bits of the pixel value, as specified in the class description above, are used to calculate the returned value. The returned value is a non pre-multiplied value.
pixel | the specified pixel |
---|
Copies the array of blue color components into the specified array.
Only the initial entries of the array as specified by
getMapSize
are written.
b | the specified array into which the elements of the array of blue color components are copied |
---|
Returns an array of the number of bits for each color/alpha component. The array contains the color components in the order red, green, blue, followed by the alpha component, if present.
IndexColorModel
Returns an array of unnormalized color/alpha components for a
specified pixel in this ColorModel
. The pixel value
is specified as an int. If the components
array is null
,
a new array is allocated that contains
offset + getNumComponents()
elements.
The components
array is returned,
with the alpha component included
only if hasAlpha
returns true.
Color/alpha components are stored in the components
array starting
at offset
even if the array is allocated by this method.
An ArrayIndexOutOfBoundsException
is thrown if the components
array is not null
and is
not large enough to hold all the color and alpha components
starting at offset
.
pixel | the specified pixel |
---|---|
components | the array to receive the color and alpha components of the specified pixel |
offset | the offset into the components array at
which to start storing the color and alpha components |
Returns an array of unnormalized color/alpha components for
a specified pixel in this ColorModel
. The pixel
value is specified by an array of data elements of type
transferType
passed in as an object reference.
If pixel
is not a primitive array of type
transferType
, a ClassCastException
is thrown. An ArrayIndexOutOfBoundsException
is thrown if pixel
is not large enough to hold
a pixel value for this ColorModel
. If the
components
array is null
, a new array
is allocated that contains
offset + getNumComponents()
elements.
The components
array is returned,
with the alpha component included
only if hasAlpha
returns true.
Color/alpha components are stored in the components
array starting at offset
even if the array is
allocated by this method. An
ArrayIndexOutOfBoundsException
is also
thrown if the components
array is not
null
and is not large enough to hold all the color
and alpha components starting at offset
.
Since IndexColorModel
can be subclassed, subclasses
inherit the implementation of this method and if they don't
override it then they throw an exception if they use an
unsupported transferType
.
pixel | the specified pixel |
---|---|
components | an array that receives the color and alpha components of the specified pixel |
offset | the index into the components array at
which to begin storing the color and alpha components of the
specified pixel |
ArrayIndexOutOfBoundsException | if pixel
is not large enough to hold a pixel value for this
ColorModel or if the
components array is not null
and is not large enough to hold all the color
and alpha components starting at offset |
---|---|
ClassCastException | if pixel is not a
primitive array of type transferType |
UnsupportedOperationException | if transferType
is not one of the supported transer types |
Returns a pixel value represented as an int in this
ColorModel
given an array of unnormalized
color/alpha components. An
ArrayIndexOutOfBoundsException
is thrown if the components
array is not large
enough to hold all of the color and alpha components starting
at offset
. Since
ColorModel
can be subclassed, subclasses inherit the
implementation of this method and if they don't override it then
they throw an exception if they use an unsupported transferType.
components | an array of unnormalized color and alpha components |
---|---|
offset | the index into components at which to
begin retrieving the color and alpha components |
int
pixel value in this
ColorModel
corresponding to the specified components.ArrayIndexOutOfBoundsException | if
the components array is not large enough to
hold all of the color and alpha components starting at
offset |
---|---|
UnsupportedOperationException | if transferType
is invalid
|
Returns a data element array representation of a pixel in this
ColorModel
given an array of unnormalized color/alpha
components. This array can then be passed to the
setDataElements
method of a WritableRaster
object. An ArrayIndexOutOfBoundsException
is
thrown if the
components
array is not large enough to hold all of the
color and alpha components starting at offset
.
If the pixel variable is null
, a new array
is allocated. If pixel
is not null
,
it must be a primitive array of type transferType
;
otherwise, a ClassCastException
is thrown.
An ArrayIndexOutOfBoundsException
is thrown if pixel
is not large enough to hold a pixel value for this
ColorModel
.
Since IndexColorModel
can be subclassed, subclasses
inherit the implementation of this method and if they don't
override it then they throw an exception if they use an
unsupported transferType
components | an array of unnormalized color and alpha components |
---|---|
offset | the index into components at which to
begin retrieving color and alpha components |
pixel | the Object representing an array of color
and alpha components |
Object
representing an array of color and
alpha components.ClassCastException | if pixel
is not a primitive array of type transferType |
---|---|
ArrayIndexOutOfBoundsException | if
pixel is not large enough to hold a pixel value
for this ColorModel or the components
array is not large enough to hold all of the color and alpha
components starting at offset |
UnsupportedOperationException | if transferType
is not one of the supported transer types |
Returns a data element array representation of a pixel in this
ColorModel, given an integer pixel representation in the
default RGB color model. This array can then be passed to the
setDataElements
method of a WritableRaster
object. If the pixel variable is
null
, a new array is allocated. If pixel
is not null
, it must be
a primitive array of type transferType
; otherwise, a
ClassCastException
is thrown. An
ArrayIndexOutOfBoundsException
is
thrown if pixel
is not large enough to hold a pixel
value for this ColorModel
. The pixel array is returned.
Since IndexColorModel
can be subclassed, subclasses
inherit the implementation of this method and if they don't
override it then they throw an exception if they use an
unsupported transferType
.
rgb | the integer pixel representation in the default RGB color model |
---|---|
pixel | the specified pixel |
IndexColorModel
.ClassCastException | if pixel
is not a primitive array of type transferType |
---|---|
ArrayIndexOutOfBoundsException | if
pixel is not large enough to hold a pixel value
for this ColorModel |
UnsupportedOperationException | if transferType
is invalid |
Returns the green color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB. The pixel value is specified as an int. Only the lower n bits of the pixel value, as specified in the class description above, are used to calculate the returned value. The returned value is a non pre-multiplied value.
pixel | the specified pixel |
---|
Copies the array of green color components into the specified array.
Only the initial entries of the array as specified by
getMapSize
are written.
g | the specified array into which the elements of the array of green color components are copied |
---|
Returns the size of the color/alpha component arrays in this
IndexColorModel
.
Returns the color/alpha components of the pixel in the default RGB color model format. The pixel value is specified as an int. Only the lower n bits of the pixel value, as specified in the class description above, are used to calculate the returned value. The returned value is in a non pre-multiplied format.
pixel | the specified pixel |
---|
Converts data for each index from the color and alpha component
arrays to an int in the default RGB ColorModel format and copies
the resulting 32-bit ARGB values into the specified array. Only
the initial entries of the array as specified by
getMapSize
are
written.
rgb | the specified array into which the converted ARGB values from this array of color and alpha components are copied. |
---|
Returns the red color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB. The pixel value is specified as an int. Only the lower n bits of the pixel value, as specified in the class description above, are used to calculate the returned value. The returned value is a non pre-multiplied value.
pixel | the specified pixel |
---|
Copies the array of red color components into the specified array.
Only the initial entries of the array as specified by
getMapSize
are written.
r | the specified array into which the elements of the array of red color components are copied |
---|
Returns the transparency. Returns either OPAQUE, BITMASK, or TRANSLUCENT
IndexColorModel
Returns the index of a transparent pixel in this
IndexColorModel
or -1 if there is no pixel
with an alpha value of 0. If a transparent pixel was
explicitly specified in one of the constructors by its
index, then that index will be preferred, otherwise,
the index of any pixel which happens to be fully transparent
may be returned.
IndexColorModel
object, or -1 if there
is no such pixel
Returns a BigInteger
that indicates the valid/invalid
pixels in the colormap. A bit is valid if the
BigInteger
value at that index is set, and is invalid
if the BigInteger
value at that index is not set.
The only valid ranges to query in the BigInteger
are
between 0 and the map size.
BigInteger
indicating the valid/invalid pixels.Returns true
if raster
is compatible
with this ColorModel
or false
if it
is not compatible with this ColorModel
.
raster | the Raster object to test for compatibility |
---|
true
if raster
is compatible
with this ColorModel
; false
otherwise.
Checks if the specified SampleModel
is compatible
with this ColorModel
. If sm
is
null
, this method returns false
.
sm | the specified SampleModel ,
or null |
---|
true
if the specified SampleModel
is compatible with this ColorModel
; false
otherwise.Returns whether or not the pixel is valid.
pixel | the specified pixel value |
---|
true
if pixel
is valid; false
otherwise.Returns whether or not all of the pixels are valid.
true
if all pixels are valid;
false
otherwise.Returns the String
representation of the contents of
this ColorModel
object.
String
representing the contents of this
ColorModel
object.