Bug 16954: Support putImageData
[WebKit-https.git] / WebCore / html / CanvasRenderingContext2D.h
1 /*
2  * Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef CanvasRenderingContext2D_h
27 #define CanvasRenderingContext2D_h
28
29 #include "FloatSize.h"
30 #include "GraphicsTypes.h"
31 #include "Path.h"
32 #include "PlatformString.h"
33 #include <wtf/Vector.h>
34
35 #if PLATFORM(CG)
36 #include <ApplicationServices/ApplicationServices.h>
37 #endif
38
39 namespace WebCore {
40
41     class CanvasGradient;
42     class CanvasPattern;
43     class CanvasStyle;
44     class FloatRect;
45     class GraphicsContext;
46     class HTMLCanvasElement;
47     class HTMLImageElement;
48     class ImageData;
49
50     typedef int ExceptionCode;
51
52     class CanvasRenderingContext2D : public RefCounted<CanvasRenderingContext2D> {
53     public:
54         CanvasRenderingContext2D(HTMLCanvasElement*);
55
56         HTMLCanvasElement* canvas() const { return m_canvas; }
57
58         CanvasStyle* strokeStyle() const;
59         void setStrokeStyle(PassRefPtr<CanvasStyle>);
60
61         CanvasStyle* fillStyle() const;
62         void setFillStyle(PassRefPtr<CanvasStyle>);
63
64         float lineWidth() const;
65         void setLineWidth(float);
66
67         String lineCap() const;
68         void setLineCap(const String&);
69
70         String lineJoin() const;
71         void setLineJoin(const String&);
72
73         float miterLimit() const;
74         void setMiterLimit(float);
75
76         float shadowOffsetX() const;
77         void setShadowOffsetX(float);
78
79         float shadowOffsetY() const;
80         void setShadowOffsetY(float);
81
82         float shadowBlur() const;
83         void setShadowBlur(float);
84
85         String shadowColor() const;
86         void setShadowColor(const String&);
87
88         float globalAlpha() const;
89         void setGlobalAlpha(float);
90
91         String globalCompositeOperation() const;
92         void setGlobalCompositeOperation(const String&);
93
94         void save();
95         void restore();
96
97         void scale(float sx, float sy);
98         void rotate(float angleInRadians);
99         void translate(float tx, float ty);
100         void transform(float m11, float m12, float m21, float m22, float dx, float dy);
101
102         void setStrokeColor(const String& color);
103         void setStrokeColor(float grayLevel);
104         void setStrokeColor(const String& color, float alpha);
105         void setStrokeColor(float grayLevel, float alpha);
106         void setStrokeColor(float r, float g, float b, float a);
107         void setStrokeColor(float c, float m, float y, float k, float a);
108
109         void setFillColor(const String& color);
110         void setFillColor(float grayLevel);
111         void setFillColor(const String& color, float alpha);
112         void setFillColor(float grayLevel, float alpha);
113         void setFillColor(float r, float g, float b, float a);
114         void setFillColor(float c, float m, float y, float k, float a);
115
116         void beginPath();
117         void closePath();
118
119         void moveTo(float x, float y);
120         void lineTo(float x, float y);
121         void quadraticCurveTo(float cpx, float cpy, float x, float y);
122         void bezierCurveTo(float cp1x, float cp1y, float cp2x, float cp2y, float x, float y);
123         void arcTo(float x0, float y0, float x1, float y1, float radius, ExceptionCode&);
124         void arc(float x, float y, float r, float sa, float ea, bool clockwise, ExceptionCode&);
125         void rect(float x, float y, float width, float height, ExceptionCode&);
126
127         void fill();
128         void stroke();
129         void clip();
130
131         bool isPointInPath(const float x, const float y);
132
133         void clearRect(float x, float y, float width, float height, ExceptionCode&);
134         void fillRect(float x, float y, float width, float height, ExceptionCode&);
135         void strokeRect(float x, float y, float width, float height, ExceptionCode&);
136         void strokeRect(float x, float y, float width, float height, float lineWidth, ExceptionCode&);
137
138         void setShadow(float width, float height, float blur);
139         void setShadow(float width, float height, float blur, const String& color);
140         void setShadow(float width, float height, float blur, float grayLevel);
141         void setShadow(float width, float height, float blur, const String& color, float alpha);
142         void setShadow(float width, float height, float blur, float grayLevel, float alpha);
143         void setShadow(float width, float height, float blur, float r, float g, float b, float a);
144         void setShadow(float width, float height, float blur, float c, float m, float y, float k, float a);
145
146         void clearShadow();
147
148         void drawImage(HTMLImageElement*, float x, float y);
149         void drawImage(HTMLImageElement*, float x, float y, float width, float height, ExceptionCode&);
150         void drawImage(HTMLImageElement*, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
151         void drawImage(HTMLCanvasElement*, float x, float y);
152         void drawImage(HTMLCanvasElement*, float x, float y, float width, float height, ExceptionCode&);
153         void drawImage(HTMLCanvasElement*, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
154
155         void drawImageFromRect(HTMLImageElement*, float sx, float sy, float sw, float sh,
156             float dx, float dy, float dw, float dh, const String& compositeOperation);
157
158         void setAlpha(float);
159
160         void setCompositeOperation(const String&);
161
162         PassRefPtr<CanvasGradient> createLinearGradient(float x0, float y0, float x1, float y1);
163         PassRefPtr<CanvasGradient> createRadialGradient(float x0, float y0, float r0, float x1, float y1, float r1);
164         PassRefPtr<CanvasPattern> createPattern(HTMLImageElement*, const String& repetitionType, ExceptionCode&);
165         PassRefPtr<CanvasPattern> createPattern(HTMLCanvasElement*, const String& repetitionType, ExceptionCode&);
166         
167         PassRefPtr<ImageData> createImageData(float width, float height) const;
168         PassRefPtr<ImageData> getImageData(float sx, float sy, float sw, float sh) const;
169         void putImageData(ImageData*, float dx, float dy, ExceptionCode&);
170         void putImageData(ImageData*, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight, ExceptionCode&);
171         
172         void reset();
173         void detachCanvas() { m_canvas = 0; }
174
175     private:
176         struct State {
177             State();
178
179             RefPtr<CanvasStyle> m_strokeStyle;
180             RefPtr<CanvasStyle> m_fillStyle;
181             Path m_path;
182             float m_lineWidth;
183             LineCap m_lineCap;
184             LineJoin m_lineJoin;
185             float m_miterLimit;
186             FloatSize m_shadowOffset;
187             float m_shadowBlur;
188             String m_shadowColor;
189             float m_globalAlpha;
190             CompositeOperator m_globalComposite;
191             bool m_appliedStrokePattern;
192             bool m_appliedFillPattern;
193 #if PLATFORM(CG)
194             CGAffineTransform m_strokeStylePatternTransform;
195             CGAffineTransform m_fillStylePatternTransform;
196 #endif
197         };
198
199         State& state() { return m_stateStack.last(); }
200         const State& state() const { return m_stateStack.last(); }
201
202         void applyShadow();
203
204         void willDraw(const FloatRect&);
205
206         GraphicsContext* drawingContext() const;
207
208         void applyStrokePattern();
209         void applyFillPattern();
210
211         void clearPathForDashboardBackwardCompatibilityMode();
212
213         HTMLCanvasElement* m_canvas;
214         Vector<State, 1> m_stateStack;
215     };
216
217 } // namespace WebCore
218
219 #endif