Reuse buffer allocation if canvas size does not change
[WebKit-https.git] / Source / WebCore / html / HTMLCanvasElement.h
1 /*
2  * Copyright (C) 2004, 2006, 2009, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Alp Toker <alp@atoker.com>
4  * Copyright (C) 2010 Torch Mobile (Beijing) Co. Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #ifndef HTMLCanvasElement_h
29 #define HTMLCanvasElement_h
30
31 #include "FloatRect.h"
32 #include "HTMLElement.h"
33 #include "IntSize.h"
34
35 #if PLATFORM(CHROMIUM) || PLATFORM(QT)
36 #define DefaultInterpolationQuality InterpolationMedium
37 #elif USE(CG)
38 #define DefaultInterpolationQuality InterpolationLow
39 #else
40 #define DefaultInterpolationQuality InterpolationDefault
41 #endif
42
43 namespace WebCore {
44
45 class CanvasContextAttributes;
46 class CanvasRenderingContext;
47 class GraphicsContext;
48 class GraphicsContextStateSaver;
49 class HTMLCanvasElement;
50 class Image;
51 class ImageData;
52 class ImageBuffer;
53 class IntSize;
54
55 class CanvasObserver {
56 public:
57     virtual ~CanvasObserver() { }
58
59     virtual void canvasChanged(HTMLCanvasElement*, const FloatRect& changedRect) = 0;
60     virtual void canvasResized(HTMLCanvasElement*) = 0;
61     virtual void canvasDestroyed(HTMLCanvasElement*) = 0;
62 };
63
64 class HTMLCanvasElement : public HTMLElement {
65 public:
66     static PassRefPtr<HTMLCanvasElement> create(Document*);
67     static PassRefPtr<HTMLCanvasElement> create(const QualifiedName&, Document*);
68     virtual ~HTMLCanvasElement();
69
70     void addObserver(CanvasObserver*);
71     void removeObserver(CanvasObserver*);
72
73     // Attributes and functions exposed to script
74     int width() const { return size().width(); }
75     int height() const { return size().height(); }
76
77     const IntSize& size() const { return m_size; }
78
79     void setWidth(int);
80     void setHeight(int);
81
82     void setSize(const IntSize& newSize)
83     { 
84         if (newSize == size())
85             return;
86         m_ignoreReset = true; 
87         setWidth(newSize.width());
88         setHeight(newSize.height());
89         m_ignoreReset = false;
90         reset();
91     }
92
93     CanvasRenderingContext* getContext(const String&, CanvasContextAttributes* attributes = 0);
94
95     static String toEncodingMimeType(const String& mimeType);
96     String toDataURL(const String& mimeType, const double* quality, ExceptionCode&);
97     String toDataURL(const String& mimeType, ExceptionCode& ec) { return toDataURL(mimeType, 0, ec); }
98
99     // Used for rendering
100     void didDraw(const FloatRect&);
101
102     void paint(GraphicsContext*, const LayoutRect&, bool useLowQualityScale = false);
103
104     GraphicsContext* drawingContext() const;
105     GraphicsContext* existingDrawingContext() const;
106
107     CanvasRenderingContext* renderingContext() const { return m_context.get(); }
108
109     ImageBuffer* buffer() const;
110     Image* copiedImage() const;
111     void clearCopiedImage();
112     PassRefPtr<ImageData> getImageData();
113     void makePresentationCopy();
114     void clearPresentationCopy();
115
116     FloatRect convertLogicalToDevice(const FloatRect&) const;
117     FloatSize convertLogicalToDevice(const FloatSize&) const;
118
119     FloatSize convertDeviceToLogical(const FloatSize&) const;
120
121     SecurityOrigin* securityOrigin() const;
122     void setOriginTainted() { m_originClean = false; }
123     bool originClean() const { return m_originClean; }
124
125     CSSStyleSelector* styleSelector();
126
127     AffineTransform baseTransform() const;
128
129 #if ENABLE(WEBGL)    
130     bool is3D() const;
131 #endif
132
133     void makeRenderingResultsAvailable();
134     bool hasCreatedImageBuffer() const { return m_hasCreatedImageBuffer; }
135
136     bool shouldAccelerate(const IntSize&) const;
137
138 private:
139     HTMLCanvasElement(const QualifiedName&, Document*);
140
141     virtual void parseAttribute(Attribute*) OVERRIDE;
142     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
143
144     void reset();
145
146     void createImageBuffer() const;
147     void clearImageBuffer() const;
148
149     void setSurfaceSize(const IntSize&);
150
151     bool shouldDefer() const;
152
153     bool paintsIntoCanvasBuffer() const;
154
155     HashSet<CanvasObserver*> m_observers;
156
157     IntSize m_size;
158
159     OwnPtr<CanvasRenderingContext> m_context;
160
161     bool m_rendererIsCanvas;
162
163     bool m_ignoreReset;
164     FloatRect m_dirtyRect;
165
166     float m_deviceScaleFactor;
167     bool m_originClean;
168
169     // m_createdImageBuffer means we tried to malloc the buffer.  We didn't necessarily get it.
170     mutable bool m_hasCreatedImageBuffer;
171     mutable bool m_didClearImageBuffer;
172     mutable OwnPtr<ImageBuffer> m_imageBuffer;
173     mutable OwnPtr<GraphicsContextStateSaver> m_contextStateSaver;
174     
175     mutable RefPtr<Image> m_presentedImage;
176     mutable RefPtr<Image> m_copiedImage; // FIXME: This is temporary for platforms that have to copy the image buffer to render (and for CSSCanvasValue).
177 };
178
179 } //namespace
180
181 #endif