| java.lang.Object
 java.awt.image.ImageFilter
java.awt.image.RGBImageFilter
| RGBImageFilter | | abstract public class RGBImageFilter extends ImageFilter (Code) | | 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));
}
}
See Also: FilteredImageSource
See Also: ImageFilter
See Also: ColorModel.getRGBdefault
version:
1.32 05/05/07
author:
Jim Graham |
| Method Summary | |
| public 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 public 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. | | public 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. | | public 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. | | public 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. | | public 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.
Converts a buffer of integer pixels to the default RGB ColorModel
and passes the converted buffer to the filterRGBPixels method.
Note: This method is intended to be called by the
ImageProducer of the Image whose pixels
are being filtered. | | public void | substituteColorModel(ColorModel oldcm, ColorModel newcm)
Registers two ColorModel objects for substitution. |
| canFilterIndexColorModel | | protected boolean canFilterIndexColorModel(Code) | | 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. Subclasses should set this variable to true in their
constructor if their filterRGB method does not depend on the
coordinate of the pixel being filtered.
See Also: RGBImageFilter.substituteColorModel
See Also: RGBImageFilter.filterRGB
See Also: IndexColorModel |
| newmodel | | protected ColorModel newmodel(Code) | | The ColorModel with which to
replace origmodel when the user calls
substituteColorModel.
|
| filterIndexColorModel | | public IndexColorModel filterIndexColorModel(IndexColorModel icm)(Code) | | Filters an IndexColorModel object by running each entry in its
color tables through the filterRGB function that RGBImageFilter
subclasses must provide. Uses coordinates of -1 to indicate that
a color table entry is being filtered rather than an actual
pixel value.
Parameters:
icm - the IndexColorModel object to be filtered
exception:
NullPointerException - if icm is null a new IndexColorModel representing the filtered colors |
| filterRGB | | abstract public int filterRGB(int x, int y, int rgb)(Code) | | Subclasses must specify a method to convert a single input pixel
in the default RGB ColorModel to a single output pixel.
Parameters:
x - the X coordinate of the pixel
Parameters:
y - the Y coordinate of the pixel
Parameters:
rgb - the integer pixel representation in the default RGBcolor model a filtered pixel in the default RGB color model.
See Also: ColorModel.getRGBdefault
See Also: RGBImageFilter.filterRGBPixels |
| filterRGBPixels | | public void filterRGBPixels(int x, int y, int w, int h, int pixels, int off, int scansize)(Code) | | Filters a buffer of pixels in the default RGB ColorModel by passing
them one by one through the filterRGB method.
Parameters:
x - the X coordinate of the upper-left corner of the region of pixels
Parameters:
y - the Y coordinate of the upper-left corner of the region of pixels
Parameters:
w - the width of the region of pixels
Parameters:
h - the height of the region of pixels
Parameters:
pixels - the array of pixels
Parameters:
off - the offset into the pixels array
Parameters:
scansize - the distance from one row of pixels to the nextin the array
See Also: ColorModel.getRGBdefault
See Also: RGBImageFilter.filterRGB |
| setColorModel | | public void setColorModel(ColorModel model)(Code) | | 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.
If the ColorModel is not an IndexColorModel or is null, this method
overrides the default ColorModel used by the ImageProducer and
specifies the default RGB ColorModel instead.
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.
See Also: ImageConsumer
See Also: ColorModel.getRGBdefault |
| setPixels | | public void setPixels(int x, int y, int w, int h, ColorModel model, byte pixels, int off, int scansize)(Code) | | 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 byte
pixels to the default RGB ColorModel and passes the converted
buffer to the filterRGBPixels method to be converted one by one.
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.
See Also: ColorModel.getRGBdefault
See Also: RGBImageFilter.filterRGBPixels |
| setPixels | | public void setPixels(int x, int y, int w, int h, ColorModel model, int pixels, int off, int scansize)(Code) | | 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.
Converts a buffer of integer pixels to the default RGB ColorModel
and passes the converted buffer to the filterRGBPixels method.
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.
See Also: ColorModel.getRGBdefault
See Also: RGBImageFilter.filterRGBPixels |
| substituteColorModel | | public void substituteColorModel(ColorModel oldcm, ColorModel newcm)(Code) | | Registers two ColorModel objects for substitution. If the oldcm
is encountered during any of the setPixels methods, the newcm
is substituted and the pixels passed through
untouched (but with the new ColorModel object).
Parameters:
oldcm - the ColorModel object to be replaced on the fly
Parameters:
newcm - the ColorModel object to replace oldcm on the fly |
| Methods inherited from java.awt.image.ImageFilter | public Object clone()(Code)(Java Doc)
public ImageFilter getFilterInstance(ImageConsumer ic)(Code)(Java Doc)
public void imageComplete(int status)(Code)(Java Doc)
public void resendTopDownLeftRight(ImageProducer ip)(Code)(Java Doc)
public void setColorModel(ColorModel model)(Code)(Java Doc)
public void setDimensions(int width, int height)(Code)(Java Doc)
public void setHints(int hints)(Code)(Java Doc)
public void setPixels(int x, int y, int w, int h, ColorModel model, byte pixels, int off, int scansize)(Code)(Java Doc)
public void setPixels(int x, int y, int w, int h, ColorModel model, int pixels, int off, int scansize)(Code)(Java Doc)
public void setProperties(Hashtable props)(Code)(Java Doc)
|
|
|