summaryrefslogtreecommitdiffstats
path: root/awt/java/awt/image/BufferedImageOp.java
blob: 85b9f4e74c1afd1f13d876588ace7b73e11070e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
/**
 * @author Alexey A. Petrenko
 * @version $Revision$
 */
package java.awt.image;

import java.awt.RenderingHints;
import java.awt.geom.Point2D;
import java.awt.geom.Rectangle2D;

/**
 * The BufferedImageOp interface provides methods for performing transformations
 * from source data to destination data for BufferedImage objects. An object
 * implementing this interface can be passed into a BufferedImageFilter 
 * to operate on a BufferedImage.
 */
public interface BufferedImageOp {
    
    /**
     * Creates a destination image with the specified BufferedImage and
     * ColorModel; this destination image is empty and has the correct size 
     * and number of bands.   
     * 
     * @param src the source BufferedImage.
     * @param destCM the destination ColorModel.
     * 
     * @return the BufferedImage.
     */
    public BufferedImage createCompatibleDestImage(BufferedImage src, ColorModel destCM);

    /**
     * Performs a filter operation on the source BufferedImage and stores 
     * the resulting BufferedImage to the destination BufferedImage. If 
     * the destination BufferedImage is null, a BufferedImage with an 
     * appropriate ColorModel is created.
     * 
     * @param src the source BufferedImage.
     * @param dest the destination BufferedImage, where the result is stored.
     * 
     * @return the filtered BufferedImage.
     */
    public BufferedImage filter(BufferedImage src, BufferedImage dest);

    /**
     * Gets the bounds of filtered image.
     * 
     * @param src the source BufferedImage to be filtered.
     * 
     * @return the rectangle bounds of filtered image.
     */
    public Rectangle2D getBounds2D(BufferedImage src);

    /**
     * Gets the point of the destination image which corresponds
     * to the specified point in the source image. 
     * 
     * @param srcPt the point of the source image.
     * @param dstPt the point where the result will be stored.
     * 
     * @return the destination point.
     */
    public Point2D getPoint2D(Point2D srcPt, Point2D dstPt);

    /**
     * Gets the RenderingHints of the BufferedImageOp.
     * 
     * @return the RenderingHints of the BufferedImageOp.
     */
    public RenderingHints getRenderingHints();
}