01 /*
02 * Copyright 1997-1998 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any 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 * @version 10 Feb 1997
40 */
41
42 public interface CompositeContext {
43 /**
44 * Releases resources allocated for a context.
45 */
46 public void dispose();
47
48 /**
49 * Composes the two source {@link Raster} objects and
50 * places the result in the destination
51 * {@link WritableRaster}. Note that the destination
52 * can be the same object as either the first or second
53 * source. Note that <code>dstIn</code> and
54 * <code>dstOut</code> must be compatible with the
55 * <code>dstColorModel</code> passed to the
56 * {@link Composite#createContext(java.awt.image.ColorModel, java.awt.image.ColorModel, java.awt.RenderingHints) createContext}
57 * method of the <code>Composite</code> interface.
58 * @param src the first source for the compositing operation
59 * @param dstIn the second source for the compositing operation
60 * @param dstOut the <code>WritableRaster</code> into which the
61 * result of the operation is stored
62 * @see Composite
63 */
64 public void compose(Raster src, Raster dstIn, WritableRaster dstOut);
65
66 }
|