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.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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.
28 #ifndef HTMLCanvasElement_h
29 #define HTMLCanvasElement_h
31 #include "FloatRect.h"
32 #include "HTMLElement.h"
35 #if PLATFORM(CHROMIUM) || PLATFORM(QT)
36 #define DefaultInterpolationQuality InterpolationMedium
38 #define DefaultInterpolationQuality InterpolationLow
40 #define DefaultInterpolationQuality InterpolationDefault
45 class CanvasContextAttributes;
46 class CanvasRenderingContext;
47 class GraphicsContext;
48 class HTMLCanvasElement;
54 class CanvasObserver {
56 virtual ~CanvasObserver() { }
58 virtual void canvasChanged(HTMLCanvasElement*, const FloatRect& changedRect) = 0;
59 virtual void canvasResized(HTMLCanvasElement*) = 0;
60 virtual void canvasDestroyed(HTMLCanvasElement*) = 0;
63 class HTMLCanvasElement : public HTMLElement {
65 static PassRefPtr<HTMLCanvasElement> create(Document*);
66 static PassRefPtr<HTMLCanvasElement> create(const QualifiedName&, Document*);
67 virtual ~HTMLCanvasElement();
69 void addObserver(CanvasObserver*);
70 void removeObserver(CanvasObserver*);
72 // Attributes and functions exposed to script
73 int width() const { return size().width(); }
74 int height() const { return size().height(); }
76 const IntSize& size() const { return m_size; }
81 void setSize(const IntSize& newSize)
83 if (newSize == size())
86 setWidth(newSize.width());
87 setHeight(newSize.height());
88 m_ignoreReset = false;
92 CanvasRenderingContext* getContext(const String&, CanvasContextAttributes* attributes = 0);
94 String toDataURL(const String& mimeType, const double* quality, ExceptionCode&);
95 String toDataURL(const String& mimeType, ExceptionCode& ec) { return toDataURL(mimeType, 0, ec); }
98 void didDraw(const FloatRect&);
100 void paint(GraphicsContext*, const LayoutRect&, bool useLowQualityScale = false);
102 GraphicsContext* drawingContext() const;
103 GraphicsContext* existingDrawingContext() const;
105 CanvasRenderingContext* renderingContext() const { return m_context.get(); }
107 ImageBuffer* buffer() const;
108 Image* copiedImage() const;
109 void clearCopiedImage();
110 PassRefPtr<ImageData> getImageData();
111 void makePresentationCopy();
112 void clearPresentationCopy();
114 FloatRect convertLogicalToDevice(const FloatRect&) const;
115 FloatSize convertLogicalToDevice(const FloatSize&) const;
117 SecurityOrigin* securityOrigin() const;
118 void setOriginTainted() { m_originClean = false; }
119 bool originClean() const { return m_originClean; }
121 CSSStyleSelector* styleSelector();
123 AffineTransform baseTransform() const;
129 void makeRenderingResultsAvailable();
130 bool hasCreatedImageBuffer() const { return m_hasCreatedImageBuffer; }
132 bool shouldAccelerate(const IntSize&) const;
135 HTMLCanvasElement(const QualifiedName&, Document*);
137 virtual void parseMappedAttribute(Attribute*);
138 virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
142 void createImageBuffer() const;
144 void setSurfaceSize(const IntSize&);
146 HashSet<CanvasObserver*> m_observers;
150 OwnPtr<CanvasRenderingContext> m_context;
152 bool m_rendererIsCanvas;
155 FloatRect m_dirtyRect;
157 float m_deviceScaleFactor;
160 // m_createdImageBuffer means we tried to malloc the buffer. We didn't necessarily get it.
161 mutable bool m_hasCreatedImageBuffer;
162 mutable OwnPtr<ImageBuffer> m_imageBuffer;
164 mutable RefPtr<Image> m_presentedImage;
165 mutable RefPtr<Image> m_copiedImage; // FIXME: This is temporary for platforms that have to copy the image buffer to render (and for CSSCanvasValue).