001 /* RasterOp.java --
002 Copyright (C) 2000, 2002, 2004, 2005, 2006, Free Software Foundation
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package java.awt.image;
040
041 import java.awt.RenderingHints;
042 import java.awt.geom.Point2D;
043 import java.awt.geom.Rectangle2D;
044
045 /**
046 * An operation that is performed on one raster (the source) producing a new
047 * raster (the destination).
048 */
049 public interface RasterOp
050 {
051 /**
052 * Performs an operation on the source raster, returning the result in a
053 * writable raster. If <code>dest</code> is <code>null</code>, a new
054 * <code>WritableRaster</code> will be created by calling the
055 * {@link #createCompatibleDestRaster(Raster)} method. If <code>dest</code>
056 * is not <code>null</code>, the result is written to <code>dest</code> then
057 * returned (this avoids creating a new <code>WritableRaster</code> each
058 * time this method is called).
059 *
060 * @param src the source raster.
061 * @param dest the destination raster (<code>null</code> permitted).
062 *
063 * @return The filtered raster.
064 */
065 WritableRaster filter(Raster src, WritableRaster dest);
066
067 /**
068 * Returns the bounds of the destination raster on the basis of this
069 * <code>RasterOp</code> being applied to the specified source raster.
070 *
071 * @param src the source raster.
072 *
073 * @return The destination bounds.
074 */
075 Rectangle2D getBounds2D(Raster src);
076
077 /**
078 * Returns a raster that can be used by this <code>RasterOp</code> as the
079 * destination raster when operating on the specified source raster.
080 *
081 * @param src the source raster.
082 *
083 * @return A new writable raster that can be used as the destination raster.
084 */
085 WritableRaster createCompatibleDestRaster(Raster src);
086
087 /**
088 * Returns the point on the destination raster that corresponds to the given
089 * point on the source raster.
090 *
091 * @param srcPoint the source point.
092 * @param destPoint the destination point (<code>null</code> permitted).
093 *
094 * @return The destination point.
095 */
096 Point2D getPoint2D(Point2D srcPoint, Point2D destPoint);
097
098 /**
099 * Returns the rendering hints for this operation.
100 *
101 * @return The rendering hints.
102 */
103 RenderingHints getRenderingHints();
104 }