Interface BufferedImageOp
-
- All Known Implementing Classes:
- AffineTransformOp, ColorConvertOp, ConvolveOp, LookupOp, RescaleOp
public interface BufferedImageOp
This interface describes single-input/single-output operations performed onBufferedImage
objects. It is implemented byAffineTransformOp
,ConvolveOp
,ColorConvertOp
,RescaleOp
, andLookupOp
. These objects can be passed into aBufferedImageFilter
to operate on aBufferedImage
in the ImageProducer-ImageFilter-ImageConsumer paradigm.Classes that implement this interface must specify whether or not they allow in-place filtering-- filter operations where the source object is equal to the destination object.
This interface cannot be used to describe more sophisticated operations such as those that take multiple sources. Note that this restriction also means that the values of the destination pixels prior to the operation are not used as input to the filter operation.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description BufferedImage
createCompatibleDestImage(BufferedImage src, ColorModel destCM)
Creates a zeroed destination image with the correct size and number of bands.BufferedImage
filter(BufferedImage src, BufferedImage dest)
Performs a single-input/single-output operation on aBufferedImage
.Rectangle2D
getBounds2D(BufferedImage src)
Returns the bounding box of the filtered destination image.Point2D
getPoint2D(Point2D srcPt, Point2D dstPt)
Returns the location of the corresponding destination point given a point in the source image.RenderingHints
getRenderingHints()
Returns the rendering hints for this operation.
-
-
-
Method Detail
filter
BufferedImage filter(BufferedImage src, BufferedImage dest)
Performs a single-input/single-output operation on aBufferedImage
. If the color models for the two images do not match, a color conversion into the destination color model is performed. If the destination image is null, aBufferedImage
with an appropriateColorModel
is created.An
IllegalArgumentException
may be thrown if the source and/or destination image is incompatible with the types of images $ allowed by the class implementing this filter.- Parameters:
-
src
- TheBufferedImage
to be filtered -
dest
- TheBufferedImage
in which to store the results$ - Returns:
-
The filtered
BufferedImage
. - Throws:
-
IllegalArgumentException
- If the source and/or destination image is not compatible with the types of images allowed by the class implementing this filter.
getBounds2D
Rectangle2D getBounds2D(BufferedImage src)
Returns the bounding box of the filtered destination image. AnIllegalArgumentException
may be thrown if the source image is incompatible with the types of images allowed by the class implementing this filter.- Parameters:
-
src
- TheBufferedImage
to be filtered - Returns:
-
The
Rectangle2D
representing the destination image's bounding box.
createCompatibleDestImage
BufferedImage createCompatibleDestImage(BufferedImage src, ColorModel destCM)
Creates a zeroed destination image with the correct size and number of bands. AnIllegalArgumentException
may be thrown if the source image is incompatible with the types of images allowed by the class implementing this filter.- Parameters:
-
src
- TheBufferedImage
to be filtered -
destCM
-ColorModel
of the destination. If null, theColorModel
of the source is used. - Returns:
- The zeroed destination image.
getPoint2D
Point2D getPoint2D(Point2D srcPt, Point2D dstPt)
Returns the location of the corresponding destination point given a point in the source image. IfdstPt
is specified, it is used to hold the return value.- Parameters:
-
srcPt
- thePoint2D
that represents the point in the source image -
dstPt
- ThePoint2D
in which to store the result - Returns:
-
The
Point2D
in the destination image that corresponds to the specified point in the source image.
getRenderingHints
RenderingHints getRenderingHints()
Returns the rendering hints for this operation.- Returns:
-
The
RenderingHints
object for thisBufferedImageOp
. Returns null if no hints have been set.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.