All Downloads are FREE. Search and download functionalities are using the official Maven repository.

java.awt.image.DirectColorModel Maven / Gradle / Ivy

There is a newer version: 1.3.1
Show newest version
/*

NOTICE


(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.

Neither this file nor any files generated from it describe a complete specification, and they may only be used as described below. For example, no permission is given for you to incorporate this file, in whole or in part, in an implementation of a Java specification.

Sun Microsystems Inc. owns the copyright in this file and it is provided to you for informative, as opposed to normative, use. The file and any files generated from it may be used to generate other informative documentation, such as a unified set of documents of API signatures for a platform that includes technologies expressed as Java APIs. The file may also be used to produce "compilation stubs," which allow applications to be compiled and validated for such platforms.

Any work generated from this file, such as unified javadocs or compiled stub files, must be accompanied by this notice in its entirety.

This work corresponds to the API signatures of JSR 217: Personal Basis Profile 1.1. In the event of a discrepency between this work and the JSR 217 specification, which is available at http://www.jcp.org/en/jsr/detail?id=217, the latter takes precedence. */ package java.awt.image; import java.awt.color.ColorSpace; import java.awt.Transparency; // PBP/PP /** * The DirectColorModel class is a ColorModel * class that works with pixel values that represent RGB * color and alpha information as separate samples and that pack all * samples for a single pixel into a single int, short, or byte quantity. * This class can be used only with ColorSpaces of type ColorSpace.TYPE_RGB. * There must be three color samples in the pixel values and there can * be a single alpha sample. For those methods that use a primitive array * pixel representation of type transferType, the array * length is always one. The transfer * types supported are DataBuffer.TYPE_BYTE, * DataBuffer.TYPE_USHORT, and DataBuffer.TYPE_INT. * Color and alpha samples are stored in the single * element of the array in bits indicated by bit masks. Each bit mask * must be contiguous and masks must not overlap. The same masks apply to * the single int pixel representation used by other methods. The * correspondence of masks and color/alpha samples is as follows: *

    *
  • Masks are identified by indices running from 0 through 2 * if no alpha is present, or 3 if an alpha is present. *
  • The first three indices refer to color samples; * index 0 corresponds to red, index 1 to green, and index 2 to blue. *
  • Index 3 corresponds to the alpha sample, if present. *
*

* A single int pixel representation is valid for all objects of this * class, since it is always possible to represent pixel values used with * this class in a single int. Therefore, methods which use this * representation will not throw an IllegalArgumentException * due to an invalid pixel value. *

* This color model is similar to an X11 TrueColor visual. * The default RGB ColorModel specified by the * {@link ColorModel#getRGBdefault() getRGBdefault} method is a * DirectColorModel with the following parameters: *

 * Number of bits:        32
 * Red mask:              0x00ff0000
 * Green mask:            0x0000ff00
 * Blue mask:             0x000000ff
 * Alpha mask:            0xff000000
 * Color space:           sRGB
 * isAlphaPremultiplied:  False
 * Transparency:          Transparency.TRANSLUCENT
 * transferType:          DataBuffer.TYPE_INT
 * 
*

* Many of the methods in this class are final. This is because the * underlying native graphics code makes assumptions about the layout * and operation of this class and those assumptions are reflected in * the implementations of the methods here that are marked final. You * can subclass this class for other reasons, but you cannot override * or modify the behavior of those methods. * * @see ColorModel * @see ColorSpace * @see BufferedImage * @see ColorModel#getRGBdefault * * @version 10 Feb 1997 */ // public class DirectColorModel extends PackedColorModel public class DirectColorModel extends ColorModel { /** * Constructs a DirectColorModel from the specified masks * that indicate which bits in an int pixel representation * contain the red, green and blue color samples. As pixel values do not * contain alpha information, all pixels are treated as opaque, which * means that alpha = 1.0. All of the bits * in each mask must be contiguous and fit in the specified number * of least significant bits of an int pixel representation. * The ColorSpace is the default sRGB space. The * transparency value is Transparency.OPAQUE. The transfer type * is the smallest of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, * or DataBuffer.TYPE_INT that can hold a single pixel. * @param bits the number of bits in the pixel values; for example, * the sum of the number of bits in the masks. * @param rmask specifies a mask indicating which bits in an * integer pixel contain the red component * @param gmask specifies a mask indicating which bits in an * integer pixel contain the green component * @param bmask specifies a mask indicating which bits in an * integer pixel contain the blue component * */ public DirectColorModel(int bits, int rmask, int gmask, int bmask) {super(0); } /** * Constructs a DirectColorModel from the specified masks * that indicate which bits in an int pixel representation * contain the red, green and blue color samples and the alpha sample, * if present. If amask is 0, pixel values do not contain * alpha information and all pixels are treated as opaque, which means * that alpha = 1.0. All of the bits in each mask must * be contiguous and fit in the specified number of least significant bits * of an int pixel representation. Alpha, if present, is not * premultiplied. The ColorSpace is the default sRGB space. * The transparency value is Transparency.OPAQUE if no alpha is * present, or Transparency.TRANSLUCENT otherwise. The transfer type * is the smallest of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, * or DataBuffer.TYPE_INT that can hold a single pixel. * @param bits the number of bits in the pixel values; for example, * the sum of the number of bits in the masks. * @param rmask specifies a mask indicating which bits in an * integer pixel contain the red component * @param gmask specifies a mask indicating which bits in an * integer pixel contain the green component * @param bmask specifies a mask indicating which bits in an * integer pixel contain the blue component * @param amask specifies a mask indicating which bits in an * integer pixel contain the alpha component */ public DirectColorModel(int bits, int rmask, int gmask, int bmask, int amask) { super(0); } /** * Constructs a DirectColorModel from the specified * parameters. Color components are in the specified * ColorSpace, which must be of type ColorSpace.TYPE_RGB * and have minimum normalized component values which are all 0.0 * and maximum values which are all 1.0. * The masks specify which bits in an int pixel * representation contain the red, green and blue color samples and * the alpha sample, if present. If amask is 0, pixel * values do not contain alpha information and all pixels are treated * as opaque, which means that alpha = 1.0. All of the * bits in each mask must be contiguous and fit in the specified number * of least significant bits of an int pixel * representation. If there is alpha, the boolean * isAlphaPremultiplied specifies 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. The transparency value is * Transparency.OPAQUE, if no alpha is present, or * Transparency.TRANSLUCENT otherwise. The transfer type * is the type of primitive array used to represent pixel values and * must be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, or * DataBuffer.TYPE_INT. * @param space the specified ColorSpace * @param bits the number of bits in the pixel values; for example, * the sum of the number of bits in the masks. * @param rmask specifies a mask indicating which bits in an * integer pixel contain the red component * @param gmask specifies a mask indicating which bits in an * integer pixel contain the green component * @param bmask specifies a mask indicating which bits in an * integer pixel contain the blue component * @param amask specifies a mask indicating which bits in an * integer pixel contain the alpha component * @param isAlphaPremultiplied true if color samples are * premultiplied by the alpha sample; false otherwise * @param transferType the type of array used to represent pixel values * @throws IllegalArgumentException if space is not a * TYPE_RGB space or if the min/max normalized component * values are not 0.0/1.0. */ public DirectColorModel(ColorSpace space, int bits, int rmask, int gmask, int bmask, int amask, boolean isAlphaPremultiplied, int transferType) { super(0); } /** * Returns the mask indicating which bits in an int pixel * representation contain the red color component. * @return the mask, which indicates which bits of the int * pixel representation contain the red color sample. */ public final int getRedMask() {return 0; } /** * Returns the mask indicating which bits in an int pixel * representation contain the green color component. * @return the mask, which indicates which bits of the int * pixel representation contain the green color sample. */ public final int getGreenMask() { return 0; } /** * Returns the mask indicating which bits in an int pixel * representation contain the blue color component. * @return the mask, which indicates which bits of the int * pixel representation contain the blue color sample. */ public final int getBlueMask() { return 0; } /** * Returns the mask indicating which bits in an int pixel * representation contain the alpha component. * @return the mask, which indicates which bits of the int * pixel representation contain the alpha sample. */ public final int getAlphaMask() { return 0; } /** * 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 is a non pre-multiplied value. Thus, if the * alpha is premultiplied, this method divides it out before returning * the value. If the alpha value is 0, for example, the red value * is 0. * @param pixel the specified pixel * @return the red color component for the specified pixel, from * 0 to 255 in the sRGB ColorSpace. */ public final int getRed(int pixel) { return 0; } /** * 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 is a non pre-multiplied value. Thus, if the * alpha is premultiplied, this method divides it out before returning * the value. If the alpha value is 0, for example, the green value * is 0. * @param pixel the specified pixel * @return the green color component for the specified pixel, from * 0 to 255 in the sRGB ColorSpace. */ public final int getGreen(int pixel) { return 0; } /** * 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 is a non pre-multiplied value. Thus, if the * alpha is premultiplied, this method divides it out before returning * the value. If the alpha value is 0, for example, the blue value * is 0. * @param pixel the specified pixel * @return the blue color component for the specified pixel, from * 0 to 255 in the sRGB ColorSpace. */ public final int getBlue(int pixel) { return 0; } /** * Returns the alpha component for the specified pixel, scaled * from 0 to 255. The pixel value is specified as an int. * @param pixel the specified pixel * @return the value of the alpha component of pixel * from 0 to 255. */ public final int getAlpha(int pixel) { return 0; } /** * 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. * The returned value is in a non pre-multiplied format. Thus, if * the alpha is premultiplied, this method divides it out of the * color components. If the alpha value is 0, for example, the color * values are each 0. * @param pixel the specified pixel * @return the RGB value of the color/alpha components of the specified * pixel. * @see ColorModel#getRGBdefault */ public final int getRGB(int pixel) { return 0; } // /** // * 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 // * by an array of data elements of type transferType passed // * in as an object reference. // * The returned value is a non pre-multiplied value. Thus, if the // * alpha is premultiplied, this method divides it out before returning // * the value. If the alpha value is 0, for example, the red value // * is 0. // * If inData is not a primitive array of type // * transferType, a ClassCastException is // * thrown. An ArrayIndexOutOfBoundsException is // * thrown if inData is not large enough to hold a // * pixel value for this ColorModel. Since // * DirectColorModel can be subclassed, subclasses inherit // * the implementation of this method and if they don't override it // * then they throw an exception if they use an unsupported // * transferType. // * An UnsupportedOperationException is thrown if this // * transferType is not supported by this // * ColorModel. // * @param inData the array containing the pixel value // * @return the value of the red component of the specified pixel. // * @throws ArrayIndexOutOfBoundsException if inData is not // * large enough to hold a pixel value for this color model // * @throws ClassCastException if inData is not a // * primitive array of type transferType // * @throws UnsupportedOperationException if this transferType // * is not supported by this color model // */ // public int getRed(Object inData) { } // // /** // * 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 // * by an array of data elements of type transferType passed // * in as an object reference. // * The returned value is a non pre-multiplied value. Thus, if the // * alpha is premultiplied, this method divides it out before returning // * the value. If the alpha value is 0, for example, the green value // * is 0. If inData is not a primitive array of type // * transferType, a ClassCastException is thrown. // * An ArrayIndexOutOfBoundsException is // * thrown if inData is not large enough to hold a pixel // * value for this ColorModel. Since // * DirectColorModel can be subclassed, subclasses inherit // * the implementation of this method and if they don't override it // * then they throw an exception if they use an unsupported // * transferType. // * An UnsupportedOperationException is // * thrown if this transferType is not supported by this // * ColorModel. // * @param inData the array containing the pixel value // * @return the value of the green component of the specified pixel. // * @throws ArrayIndexOutOfBoundsException if inData is not // * large enough to hold a pixel value for this color model // * @throws ClassCastException if inData is not a // * primitive array of type transferType // * @throws UnsupportedOperationException if this transferType // * is not supported by this color model // */ // public int getGreen(Object inData) { } // // /** // * 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 // * by an array of data elements of type transferType passed // * in as an object reference. // * The returned value is a non pre-multiplied value. Thus, if the // * alpha is premultiplied, this method divides it out before returning // * the value. If the alpha value is 0, for example, the blue value // * is 0. If inData is not a primitive array of type // * transferType, a ClassCastException is thrown. // * An ArrayIndexOutOfBoundsException is // * thrown if inData is not large enough to hold a pixel // * value for this ColorModel. Since // * DirectColorModel can be subclassed, subclasses inherit // * the implementation of this method and if they don't override it // * then they throw an exception if they use an unsupported // * transferType. // * An UnsupportedOperationException is // * thrown if this transferType is not supported by this // * ColorModel. // * @param inData the array containing the pixel value // * @return the value of the blue component of the specified pixel. // * @throws ArrayIndexOutOfBoundsException if inData is not // * large enough to hold a pixel value for this color model // * @throws ClassCastException if inData is not a // * primitive array of type transferType // * @throws UnsupportedOperationException if this transferType // * is not supported by this color model // */ // public int getBlue(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, a ClassCastException is // * thrown. An ArrayIndexOutOfBoundsException is // * thrown if inData is not large enough to hold a pixel // * value for this ColorModel. Since // * DirectColorModel can be subclassed, subclasses inherit // * the implementation of this method and if they don't override it // * then they throw an exception if they use an unsupported // * transferType. // * If this transferType is not supported, an // * UnsupportedOperationException is thrown. // * @param inData the specified pixel // * @return the alpha component of the specified pixel, scaled from // * 0 to 255. // * @exception ClassCastException if inData // * is not a primitive array of type transferType // * @exception ArrayIndexOutOfBoundsException if // * inData is not large enough to hold a pixel value // * for this ColorModel // * @exception UnsupportedOperationException if this // * tranferType is not supported by this // * ColorModel // */ // public int getAlpha(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, a ClassCastException is // * thrown. An ArrayIndexOutOfBoundsException is // * thrown if inData is not large enough to hold a pixel // * value for this ColorModel. // * The returned value is in a non pre-multiplied format. Thus, if // * the alpha is premultiplied, this method divides it out of the // * color components. If the alpha value is 0, for example, the color // * values is 0. Since DirectColorModel can be // * subclassed, subclasses inherit the implementation of this method // * and if they don't override it then // * they throw an exception if they use an unsupported // * transferType. // * // * @param inData the specified pixel // * @return the color and alpha components of the specified pixel. // * @exception UnsupportedOperationException if this // * transferType is not supported by this // * ColorModel // * @see ColorModel#getRGBdefault // */ // public int getRGB(Object inData) { } // /** // * Returns a data element array representation of a pixel in this // * ColorModel, given an integer pixel representation in the // * default RGB color model. // * This array can then be passed to the setDataElements // * method of a WritableRaster object. If the pixel variable // * is null, a new array is allocated. If pixel // * is not null, it must be a primitive array of type // * transferType; otherwise, a // * ClassCastException is thrown. An // * ArrayIndexOutOfBoundsException is // * thrown if pixel is not large enough to hold a pixel // * value for this ColorModel. The pixel array is returned. // * Since DirectColorModel can be subclassed, subclasses // * inherit the implementation of this method and if they don't // * override it then they throw an exception if they use an unsupported // * transferType. // * // * @param rgb the integer pixel representation in the default RGB // * color model // * @param pixel the specified pixel // * @return an array representation of the specified pixel in this // * ColorModel // * @exception ClassCastException if pixel // * is not a primitive array of type transferType // * @exception ArrayIndexOutOfBoundsException if // * pixel is not large enough to hold a pixel value // * for this ColorModel // * @exception UnsupportedOperationException if this // * transferType is not supported by this // * ColorModel // * @see WritableRaster#setDataElements // * @see SampleModel#setDataElements // */ // public Object getDataElements(int rgb, Object pixel) { } // // /** // * Returns an array of unnormalized color/alpha components given a pixel // * in this ColorModel. The pixel value is specified as an // * int. If the components array is // * null, a new array is allocated. The // * components array is returned. Color/alpha components are // * stored in the components array starting at // * offset, even if the array is allocated by this method. // * An ArrayIndexOutOfBoundsException is thrown if the // * components array is not null and is not large // * enough to hold all the color and alpha components, starting at // * offset. // * @param pixel the specified pixel // * @param components the array to receive the color and alpha // * components of the specified pixel // * @param offset the offset into the components array at // * which to start storing the color and alpha components // * @return an array containing the color and alpha components of the // * specified pixel starting at the specified offset. // */ // public final int[] getComponents(int pixel, int[] components, int offset) // { } // // /** // * Returns an array of unnormalized color/alpha components given a pixel // * in this ColorModel. The pixel value is specified by an // * array of data elements of type transferType passed in as // * an object reference. If pixel is not a primitive array // * of type transferType, a ClassCastException // * is thrown. An ArrayIndexOutOfBoundsException is // * thrown if pixel is not large enough to hold a // * pixel value for this ColorModel. If the // * components array is null, a new // * array is allocated. The components array is returned. // * Color/alpha components are stored in the components array // * starting at offset, even if the array is allocated by // * this method. An ArrayIndexOutOfBoundsException // * is thrown if the components array is not // * null and is not large enough to hold all the color and // * alpha components, starting at offset. // * Since DirectColorModel can be subclassed, subclasses // * inherit the implementation of this method and if they don't // * override it then they throw an exception if they use an unsupported // * transferType. // * @param pixel the specified pixel // * @param components the array to receive the color and alpha // * components of the specified pixel // * @param offset the offset into the components array at // * which to start storing the color and alpha components // * @return an array containing the color and alpha components of the // * specified pixel starting at the specified offset. // * @exception ClassCastException if pixel // * is not a primitive array of type transferType // * @exception ArrayIndexOutOfBoundsException if // * pixel is not large enough to hold a pixel value // * for this ColorModel, or if components // * is not null and is not large enough to hold all the // * color and alpha components, starting at offset // * @exception UnsupportedOperationException if this // * transferType is not supported by this // * color model // */ // public final int[] getComponents(Object pixel, int[] components, int offset) // { } // // /** // * Creates a WritableRaster with the specified width and // * height that has a data layout (SampleModel) compatible // * with this ColorModel. // * @param w the width to apply to the new WritableRaster // * @param h the height to apply to the new WritableRaster // * @return a WritableRaster object with the specified // * width and height. // * @throws IllegalArgumentException if w or h // * is less than or equal to zero // * @see WritableRaster // * @see SampleModel // */ // public final WritableRaster createCompatibleWritableRaster(int w, int h) { } // // /** // * Returns a pixel value represented as an int in this // * ColorModel, given an array of unnormalized color/alpha // * components. An ArrayIndexOutOfBoundsException is // * thrown if the components array is // * not large enough to hold all the color and alpha components, starting // * at offset. // * @param components an array of unnormalized color and alpha // * components // * @param offset the index into components at which to // * begin retrieving the color and alpha components // * @return an int pixel value in this // * ColorModel corresponding to the specified components. // * @exception ArrayIndexOutOfBoundsException if // * the components array is not large enough to // * hold all of the color and alpha components starting at // * offset // */ // public int getDataElement(int[] components, int offset) { } // // /** // * Returns a data element array representation of a pixel in this // * ColorModel, given an array of unnormalized color/alpha // * components. // * This array can then be passed to the setDataElements // * method of a WritableRaster object. // * An ArrayIndexOutOfBoundsException is thrown if the // * components array // * is not large enough to hold all the color and alpha components, // * starting at offset. If the obj variable is // * null, a new array is allocated. If obj is // * not null, it must be a primitive array // * of type transferType; otherwise, a // * ClassCastException is thrown. // * An ArrayIndexOutOfBoundsException is thrown if // * obj is not large enough to hold a pixel value for this // * ColorModel. // * Since DirectColorModel can be subclassed, subclasses // * inherit the implementation of this method and if they don't // * override it then they throw an exception if they use an unsupported // * transferType. // * @param components an array of unnormalized color and alpha // * components // * @param offset the index into components at which to // * begin retrieving color and alpha components // * @param obj the Object representing an array of color // * and alpha components // * @return an Object representing an array of color and // * alpha components. // * @exception ClassCastException if obj // * is not a primitive array of type transferType // * @exception ArrayIndexOutOfBoundsException if // * obj is not large enough to hold a pixel value // * for this ColorModel or the components // * array is not large enough to hold all of the color and alpha // * components starting at offset // * @exception UnsupportedOperationException if this // * transferType is not supported by this // * color model // * @see WritableRaster#setDataElements // * @see SampleModel#setDataElements // */ // public Object getDataElements(int[] components, int offset, Object obj) { } // // /** // * Forces the raster data to match the state specified in the // * isAlphaPremultiplied variable, assuming the data is // * currently correctly described by this ColorModel. 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 this // * ColorModel with the isAlphaPremultiplied // * flag set appropriately. This method will throw a // * UnsupportedOperationException if this transferType is // * not supported by this ColorModel. Since // * ColorModel can be subclassed, subclasses inherit the // * implementation of this method and if they don't override it then // * they throw an exception if they use an unsupported transferType. // * // * @param raster the WritableRaster data // * @param isAlphaPremultiplied true if the alpha is // * premultiplied; false otherwise // * @return a ColorModel object that represents the // * coerced data. // * @exception UnsupportedOperationException if this // * transferType is not supported by this // * color model // */ // public final ColorModel coerceData(WritableRaster raster, boolean // isAlphaPremultiplied) // { } // // /** // * Returns true if raster is compatible // * with this ColorModel and false if it is // * not. // * @param raster the {@link Raster} object to test for compatibility // * @return true if raster is compatible // * with this ColorModel; false otherwise. // */ // public boolean isCompatibleRaster(Raster raster) { } /** * Returns a String that represents this * DirectColorModel. * @return a String representing this * DirectColorModel. */ public String toString() { return null; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy