<rdar://problem/10912680> Pixel access canvas APIs do not operate at backing store...
[WebKit-https.git] / Source / WebCore / html / canvas / CanvasRenderingContext2D.h
1 /*
2  * Copyright (C) 2006, 2007, 2009 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 "AffineTransform.h"
30 #include "CanvasRenderingContext.h"
31 #include "Color.h"
32 #include "ColorSpace.h"
33 #include "DashArray.h"
34 #include "FloatSize.h"
35 #include "Font.h"
36 #include "GraphicsTypes.h"
37 #include "ImageBuffer.h"
38 #include "Path.h"
39 #include "PlatformString.h"
40 #include <wtf/Vector.h>
41
42 #if USE(ACCELERATED_COMPOSITING)
43 #include "GraphicsLayer.h"
44 #endif
45
46 namespace WebCore {
47
48 class CanvasGradient;
49 class CanvasPattern;
50 class CanvasStyle;
51 class FloatRect;
52 class GraphicsContext;
53 class HTMLCanvasElement;
54 class HTMLImageElement;
55 class HTMLVideoElement;
56 class ImageData;
57 class TextMetrics;
58
59 typedef int ExceptionCode;
60
61 class CanvasRenderingContext2D : public CanvasRenderingContext {
62 public:
63     static PassOwnPtr<CanvasRenderingContext2D> create(HTMLCanvasElement* canvas, bool usesCSSCompatibilityParseMode, bool usesDashboardCompatibilityMode)
64     {
65         return adoptPtr(new CanvasRenderingContext2D(canvas, usesCSSCompatibilityParseMode, usesDashboardCompatibilityMode));
66     }
67     virtual ~CanvasRenderingContext2D();
68
69     virtual bool is2d() const { return true; }
70     virtual bool isAccelerated() const;
71
72     CanvasStyle* strokeStyle() const;
73     void setStrokeStyle(PassRefPtr<CanvasStyle>);
74
75     CanvasStyle* fillStyle() const;
76     void setFillStyle(PassRefPtr<CanvasStyle>);
77
78     float lineWidth() const;
79     void setLineWidth(float);
80
81     String lineCap() const;
82     void setLineCap(const String&);
83
84     String lineJoin() const;
85     void setLineJoin(const String&);
86
87     float miterLimit() const;
88     void setMiterLimit(float);
89
90     const DashArray* webkitLineDash() const;
91     void setWebkitLineDash(const DashArray&);
92
93     float webkitLineDashOffset() const;
94     void setWebkitLineDashOffset(float);
95
96     float shadowOffsetX() const;
97     void setShadowOffsetX(float);
98
99     float shadowOffsetY() const;
100     void setShadowOffsetY(float);
101
102     float shadowBlur() const;
103     void setShadowBlur(float);
104
105     String shadowColor() const;
106     void setShadowColor(const String&);
107
108     float globalAlpha() const;
109     void setGlobalAlpha(float);
110
111     String globalCompositeOperation() const;
112     void setGlobalCompositeOperation(const String&);
113
114     void save();
115     void restore();
116     void setAllAttributesToDefault();
117
118     void scale(float sx, float sy);
119     void rotate(float angleInRadians);
120     void translate(float tx, float ty);
121     void transform(float m11, float m12, float m21, float m22, float dx, float dy);
122     void setTransform(float m11, float m12, float m21, float m22, float dx, float dy);
123
124     void setStrokeColor(const String& color);
125     void setStrokeColor(float grayLevel);
126     void setStrokeColor(const String& color, float alpha);
127     void setStrokeColor(float grayLevel, float alpha);
128     void setStrokeColor(float r, float g, float b, float a);
129     void setStrokeColor(float c, float m, float y, float k, float a);
130
131     void setFillColor(const String& color);
132     void setFillColor(float grayLevel);
133     void setFillColor(const String& color, float alpha);
134     void setFillColor(float grayLevel, float alpha);
135     void setFillColor(float r, float g, float b, float a);
136     void setFillColor(float c, float m, float y, float k, float a);
137
138     void beginPath();
139     void closePath();
140
141     void moveTo(float x, float y);
142     void lineTo(float x, float y);
143     void quadraticCurveTo(float cpx, float cpy, float x, float y);
144     void bezierCurveTo(float cp1x, float cp1y, float cp2x, float cp2y, float x, float y);
145     void arcTo(float x0, float y0, float x1, float y1, float radius, ExceptionCode&);
146     void arc(float x, float y, float r, float sa, float ea, bool clockwise, ExceptionCode&);
147     void rect(float x, float y, float width, float height);
148
149     void fill();
150     void stroke();
151     void clip();
152
153     bool isPointInPath(const float x, const float y);
154
155     void clearRect(float x, float y, float width, float height);
156     void fillRect(float x, float y, float width, float height);
157     void strokeRect(float x, float y, float width, float height);
158     void strokeRect(float x, float y, float width, float height, float lineWidth);
159
160     void setShadow(float width, float height, float blur);
161     void setShadow(float width, float height, float blur, const String& color);
162     void setShadow(float width, float height, float blur, float grayLevel);
163     void setShadow(float width, float height, float blur, const String& color, float alpha);
164     void setShadow(float width, float height, float blur, float grayLevel, float alpha);
165     void setShadow(float width, float height, float blur, float r, float g, float b, float a);
166     void setShadow(float width, float height, float blur, float c, float m, float y, float k, float a);
167
168     void clearShadow();
169
170     void drawImage(HTMLImageElement*, float x, float y, ExceptionCode&);
171     void drawImage(HTMLImageElement*, float x, float y, float width, float height, ExceptionCode&);
172     void drawImage(HTMLImageElement*, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh, ExceptionCode&);
173     void drawImage(HTMLImageElement*, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
174     void drawImage(HTMLCanvasElement*, float x, float y, ExceptionCode&);
175     void drawImage(HTMLCanvasElement*, float x, float y, float width, float height, ExceptionCode&);
176     void drawImage(HTMLCanvasElement*, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh, ExceptionCode&);
177     void drawImage(HTMLCanvasElement*, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
178     void drawImage(HTMLImageElement*, const FloatRect& srcRect, const FloatRect& dstRect, const CompositeOperator&, ExceptionCode&);
179 #if ENABLE(VIDEO)
180     void drawImage(HTMLVideoElement*, float x, float y, ExceptionCode&);
181     void drawImage(HTMLVideoElement*, float x, float y, float width, float height, ExceptionCode&);
182     void drawImage(HTMLVideoElement*, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh, ExceptionCode&);
183     void drawImage(HTMLVideoElement*, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
184 #endif
185
186     void drawImageFromRect(HTMLImageElement*, float sx = 0, float sy = 0, float sw = 0, float sh = 0,
187                            float dx = 0, float dy = 0, float dw = 0, float dh = 0, const String& compositeOperation = emptyString());
188
189     void setAlpha(float);
190
191     void setCompositeOperation(const String&);
192
193     PassRefPtr<CanvasGradient> createLinearGradient(float x0, float y0, float x1, float y1, ExceptionCode&);
194     PassRefPtr<CanvasGradient> createRadialGradient(float x0, float y0, float r0, float x1, float y1, float r1, ExceptionCode&);
195     PassRefPtr<CanvasPattern> createPattern(HTMLImageElement*, const String& repetitionType, ExceptionCode&);
196     PassRefPtr<CanvasPattern> createPattern(HTMLCanvasElement*, const String& repetitionType, ExceptionCode&);
197
198     PassRefPtr<ImageData> createImageData(PassRefPtr<ImageData>, ExceptionCode&) const;
199     PassRefPtr<ImageData> createImageData(float width, float height, ExceptionCode&) const;
200     PassRefPtr<ImageData> getImageData(float sx, float sy, float sw, float sh, ExceptionCode&) const;
201     PassRefPtr<ImageData> webkitGetImageDataHD(float sx, float sy, float sw, float sh, ExceptionCode&) const;
202     void putImageData(ImageData*, float dx, float dy, ExceptionCode&);
203     void putImageData(ImageData*, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight, ExceptionCode&);
204     void webkitPutImageDataHD(ImageData*, float dx, float dy, ExceptionCode&);
205     void webkitPutImageDataHD(ImageData*, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight, ExceptionCode&);
206
207     float webkitBackingStorePixelRatio() const { return canvas()->deviceScaleFactor(); }
208
209     void reset();
210
211     String font() const;
212     void setFont(const String&);
213
214     String textAlign() const;
215     void setTextAlign(const String&);
216
217     String textBaseline() const;
218     void setTextBaseline(const String&);
219
220     void fillText(const String& text, float x, float y);
221     void fillText(const String& text, float x, float y, float maxWidth);
222     void strokeText(const String& text, float x, float y);
223     void strokeText(const String& text, float x, float y, float maxWidth);
224     PassRefPtr<TextMetrics> measureText(const String& text);
225
226     LineCap getLineCap() const { return state().m_lineCap; }
227     LineJoin getLineJoin() const { return state().m_lineJoin; }
228
229 #if ENABLE(ACCELERATED_2D_CANVAS) && USE(ACCELERATED_COMPOSITING)
230     virtual PlatformLayer* platformLayer() const;
231 #endif
232
233 private:
234     struct State : FontSelectorClient {
235         State();
236         virtual ~State();
237
238         State(const State&);
239         State& operator=(const State&);
240
241         virtual void fontsNeedUpdate(FontSelector*);
242
243         String m_unparsedStrokeColor;
244         String m_unparsedFillColor;
245         RefPtr<CanvasStyle> m_strokeStyle;
246         RefPtr<CanvasStyle> m_fillStyle;
247         float m_lineWidth;
248         LineCap m_lineCap;
249         LineJoin m_lineJoin;
250         float m_miterLimit;
251         FloatSize m_shadowOffset;
252         float m_shadowBlur;
253         RGBA32 m_shadowColor;
254         float m_globalAlpha;
255         CompositeOperator m_globalComposite;
256         AffineTransform m_transform;
257         bool m_invertibleCTM;
258         DashArray m_lineDash;
259         float m_lineDashOffset;
260
261         // Text state.
262         TextAlign m_textAlign;
263         TextBaseline m_textBaseline;
264
265         String m_unparsedFont;
266         Font m_font;
267         bool m_realizedFont;
268     };
269
270     enum CanvasDidDrawOption {
271         CanvasDidDrawApplyNone = 0,
272         CanvasDidDrawApplyTransform = 1,
273         CanvasDidDrawApplyShadow = 1 << 1,
274         CanvasDidDrawApplyClip = 1 << 2,
275         CanvasDidDrawApplyAll = 0xffffffff
276     };
277
278     CanvasRenderingContext2D(HTMLCanvasElement*, bool usesCSSCompatibilityParseMode, bool usesDashboardCompatibilityMode);
279
280     Path m_path;
281
282     State& state() { return m_stateStack.last(); }
283     const State& state() const { return m_stateStack.last(); }
284
285     void applyShadow();
286     bool shouldDrawShadows() const;
287
288     void didDraw(const FloatRect&, unsigned options = CanvasDidDrawApplyAll);
289     void didDrawEntireCanvas();
290
291     GraphicsContext* drawingContext() const;
292
293     void unwindStateStack();
294
295     void applyStrokePattern();
296     void applyFillPattern();
297
298     void drawTextInternal(const String& text, float x, float y, bool fill, float maxWidth = 0, bool useMaxWidth = false);
299
300     const Font& accessFont();
301
302 #if ENABLE(DASHBOARD_SUPPORT)
303     void clearPathForDashboardBackwardCompatibilityMode();
304 #endif
305
306     void clearCanvas();
307     Path transformAreaToDevice(const Path&) const;
308     Path transformAreaToDevice(const FloatRect&) const;
309     bool rectContainsCanvas(const FloatRect&) const;
310
311     template<class T> IntRect calculateCompositingBufferRect(const T&, IntSize*);
312     PassOwnPtr<ImageBuffer> createCompositingBuffer(const IntRect&);
313     void compositeBuffer(ImageBuffer*, const IntRect&, CompositeOperator);
314
315     template<class T> void fullCanvasCompositedFill(const T&);
316     template<class T> void fullCanvasCompositedDrawImage(T*, ColorSpace, const FloatRect&, const FloatRect&, CompositeOperator);
317
318     void prepareGradientForDashboard(CanvasGradient* gradient) const;
319
320     PassRefPtr<ImageData> getImageData(ImageBuffer::CoordinateSystem, float sx, float sy, float sw, float sh, ExceptionCode&) const;
321     void putImageData(ImageData*, ImageBuffer::CoordinateSystem, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight, ExceptionCode&);
322
323     Vector<State, 1> m_stateStack;
324     bool m_usesCSSCompatibilityParseMode;
325 #if ENABLE(DASHBOARD_SUPPORT)
326     bool m_usesDashboardCompatibilityMode;
327 #endif
328 };
329
330 } // namespace WebCore
331
332 #endif