java.lang.Object java.awt.image.ImageFilter java.awt.image.RGBImageFilter
public abstract class RGBImageFilter
This class provides an easy way to create an ImageFilter which modifies the pixels of an image in the default RGB ColorModel. It is meant to be used in conjunction with a FilteredImageSource object to produce filtered versions of existing images. It is an abstract class that provides the calls needed to channel all of the pixel data through a single method which converts pixels one at a time in the default RGB ColorModel regardless of the ColorModel being used by the ImageProducer. The only method which needs to be defined to create a useable image filter is the filterRGB method. Here is an example of a definition of a filter which swaps the red and blue components of an image:
class RedBlueSwapFilter extends RGBImageFilter { public RedBlueSwapFilter() { // The filter's operation does not depend on the // pixel's location, so IndexColorModels can be // filtered directly. canFilterIndexColorModel = true; } public int filterRGB(int x, int y, int rgb) { return ((rgb & 0xff00ff00) | ((rgb & 0xff0000) >> 16) | ((rgb & 0xff) << 16)); } }
Field Summary | |
---|---|
protected boolean |
canFilterIndexColorModel
This boolean indicates whether or not it is acceptable to apply the color filtering of the filterRGB method to the color table entries of an IndexColorModel object in lieu of pixel by pixel filtering. |
protected ColorModel |
newmodel
The ColorModel with which to replace origmodel when the user calls substituteColorModel. |
protected ColorModel |
origmodel
The ColorModel to be replaced by newmodel when the user calls substituteColorModel . |
Fields inherited from class java.awt.image. ImageFilter |
---|
consumer |
Fields inherited from interface java.awt.image. ImageConsumer |
---|
COMPLETESCANLINES , IMAGEABORTED , IMAGEERROR , RANDOMPIXELORDER , SINGLEFRAME , SINGLEFRAMEDONE , SINGLEPASS , STATICIMAGEDONE , TOPDOWNLEFTRIGHT |
Constructor Summary | |
---|---|
RGBImageFilter
() |
Method Summary | |
---|---|
IndexColorModel |
filterIndexColorModel
(
IndexColorModel
icm) Filters an IndexColorModel object by running each entry in its color tables through the filterRGB function that RGBImageFilter subclasses must provide. |
abstract int |
filterRGB
(int x, int y, int rgb) Subclasses must specify a method to convert a single input pixel in the default RGB ColorModel to a single output pixel. |
void |
filterRGBPixels
(int x, int y, int w, int h, int[] pixels, int off, int scansize) Filters a buffer of pixels in the default RGB ColorModel by passing them one by one through the filterRGB method. |
void |
setColorModel
(
ColorModel
model) If the ColorModel is an IndexColorModel and the subclass has set the canFilterIndexColorModel flag to true, we substitute a filtered version of the color model here and wherever that original ColorModel object appears in the setPixels methods. |
void |
setPixels
(int x, int y, int w, int h,
ColorModel
model, byte[] pixels, int off, int scansize) If the ColorModel object is the same one that has already been converted, then simply passes the pixels through with the converted ColorModel. |
void |
setPixels
(int x, int y, int w, int h,
ColorModel
model, int[] pixels, int off, int scansize) If the ColorModel object is the same one that has already been converted, then simply passes the pixels through with the converted ColorModel, otherwise converts the buffer of integer pixels to the default RGB ColorModel and passes the converted buffer to the filterRGBPixels method to be converted one by one. |
void |
substituteColorModel
(
ColorModel
oldcm,
ColorModel
newcm) Registers two ColorModel objects for substitution. |
Methods inherited from class java.awt.image. ImageFilter |
---|
clone , getFilterInstance , imageComplete , resendTopDownLeftRight , setDimensions , setHints , setProperties |
Methods inherited from class java.lang. Object |
---|
equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
Field Detail |
---|
protected ColorModel origmodel
protected ColorModel newmodel
protected boolean canFilterIndexColorModel
Constructor Detail |
---|
public RGBImageFilter()
Method Detail |
---|
public void setColorModel(ColorModel model)
Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation.
public void substituteColorModel(ColorModel oldcm, ColorModel newcm)
public IndexColorModel filterIndexColorModel(IndexColorModel icm)
public void filterRGBPixels(int x, int y, int w, int h, int[] pixels, int off, int scansize)
public void setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize)
Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation.
public void setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize)
Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to filter pixels from an image should avoid calling this method directly since that operation could interfere with the filtering operation.
public abstract int filterRGB(int x, int y, int rgb)