001    /* BufferedImageOp.java -- 
002       Copyright (C) 2002, 2006, Free Software Foundation, Inc.
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 <code>BufferedImage</code> (the 
047     * source) producing a new <code>BufferedImage</code> (the destination).
048     */
049    public interface BufferedImageOp
050    {
051      /**
052       * Performs an operation on the source image, returning the result in a
053       * <code>BufferedImage</code>.  If <code>dest</code> is <code>null</code>, a 
054       * new <code>BufferedImage</code> will be created by calling the
055       * {@link #createCompatibleDestImage} 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>BufferedImage</code> each 
058       * time this method is called).
059       * 
060       * @param src  the source image.
061       * @param dst  the destination image (<code>null</code> permitted).
062       * 
063       * @return The filterd image.
064       */
065      BufferedImage filter(BufferedImage src, BufferedImage dst);
066      
067      /**
068       * Returns the bounds of the destination image on the basis of this
069       * <code>BufferedImageOp</code> being applied to the specified source image.
070       * 
071       * @param src  the source image.
072       * 
073       * @return The destination bounds.
074       */
075      Rectangle2D getBounds2D(BufferedImage src);
076      
077      /**
078       * Returns a new <code>BufferedImage</code> that can be used by this 
079       * <code>BufferedImageOp</code> as the destination image when filtering 
080       * the specified source image.
081       * 
082       * @param src  the source image.
083       * @param dstCM  the color model for the destination image.
084       * 
085       * @return A new image that can be used as the destination image.
086       */
087      BufferedImage createCompatibleDestImage(BufferedImage src, ColorModel dstCM);
088      
089      /**
090       * Returns the point on the destination image that corresponds to the given
091       * point on the source image.
092       * 
093       * @param src  the source point.
094       * @param dst  the destination point (<code>null</code> permitted).
095       * 
096       * @return The destination point.
097       */
098      Point2D getPoint2D(Point2D src, Point2D dst);
099      
100      /**
101       * Returns the rendering hints for this operation.
102       * 
103       * @return The rendering hints.
104       */
105      RenderingHints getRenderingHints();
106      
107    }