48590697dce522eca02be70e59dc8c81c455046d
[WebKit-https.git] / WebCore / html / CanvasRenderingContext2D.h
1 /*
2  * Copyright (C) 2006 Apple Computer, 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 HTMLCanvas2DContext_h
27 #define HTMLCanvas2DContext_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 __APPLE__
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
49     typedef int ExceptionCode;
50
51     class CanvasRenderingContext2D : public Shared<CanvasRenderingContext2D> {
52     public:
53         CanvasRenderingContext2D(HTMLCanvasElement*);
54
55         HTMLCanvasElement* canvas() const { return m_canvas; }
56
57         CanvasStyle* strokeStyle() const;
58         void setStrokeStyle(PassRefPtr<CanvasStyle>);
59
60         CanvasStyle* fillStyle() const;
61         void setFillStyle(PassRefPtr<CanvasStyle>);
62
63         float lineWidth() const;
64         void setLineWidth(float);
65
66         String lineCap() const;
67         void setLineCap(const String&);
68
69         String lineJoin() const;
70         void setLineJoin(const String&);
71
72         float miterLimit() const;
73         void setMiterLimit(float);
74
75         float shadowOffsetX() const;
76         void setShadowOffsetX(float);
77
78         float shadowOffsetY() const;
79         void setShadowOffsetY(float);
80
81         float shadowBlur() const;
82         void setShadowBlur(float);
83
84         String shadowColor() const;
85         void setShadowColor(const String&);
86
87         float globalAlpha() const;
88         void setGlobalAlpha(float);
89
90         String globalCompositeOperation() const;
91         void setGlobalCompositeOperation(const String&);
92
93         void save();
94         void restore();
95
96         void scale(float sx, float sy);
97         void rotate(float angleInRadians);
98         void translate(float tx, float ty);
99
100         void setStrokeColor(const String& color);
101         void setStrokeColor(float grayLevel);
102         void setStrokeColor(const String& color, float alpha);
103         void setStrokeColor(float grayLevel, float alpha);
104         void setStrokeColor(float r, float g, float b, float a);
105         void setStrokeColor(float c, float m, float y, float k, float a);
106
107         void setFillColor(const String& color);
108         void setFillColor(float grayLevel);
109         void setFillColor(const String& color, float alpha);
110         void setFillColor(float grayLevel, float alpha);
111         void setFillColor(float r, float g, float b, float a);
112         void setFillColor(float c, float m, float y, float k, float a);
113
114         void beginPath();
115         void closePath();
116
117         void moveTo(float x, float y);
118         void lineTo(float x, float y);
119         void quadraticCurveTo(float cpx, float cpy, float x, float y);
120         void bezierCurveTo(float cp1x, float cp1y, float cp2x, float cp2y, float x, float y);
121         void arcTo(float x0, float y0, float x1, float y1, float radius, ExceptionCode&);
122         void arc(float x, float y, float r, float sa, float ea, bool clockwise, ExceptionCode&);
123         void rect(float x, float y, float width, float height, ExceptionCode&);
124
125         void fill();
126         void stroke();
127         void clip();
128
129         void clearRect(float x, float y, float width, float height, ExceptionCode&);
130         void fillRect(float x, float y, float width, float height, ExceptionCode&);
131         void strokeRect(float x, float y, float width, float height, ExceptionCode&);
132         void strokeRect(float x, float y, float width, float height, float lineWidth, ExceptionCode&);
133
134         void setShadow(float width, float height, float blur);
135         void setShadow(float width, float height, float blur, const String& color);
136         void setShadow(float width, float height, float blur, float grayLevel);
137         void setShadow(float width, float height, float blur, const String& color, float alpha);
138         void setShadow(float width, float height, float blur, float grayLevel, float alpha);
139         void setShadow(float width, float height, float blur, float r, float g, float b, float a);
140         void setShadow(float width, float height, float blur, float c, float m, float y, float k, float a);
141
142         void clearShadow();
143
144         void drawImage(HTMLImageElement*, float x, float y);
145         void drawImage(HTMLImageElement*, float x, float y, float width, float height, ExceptionCode&);
146         void drawImage(HTMLImageElement*, float sx, float sy, float sw, float sh,
147             float dx, float dy, float dw, float dh, ExceptionCode&);
148         void drawImage(HTMLCanvasElement*, float x, float y);
149         void drawImage(HTMLCanvasElement*, float x, float y, float width, float height, ExceptionCode&);
150         void drawImage(HTMLCanvasElement*, float sx, float sy, float sw, float sh,
151             float dx, float dy, float dw, float dh, ExceptionCode&);
152
153         void drawImageFromRect(HTMLImageElement*, float sx, float sy, float sw, float sh,
154             float dx, float dy, float dw, float dh, const String& compositeOperation);
155
156         void setAlpha(float);
157
158         void setCompositeOperation(const String&);
159
160         PassRefPtr<CanvasGradient> createLinearGradient(float x0, float y0, float x1, float y1);
161         PassRefPtr<CanvasGradient> createRadialGradient(float x0, float y0, float r0, float x1, float y1, float r1);
162         PassRefPtr<CanvasPattern> createPattern(HTMLImageElement*, const String& repetitionType, ExceptionCode&);
163         PassRefPtr<CanvasPattern> createPattern(HTMLCanvasElement*, const String& repetitionType, ExceptionCode&);
164
165         void reset();
166         void detachCanvas() { m_canvas = 0; }
167
168     private:
169         struct State {
170             State();
171
172             RefPtr<CanvasStyle> m_strokeStyle;
173             RefPtr<CanvasStyle> m_fillStyle;
174             Path m_path;
175             float m_lineWidth;
176             LineCap m_lineCap;
177             LineJoin m_lineJoin;
178             float m_miterLimit;
179             FloatSize m_shadowOffset;
180             float m_shadowBlur;
181             String m_shadowColor;
182             float m_globalAlpha;
183             CompositeOperator m_globalComposite;
184             bool m_appliedStrokePattern;
185             bool m_appliedFillPattern;
186 #if __APPLE__
187             CGAffineTransform m_strokeStylePatternTransform;
188             CGAffineTransform m_fillStylePatternTransform;
189 #endif
190         };
191
192         State& state() { return m_stateStack.last(); }
193         const State& state() const { return m_stateStack.last(); }
194
195         void applyShadow();
196
197         void willDraw(const FloatRect&);
198
199         GraphicsContext* drawingContext() const;
200
201         void applyStrokePattern();
202         void applyFillPattern();
203
204         HTMLCanvasElement* m_canvas;
205         Vector<State, 1> m_stateStack;
206     };
207
208 } // namespace WebCore
209
210 #endif