- java.lang.Object
-
- java.awt.image.ColorModel
-
- java.awt.image.ComponentColorModel
-
- All Implemented Interfaces:
Transparency
public class ComponentColorModel extends ColorModel
AColorModelclass that works with pixel values that represent color and alpha information as separate samples and that store each sample in a separate data element. This class can be used with an arbitraryColorSpace. The number of color samples in the pixel values must be same as the number of color components in theColorSpace. There may be a single alpha sample.For those methods that use a primitive array pixel representation of type
transferType, the array length is the same as the number of color and alpha samples. Color samples are stored first in the array followed by the alpha sample, if present. The order of the color samples is specified by theColorSpace. Typically, this order reflects the name of the color space type. For example, forTYPE_RGB, index 0 corresponds to red, index 1 to green, and index 2 to blue.The translation from pixel sample values to color/alpha components for display or processing purposes is based on a one-to-one correspondence of samples to components. Depending on the transfer type used to create an instance of
ComponentColorModel, the pixel sample values represented by that instance may be signed or unsigned and may be of integral type or float or double (see below for details). The translation from sample values to normalized color/alpha components must follow certain rules. For float and double samples, the translation is an identity, i.e. normalized component values are equal to the corresponding sample values. For integral samples, the translation should be only a simple scale and offset, where the scale and offset constants may be different for each component. The result of applying the scale and offset constants is a set of color/alpha component values, which are guaranteed to fall within a certain range. Typically, the range for a color component will be the range defined by thegetMinValueandgetMaxValuemethods of theColorSpaceclass. The range for an alpha component should be 0.0 to 1.0.Instances of
ComponentColorModelcreated with transfer typesDataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT, andDataBuffer.TYPE_INThave pixel sample values which are treated as unsigned integral values. The number of bits in a color or alpha sample of a pixel value might not be the same as the number of bits for the corresponding color or alpha sample passed to theComponentColorModel(ColorSpace, int[], boolean, boolean, int, int)constructor. In that case, this class assumes that the least significant n bits of a sample value hold the component value, where n is the number of significant bits for the component passed to the constructor. It also assumes that any higher-order bits in a sample value are zero. Thus, sample values range from 0 to 2n - 1. This class maps these sample values to normalized color component values such that 0 maps to the value obtained from theColorSpace's getMinValuemethod for each component and 2n - 1 maps to the value obtained fromgetMaxValue. To create aComponentColorModelwith a different color sample mapping requires subclassing this class and overriding thegetNormalizedComponents(Object, float[], int)method. The mapping for an alpha sample always maps 0 to 0.0 and 2n - 1 to 1.0.For instances with unsigned sample values, the unnormalized color/alpha component representation is only supported if two conditions hold. First, sample value 0 must map to normalized component value 0.0 and sample value 2n - 1 to 1.0. Second the min/max range of all color components of the
ColorSpacemust be 0.0 to 1.0. In this case, the component representation is the n least significant bits of the corresponding sample. Thus 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 these conditions are not met, any method taking an unnormalized component argument will throw anIllegalArgumentException.Instances of
ComponentColorModelcreated with transfer typesDataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, andDataBuffer.TYPE_DOUBLEhave pixel sample values which are treated as signed short, float, or double values. Such instances do not support the unnormalized color/alpha component representation, so any methods taking such a representation as an argument will throw anIllegalArgumentExceptionwhen called on one of these instances. The normalized component values of instances of this class have a range which depends on the transfer type as follows: for float samples, the full range of the float data type; for double samples, the full range of the float data type (resulting from casting double to float); for short samples, from approximately -maxVal to +maxVal, where maxVal is the per component maximum value for theColorSpace(-32767 maps to -maxVal, 0 maps to 0.0, and 32767 maps to +maxVal). A subclass may override the scaling for short sample values to normalized component values by overriding thegetNormalizedComponents(Object, float[], int)method. For float and double samples, the normalized component values are taken to be equal to the corresponding sample values, and subclasses should not attempt to add any non-identity scaling for these transfer types.Instances of
ComponentColorModelcreated with transfer typesDataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, andDataBuffer.TYPE_DOUBLEuse all the bits of all sample values. Thus all color/alpha components have 16 bits when usingDataBuffer.TYPE_SHORT, 32 bits when usingDataBuffer.TYPE_FLOAT, and 64 bits when usingDataBuffer.TYPE_DOUBLE. When theComponentColorModel(ColorSpace, int[], boolean, boolean, int, int)form of constructor is used with one of these transfer types, the bits array argument is ignored.It is possible to have color/alpha sample values which cannot be reasonably interpreted as component values for rendering. This can happen when
ComponentColorModelis subclassed to override the mapping of unsigned sample values to normalized color component values or when signed sample values outside a certain range are used. (As an example, specifying an alpha component as a signed short value outside the range 0 to 32767, normalized range 0.0 to 1.0, can lead to unexpected results.) It is the responsibility of applications to appropriately scale pixel data before rendering such that color components fall within the normalized range of theColorSpace(obtained using thegetMinValueandgetMaxValuemethods of theColorSpaceclass) and the alpha component is between 0.0 and 1.0. If color or alpha component values fall outside these ranges, rendering results are indeterminate.Methods that use a single int pixel representation throw an
IllegalArgumentException, unless the number of components for theComponentColorModelis one and the component value is unsigned -- in other words, a single color component using a transfer type ofDataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT, orDataBuffer.TYPE_INTand no alpha.A
ComponentColorModelcan be used in conjunction with aComponentSampleModel, aBandedSampleModel, or aPixelInterleavedSampleModelto construct aBufferedImage.
-
-
Field Summary
-
Fields declared in class java.awt.image.ColorModel
pixel_bits, transferType
-
Fields declared in interface java.awt.Transparency
BITMASK, OPAQUE, TRANSLUCENT
-
-
Constructor Summary
Constructors Constructor Description ComponentColorModel(ColorSpace colorSpace, boolean hasAlpha, boolean isAlphaPremultiplied, int transparency, int transferType)Constructs aComponentColorModelfrom the specified parameters.ComponentColorModel(ColorSpace colorSpace, int[] bits, boolean hasAlpha, boolean isAlphaPremultiplied, int transparency, int transferType)Constructs aComponentColorModelfrom the specified parameters.
-
Method Summary
All Methods Instance Methods Concrete 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)Tests if the specifiedObjectis an instance ofComponentColorModeland equals thisComponentColorModel.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.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.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.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 an int in 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.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.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 RGB ColorSpace, 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.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.inthashCode()Returns the hash code for this ComponentColorModel.booleanisCompatibleRaster(Raster raster)Returns true ifrasteris compatible with thisColorModel; false if it is not.booleanisCompatibleSampleModel(SampleModel sm)Checks whether or not the specifiedSampleModelis compatible with thisColorModel.-
Methods declared in class java.awt.image.ColorModel
finalize, getColorSpace, getComponentSize, getComponentSize, getNumColorComponents, getNumComponents, getPixelSize, getRGBdefault, getTransferType, getTransparency, hasAlpha, isAlphaPremultiplied, toString
-
-
-
-
Constructor Detail
-
ComponentColorModel
public ComponentColorModel(ColorSpace colorSpace, int[] bits, boolean hasAlpha, boolean isAlphaPremultiplied, int transparency, int transferType)
Constructs aComponentColorModelfrom the specified parameters. Color components will be in the specifiedColorSpace. The supported transfer types areDataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, andDataBuffer.TYPE_DOUBLE. If not null, thebitsarray specifies the number of significant bits per color and alpha component and its length should be at least 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. When thetransferTypeisDataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLEthebitsarray argument is ignored.hasAlphaindicates whether alpha information is present. IfhasAlphais true, then the booleanisAlphaPremultipliedspecifies how to interpret color and alpha samples in pixel values. If the boolean is true, color samples are assumed to have been multiplied by the alpha sample. Thetransparencyspecifies what alpha values can be represented by this color model. The acceptabletransparencyvalues areOPAQUE,BITMASKorTRANSLUCENT. ThetransferTypeis the type of primitive array used to represent pixel values.- Parameters:
colorSpace- TheColorSpaceassociated with this color model.bits- The number of significant bits per component. May be null, in which case all bits of all component samples will be significant. Ignored if transferType is one ofDataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLE, in which case all bits of all component samples will be significant.hasAlpha- If true, this color model supports alpha.isAlphaPremultiplied- If true, alpha is premultiplied.transparency- Specifies what alpha values can be represented by this color model.transferType- Specifies the type of primitive array used to represent pixel values.- Throws:
IllegalArgumentException- If thebitsarray argument is not null, its length is less than the number of color and alpha components, and transferType is one ofDataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT, orDataBuffer.TYPE_INT.IllegalArgumentException- If transferType is not one ofDataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLE.- See Also:
ColorSpace,Transparency
-
ComponentColorModel
public ComponentColorModel(ColorSpace colorSpace, boolean hasAlpha, boolean isAlphaPremultiplied, int transparency, int transferType)
Constructs aComponentColorModelfrom the specified parameters. Color components will be in the specifiedColorSpace. The supported transfer types areDataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, andDataBuffer.TYPE_DOUBLE. The number of significant bits per color and alpha component will be 8, 16, 32, 16, 32, or 64, respectively. The number of color components will be the number of components in theColorSpace. There will be an alpha component ifhasAlphaistrue. IfhasAlphais true, then the booleanisAlphaPremultipliedspecifies how to interpret color and alpha samples in pixel values. If the boolean is true, color samples are assumed to have been multiplied by the alpha sample. Thetransparencyspecifies what alpha values can be represented by this color model. The acceptabletransparencyvalues areOPAQUE,BITMASKorTRANSLUCENT. ThetransferTypeis the type of primitive array used to represent pixel values.- Parameters:
colorSpace- TheColorSpaceassociated with this color model.hasAlpha- If true, this color model supports alpha.isAlphaPremultiplied- If true, alpha is premultiplied.transparency- Specifies what alpha values can be represented by this color model.transferType- Specifies the type of primitive array used to represent pixel values.- Throws:
IllegalArgumentException- If transferType is not one ofDataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLE.- Since:
- 1.4
- See Also:
ColorSpace,Transparency
-
-
Method Detail
-
getRed
public 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. The returned value will be a non pre-multiplied value. If the alpha is premultiplied, this method divides it out before returning the value (if the alpha value is 0, the red value will be 0).- Specified by:
getRedin classColorModel- Parameters:
pixel- The pixel from which you want to get the red color component.- Returns:
- The red color component for the specified pixel, as an int.
- Throws:
IllegalArgumentException- If there is more than one component in thisColorModel.IllegalArgumentException- If the component value for thisColorModelis signed
-
getGreen
public 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. The returned value will be a non pre-multiplied value. If the alpha is premultiplied, this method divides it out before returning the value (if the alpha value is 0, the green value will be 0).- Specified by:
getGreenin classColorModel- Parameters:
pixel- The pixel from which you want to get the green color component.- Returns:
- The green color component for the specified pixel, as an int.
- Throws:
IllegalArgumentException- If there is more than one component in thisColorModel.IllegalArgumentException- If the component value for thisColorModelis signed
-
getBlue
public 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. The returned value will be a non pre-multiplied value. 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).- Specified by:
getBluein classColorModel- Parameters:
pixel- The pixel from which you want to get the blue color component.- Returns:
- The blue color component for the specified pixel, as an int.
- Throws:
IllegalArgumentException- If there is more than one component in thisColorModel.IllegalArgumentException- If the component value for thisColorModelis signed
-
getAlpha
public 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.- Specified by:
getAlphain classColorModel- Parameters:
pixel- The pixel from which you want to get the alpha component.- Returns:
- The alpha component for the specified pixel, as an int.
- Throws:
IllegalArgumentException- If there is more than one component in thisColorModel.IllegalArgumentException- If the component value for thisColorModelis signed
-
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 returned value will be in a non pre-multiplied format. If the alpha is premultiplied, this method divides it out of the color components (if the alpha value is 0, the color values will be 0).- Overrides:
getRGBin classColorModel- Parameters:
pixel- The pixel from which you want to get the color/alpha components.- Returns:
- The color/alpha components for the specified pixel, as an int.
- Throws:
IllegalArgumentException- If there is more than one component in thisColorModel.IllegalArgumentException- If the component value for thisColorModelis signed- See Also:
ColorModel.getRGBdefault()
-
getRed
public int getRed(Object inData)
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. Thepixelvalue is specified by an array of data elements of typetransferTypepassed in as an object reference. The returned value will be a non pre-multiplied value. If the alpha is premultiplied, this method divides it out before returning the value (if the alpha value is 0, the red value will be 0). SinceComponentColorModelcan be subclassed, subclasses inherit the implementation of this method and if they don't override it then they throw an exception if they use an unsupportedtransferType.- Overrides:
getRedin classColorModel- Parameters:
inData- The pixel from which you want to get the red color component, specified by an array of data elements of typetransferType.- Returns:
- The red color component for the specified pixel, as an int.
- Throws:
ClassCastException- IfinDatais not a primitive array of typetransferType.ArrayIndexOutOfBoundsException- ifinDatais not large enough to hold a pixel value for thisColorModel.UnsupportedOperationException- If the transfer type of thisComponentColorModelis not one of the supported transfer types:DataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLE.
-
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. Thepixelvalue is specified by an array of data elements of typetransferTypepassed in as an object reference. The returned value is a non pre-multiplied value. If the alpha is premultiplied, this method divides it out before returning the value (if the alpha value is 0, the green value will be 0). SinceComponentColorModelcan be subclassed, subclasses inherit the implementation of this method and if they don't override it then they throw an exception if they use an unsupportedtransferType.- Overrides:
getGreenin classColorModel- Parameters:
inData- The pixel from which you want to get the green color component, specified by an array of data elements of typetransferType.- Returns:
- The green color component for the specified pixel, as an int.
- Throws:
ClassCastException- IfinDatais not a primitive array of typetransferType.ArrayIndexOutOfBoundsException- ifinDatais not large enough to hold a pixel value for thisColorModel.UnsupportedOperationException- If the transfer type of thisComponentColorModelis not one of the supported transfer types:DataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLE.
-
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. Thepixelvalue is specified by an array of data elements of typetransferTypepassed in as an object reference. The returned value is a non pre-multiplied value. 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). SinceComponentColorModelcan be subclassed, subclasses inherit the implementation of this method and if they don't override it then they throw an exception if they use an unsupportedtransferType.- Overrides:
getBluein classColorModel- Parameters:
inData- The pixel from which you want to get the blue color component, specified by an array of data elements of typetransferType.- Returns:
- The blue color component for the specified pixel, as an int.
- Throws:
ClassCastException- IfinDatais not a primitive array of typetransferType.ArrayIndexOutOfBoundsException- ifinDatais not large enough to hold a pixel value for thisColorModel.UnsupportedOperationException- If the transfer type of thisComponentColorModelis not one of the supported transfer types:DataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLE.
-
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 typetransferTypepassed in as an object reference. SinceComponentColorModelcan be subclassed, subclasses inherit the implementation of this method and if they don't override it then they throw an exception if they use an unsupportedtransferType.- Overrides:
getAlphain classColorModel- Parameters:
inData- The pixel from which you want to get the alpha component, specified by an array of data elements of typetransferType.- Returns:
- The alpha component for the specified pixel, as an int.
- Throws:
ClassCastException- IfinDatais not a primitive array of typetransferType.ArrayIndexOutOfBoundsException- ifinDatais not large enough to hold a pixel value for thisColorModel.UnsupportedOperationException- If the transfer type of thisComponentColorModelis not one of the supported transfer types:DataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLE.
-
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 typetransferTypepassed in as an object reference. The returned value is in a non pre-multiplied format. If the alpha is premultiplied, this method divides it out of the color components (if the alpha value is 0, the color values will be 0). SinceComponentColorModelcan be subclassed, subclasses inherit the implementation of this method and if they don't override it then they throw an exception if they use an unsupportedtransferType.- Overrides:
getRGBin classColorModel- Parameters:
inData- The pixel from which you want to get the color/alpha components, specified by an array of data elements of typetransferType.- Returns:
- The color/alpha components for the specified pixel, as an int.
- Throws:
ClassCastException- IfinDatais not a primitive array of typetransferType.ArrayIndexOutOfBoundsException- ifinDatais not large enough to hold a pixel value for thisColorModel.UnsupportedOperationException- If the transfer type of thisComponentColorModelis not one of the supported transfer types:DataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLE.- See Also:
ColorModel.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 thesetDataElementsmethod of aWritableRasterobject. If thepixelparameter is null, a new array is allocated. SinceComponentColorModelcan be subclassed, subclasses inherit the implementation of this method and if they don't override it then they throw an exception if they use an unsupportedtransferType.- Overrides:
getDataElementsin classColorModel- Parameters:
rgb- the integer representation of the pixel in the RGB color modelpixel- the specified pixel- Returns:
- The data element array representation of a pixel
in this
ColorModel. - Throws:
ClassCastException- Ifpixelis not null and is not a primitive array of typetransferType.ArrayIndexOutOfBoundsException- Ifpixelis not large enough to hold a pixel value for thisColorModel.UnsupportedOperationException- If the transfer type of thisComponentColorModelis not one of the supported transfer types:DataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLE.- 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. An IllegalArgumentException is thrown if the component value for thisColorModelis not conveniently representable in the unnormalized form. Color/alpha components are stored in thecomponentsarray starting atoffset(even if the array is allocated by this method).- Overrides:
getComponentsin classColorModel- Parameters:
pixel- The pixel value specified as an integer.components- An integer array in which to store the unnormalized color/alpha components. If thecomponentsarray is null, a new array is allocated.offset- An offset into thecomponentsarray.- Returns:
- The components array.
- Throws:
IllegalArgumentException- If there is more than one component in thisColorModel.IllegalArgumentException- If thisColorModeldoes not support the unnormalized formArrayIndexOutOfBoundsException- If thecomponentsarray is not null and is not large enough to hold all the color and alpha components (starting at offset).
-
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 typetransferTypepassed in as an object reference. An IllegalArgumentException is thrown if the component values for thisColorModelare not conveniently representable in the unnormalized form. Color/alpha components are stored in thecomponentsarray starting atoffset(even if the array is allocated by this method). SinceComponentColorModelcan be subclassed, subclasses inherit the implementation of this method and if they don't override it then this method might throw an exception if they use an unsupportedtransferType.- Overrides:
getComponentsin classColorModel- Parameters:
pixel- A pixel value specified by an array of data elements of typetransferType.components- An integer array in which to store the unnormalized color/alpha components. If thecomponentsarray is null, a new array is allocated.offset- An offset into thecomponentsarray.- Returns:
- The
componentsarray. - Throws:
IllegalArgumentException- If thisComponentColorModeldoes not support the unnormalized formUnsupportedOperationException- in some cases iff the transfer type of thisComponentColorModelis not one of the following transfer types:DataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT, orDataBuffer.TYPE_INT.ClassCastException- Ifpixelis not a primitive array of typetransferType.IllegalArgumentException- If thecomponentsarray is not null and is not large enough to hold all the color and alpha components (starting at offset), or ifpixelis not large enough to hold a pixel value for this ColorModel.
-
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.- Overrides:
getUnnormalizedComponentsin classColorModel- 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 thisComponentColorModeldoes not support the unnormalized formIllegalArgumentException- if the length ofnormComponentsminusnormOffsetis less thannumComponents
-
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.- Overrides:
getNormalizedComponentsin classColorModel- 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 thisComponentColorModeldoes not support the unnormalized form
-
getDataElement
public int getDataElement(int[] components, int offset)Returns a pixel value represented as an int in thisColorModel, given an array of unnormalized color/alpha components.- Overrides:
getDataElementin classColorModel- Parameters:
components- An array of unnormalized color/alpha components.offset- An offset into thecomponentsarray.- Returns:
- A pixel value represented as an int.
- Throws:
IllegalArgumentException- If there is more than one component in thisColorModel.IllegalArgumentException- If thisComponentColorModeldoes not support the unnormalized form
-
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.- Overrides:
getDataElementsin classColorModel- Parameters:
components- An array of unnormalized color/alpha components.offset- The integer offset into thecomponentsarray.obj- The object in which to store the data element array representation of the pixel. Ifobjvariable is null, a new array is allocated. Ifobjis not null, it must be a primitive array of typetransferType. AnArrayIndexOutOfBoundsExceptionis thrown ifobjis not large enough to hold a pixel value for thisColorModel. SinceComponentColorModelcan be subclassed, subclasses inherit the implementation of this method and if they don't override it then they throw an exception if they use an unsupportedtransferType.- Returns:
- The data element array representation of a pixel
in this
ColorModel. - Throws:
IllegalArgumentException- If the components array is not large enough to hold all the color and alpha components (starting at offset).ClassCastException- Ifobjis not null and is not a primitive array of typetransferType.ArrayIndexOutOfBoundsException- Ifobjis not large enough to hold a pixel value for thisColorModel.IllegalArgumentException- If thisComponentColorModeldoes not support the unnormalized formUnsupportedOperationException- If the transfer type of thisComponentColorModelis not one of the following transfer types:DataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT, orDataBuffer.TYPE_INT.- 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).- Overrides:
getDataElementin classColorModel- 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.- Overrides:
getDataElementsin classColorModel- 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).This method must be overridden by a subclass if that subclass is designed to translate pixel sample values to color component values in a non-default way. The default translations implemented by this class is described in the class comments. Any subclass implementing a non-default translation must follow the constraints on allowable translations defined there.
- Overrides:
getNormalizedComponentsin classColorModel- 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.- Since:
- 1.4
-
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 also returns an instance of thisColorModelwith theisAlphaPremultipliedflag set appropriately. SinceColorModelcan be subclassed, subclasses inherit the implementation of this method and if they don't override it then they throw an exception if they use an unsupportedtransferType.- Overrides:
coerceDatain classColorModel- Parameters:
raster- theWritableRasterdataisAlphaPremultiplied-trueif the alpha is premultiplied;falseotherwise- Returns:
- a
ColorModelobject that represents the coerced data. - Throws:
NullPointerException- ifrasterisnulland data coercion is required.UnsupportedOperationException- if the transfer type of thisComponentColorModelis not one of the supported transfer types:DataBuffer.TYPE_BYTE,DataBuffer.TYPE_USHORT,DataBuffer.TYPE_INT,DataBuffer.TYPE_SHORT,DataBuffer.TYPE_FLOAT, orDataBuffer.TYPE_DOUBLE.
-
isCompatibleRaster
public boolean isCompatibleRaster(Raster raster)
Returns true ifrasteris compatible with thisColorModel; false if it is not.- Overrides:
isCompatibleRasterin classColorModel- Parameters:
raster- TheRasterobject to test for compatibility.- Returns:
trueifrasteris compatible with thisColorModel,falseif it is not.
-
createCompatibleWritableRaster
public WritableRaster createCompatibleWritableRaster(int w, int h)
Creates aWritableRasterwith the specified width and height, that has a data layout (SampleModel) compatible with thisColorModel.- Overrides:
createCompatibleWritableRasterin classColorModel- Parameters:
w- The width of theWritableRasteryou want to create.h- The height of theWritableRasteryou want to create.- Returns:
- A
WritableRasterthat is compatible with 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.- Overrides:
createCompatibleSampleModelin classColorModel- Parameters:
w- The width of theSampleModelyou want to create.h- The height of theSampleModelyou want to create.- Returns:
- A
SampleModelthat is compatible with thisColorModel. - See Also:
SampleModel
-
isCompatibleSampleModel
public boolean isCompatibleSampleModel(SampleModel sm)
Checks whether or not the specifiedSampleModelis compatible with thisColorModel.- Overrides:
isCompatibleSampleModelin classColorModel- Parameters:
sm- TheSampleModelto test for compatibility.- Returns:
trueif theSampleModelis compatible with thisColorModel,falseif it is not.- See Also:
SampleModel
-
getAlphaRaster
public WritableRaster getAlphaRaster(WritableRaster raster)
Returns aRasterrepresenting the alpha channel of an image, extracted from the inputRaster. This method assumes thatRasterobjects associated with thisColorModelstore the alpha band, if present, as the last band of image data. Returns null if there is no separate spatial alpha channel associated with thisColorModel. This method creates a newRaster, but will share the data array.- Overrides:
getAlphaRasterin classColorModel- Parameters:
raster- TheWritableRasterfrom which to extract the alpha channel.- Returns:
- A
WritableRastercontaining the image's alpha channel.
-
equals
public boolean equals(Object obj)
Tests if the specifiedObjectis an instance ofComponentColorModeland equals thisComponentColorModel.- Overrides:
equalsin classColorModel- Parameters:
obj- theObjectto test for equality- Returns:
trueif the specifiedObjectis an instance ofComponentColorModeland equals thisComponentColorModel;falseotherwise.- See Also:
Object.hashCode()
-
hashCode
public int hashCode()
Returns the hash code for this ComponentColorModel.- Overrides:
hashCodein classColorModel- Returns:
- a hash code for this ComponentColorModel.
- See Also:
Object.equals(java.lang.Object)
-
-