OpenJDK 27 · java.awt.image.BufferedImageOp · APIdia, the JavaDoc alternative

This interface describes single-input/single-output operations performed on BufferedImage objects. It is implemented by AffineTransformOp, ConvolveOp, ColorConvertOp, RescaleOp, and LookupOp. These objects can be passed into a BufferedImageFilter to operate on a BufferedImage 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

Modifier and Type	Method and Description
public BufferedImage	Returns: The zeroed destination image. createCompatibleDestImage(BufferedImage The `BufferedImage` to be filtered src, ColorModel `ColorModel` of the destination. If null, the `ColorModel` of the source is used. destCM) Creates a zeroed destination image with the correct size and number of bands.
public BufferedImage	Returns: The filtered `BufferedImage`. filter(BufferedImage The `BufferedImage` to be filtered src, BufferedImage The `BufferedImage` in which to store the results$ dest) Performs a single-input/single-output operation on a `BufferedImage`.
public Rectangle2D	Returns: The `Rectangle2D` representing the destination image's bounding box. getBounds2D(BufferedImage The `BufferedImage` to be filtered src) Returns the bounding box of the filtered destination image.
public Point2D	Returns: The `Point2D` in the destination image that corresponds to the specified point in the source image. getPoint2D(Point2D the `Point2D` that represents the point in the source image srcPt, Point2D The `Point2D` in which to store the result dstPt) Returns the location of the corresponding destination point given a point in the source image.
public RenderingHints	Returns: The `RenderingHints` object for this `BufferedImageOp`. Returns null if no hints have been set. getRenderingHints() Returns the rendering hints for this operation.

Method Detail

createCompatibleDestImage back to summary

createCompatibleDestImage	back to summary
public BufferedImage createCompatibleDestImage(BufferedImage src, ColorModel destCM) Creates a zeroed destination image with the correct size and number of bands. An `IllegalArgumentException` may be thrown if the source image is incompatible with the types of images allowed by the class implementing this filter. Parameters src:BufferedImage The `BufferedImage` to be filtered destCM:ColorModel `ColorModel` of the destination. If null, the `ColorModel` of the source is used. Returns:BufferedImage The zeroed destination image.

public BufferedImage createCompatibleDestImage(BufferedImage src, ColorModel destCM)

Creates a zeroed destination image with the correct size and number of bands. An IllegalArgumentException may be thrown if the source image is incompatible with the types of images allowed by the class implementing this filter.

Parameters

src:BufferedImage: The BufferedImage to be filtered
destCM:ColorModel: ColorModel of the destination. If null, the ColorModel of the source is used.

Returns:BufferedImage

The zeroed destination image.

filter back to summary

filter	back to summary
public BufferedImage filter(BufferedImage src, BufferedImage dest) Performs a single-input/single-output operation on a `BufferedImage`. 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, a `BufferedImage` with an appropriate `ColorModel` 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:BufferedImage The `BufferedImage` to be filtered dest:BufferedImage The `BufferedImage` in which to store the results$ Returns:BufferedImage The filtered `BufferedImage`. Exceptions IllegalArgumentException: If the source and/or destination image is not compatible with the types of images allowed by the class implementing this filter.

public BufferedImage filter(BufferedImage src, BufferedImage dest)

Performs a single-input/single-output operation on a BufferedImage. 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, a BufferedImage with an appropriate ColorModel 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:BufferedImage: The BufferedImage to be filtered
dest:BufferedImage: The BufferedImage in which to store the results$

Returns:BufferedImage

The filtered BufferedImage.

Exceptions

IllegalArgumentException:: If the source and/or destination image is not compatible with the types of images allowed by the class implementing this filter.

getBounds2D back to summary

getBounds2D	back to summary
public Rectangle2D getBounds2D(BufferedImage src) Returns the bounding box of the filtered destination image. An `IllegalArgumentException` may be thrown if the source image is incompatible with the types of images allowed by the class implementing this filter. Parameters src:BufferedImage The `BufferedImage` to be filtered Returns:Rectangle2D The `Rectangle2D` representing the destination image's bounding box.

public Rectangle2D getBounds2D(BufferedImage src)

Returns the bounding box of the filtered destination image. An IllegalArgumentException may be thrown if the source image is incompatible with the types of images allowed by the class implementing this filter.

Parameters

src:BufferedImage: The BufferedImage to be filtered

Returns:Rectangle2D

The Rectangle2D representing the destination image's bounding box.

getPoint2D back to summary

getPoint2D	back to summary
public Point2D getPoint2D(Point2D srcPt, Point2D dstPt) Returns the location of the corresponding destination point given a point in the source image. If `dstPt` is specified, it is used to hold the return value. Parameters srcPt:Point2D the `Point2D` that represents the point in the source image dstPt:Point2D The `Point2D` in which to store the result Returns:Point2D The `Point2D` in the destination image that corresponds to the specified point in the source image.

public Point2D getPoint2D(Point2D srcPt, Point2D dstPt)

Returns the location of the corresponding destination point given a point in the source image. If dstPt is specified, it is used to hold the return value.

Parameters

srcPt:Point2D: the Point2D that represents the point in the source image
dstPt:Point2D: The Point2D in which to store the result

Returns:Point2D

The Point2D in the destination image that corresponds to the specified point in the source image.

getRenderingHints back to summary

getRenderingHints	back to summary
public RenderingHints getRenderingHints() Returns the rendering hints for this operation. Returns:RenderingHints The `RenderingHints` object for this `BufferedImageOp`. Returns null if no hints have been set.

public RenderingHints getRenderingHints()

Returns the rendering hints for this operation.

Returns:RenderingHints: The RenderingHints object for this BufferedImageOp. Returns null if no hints have been set.

public Interface BufferedImageOp

Method Summary

Method Detail