1 /*
   2  * Copyright (c) 1997, 1998, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.awt;
  27 
  28 import java.awt.image.Raster;
  29 import java.awt.image.WritableRaster;
  30 
  31 /**
  32  * The <code>CompositeContext</code> interface defines the encapsulated
  33  * and optimized environment for a compositing operation.
  34  * <code>CompositeContext</code> objects maintain state for
  35  * compositing operations.  In a multi-threaded environment, several
  36  * contexts can exist simultaneously for a single {@link Composite}
  37  * object.
  38  * @see Composite
  39  */
  40 
  41 public interface CompositeContext {
  42     /**
  43      * Releases resources allocated for a context.
  44      */
  45     public void dispose();
  46 
  47     /**
  48      * Composes the two source {@link Raster} objects and
  49      * places the result in the destination
  50      * {@link WritableRaster}.  Note that the destination
  51      * can be the same object as either the first or second
  52      * source. Note that <code>dstIn</code> and
  53      * <code>dstOut</code> must be compatible with the
  54      * <code>dstColorModel</code> passed to the
  55      * {@link Composite#createContext(java.awt.image.ColorModel, java.awt.image.ColorModel, java.awt.RenderingHints) createContext}
  56      * method of the <code>Composite</code> interface.
  57      * @param src the first source for the compositing operation
  58      * @param dstIn the second source for the compositing operation
  59      * @param dstOut the <code>WritableRaster</code> into which the
  60      * result of the operation is stored
  61      * @see Composite
  62      */
  63     public void compose(Raster src,
  64                         Raster dstIn,
  65                         WritableRaster dstOut);
  66 
  67 
  68 }