Class BufferedImageFilter
- java.lang.Object
-
- java.awt.image.ImageFilter
-
- java.awt.image.BufferedImageFilter
- All Implemented Interfaces:
-
ImageConsumer
,Cloneable
public class BufferedImageFilter extends ImageFilter implements Cloneable
The BufferedImageFilter
class subclasses an ImageFilter
to provide a simple means of using a single-source/single-destination image operator (BufferedImageOp
) to filter a BufferedImage
in the Image Producer/Consumer/Observer paradigm. Examples of these image operators are: ConvolveOp
, AffineTransformOp
and LookupOp
.
- See Also:
-
ImageFilter
,BufferedImage
,BufferedImageOp
Field Summary
Fields declared in class java.awt.image.ImageFilter
consumer
Fields declared in interface java.awt.image.ImageConsumer
COMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT
Constructor Summary
Constructor | Description |
---|---|
BufferedImageFilter(BufferedImageOp op) | Constructs a |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
BufferedImageOp | getBufferedImageOp() | Returns the |
void | imageComplete(int status) | Filters the information provided in the |
void | setColorModel(ColorModel model) | Filters the information provided in the |
void | setDimensions(int width,
int height) | Filters the information provided in the |
void | setPixels(int x,
int y,
int w,
int h,
ColorModel model,
byte[] pixels,
int off,
int scansize) | Filters the information provided in the |
void | setPixels(int x,
int y,
int w,
int h,
ColorModel model,
int[] pixels,
int off,
int scansize) | Filters the information provided in the |
Methods declared in class java.awt.image.ImageFilter
clone, getFilterInstance, resendTopDownLeftRight, setHints, setProperties
Methods declared in class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Constructor Detail
BufferedImageFilter
public BufferedImageFilter(BufferedImageOp op)
Constructs a BufferedImageFilter
with the specified single-source/single-destination operator.
- Parameters:
-
op
- the specifiedBufferedImageOp
to use to filter aBufferedImage
- Throws:
-
NullPointerException
- if op is null
Method Detail
getBufferedImageOp
public BufferedImageOp getBufferedImageOp()
Returns the BufferedImageOp
.
- Returns:
- the operator of this
BufferedImageFilter
.
setDimensions
public void setDimensions(int width, int height)
Filters the information provided in the setDimensions
method of the ImageConsumer
interface.
Note: This method is intended to be called by the ImageProducer
of the Image
whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.
- Specified by:
-
setDimensions
in interfaceImageConsumer
- Overrides:
-
setDimensions
in classImageFilter
- Parameters:
-
width
- the width to which to set the width of thisBufferedImageFilter
-
height
- the height to which to set the height of thisBufferedImageFilter
- See Also:
ImageConsumer.setDimensions(int, int)
setColorModel
public void setColorModel(ColorModel model)
Filters the information provided in the setColorModel
method of the ImageConsumer
interface.
If model
is null
, this method clears the current ColorModel
of this BufferedImageFilter
.
Note: This method is intended to be called by the ImageProducer
of the Image
whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.
- Specified by:
-
setColorModel
in interfaceImageConsumer
- Overrides:
-
setColorModel
in classImageFilter
- Parameters:
-
model
- theColorModel
to which to set theColorModel
of thisBufferedImageFilter
- See Also:
ImageConsumer.setColorModel(java.awt.image.ColorModel)
setPixels
public void setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize)
Filters the information provided in the setPixels
method of the ImageConsumer
interface which takes an array of bytes.
Note: This method is intended to be called by the ImageProducer
of the Image
whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.
- Specified by:
-
setPixels
in interfaceImageConsumer
- Overrides:
-
setPixels
in classImageFilter
- Parameters:
-
x
- the X coordinate of the upper-left corner of the area of pixels to be set -
y
- the Y coordinate of the upper-left corner of the area of pixels to be set -
w
- the width of the area of pixels -
h
- the height of the area of pixels -
model
- the specifiedColorModel
-
pixels
- the array of pixels -
off
- the offset into thepixels
array -
scansize
- the distance from one row of pixels to the next in thepixels
array - Throws:
-
IllegalArgumentException
- if width or height are less than zero. - See Also:
ImageConsumer.setPixels(int, int, int, int, ColorModel, byte[], int, int)
setPixels
public void setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize)
Filters the information provided in the setPixels
method of the ImageConsumer
interface which takes an array of integers.
Note: This method is intended to be called by the ImageProducer
of the Image
whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.
- Specified by:
-
setPixels
in interfaceImageConsumer
- Overrides:
-
setPixels
in classImageFilter
- Parameters:
-
x
- the X coordinate of the upper-left corner of the area of pixels to be set -
y
- the Y coordinate of the upper-left corner of the area of pixels to be set -
w
- the width of the area of pixels -
h
- the height of the area of pixels -
model
- the specifiedColorModel
-
pixels
- the array of pixels -
off
- the offset into thepixels
array -
scansize
- the distance from one row of pixels to the next in thepixels
array - Throws:
-
IllegalArgumentException
- if width or height are less than zero. - See Also:
ImageConsumer.setPixels(int, int, int, int, ColorModel, int[], int, int)
imageComplete
public void imageComplete(int status)
Filters the information provided in the imageComplete
method of the ImageConsumer
interface.
Note: This method is intended to be called by the ImageProducer
of the Image
whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.
- Specified by:
-
imageComplete
in interfaceImageConsumer
- Overrides:
-
imageComplete
in classImageFilter
- Parameters:
-
status
- the status of image loading - Throws:
-
ImagingOpException
- if there was a problem calling the filter method of theBufferedImageOp
associated with this instance. - See Also:
ImageConsumer.imageComplete(int)