- 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
TheColorModelabstract 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 aColorModelis specified by itsColorSpace. AColorModelused with pixel data that does not include alpha information treats all pixels as opaque, which is an alpha value of 1.0.This
ColorModelclass 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 singlebyteor singleintvalues. For purposes of theColorModelclass, pixel value arguments were passed as ints. The Java(tm) 2 Platform API introduced additional classes for representing images. WithBufferedImageorRenderedImageobjects, based onRasterandSampleModelclasses, pixel values might not be conveniently representable as a single int. Consequently,ColorModelnow has methods that accept pixel values represented as arrays of primitive types. The primitive type used by a particularColorModelobject is called its transfer type.ColorModelobjects used with images for which pixel values are not conveniently representable as a single int throw anIllegalArgumentExceptionwhen methods taking a single int pixel argument are called. Subclasses ofColorModelmust specify the conditions under which this occurs. This does not occur withDirectColorModelorIndexColorModelobjects.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
ColorModelobject is specified when the object is created, either explicitly or by default. All subclasses ofColorModelmust 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 itsRasterand of theRasterobject'sSampleModel(available from thegetTransferTypemethods of these classes) must match that of theColorModel. The number of elements in an array representing a pixel for theRasterandSampleModel(available from thegetNumDataElementsmethods 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
SampleModelof aBufferedImageobject'sRasterand 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
ColorModelclass use two different representations of color and alpha components - a normalized form and an unnormalized form. In the normalized form, each component is afloatvalue 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 theColorSpaceobject. 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 thegetMinValueandgetMaxValuemethods of theColorSpaceclass. Normalized color component values are not premultiplied. AllColorModelsmust 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
ColorModelrepresent color samples premultiplied by the alpha sample, unnormalized color component values are also premultiplied. The unnormalized form is used only with instances ofColorModelwhoseColorSpacehas 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 forColorModelswhose 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. SuchColorModelobjects throw anIllegalArgumentExceptionwhen methods involving an unnormalized argument are called. Subclasses ofColorModelmust specify the conditions under which this occurs.
-
-
Field Summary
Fields Modifier and Type Field Description protected intpixel_bitsThe total number of bits in the pixel.protected inttransferTypeData type of the array used to represent pixel values.-
Fields declared in interface java.awt.Transparency
BITMASK, OPAQUE, TRANSLUCENT
-
-
Constructor Summary
Constructors Modifier Constructor Description ColorModel(int bits)Constructs aColorModelthat translates pixels of the specified number of bits to color/alpha components.protectedColorModel(int pixel_bits, int[] bits, ColorSpace cspace, boolean hasAlpha, boolean isAlphaPremultiplied, int transparency, int transferType)Constructs aColorModelthat translates pixel values to color/alpha components.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ColorModelcoerceData(WritableRaster raster, boolean isAlphaPremultiplied)Forces the raster data to match the state specified in theisAlphaPremultipliedvariable, assuming the data is currently correctly described by thisColorModel.SampleModelcreateCompatibleSampleModel(int w, int h)Creates aSampleModelwith the specified width and height that has a data layout compatible with thisColorModel.WritableRastercreateCompatibleWritableRaster(int w, int h)Creates aWritableRasterwith the specified width and height that has a data layout (SampleModel) compatible with thisColorModel.booleanequals(Object obj)This method simply delegates to the default implementation inObjectwhich is identical to an==test since this class cannot enforce the issues of a proper equality test among multiple independent subclass branches.voidfinalize()Deprecated.Thefinalizemethod has been deprecated.abstract intgetAlpha(int pixel)Returns the alpha component for the specified pixel, scaled from 0 to 255.intgetAlpha(Object inData)Returns the alpha component for the specified pixel, scaled from 0 to 255.WritableRastergetAlphaRaster(WritableRaster raster)Returns aRasterrepresenting the alpha channel of an image, extracted from the inputRaster, provided that pixel values of thisColorModelrepresent color and alpha information as separate spatial bands (e.g.abstract intgetBlue(int pixel)Returns the blue color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB.intgetBlue(Object inData)Returns the blue color component for the specified pixel, scaled from 0 to 255 in the default RGBColorSpace, sRGB.ColorSpacegetColorSpace()Returns theColorSpaceassociated 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.intgetComponentSize(int componentIdx)Returns the number of bits for the specified color/alpha component.intgetDataElement(float[] normComponents, int normOffset)Returns a pixel value represented as anintin thisColorModel, given an array of normalized color/alpha components.intgetDataElement(int[] components, int offset)Returns a pixel value represented as anintin thisColorModel, given an array of unnormalized color/alpha components.ObjectgetDataElements(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.ObjectgetDataElements(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.ObjectgetDataElements(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 intgetGreen(int pixel)Returns the green color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB.intgetGreen(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.intgetNumColorComponents()Returns the number of color components in thisColorModel.intgetNumComponents()Returns the number of components, including alpha, in thisColorModel.intgetPixelSize()Returns the number of bits per pixel described by thisColorModel.abstract intgetRed(int pixel)Returns the red color component for the specified pixel, scaled from 0 to 255 in the default RGB ColorSpace, sRGB.intgetRed(Object inData)Returns the red color component for the specified pixel, scaled from 0 to 255 in the default RGBColorSpace, sRGB.intgetRGB(int pixel)Returns the color/alpha components of the pixel in the default RGB color model format.intgetRGB(Object inData)Returns the color/alpha components for the specified pixel in the default RGB color model format.static ColorModelgetRGBdefault()Returns aDirectColorModelthat 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.intgetTransferType()Returns the transfer type of thisColorModel.intgetTransparency()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.booleanhasAlpha()Returns whether or not alpha is supported in thisColorModel.inthashCode()This method simply delegates to the default implementation inObjectwhich returns the system ID for the class.booleanisAlphaPremultiplied()Returns whether or not the alpha has been premultiplied in the pixel values to be translated by thisColorModel.booleanisCompatibleRaster(Raster raster)Returnstrueifrasteris compatible with thisColorModelandfalseif it is not.booleanisCompatibleSampleModel(SampleModel sm)Checks if theSampleModelis compatible with thisColorModel.StringtoString()Returns theStringrepresentation of the contents of thisColorModelobject.
-
-
-
Constructor Detail
-
ColorModel
public ColorModel(int bits)
Constructs aColorModelthat 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 inbitsis less than 1
-
ColorModel
protected ColorModel(int pixel_bits, int[] bits, ColorSpace cspace, boolean hasAlpha, boolean isAlphaPremultiplied, int transparency, int transferType)Constructs aColorModelthat translates pixel values to color/alpha components. Color components will be in the specifiedColorSpace.pixel_bitsis 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 theColorSpaceif there is no alpha information in the pixel values, or one more than this number if there is alpha information.hasAlphaindicates whether or not alpha information is present. ThebooleanisAlphaPremultipliedspecifies how to interpret pixel values in which color and alpha information are represented as separate spatial bands. If thebooleanistrue, color samples are assumed to have been multiplied by the alpha sample. Thetransparencyspecifies 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 anIndexColorModelwithpixel_bitsequal 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 specifiedColorSpacehasAlpha-trueif alpha information is present;falseotherwiseisAlphaPremultiplied-trueif color samples are assumed to be premultiplied by the alpha samples;falseotherwisetransparency- 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 inbitsis less than 1 or if any of the elements inbitsis less than 0.- See Also:
Transparency
-
-
Method Detail
-
getRGBdefault
public static ColorModel getRGBdefault()
Returns aDirectColorModelthat 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 efficientColorModelfor a particular device or for all images. It is merely used as a common color model format.- Returns:
- a
DirectColorModelobject describing default RGB values.
-
hasAlpha
public final boolean hasAlpha()
Returns whether or not alpha is supported in thisColorModel.- Returns:
trueif alpha is supported in thisColorModel;falseotherwise.
-
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, thisColorModelis 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:
trueif the alpha values are premultiplied in the pixel values to be translated by thisColorModel;falseotherwise.
-
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 thisColorModelsupports 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- ifcomponentIdxis 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:
getTransparencyin 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. AnIllegalArgumentExceptionis thrown if pixel values for thisColorModelare 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. AnIllegalArgumentExceptionis thrown if pixel values for thisColorModelare 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. AnIllegalArgumentExceptionis thrown if pixel values for thisColorModelare 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. AnIllegalArgumentExceptionis thrown if pixel values for thisColorModelare 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. AnIllegalArgumentExceptionthrown if pixel values for thisColorModelare 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. IfinDatais not a primitive array of type transferType, aClassCastExceptionis thrown. AnArrayIndexOutOfBoundsExceptionis thrown ifinDatais not large enough to hold a pixel value for thisColorModel. If thistransferTypeis not supported, aUnsupportedOperationExceptionwill be thrown. SinceColorModelis 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 atransferTypeother 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- ifinDatais not a primitive array of typetransferTypeArrayIndexOutOfBoundsException- ifinDatais not large enough to hold a pixel value for thisColorModelUnsupportedOperationException- if thistransferTypeis 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. IfinDatais not a primitive array of type transferType, aClassCastExceptionis thrown. AnArrayIndexOutOfBoundsExceptionis thrown ifinDatais not large enough to hold a pixel value for thisColorModel. If thistransferTypeis not supported, aUnsupportedOperationExceptionwill be thrown. SinceColorModelis 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 atransferTypeother 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:
ClassCastException- ifinDatais not a primitive array of typetransferTypeArrayIndexOutOfBoundsException- ifinDatais not large enough to hold a pixel value for thisColorModelUnsupportedOperationException- if thistransferTypeis 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. IfinDatais not a primitive array of type transferType, aClassCastExceptionis thrown. AnArrayIndexOutOfBoundsExceptionis thrown ifinDatais not large enough to hold a pixel value for thisColorModel. If thistransferTypeis not supported, aUnsupportedOperationExceptionwill be thrown. SinceColorModelis 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 atransferTypeother 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- ifinDatais not a primitive array of typetransferTypeArrayIndexOutOfBoundsException- ifinDatais not large enough to hold a pixel value for thisColorModelUnsupportedOperationException- if thistransferTypeis 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, aClassCastExceptionis thrown. AnArrayIndexOutOfBoundsExceptionis thrown ifinDatais not large enough to hold a pixel value for thisColorModel. If thistransferTypeis not supported, aUnsupportedOperationExceptionwill be thrown. SinceColorModelis 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 atransferTypeother 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- ifinDatais not a primitive array of typetransferTypeArrayIndexOutOfBoundsException- ifinDatais not large enough to hold a pixel value for thisColorModelUnsupportedOperationException- if thistranferTypeis 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, aClassCastExceptionis thrown. AnArrayIndexOutOfBoundsExceptionis thrown ifinDatais 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 aWritableRasterobject. If the pixel variable isnull, a new array will be allocated. Ifpixelis notnull, it must be a primitive array of typetransferType; otherwise, aClassCastExceptionis thrown. AnArrayIndexOutOfBoundsExceptionis thrown ifpixelis not large enough to hold a pixel value for thisColorModel. The pixel array is returned. If thistransferTypeis not supported, aUnsupportedOperationExceptionwill be thrown. SinceColorModelis 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- ifpixelis not a primitive array of typetransferTypeArrayIndexOutOfBoundsException- ifpixelis not large enough to hold a pixel value for thisColorModelUnsupportedOperationException- 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. AnIllegalArgumentExceptionwill be thrown if pixel values for thisColorModelare not conveniently representable as a singleintor if color component values for thisColorModelare 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). AnArrayIndexOutOfBoundsExceptionis thrown if the components array is notnulland is not large enough to hold all the color and alpha components (starting at offset). SinceColorModelis 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 thecomponentsarray 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. Ifpixelis not a primitive array of type transferType, aClassCastExceptionis thrown. AnIllegalArgumentExceptionwill be thrown if color component values for thisColorModelare not conveniently representable in the unnormalized form. AnArrayIndexOutOfBoundsExceptionis thrown ifpixelis 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 thecomponentsarray starting atoffset(even if the array is allocated by this method). AnArrayIndexOutOfBoundsExceptionis thrown if the components array is notnulland is not large enough to hold all the color and alpha components (starting atoffset). SinceColorModelis 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 thecomponentsarray 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 theColorSpaceobject for thisColorModel. AnIllegalArgumentExceptionwill be thrown if color component values for thisColorModelare not conveniently representable in the unnormalized form. If thecomponentsarray isnull, a new array will be allocated. Thecomponentsarray will be returned. Color/alpha components are stored in thecomponentsarray starting atoffset(even if the array is allocated by this method). AnArrayIndexOutOfBoundsExceptionis thrown if thecomponentsarray is notnulland is not large enough to hold all the color and alpha components (starting atoffset). AnIllegalArgumentExceptionis thrown if thenormComponentsarray is not large enough to hold all the color and alpha components starting atnormOffset.- Parameters:
normComponents- an array containing normalized componentsnormOffset- the offset into thenormComponentsarray at which to start retrieving normalized componentscomponents- an array that receives the components fromnormComponentsoffset- the index intocomponentsat which to begin storing normalized components fromnormComponents- Returns:
- an array containing unnormalized color and alpha components.
- Throws:
IllegalArgumentException- If the component values for thisColorModelare not conveniently representable in the unnormalized form.IllegalArgumentException- if the length ofnormComponentsminusnormOffsetis less thannumComponentsUnsupportedOperationException- if the constructor of thisColorModelcalled 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 theColorSpaceobject for thisColorModel. AnIllegalArgumentExceptionwill be thrown if color component values for thisColorModelare not conveniently representable in the unnormalized form. If thenormComponentsarray isnull, a new array will be allocated. ThenormComponentsarray will be returned. Color/alpha components are stored in thenormComponentsarray starting atnormOffset(even if the array is allocated by this method). AnArrayIndexOutOfBoundsExceptionis thrown if thenormComponentsarray is notnulland is not large enough to hold all the color and alpha components (starting atnormOffset). AnIllegalArgumentExceptionis thrown if thecomponentsarray is not large enough to hold all the color and alpha components starting atoffset.Since
ColorModelis 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 thecomponentsarray at which to start retrieving unnormalized componentsnormComponents- an array that receives the normalized componentsnormOffset- the index intonormComponentsat which to begin storing normalized components- Returns:
- an array containing normalized color and alpha components.
- Throws:
IllegalArgumentException- If the component values for thisColorModelare not conveniently representable in the unnormalized form.UnsupportedOperationException- if the constructor of thisColorModelcalled 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 anintin thisColorModel, given an array of unnormalized color/alpha components. This method will throw anIllegalArgumentExceptionif component values for thisColorModelare not conveniently representable as a singleintor if color component values for thisColorModelare not conveniently representable in the unnormalized form. AnArrayIndexOutOfBoundsExceptionis thrown if thecomponentsarray is not large enough to hold all the color and alpha components (starting atoffset). SinceColorModelis 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 intocomponentsat which to begin retrieving the color and alpha components- Returns:
- an
intpixel value in thisColorModelcorresponding to the specified components. - Throws:
IllegalArgumentException- if pixel values for thisColorModelare not conveniently representable as a singleintIllegalArgumentException- if component values for thisColorModelare not conveniently representable in the unnormalized formArrayIndexOutOfBoundsException- if thecomponentsarray is not large enough to hold all of the color and alpha components starting atoffsetUnsupportedOperationException- 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 thesetDataElementsmethod of aWritableRasterobject. This method will throw anIllegalArgumentExceptionif color component values for thisColorModelare not conveniently representable in the unnormalized form. AnArrayIndexOutOfBoundsExceptionis thrown if thecomponentsarray is not large enough to hold all the color and alpha components (starting atoffset). If theobjvariable isnull, a new array will be allocated. Ifobjis notnull, it must be a primitive array of type transferType; otherwise, aClassCastExceptionis thrown. AnArrayIndexOutOfBoundsExceptionis thrown ifobjis not large enough to hold a pixel value for thisColorModel. SinceColorModelis 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 intocomponentsat which to begin retrieving color and alpha componentsobj- theObjectrepresenting an array of color and alpha components- Returns:
- an
Objectrepresenting an array of color and alpha components. - Throws:
ClassCastException- ifobjis not a primitive array of typetransferTypeArrayIndexOutOfBoundsException- ifobjis not large enough to hold a pixel value for thisColorModelor thecomponentsarray is not large enough to hold all of the color and alpha components starting atoffsetIllegalArgumentException- if component values for thisColorModelare 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 anintin thisColorModel, given an array of normalized color/alpha components. This method will throw anIllegalArgumentExceptionif pixel values for thisColorModelare not conveniently representable as a singleint. AnArrayIndexOutOfBoundsExceptionis thrown if thenormComponentsarray is not large enough to hold all the color and alpha components (starting atnormOffset). SinceColorModelis 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 intonormComponentsat which to begin retrieving the color and alpha components- Returns:
- an
intpixel value in thisColorModelcorresponding to the specified components. - Throws:
IllegalArgumentException- if pixel values for thisColorModelare not conveniently representable as a singleintArrayIndexOutOfBoundsException- if thenormComponentsarray 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 thesetDataElementsmethod of aWritableRasterobject. AnArrayIndexOutOfBoundsExceptionis thrown if thenormComponentsarray is not large enough to hold all the color and alpha components (starting atnormOffset). If theobjvariable isnull, a new array will be allocated. Ifobjis notnull, it must be a primitive array of type transferType; otherwise, aClassCastExceptionis thrown. AnArrayIndexOutOfBoundsExceptionis thrown ifobjis not large enough to hold a pixel value for thisColorModel. SinceColorModelis 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 intonormComponentsat which to begin retrieving color and alpha componentsobj- a primitive data array to hold the returned pixel- Returns:
- an
Objectwhich is a primitive data array representation of a pixel - Throws:
ClassCastException- ifobjis not a primitive array of typetransferTypeArrayIndexOutOfBoundsException- ifobjis not large enough to hold a pixel value for thisColorModelor thenormComponentsarray 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, aClassCastExceptionis thrown. AnArrayIndexOutOfBoundsExceptionis thrown ifpixelis not large enough to hold a pixel value for thisColorModel. Normalized components are float values between a per component minimum and maximum specified by theColorSpaceobject for thisColorModel. If thenormComponentsarray isnull, a new array will be allocated. ThenormComponentsarray will be returned. Color/alpha components are stored in thenormComponentsarray starting atnormOffset(even if the array is allocated by this method). AnArrayIndexOutOfBoundsExceptionis thrown if thenormComponentsarray is notnulland is not large enough to hold all the color and alpha components (starting atnormOffset). SinceColorModelis 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 thenormComponentsarray at which to start storing normalized components- Returns:
- an array containing normalized color and alpha components.
- Throws:
ClassCastException- ifpixelis not a primitive array of type transferTypeArrayIndexOutOfBoundsException- ifnormComponentsis not large enough to hold all color and alpha components starting atnormOffsetArrayIndexOutOfBoundsException- ifpixelis not large enough to hold a pixel value for thisColorModel.UnsupportedOperationException- if the constructor of thisColorModelcalled 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)
This method simply delegates to the default implementation inObjectwhich is identical to an==test since this class cannot enforce the issues of a proper equality test among multiple independent subclass branches. Subclasses are encouraged to override this method and provide equality testing for their own properties in addition to equality tests for the following common base properties ofColorModel:- Support for alpha component.
- Is alpha premultiplied.
- Number of bits per pixel.
- Type of transparency like Opaque, Bitmask or Translucent.
- Number of components in a pixel.
ColorSpacetype.- Type of the array used to represent pixel values.
- Number of significant bits per color and alpha component.
- Overrides:
equalsin classObject- Parameters:
obj- the reference object with which to compare.- Returns:
trueif this object is the same as the obj argument;falseotherwise.- See Also:
Object.hashCode()
-
hashCode
public int hashCode()
This method simply delegates to the default implementation inObjectwhich returns the system ID for the class. Subclasses are encouraged to override this method and provide a hash for their own properties in addition to hashing the values of the following common base properties ofColorModel:- Support for alpha component.
- Is alpha premultiplied.
- Number of bits per pixel.
- Type of transparency like Opaque, Bitmask or Translucent.
- Number of components in a pixel.
ColorSpacetype.- Type of the array used to represent pixel values.
- Number of significant bits per color and alpha component.
- Overrides:
hashCodein classObject- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object)
-
getColorSpace
public final ColorSpace getColorSpace()
Returns theColorSpaceassociated with thisColorModel.- Returns:
- the
ColorSpaceof thisColorModel.
-
coerceData
public ColorModel coerceData(WritableRaster raster, boolean isAlphaPremultiplied)
Forces the raster data to match the state specified in theisAlphaPremultipliedvariable, 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 thisColorModelwith theisAlphaPremultipliedflag set appropriately. This method will throw aUnsupportedOperationExceptionif it is not supported by thisColorModel. SinceColorModelis 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- theWritableRasterdataisAlphaPremultiplied-trueif the alpha is premultiplied;falseotherwise- Returns:
- a
ColorModelobject that represents the coerced data.
-
isCompatibleRaster
public boolean isCompatibleRaster(Raster raster)
Returnstrueifrasteris compatible with thisColorModelandfalseif it is not. SinceColorModelis 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- theRasterobject to test for compatibility- Returns:
trueifrasteris compatible with thisColorModel.- Throws:
UnsupportedOperationException- if this method has not been implemented for thisColorModel
-
createCompatibleWritableRaster
public WritableRaster createCompatibleWritableRaster(int w, int h)
Creates aWritableRasterwith the specified width and height that has a data layout (SampleModel) compatible with thisColorModel. SinceColorModelis 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 newWritableRasterh- the height to apply to the newWritableRaster- Returns:
- a
WritableRasterobject 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 aSampleModelwith the specified width and height that has a data layout compatible with thisColorModel. SinceColorModelis 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 newSampleModelh- the height to apply to the newSampleModel- Returns:
- a
SampleModelobject 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 theSampleModelis compatible with thisColorModel. SinceColorModelis 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:
trueif the specifiedSampleModelis compatible with thisColorModel;falseotherwise.- Throws:
UnsupportedOperationException- if this method is not supported by thisColorModel- See Also:
SampleModel
-
finalize
@Deprecated(since="9") public void finalize()
Deprecated.Thefinalizemethod has been deprecated. Subclasses that overridefinalizein order to perform cleanup should be modified to use alternative cleanup mechanisms and to remove the overridingfinalizemethod. When overriding thefinalizemethod, its implementation must explicitly ensure thatsuper.finalize()is invoked as described inObject.finalize(). See the specification forObject.finalize()for further information about migration options.Disposes of system resources associated with thisColorModelonce thisColorModelis no longer referenced.
-
getAlphaRaster
public WritableRaster getAlphaRaster(WritableRaster raster)
Returns aRasterrepresenting the alpha channel of an image, extracted from the inputRaster, provided that pixel values of thisColorModelrepresent color and alpha information as separate spatial bands (e.g.ComponentColorModelandDirectColorModel). This method assumes thatRasterobjects associated with such aColorModelstore the alpha band, if present, as the last band of image data. Returnsnullif there is no separate spatial alpha channel associated with thisColorModel. If this is anIndexColorModelwhich has alpha in the lookup table, this method will returnnullsince there is no spatially discrete alpha channel. This method will create a newRaster(but will share the data array). SinceColorModelis an abstract class, any instance is an instance of a subclass. Subclasses must override this method to get any behavior other than returningnullbecause the implementation in this abstract class returnsnull.- Parameters:
raster- the specifiedRaster- Returns:
- a
Rasterrepresenting the alpha channel of an image, obtained from the specifiedRaster.
-
-