libjava/java/awt/CompositeContext.java

   1 /* Composite.java -- the context for compositing graphics layers
   2    Copyright (C) 2002, 2005  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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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;
  40
  41 import java.awt.image.Raster;
  42 import java.awt.image.WritableRaster;
  43
  44 /**
  45  * This interface provides an optimized environment for compositing graphics.
  46  * Several such contexts may exist for a given <code>Composite</code> object.
  47  *
  48  * @author Eric Blake (ebb9@email.byu.edu)
  49  * @see Composite
  50  * @since 1.2
  51  * @status updated to 1.4
  52  */
  53 public interface CompositeContext
  54 {
  55   /**
  56    * Release resources allocated for the compositing.
  57    */
  58   void dispose();
  59
  60   /**
  61    * Compose the two source images into the composite image. The destination
  62    * can be the same as one of the two inputs, and the destination must be
  63    * compatible with the ColorModel chosen in {@link Composite#createContext}.
  64    *
  65    * @param src the lower image source in compositing
  66    * @param dstIn the upper image source in compositing
  67    * @param dstOut the destination for the composite
  68    * @see Composite
  69    */
  70   void compose(Raster src, Raster dstIn, WritableRaster dstOut);
  71 } // interface CompositeContext