- java.lang.Object
-
- java.awt.image.ColorModel
-
- All Implemented Interfaces:
- Transparency
- Direct Known Subclasses:
- ComponentColorModel, IndexColorModel, PackedColorModel
public abstract class ColorModel extends Object implements Transparency
TheColorModel
abstract class encapsulates the methods for translating a pixel value to color components (for example, red, green, and blue) and an alpha component. In order to render an image to the screen, a printer, or another image, pixel values must be converted to color and alpha components. As arguments to or return values from methods of this class, pixels are represented as 32-bit ints or as arrays of primitive types. The number, order, and interpretation of color components for aColorModel
is specified by itsColorSpace
. AColorModel
used with pixel data that does not include alpha information treats all pixels as opaque, which is an alpha value of 1.0.This
ColorModel
class supports two representations of pixel values. A pixel value can be a single 32-bit int or an array of primitive types. The Java(tm) Platform 1.0 and 1.1 APIs represented pixels as singlebyte
or singleint
values. For purposes of theColorModel
class, pixel value arguments were passed as ints. The Java(tm) 2 Platform API introduced additional classes for representing images. WithBufferedImage
orRenderedImage
objects, based onRaster
andSampleModel
classes, pixel values might not be conveniently representable as a single int. Consequently,ColorModel
now has methods that accept pixel values represented as arrays of primitive types. The primitive type used by a particularColorModel
object is called its transfer type.ColorModel
objects used with images for which pixel values are not conveniently representable as a single int throw anIllegalArgumentException
when methods taking a single int pixel argument are called. Subclasses ofColorModel
must specify the conditions under which this occurs. This does not occur withDirectColorModel
orIndexColorModel
objects.Currently, the transfer types supported by the Java 2D(tm) API are DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, and DataBuffer.TYPE_DOUBLE. Most rendering operations will perform much faster when using ColorModels and images based on the first three of these types. In addition, some image filtering operations are not supported for ColorModels and images based on the latter three types. The transfer type for a particular
ColorModel
object is specified when the object is created, either explicitly or by default. All subclasses ofColorModel
must specify what the possible transfer types are and how the number of elements in the primitive arrays representing pixels is determined.For
BufferedImages
, the transfer type of itsRaster
and of theRaster
object'sSampleModel
(available from thegetTransferType
methods of these classes) must match that of theColorModel
. The number of elements in an array representing a pixel for theRaster
andSampleModel
(available from thegetNumDataElements
methods of these classes) must match that of theColorModel
.The algorithm used to convert from pixel values to color and alpha components varies by subclass. For example, there is not necessarily a one-to-one correspondence between samples obtained from the
SampleModel
of aBufferedImage
object'sRaster
and color/alpha components. Even when there is such a correspondence, the number of bits in a sample is not necessarily the same as the number of bits in the corresponding color/alpha component. Each subclass must specify how the translation from pixel values to color/alpha components is done.Methods in the
ColorModel
class use two different representations of color and alpha components - a normalized form and an unnormalized form. In the normalized form, each component is afloat
value between some minimum and maximum values. For the alpha component, the minimum is 0.0 and the maximum is 1.0. For color components the minimum and maximum values for each component can be obtained from theColorSpace
object. These values will often be 0.0 and 1.0 (e.g. normalized component values for the default sRGB color space range from 0.0 to 1.0), but some color spaces have component values with different upper and lower limits. These limits can be obtained using thegetMinValue
andgetMaxValue
methods of theColorSpace
class. Normalized color component values are not premultiplied. AllColorModels
must support the normalized form.In the unnormalized form, each component is an unsigned integral value between 0 and 2n - 1, where n is the number of significant bits for a particular component. If pixel values for a particular
ColorModel
represent color samples premultiplied by the alpha sample, unnormalized color component values are also premultiplied. The unnormalized form is used only with instances ofColorModel
whoseColorSpace
has minimum component values of 0.0 for all components and maximum values of 1.0 for all components. The unnormalized form for color and alpha components can be a convenient representation forColorModels
whose normalized component values all lie between 0.0 and 1.0. In such cases the integral value 0 maps to 0.0 and the value 2n - 1 maps to 1.0. In other cases, such as when the normalized component values can be either negative or positive, the unnormalized form is not convenient. SuchColorModel
objects throw anIllegalArgumentException
when methods involving an unnormalized argument are called. Subclasses ofColorModel
must specify the conditions under which this occurs.
-
-
Field Summary
Fields Modifier and Type Field and Description protected int
pixel_bits
The total number of bits in the pixel.protected int
transferType
Data type of the array used to represent pixel values.-
Fields inherited from interface java.awt.Transparency
BITMASK, OPAQUE, TRANSLUCENT
-
-
Constructor Summary
Constructors Modifier Constructor and Description ColorModel(int bits)
Constructs aColorModel
that translates pixels of the specified number of bits to color/alpha components.protected
ColorModel(int pixel_bits, int[] bits, ColorSpace cspace, boolean hasAlpha, boolean isAlphaPremultiplied, int transparency, int transferType)
Constructs aColorModel
that translates pixel values to color/alpha components.
-
Method Summary
Methods Modifier and Type Method and Description ColorModel
coerceData(WritableRaster raster, boolean isAlphaPremultiplied)
Forces the raster data to match the state specified in theisAlphaPremultiplied
variable, assuming the data is currently correctly described by thisColorModel
.SampleModel
createCompatibleSampleModel(int w, int h)
Creates aSampleModel
with the specified width and height that has a data layout compatible with thisColorModel
.WritableRaster
createCompatibleWritableRaster(int w, int h)
Creates aWritableRaster
with the specified width and height that has a data layout (SampleModel
) compatible with thisColorModel
.boolean
equals(Object obj)
Tests if the specifiedObject
is an instance ofColorModel
and if it equals thisColorModel
.void
finalize()
Disposes of system resources associated with thisColorModel
once thisColorModel
is no longer referenced.abstract int
getAlpha(int pixel)
Returns the alpha component for the specified pixel, scaled from 0 to 255.int
getAlpha(Object inData)
Returns the alpha component for the specified pixel, scaled from 0 to 255.WritableRaster
getAlphaRaster(WritableRaster raster)
Returns aRaster
representing the alpha channel of an image, extracted from the inputRaster
, provided that pixel values of thisColorModel
represent color and alpha information as separate spatial bands (e.g.abstract int
getBlue(int pixel)
Returns the blue color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB.int
getBlue(Object inData)
Returns the blue color component for the specified pixel, scaled from 0 to 255 in the default RGBColorSpace
, sRGB.ColorSpace
getColorSpace()
Returns theColorSpace
associated with thisColorModel
.int[]
getComponents(int pixel, int[] components, int offset)
Returns an array of unnormalized color/alpha components given a pixel in thisColorModel
.int[]
getComponents(Object pixel, int[] components, int offset)
Returns an array of unnormalized color/alpha components given a pixel in thisColorModel
.int[]
getComponentSize()
Returns an array of the number of bits per color/alpha component.int
getComponentSize(int componentIdx)
Returns the number of bits for the specified color/alpha component.int
getDataElement(float[] normComponents, int normOffset)
Returns a pixel value represented as anint
in thisColorModel
, given an array of normalized color/alpha components.int
getDataElement(int[] components, int offset)
Returns a pixel value represented as anint
in thisColorModel
, given an array of unnormalized color/alpha components.Object
getDataElements(float[] normComponents, int normOffset, Object obj)
Returns a data element array representation of a pixel in thisColorModel
, given an array of normalized color/alpha components.Object
getDataElements(int[] components, int offset, Object obj)
Returns a data element array representation of a pixel in thisColorModel
, given an array of unnormalized color/alpha components.Object
getDataElements(int rgb, Object pixel)
Returns a data element array representation of a pixel in thisColorModel
, given an integer pixel representation in the default RGB color model.abstract int
getGreen(int pixel)
Returns the green color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB.int
getGreen(Object inData)
Returns the green color component for the specified pixel, scaled from 0 to 255 in the default RGBColorSpace
, sRGB.float[]
getNormalizedComponents(int[] components, int offset, float[] normComponents, int normOffset)
Returns an array of all of the color/alpha components in normalized form, given an unnormalized component array.float[]
getNormalizedComponents(Object pixel, float[] normComponents, int normOffset)
Returns an array of all of the color/alpha components in normalized form, given a pixel in thisColorModel
.int
getNumColorComponents()
Returns the number of color components in thisColorModel
.int
getNumComponents()
Returns the number of components, including alpha, in thisColorModel
.int
getPixelSize()
Returns the number of bits per pixel described by thisColorModel
.abstract int
getRed(int pixel)
Returns the red color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB.int
getRed(Object inData)
Returns the red color component for the specified pixel, scaled from 0 to 255 in the default RGBColorSpace
, sRGB.int
getRGB(int pixel)
Returns the color/alpha components of the pixel in the default RGB color model format.int
getRGB(Object inData)
Returns the color/alpha components for the specified pixel in the default RGB color model format.static ColorModel
getRGBdefault()
Returns aDirectColorModel
that describes the default format for integer RGB values used in many of the methods in the AWT image interfaces for the convenience of the programmer.int
getTransferType()
Returns the transfer type of thisColorModel
.int
getTransparency()
Returns the transparency.int[]
getUnnormalizedComponents(float[] normComponents, int normOffset, int[] components, int offset)
Returns an array of all of the color/alpha components in unnormalized form, given a normalized component array.boolean
hasAlpha()
Returns whether or not alpha is supported in thisColorModel
.int
hashCode()
Returns the hash code for this ColorModel.boolean
isAlphaPremultiplied()
Returns whether or not the alpha has been premultiplied in the pixel values to be translated by thisColorModel
.boolean
isCompatibleRaster(Raster raster)
Returnstrue
ifraster
is compatible with thisColorModel
andfalse
if it is not.boolean
isCompatibleSampleModel(SampleModel sm)
Checks if theSampleModel
is compatible with thisColorModel
.String
toString()
Returns theString
representation of the contents of thisColorModel
object.
-
-
-
Field Detail
-
pixel_bits
protected int pixel_bits
The total number of bits in the pixel.
-
transferType
protected int transferType
Data type of the array used to represent pixel values.
-
-
Constructor Detail
-
ColorModel
public ColorModel(int bits)
Constructs aColorModel
that translates pixels of the specified number of bits to color/alpha components. The color space is the default RGBColorSpace
, which is sRGB. Pixel values are assumed to include alpha information. If color and alpha information are represented in the pixel value as separate spatial bands, the color bands are assumed not to be premultiplied with the alpha value. The transparency type is java.awt.Transparency.TRANSLUCENT. The transfer type will be the smallest of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or DataBuffer.TYPE_INT that can hold a single pixel (or DataBuffer.TYPE_UNDEFINED if bits is greater than 32). Since this constructor has no information about the number of bits per color and alpha component, any subclass calling this constructor should override any method that requires this information.- Parameters:
bits
- the number of bits of a pixel- Throws:
IllegalArgumentException
- if the number of bits inbits
is less than 1
-
ColorModel
protected ColorModel(int pixel_bits, int[] bits, ColorSpace cspace, boolean hasAlpha, boolean isAlphaPremultiplied, int transparency, int transferType)
Constructs aColorModel
that translates pixel values to color/alpha components. Color components will be in the specifiedColorSpace
.pixel_bits
is the number of bits in the pixel values. The bits array specifies the number of significant bits per color and alpha component. Its length should be the number of components in theColorSpace
if there is no alpha information in the pixel values, or one more than this number if there is alpha information.hasAlpha
indicates whether or not alpha information is present. Theboolean
isAlphaPremultiplied
specifies how to interpret pixel values in which color and alpha information are represented as separate spatial bands. If theboolean
istrue
, color samples are assumed to have been multiplied by the alpha sample. Thetransparency
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. Note that the bits array contains the number of significant bits per color/alpha component after the translation from pixel values. For example, for anIndexColorModel
withpixel_bits
equal to 16, the bits array might have four elements with each element set to 8.- Parameters:
pixel_bits
- the number of bits in the pixel valuesbits
- array that specifies the number of significant bits per color and alpha componentcspace
- the specifiedColorSpace
hasAlpha
-true
if alpha information is present;false
otherwiseisAlphaPremultiplied
-true
if color samples are assumed to be premultiplied by the alpha samples;false
otherwisetransparency
- what alpha values can be represented by this color modeltransferType
- the type of the array used to represent pixel values- Throws:
IllegalArgumentException
- if the length of the bit array is less than the number of color or alpha components in thisColorModel
, or if the transparency is not a valid value.IllegalArgumentException
- if the sum of the number of bits inbits
is less than 1 or if any of the elements inbits
is less than 0.- See Also:
Transparency
-
-
Method Detail
-
getRGBdefault
public static ColorModel getRGBdefault()
Returns aDirectColorModel
that describes the default format for integer RGB values used in many of the methods in the AWT image interfaces for the convenience of the programmer. The color space is the defaultColorSpace
, sRGB. The format for the RGB values is an integer with 8 bits each of alpha, red, green, and blue color components ordered correspondingly from the most significant byte to the least significant byte, as in: 0xAARRGGBB. Color components are not premultiplied by the alpha component. This format does not necessarily represent the native or the most efficientColorModel
for a particular device or for all images. It is merely used as a common color model format.- Returns:
- a
DirectColorModel
object describing default RGB values.
-
hasAlpha
public final boolean hasAlpha()
Returns whether or not alpha is supported in thisColorModel
.- Returns:
true
if alpha is supported in thisColorModel
;false
otherwise.
-
isAlphaPremultiplied
public final boolean isAlphaPremultiplied()
Returns whether or not the alpha has been premultiplied in the pixel values to be translated by thisColorModel
. If the boolean istrue
, thisColorModel
is to be used to interpret pixel values in which color and alpha information are represented as separate spatial bands, and color samples are assumed to have been multiplied by the alpha sample.- Returns:
true
if the alpha values are premultiplied in the pixel values to be translated by thisColorModel
;false
otherwise.
-
getTransferType
public final int getTransferType()
Returns the transfer type of thisColorModel
. The transfer type is the type of primitive array used to represent pixel values as arrays.- Returns:
- the transfer type.
- Since:
- 1.3
-
getPixelSize
public int getPixelSize()
Returns the number of bits per pixel described by thisColorModel
.- Returns:
- the number of bits per pixel.
-
getComponentSize
public int getComponentSize(int componentIdx)
Returns the number of bits for the specified color/alpha component. Color components are indexed in the order specified by theColorSpace
. Typically, this order reflects the name of the color space type. For example, for TYPE_RGB, index 0 corresponds to red, index 1 to green, and index 2 to blue. If thisColorModel
supports alpha, the alpha component corresponds to the index following the last color component.- Parameters:
componentIdx
- the index of the color/alpha component- Returns:
- the number of bits for the color/alpha component at the specified index.
- Throws:
ArrayIndexOutOfBoundsException
- ifcomponentIdx
is greater than the number of components or less than zeroNullPointerException
- if the number of bits array isnull
-
getComponentSize
public int[] getComponentSize()
Returns an array of the number of bits per color/alpha component. The array contains the color components in the order specified by theColorSpace
, followed by the alpha component, if present.- Returns:
- an array of the number of bits per color/alpha component
-
getTransparency
public int getTransparency()
Returns the transparency. Returns either OPAQUE, BITMASK, or TRANSLUCENT.- Specified by:
getTransparency
in interfaceTransparency
- Returns:
- the transparency of this
ColorModel
. - See Also:
Transparency.OPAQUE
,Transparency.BITMASK
,Transparency.TRANSLUCENT
-
getNumComponents
public int getNumComponents()
Returns the number of components, including alpha, in thisColorModel
. This is equal to the number of color components, optionally plus one, if there is an alpha component.- Returns:
- the number of components in this
ColorModel
-
getNumColorComponents
public int getNumColorComponents()
Returns the number of color components in thisColorModel
. This is the number of components returned byColorSpace.getNumComponents()
.- Returns:
- the number of color components in this
ColorModel
. - See Also:
ColorSpace.getNumComponents()
-
getRed
public abstract int getRed(int pixel)
Returns the red color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB. A color conversion is done if necessary. The pixel value is specified as an int. AnIllegalArgumentException
is thrown if pixel values for thisColorModel
are not conveniently representable as a single int. The returned value is not a pre-multiplied value. For example, if the alpha is premultiplied, this method divides it out before returning the value. If the alpha value is 0, the red value is 0.- Parameters:
pixel
- a specified pixel- Returns:
- the value of the red component of the specified pixel.
-
getGreen
public abstract int getGreen(int pixel)
Returns the green color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB. A color conversion is done if necessary. The pixel value is specified as an int. AnIllegalArgumentException
is thrown if pixel values for thisColorModel
are not conveniently representable as a single int. The returned value is a non pre-multiplied value. For example, if the alpha is premultiplied, this method divides it out before returning the value. If the alpha value is 0, the green value is 0.- Parameters:
pixel
- the specified pixel- Returns:
- the value of the green component of the specified pixel.
-
getBlue
public abstract int getBlue(int pixel)
Returns the blue color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB. A color conversion is done if necessary. The pixel value is specified as an int. AnIllegalArgumentException
is thrown if pixel values for thisColorModel
are not conveniently representable as a single int. The returned value is a non pre-multiplied value, for example, if the alpha is premultiplied, this method divides it out before returning the value. If the alpha value is 0, the blue value is 0.- Parameters:
pixel
- the specified pixel- Returns:
- the value of the blue component of the specified pixel.
-
getAlpha
public abstract int getAlpha(int pixel)
Returns the alpha component for the specified pixel, scaled from 0 to 255. The pixel value is specified as an int. AnIllegalArgumentException
is thrown if pixel values for thisColorModel
are not conveniently representable as a single int.- Parameters:
pixel
- the specified pixel- Returns:
- the value of alpha component of the specified pixel.
-
getRGB
public int getRGB(int pixel)
Returns the color/alpha components of the pixel in the default RGB color model format. A color conversion is done if necessary. The pixel value is specified as an int. AnIllegalArgumentException
thrown if pixel values for thisColorModel
are not conveniently representable as a single int. The returned value is in a non pre-multiplied format. For example, if the alpha is premultiplied, this method divides it out of the color components. If the alpha value is 0, the color values are 0.- Parameters:
pixel
- the specified pixel- Returns:
- the RGB value of the color/alpha components of the specified pixel.
- See Also:
getRGBdefault()
-
getRed
public int getRed(Object inData)
Returns the red color component for the specified pixel, scaled from 0 to 255 in the default RGBColorSpace
, sRGB. A color conversion is done if necessary. The pixel value is specified by an array of data elements of type transferType passed in as an object reference. The returned value is a non pre-multiplied value. For example, if alpha is premultiplied, this method divides it out before returning the value. If the alpha value is 0, the red value is 0. IfinData
is not a primitive array of type transferType, aClassCastException
is thrown. AnArrayIndexOutOfBoundsException
is thrown ifinData
is not large enough to hold a pixel value for thisColorModel
. If thistransferType
is not supported, aUnsupportedOperationException
will be thrown. SinceColorModel
is an abstract class, any instance must be an instance of a subclass. Subclasses inherit the implementation of this method and if they don't override it, this method throws an exception if the subclass uses atransferType
other thanDataBuffer.TYPE_BYTE
,DataBuffer.TYPE_USHORT
, orDataBuffer.TYPE_INT
.- Parameters:
inData
- an array of pixel values- Returns:
- the value of the red component of the specified pixel.
- Throws:
ClassCastException
- ifinData
is not a primitive array of typetransferType
ArrayIndexOutOfBoundsException
- ifinData
is not large enough to hold a pixel value for thisColorModel
UnsupportedOperationException
- if thistranferType
is not supported by thisColorModel
-
getGreen
public int getGreen(Object inData)
Returns the green color component for the specified pixel, scaled from 0 to 255 in the default RGBColorSpace
, sRGB. A color conversion is done if necessary. The pixel value is specified by an array of data elements of type transferType passed in as an object reference. The returned value will be a non pre-multiplied value. For example, if the alpha is premultiplied, this method divides it out before returning the value. If the alpha value is 0, the green value is 0. IfinData
is not a primitive array of type transferType, aClassCastException
is thrown. AnArrayIndexOutOfBoundsException
is thrown ifinData
is not large enough to hold a pixel value for thisColorModel
. If thistransferType
is not supported, aUnsupportedOperationException
will be thrown. SinceColorModel
is an abstract class, any instance must be an instance of a subclass. Subclasses inherit the implementation of this method and if they don't override it, this method throws an exception if the subclass uses atransferType
other thanDataBuffer.TYPE_BYTE
,DataBuffer.TYPE_USHORT
, orDataBuffer.TYPE_INT
.- Parameters:
inData
- an array of pixel values- Returns:
- the value of the green component of the specified pixel.
- Throws:
- ifClassCastException
inData
is not a primitive array of typetransferType
- ifArrayIndexOutOfBoundsException
inData
is not large enough to hold a pixel value for thisColorModel
- if thisUnsupportedOperationException
tranferType
is not supported by thisColorModel
-
getBlue
public int getBlue(Object inData)
Returns the blue color component for the specified pixel, scaled from 0 to 255 in the default RGBColorSpace
, sRGB. A color conversion is done if necessary. The pixel value is specified by an array of data elements of type transferType passed in as an object reference. The returned value is a non pre-multiplied value. For example, if the alpha is premultiplied, this method divides it out before returning the value. If the alpha value is 0, the blue value will be 0. IfinData
is not a primitive array of type transferType, aClassCastException
is thrown. AnArrayIndexOutOfBoundsException
is thrown ifinData
is not large enough to hold a pixel value for thisColorModel
. If thistransferType
is not supported, aUnsupportedOperationException
will be thrown. SinceColorModel
is an abstract class, any instance must be an instance of a subclass. Subclasses inherit the implementation of this method and if they don't override it, this method throws an exception if the subclass uses atransferType
other thanDataBuffer.TYPE_BYTE
,DataBuffer.TYPE_USHORT
, orDataBuffer.TYPE_INT
.- Parameters:
inData
- an array of pixel values- Returns:
- the value of the blue component of the specified pixel.
- Throws:
ClassCastException
- ifinData
is not a primitive array of typetransferType
ArrayIndexOutOfBoundsException
- ifinData
is not large enough to hold a pixel value for thisColorModel
UnsupportedOperationException
- if thistranferType
is not supported by thisColorModel
-
getAlpha
public int getAlpha(Object inData)
Returns the alpha component for the specified pixel, scaled from 0 to 255. The pixel value is specified by an array of data elements of type transferType passed in as an object reference. If inData is not a primitive array of type transferType, aClassCastException
is thrown. AnArrayIndexOutOfBoundsException
is thrown ifinData
is not large enough to hold a pixel value for thisColorModel
. If thistransferType
is not supported, aUnsupportedOperationException
will be thrown. SinceColorModel
is an abstract class, any instance must be an instance of a subclass. Subclasses inherit the implementation of this method and if they don't override it, this method throws an exception if the subclass uses atransferType
other thanDataBuffer.TYPE_BYTE
,DataBuffer.TYPE_USHORT
, orDataBuffer.TYPE_INT
.- Parameters:
inData
- the specified pixel- Returns:
- the alpha component of the specified pixel, scaled from 0 to 255.
- Throws:
ClassCastException
- ifinData
is not a primitive array of typetransferType
ArrayIndexOutOfBoundsException
- ifinData
is not large enough to hold a pixel value for thisColorModel
UnsupportedOperationException
- if thistranferType
is not supported by thisColorModel
-
getRGB
public int getRGB(Object inData)
Returns the color/alpha components for the specified pixel in the default RGB color model format. A color conversion is done if necessary. The pixel value is specified by an array of data elements of type transferType passed in as an object reference. If inData is not a primitive array of type transferType, aClassCastException
is thrown. AnArrayIndexOutOfBoundsException
is thrown ifinData
is not large enough to hold a pixel value for thisColorModel
. The returned value will be in a non pre-multiplied format, i.e. if the alpha is premultiplied, this method will divide it out of the color components (if the alpha value is 0, the color values will be 0).- Parameters:
inData
- the specified pixel- Returns:
- the color and alpha components of the specified pixel.
- See Also:
getRGBdefault()
-
getDataElements
public Object getDataElements(int rgb, Object pixel)
Returns a data element array representation of a pixel in thisColorModel
, given an integer pixel representation in the default RGB color model. This array can then be passed to theWritableRaster.setDataElements(int, int, java.lang.Object)
method of aWritableRaster
object. If the pixel variable isnull
, a new array will be allocated. Ifpixel
is notnull
, it must be a primitive array of typetransferType
; otherwise, aClassCastException
is thrown. AnArrayIndexOutOfBoundsException
is thrown ifpixel
is not large enough to hold a pixel value for thisColorModel
. The pixel array is returned. If thistransferType
is not supported, aUnsupportedOperationException
will be thrown. SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method since the implementation in this abstract class throws anUnsupportedOperationException
.- Parameters:
rgb
- the integer pixel representation in the default RGB color modelpixel
- the specified pixel- Returns:
- an array representation of the specified pixel in this
ColorModel
. - Throws:
ClassCastException
- ifpixel
is not a primitive array of typetransferType
ArrayIndexOutOfBoundsException
- ifpixel
is not large enough to hold a pixel value for thisColorModel
UnsupportedOperationException
- if this method is not supported by thisColorModel
- See Also:
WritableRaster.setDataElements(int, int, java.lang.Object)
,SampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer)
-
getComponents
public int[] getComponents(int pixel, int[] components, int offset)
Returns an array of unnormalized color/alpha components given a pixel in thisColorModel
. The pixel value is specified as anint
. AnIllegalArgumentException
will be thrown if pixel values for thisColorModel
are not conveniently representable as a singleint
or if color component values for thisColorModel
are not conveniently representable in the unnormalized form. For example, this method can be used to retrieve the components for a specific pixel value in aDirectColorModel
. If the components array isnull
, a new array will be allocated. The components array will be returned. Color/alpha components are stored in the components array starting atoffset
(even if the array is allocated by this method). AnArrayIndexOutOfBoundsException
is thrown if the components array is notnull
and is not large enough to hold all the color and alpha components (starting at offset). SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method since the implementation in this abstract class throws anUnsupportedOperationException
.- Parameters:
pixel
- the specified pixelcomponents
- the array to receive the color and alpha components of the specified pixeloffset
- the offset into thecomponents
array at which to start storing the color and alpha components- Returns:
- an array containing the color and alpha components of the specified pixel starting at the specified offset.
- Throws:
UnsupportedOperationException
- if this method is not supported by thisColorModel
-
getComponents
public int[] getComponents(Object pixel, int[] components, int offset)
Returns an array of unnormalized color/alpha components given a pixel in thisColorModel
. The pixel value is specified by an array of data elements of type transferType passed in as an object reference. Ifpixel
is not a primitive array of type transferType, aClassCastException
is thrown. AnIllegalArgumentException
will be thrown if color component values for thisColorModel
are not conveniently representable in the unnormalized form. AnArrayIndexOutOfBoundsException
is thrown ifpixel
is not large enough to hold a pixel value for thisColorModel
. This method can be used to retrieve the components for a specific pixel value in anyColorModel
. If the components array isnull
, a new array will be allocated. The components array will be returned. Color/alpha components are stored in thecomponents
array starting atoffset
(even if the array is allocated by this method). AnArrayIndexOutOfBoundsException
is thrown if the components array is notnull
and is not large enough to hold all the color and alpha components (starting atoffset
). SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method since the implementation in this abstract class throws anUnsupportedOperationException
.- Parameters:
pixel
- the specified pixelcomponents
- an array that receives the color and alpha components of the specified pixeloffset
- the index into thecomponents
array at which to begin storing the color and alpha components of the specified pixel- Returns:
- an array containing the color and alpha components of the specified pixel starting at the specified offset.
- Throws:
UnsupportedOperationException
- if this method is not supported by thisColorModel
-
getUnnormalizedComponents
public int[] getUnnormalizedComponents(float[] normComponents, int normOffset, int[] components, int offset)
Returns an array of all of the color/alpha components in unnormalized form, given a normalized component array. Unnormalized components are unsigned integral values between 0 and 2n - 1, where n is the number of bits for a particular component. Normalized components are float values between a per component minimum and maximum specified by theColorSpace
object for thisColorModel
. AnIllegalArgumentException
will be thrown if color component values for thisColorModel
are not conveniently representable in the unnormalized form. If thecomponents
array isnull
, a new array will be allocated. Thecomponents
array will be returned. Color/alpha components are stored in thecomponents
array starting atoffset
(even if the array is allocated by this method). AnArrayIndexOutOfBoundsException
is thrown if thecomponents
array is notnull
and is not large enough to hold all the color and alpha components (starting atoffset
). AnIllegalArgumentException
is thrown if thenormComponents
array is not large enough to hold all the color and alpha components starting atnormOffset
.- Parameters:
normComponents
- an array containing normalized componentsnormOffset
- the offset into thenormComponents
array at which to start retrieving normalized componentscomponents
- an array that receives the components fromnormComponents
offset
- the index intocomponents
at which to begin storing normalized components fromnormComponents
- Returns:
- an array containing unnormalized color and alpha components.
- Throws:
IllegalArgumentException
- If the component values for thisColorModel
are not conveniently representable in the unnormalized form.IllegalArgumentException
- if the length ofnormComponents
minusnormOffset
is less thannumComponents
UnsupportedOperationException
- if the constructor of thisColorModel
called thesuper(bits)
constructor, but did not override this method. See the constructor,ColorModel(int)
.
-
getNormalizedComponents
public float[] getNormalizedComponents(int[] components, int offset, float[] normComponents, int normOffset)
Returns an array of all of the color/alpha components in normalized form, given an unnormalized component array. Unnormalized components are unsigned integral values between 0 and 2n - 1, where n is the number of bits for a particular component. Normalized components are float values between a per component minimum and maximum specified by theColorSpace
object for thisColorModel
. AnIllegalArgumentException
will be thrown if color component values for thisColorModel
are not conveniently representable in the unnormalized form. If thenormComponents
array isnull
, a new array will be allocated. ThenormComponents
array will be returned. Color/alpha components are stored in thenormComponents
array starting atnormOffset
(even if the array is allocated by this method). AnArrayIndexOutOfBoundsException
is thrown if thenormComponents
array is notnull
and is not large enough to hold all the color and alpha components (starting atnormOffset
). AnIllegalArgumentException
is thrown if thecomponents
array is not large enough to hold all the color and alpha components starting atoffset
.Since
ColorModel
is an abstract class, any instance is an instance of a subclass. The default implementation of this method in this abstract class assumes that component values for this class are conveniently representable in the unnormalized form. Therefore, subclasses which may have instances which do not support the unnormalized form must override this method.- Parameters:
components
- an array containing unnormalized componentsoffset
- the offset into thecomponents
array at which to start retrieving unnormalized componentsnormComponents
- an array that receives the normalized componentsnormOffset
- the index intonormComponents
at which to begin storing normalized components- Returns:
- an array containing normalized color and alpha components.
- Throws:
IllegalArgumentException
- If the component values for thisColorModel
are not conveniently representable in the unnormalized form.UnsupportedOperationException
- if the constructor of thisColorModel
called thesuper(bits)
constructor, but did not override this method. See the constructor,ColorModel(int)
.UnsupportedOperationException
- if this method is unable to determine the number of bits per component
-
getDataElement
public int getDataElement(int[] components, int offset)
Returns a pixel value represented as anint
in thisColorModel
, given an array of unnormalized color/alpha components. This method will throw anIllegalArgumentException
if component values for thisColorModel
are not conveniently representable as a singleint
or if color component values for thisColorModel
are not conveniently representable in the unnormalized form. AnArrayIndexOutOfBoundsException
is thrown if thecomponents
array is not large enough to hold all the color and alpha components (starting atoffset
). SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method since the implementation in this abstract class throws anUnsupportedOperationException
.- Parameters:
components
- an array of unnormalized color and alpha componentsoffset
- the index intocomponents
at which to begin retrieving the color and alpha components- Returns:
- an
int
pixel value in thisColorModel
corresponding to the specified components. - Throws:
IllegalArgumentException
- if pixel values for thisColorModel
are not conveniently representable as a singleint
IllegalArgumentException
- if component values for thisColorModel
are not conveniently representable in the unnormalized formArrayIndexOutOfBoundsException
- if thecomponents
array is not large enough to hold all of the color and alpha components starting atoffset
UnsupportedOperationException
- if this method is not supported by thisColorModel
-
getDataElements
public Object getDataElements(int[] components, int offset, Object obj)
Returns a data element array representation of a pixel in thisColorModel
, given an array of unnormalized color/alpha components. This array can then be passed to thesetDataElements
method of aWritableRaster
object. This method will throw anIllegalArgumentException
if color component values for thisColorModel
are not conveniently representable in the unnormalized form. AnArrayIndexOutOfBoundsException
is thrown if thecomponents
array is not large enough to hold all the color and alpha components (starting atoffset
). If theobj
variable isnull
, a new array will be allocated. Ifobj
is notnull
, it must be a primitive array of type transferType; otherwise, aClassCastException
is thrown. AnArrayIndexOutOfBoundsException
is thrown ifobj
is not large enough to hold a pixel value for thisColorModel
. SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method since the implementation in this abstract class throws anUnsupportedOperationException
.- Parameters:
components
- an array of unnormalized color and alpha componentsoffset
- the index intocomponents
at which to begin retrieving color and alpha componentsobj
- theObject
representing an array of color and alpha components- Returns:
- an
Object
representing an array of color and alpha components. - Throws:
ClassCastException
- ifobj
is not a primitive array of typetransferType
ArrayIndexOutOfBoundsException
- ifobj
is not large enough to hold a pixel value for thisColorModel
or thecomponents
array is not large enough to hold all of the color and alpha components starting atoffset
IllegalArgumentException
- if component values for thisColorModel
are not conveniently representable in the unnormalized formUnsupportedOperationException
- if this method is not supported by thisColorModel
- See Also:
WritableRaster.setDataElements(int, int, java.lang.Object)
,SampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer)
-
getDataElement
public int getDataElement(float[] normComponents, int normOffset)
Returns a pixel value represented as anint
in thisColorModel
, given an array of normalized color/alpha components. This method will throw anIllegalArgumentException
if pixel values for thisColorModel
are not conveniently representable as a singleint
. AnArrayIndexOutOfBoundsException
is thrown if thenormComponents
array is not large enough to hold all the color and alpha components (starting atnormOffset
). SinceColorModel
is an abstract class, any instance is an instance of a subclass. The default implementation of this method in this abstract class first converts from the normalized form to the unnormalized form and then callsgetDataElement(int[], int)
. Subclasses which may have instances which do not support the unnormalized form must override this method.- Parameters:
normComponents
- an array of normalized color and alpha componentsnormOffset
- the index intonormComponents
at which to begin retrieving the color and alpha components- Returns:
- an
int
pixel value in thisColorModel
corresponding to the specified components. - Throws:
IllegalArgumentException
- if pixel values for thisColorModel
are not conveniently representable as a singleint
ArrayIndexOutOfBoundsException
- if thenormComponents
array is not large enough to hold all of the color and alpha components starting atnormOffset
- Since:
- 1.4
-
getDataElements
public Object getDataElements(float[] normComponents, int normOffset, Object obj)
Returns a data element array representation of a pixel in thisColorModel
, given an array of normalized color/alpha components. This array can then be passed to thesetDataElements
method of aWritableRaster
object. AnArrayIndexOutOfBoundsException
is thrown if thenormComponents
array is not large enough to hold all the color and alpha components (starting atnormOffset
). If theobj
variable isnull
, a new array will be allocated. Ifobj
is notnull
, it must be a primitive array of type transferType; otherwise, aClassCastException
is thrown. AnArrayIndexOutOfBoundsException
is thrown ifobj
is not large enough to hold a pixel value for thisColorModel
. SinceColorModel
is an abstract class, any instance is an instance of a subclass. The default implementation of this method in this abstract class first converts from the normalized form to the unnormalized form and then callsgetDataElement(int[], int, Object)
. Subclasses which may have instances which do not support the unnormalized form must override this method.- Parameters:
normComponents
- an array of normalized color and alpha componentsnormOffset
- the index intonormComponents
at which to begin retrieving color and alpha componentsobj
- a primitive data array to hold the returned pixel- Returns:
- an
Object
which is a primitive data array representation of a pixel - Throws:
ClassCastException
- ifobj
is not a primitive array of typetransferType
ArrayIndexOutOfBoundsException
- ifobj
is not large enough to hold a pixel value for thisColorModel
or thenormComponents
array is not large enough to hold all of the color and alpha components starting atnormOffset
- Since:
- 1.4
- See Also:
WritableRaster.setDataElements(int, int, java.lang.Object)
,SampleModel.setDataElements(int, int, java.lang.Object, java.awt.image.DataBuffer)
-
getNormalizedComponents
public float[] getNormalizedComponents(Object pixel, float[] normComponents, int normOffset)
Returns an array of all of the color/alpha components in normalized form, given a pixel in thisColorModel
. 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, aClassCastException
is thrown. AnArrayIndexOutOfBoundsException
is thrown ifpixel
is not large enough to hold a pixel value for thisColorModel
. Normalized components are float values between a per component minimum and maximum specified by theColorSpace
object for thisColorModel
. If thenormComponents
array isnull
, a new array will be allocated. ThenormComponents
array will be returned. Color/alpha components are stored in thenormComponents
array starting atnormOffset
(even if the array is allocated by this method). AnArrayIndexOutOfBoundsException
is thrown if thenormComponents
array is notnull
and is not large enough to hold all the color and alpha components (starting atnormOffset
). SinceColorModel
is an abstract class, any instance is an instance of a subclass. The default implementation of this method in this abstract class first retrieves color and alpha components in the unnormalized form usinggetComponents(Object, int[], int)
and then callsgetNormalizedComponents(int[], int, float[], int)
. Subclasses which may have instances which do not support the unnormalized form must override this method.- Parameters:
pixel
- the specified pixelnormComponents
- an array to receive the normalized componentsnormOffset
- the offset into thenormComponents
array at which to start storing normalized components- Returns:
- an array containing normalized color and alpha components.
- Throws:
ClassCastException
- ifpixel
is not a primitive array of type transferTypeArrayIndexOutOfBoundsException
- ifnormComponents
is not large enough to hold all color and alpha components starting atnormOffset
ArrayIndexOutOfBoundsException
- ifpixel
is not large enough to hold a pixel value for thisColorModel
.UnsupportedOperationException
- if the constructor of thisColorModel
called thesuper(bits)
constructor, but did not override this method. See the constructor,ColorModel(int)
.UnsupportedOperationException
- if this method is unable to determine the number of bits per component- Since:
- 1.4
-
equals
public boolean equals(Object obj)
Tests if the specifiedObject
is an instance ofColorModel
and if it equals thisColorModel
.- Overrides:
equals
in classObject
- Parameters:
obj
- theObject
to test for equality- Returns:
true
if the specifiedObject
is an instance ofColorModel
and equals thisColorModel
;false
otherwise.- See Also:
Object.hashCode()
,HashMap
-
hashCode
public int hashCode()
Returns the hash code for this ColorModel.- Overrides:
hashCode
in classObject
- Returns:
- a hash code for this ColorModel.
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
getColorSpace
public final ColorSpace getColorSpace()
Returns theColorSpace
associated with thisColorModel
.- Returns:
- the
ColorSpace
of thisColorModel
.
-
coerceData
public ColorModel coerceData(WritableRaster raster, boolean isAlphaPremultiplied)
Forces the raster data to match the state specified in theisAlphaPremultiplied
variable, assuming the data is currently correctly described by thisColorModel
. It may multiply or divide the color raster data by alpha, or do nothing if the data is in the correct state. If the data needs to be coerced, this method will also return an instance of thisColorModel
with theisAlphaPremultiplied
flag set appropriately. This method will throw aUnsupportedOperationException
if it is not supported by thisColorModel
. SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method since the implementation in this abstract class throws anUnsupportedOperationException
.- Parameters:
raster
- theWritableRaster
dataisAlphaPremultiplied
-true
if the alpha is premultiplied;false
otherwise- Returns:
- a
ColorModel
object that represents the coerced data.
-
isCompatibleRaster
public boolean isCompatibleRaster(Raster raster)
Returnstrue
ifraster
is compatible with thisColorModel
andfalse
if it is not. SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method since the implementation in this abstract class throws anUnsupportedOperationException
.- Parameters:
raster
- theRaster
object to test for compatibility- Returns:
true
ifraster
is compatible with thisColorModel
.- Throws:
UnsupportedOperationException
- if this method has not been implemented for thisColorModel
-
createCompatibleWritableRaster
public WritableRaster createCompatibleWritableRaster(int w, int h)
Creates aWritableRaster
with the specified width and height that has a data layout (SampleModel
) compatible with thisColorModel
. SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method since the implementation in this abstract class throws anUnsupportedOperationException
.- Parameters:
w
- the width to apply to the newWritableRaster
h
- the height to apply to the newWritableRaster
- Returns:
- a
WritableRaster
object with the specified width and height. - Throws:
UnsupportedOperationException
- if this method is not supported by thisColorModel
- See Also:
WritableRaster
,SampleModel
-
createCompatibleSampleModel
public SampleModel createCompatibleSampleModel(int w, int h)
Creates aSampleModel
with the specified width and height that has a data layout compatible with thisColorModel
. SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method since the implementation in this abstract class throws anUnsupportedOperationException
.- Parameters:
w
- the width to apply to the newSampleModel
h
- the height to apply to the newSampleModel
- Returns:
- a
SampleModel
object with the specified width and height. - Throws:
UnsupportedOperationException
- if this method is not supported by thisColorModel
- See Also:
SampleModel
-
isCompatibleSampleModel
public boolean isCompatibleSampleModel(SampleModel sm)
Checks if theSampleModel
is compatible with thisColorModel
. SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method since the implementation in this abstract class throws anUnsupportedOperationException
.- Parameters:
sm
- the specifiedSampleModel
- Returns:
true
if the specifiedSampleModel
is compatible with thisColorModel
;false
otherwise.- Throws:
UnsupportedOperationException
- if this method is not supported by thisColorModel
- See Also:
SampleModel
-
finalize
public void finalize()
Disposes of system resources associated with thisColorModel
once thisColorModel
is no longer referenced.
-
getAlphaRaster
public WritableRaster getAlphaRaster(WritableRaster raster)
Returns aRaster
representing the alpha channel of an image, extracted from the inputRaster
, provided that pixel values of thisColorModel
represent color and alpha information as separate spatial bands (e.g.ComponentColorModel
andDirectColorModel
). This method assumes thatRaster
objects associated with such aColorModel
store the alpha band, if present, as the last band of image data. Returnsnull
if there is no separate spatial alpha channel associated with thisColorModel
. If this is anIndexColorModel
which has alpha in the lookup table, this method will returnnull
since there is no spatially discrete alpha channel. This method will create a newRaster
(but will share the data array). SinceColorModel
is an abstract class, any instance is an instance of a subclass. Subclasses must override this method to get any behavior other than returningnull
because the implementation in this abstract class returnsnull
.- Parameters:
raster
- the specifiedRaster
- Returns:
- a
Raster
representing the alpha channel of an image, obtained from the specifiedRaster
.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/awt/image/ColorModel.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.