1 /* BufferedImageOp.java -- 2 Copyright (C) 2002, 2006, Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 39 package java.awt.image; 40 41 import java.awt.RenderingHints; 42 import java.awt.geom.Point2D; 43 import java.awt.geom.Rectangle2D; 44 45 /** 46 * An operation that is performed on one <code>BufferedImage</code> (the 47 * source) producing a new <code>BufferedImage</code> (the destination). 48 */ 49 public interface BufferedImageOp 50 { 51 /** 52 * Performs an operation on the source image, returning the result in a 53 * <code>BufferedImage</code>. If <code>dest</code> is <code>null</code>, a 54 * new <code>BufferedImage</code> will be created by calling the 55 * {@link #createCompatibleDestImage} method. If <code>dest</code> 56 * is not <code>null</code>, the result is written to <code>dest</code> then 57 * returned (this avoids creating a new <code>BufferedImage</code> each 58 * time this method is called). 59 * 60 * @param src the source image. 61 * @param dst the destination image (<code>null</code> permitted). 62 * 63 * @return The filterd image. 64 */ filter(BufferedImage src, BufferedImage dst)65 BufferedImage filter(BufferedImage src, BufferedImage dst); 66 67 /** 68 * Returns the bounds of the destination image on the basis of this 69 * <code>BufferedImageOp</code> being applied to the specified source image. 70 * 71 * @param src the source image. 72 * 73 * @return The destination bounds. 74 */ getBounds2D(BufferedImage src)75 Rectangle2D getBounds2D(BufferedImage src); 76 77 /** 78 * Returns a new <code>BufferedImage</code> that can be used by this 79 * <code>BufferedImageOp</code> as the destination image when filtering 80 * the specified source image. 81 * 82 * @param src the source image. 83 * @param dstCM the color model for the destination image. 84 * 85 * @return A new image that can be used as the destination image. 86 */ createCompatibleDestImage(BufferedImage src, ColorModel dstCM)87 BufferedImage createCompatibleDestImage(BufferedImage src, ColorModel dstCM); 88 89 /** 90 * Returns the point on the destination image that corresponds to the given 91 * point on the source image. 92 * 93 * @param src the source point. 94 * @param dst the destination point (<code>null</code> permitted). 95 * 96 * @return The destination point. 97 */ getPoint2D(Point2D src, Point2D dst)98 Point2D getPoint2D(Point2D src, Point2D dst); 99 100 /** 101 * Returns the rendering hints for this operation. 102 * 103 * @return The rendering hints. 104 */ getRenderingHints()105 RenderingHints getRenderingHints(); 106 107 } 108