OLD | NEW |
1 /* | 1 /* |
2 * Copyright (C) 2006 Apple Computer, Inc. All rights reserved. | 2 * Copyright (C) 2006 Apple Computer, Inc. All rights reserved. |
3 * | 3 * |
4 * Redistribution and use in source and binary forms, with or without | 4 * Redistribution and use in source and binary forms, with or without |
5 * modification, are permitted provided that the following conditions | 5 * modification, are permitted provided that the following conditions |
6 * are met: | 6 * are met: |
7 * 1. Redistributions of source code must retain the above copyright | 7 * 1. Redistributions of source code must retain the above copyright |
8 * notice, this list of conditions and the following disclaimer. | 8 * notice, this list of conditions and the following disclaimer. |
9 * 2. Redistributions in binary form must reproduce the above copyright | 9 * 2. Redistributions in binary form must reproduce the above copyright |
10 * notice, this list of conditions and the following disclaimer in the | 10 * notice, this list of conditions and the following disclaimer in the |
11 * documentation and/or other materials provided with the distribution. | 11 * documentation and/or other materials provided with the distribution. |
12 * | 12 * |
13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY | 13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY |
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | 14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | 15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR | 16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR |
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | 17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | 18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | 19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY | 20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY |
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | 21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | 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. | 23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
24 */ | 24 */ |
25 | 25 |
26 // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-elemen
t.html#canvasrenderingcontext2d | 26 // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-elemen
t.html#canvasrenderingcontext2d |
27 | 27 |
28 // FIXME: float => double throughout | 28 // FIXME: float => double throughout |
29 // FIXME: Use union type in drawImage and createPattern once supported: | |
30 // http://crbug.com/372891 | |
31 typedef (HTMLImageElement or | 29 typedef (HTMLImageElement or |
32 HTMLVideoElement or | 30 HTMLVideoElement or |
33 HTMLCanvasElement // or | 31 HTMLCanvasElement or |
34 // CanvasRenderingContext2D or | 32 // CanvasRenderingContext2D or |
35 // ImageBitmap | 33 ImageBitmap) CanvasImageSource; |
36 ) CanvasImageSource; | |
37 | 34 |
38 enum CanvasFillRule { "nonzero", "evenodd" }; | 35 enum CanvasFillRule { "nonzero", "evenodd" }; |
39 | 36 |
40 [ | 37 [ |
41 TypeChecking=(Interface,Unrestricted), | 38 SetWrapperReferenceFrom=canvas, |
| 39 TypeChecking=Interface, |
42 WillBeGarbageCollected, | 40 WillBeGarbageCollected, |
43 ] interface CanvasRenderingContext2D { | 41 ] interface CanvasRenderingContext2D { |
44 // back-reference to the canvas | 42 // back-reference to the canvas |
45 readonly attribute HTMLCanvasElement canvas; | 43 readonly attribute HTMLCanvasElement canvas; |
46 | 44 |
47 // state | 45 // state |
48 void save(); // push state on state stack | 46 void save(); // push state on state stack |
49 void restore(); // pop state stack and restore state | 47 void restore(); // pop state stack and restore state |
50 | 48 |
51 // transformations (default transform is the identity matrix) | 49 // transformations (default transform is the identity matrix) |
52 [RuntimeEnabled=ExperimentalCanvasFeatures] attribute SVGMatrix currentTrans
form; | 50 [RuntimeEnabled=ExperimentalCanvasFeatures] attribute SVGMatrix currentTrans
form; |
53 void scale(unrestricted float x, unrestricted float y); | 51 void scale(unrestricted float x, unrestricted float y); |
54 void rotate(unrestricted float angle); | 52 void rotate(unrestricted float angle); |
55 void translate(unrestricted float x, unrestricted float y); | 53 void translate(unrestricted float x, unrestricted float y); |
56 void transform(unrestricted float a, unrestricted float b, unrestricted floa
t c, unrestricted float d, unrestricted float e, unrestricted float f); | 54 void transform(unrestricted float a, unrestricted float b, unrestricted floa
t c, unrestricted float d, unrestricted float e, unrestricted float f); |
57 void setTransform(unrestricted float a, unrestricted float b, unrestricted f
loat c, unrestricted float d, unrestricted float e, unrestricted float f); | 55 void setTransform(unrestricted float a, unrestricted float b, unrestricted f
loat c, unrestricted float d, unrestricted float e, unrestricted float f); |
58 void resetTransform(); | 56 void resetTransform(); |
59 | 57 |
60 // compositing | 58 // compositing |
61 attribute unrestricted float globalAlpha; // (default 1.0) | 59 attribute unrestricted float globalAlpha; // (default 1.0) |
62 [TreatNullAs=NullString] attribute DOMString globalCompositeOperation; // (d
efault source-over) | 60 [TreatNullAs=NullString] attribute DOMString globalCompositeOperation; // (d
efault source-over) |
| 61 [RuntimeEnabled=ExperimentalCanvasFeatures] attribute DOMString filter; // (
default 'none') |
63 | 62 |
64 // image smoothing | 63 // image smoothing |
65 [ImplementedAs=imageSmoothingEnabled, MeasureAs=PrefixedImageSmoothingEnable
d, DartSuppress] attribute boolean webkitImageSmoothingEnabled; | 64 [ImplementedAs=imageSmoothingEnabled, DeprecateAs=PrefixedImageSmoothingEnab
led] attribute boolean webkitImageSmoothingEnabled; |
66 [MeasureAs=UnprefixedImageSmoothingEnabled] attribute boolean imageSmoothing
Enabled; | 65 [MeasureAs=UnprefixedImageSmoothingEnabled] attribute boolean imageSmoothing
Enabled; |
67 | 66 |
68 // colors and styles (see also the CanvasDrawingStyles interface) | 67 // colors and styles (see also the CanvasDrawingStyles interface) |
69 // FIXME: Use union types when supported: http://crbug.com/372891 | 68 attribute (DOMString or CanvasGradient or CanvasPattern) strokeStyle; // (de
fault black) |
70 [Custom] attribute object strokeStyle; // (default black) | 69 attribute (DOMString or CanvasGradient or CanvasPattern) fillStyle; // (defa
ult black) |
71 [Custom] attribute object fillStyle; // (default black) | |
72 CanvasGradient createLinearGradient(float x0, float y0, float x1, float y1); | 70 CanvasGradient createLinearGradient(float x0, float y0, float x1, float y1); |
73 [RaisesException] CanvasGradient createRadialGradient(float x0, float y0, fl
oat r0, float x1, float y1, float r1); | 71 [RaisesException] CanvasGradient createRadialGradient(float x0, float y0, fl
oat r0, float x1, float y1, float r1); |
74 [RaisesException] CanvasPattern createPattern(HTMLCanvasElement canvas, DOMS
tring? repetitionType); | 72 [RaisesException] CanvasPattern createPattern(CanvasImageSource image, DOMSt
ring? repetitionType); |
75 [RaisesException] CanvasPattern createPattern(HTMLImageElement image, DOMStr
ing? repetitionType); | |
76 [RaisesException] CanvasPattern createPattern(HTMLVideoElement image, DOMStr
ing? repetitionType); | |
77 | 73 |
78 // shadows | 74 // shadows |
79 attribute unrestricted float shadowOffsetX; | 75 attribute unrestricted float shadowOffsetX; |
80 attribute unrestricted float shadowOffsetY; | 76 attribute unrestricted float shadowOffsetY; |
81 attribute unrestricted float shadowBlur; | 77 attribute unrestricted float shadowBlur; |
82 [TreatNullAs=NullString] attribute DOMString shadowColor; | 78 [TreatNullAs=NullString] attribute DOMString shadowColor; |
83 | 79 |
84 // rects | 80 // rects |
85 void clearRect(unrestricted float x, unrestricted float y, unrestricted floa
t width, unrestricted float height); | 81 void clearRect(unrestricted float x, unrestricted float y, unrestricted floa
t width, unrestricted float height); |
86 void fillRect(unrestricted float x, unrestricted float y, unrestricted float
width, unrestricted float height); | 82 void fillRect(unrestricted float x, unrestricted float y, unrestricted float
width, unrestricted float height); |
(...skipping 16 matching lines...) Expand all Loading... |
103 boolean isPointInPath(Path2D path, unrestricted float x, unrestricted float
y, optional CanvasFillRule winding); | 99 boolean isPointInPath(Path2D path, unrestricted float x, unrestricted float
y, optional CanvasFillRule winding); |
104 boolean isPointInStroke(unrestricted float x, unrestricted float y); | 100 boolean isPointInStroke(unrestricted float x, unrestricted float y); |
105 boolean isPointInStroke(Path2D path, unrestricted float x, unrestricted floa
t y); | 101 boolean isPointInStroke(Path2D path, unrestricted float x, unrestricted floa
t y); |
106 | 102 |
107 // text (see also the CanvasDrawingStyles interface) | 103 // text (see also the CanvasDrawingStyles interface) |
108 void fillText(DOMString text, unrestricted float x, unrestricted float y, op
tional unrestricted float maxWidth); | 104 void fillText(DOMString text, unrestricted float x, unrestricted float y, op
tional unrestricted float maxWidth); |
109 void strokeText(DOMString text, unrestricted float x, unrestricted float y,
optional unrestricted float maxWidth); | 105 void strokeText(DOMString text, unrestricted float x, unrestricted float y,
optional unrestricted float maxWidth); |
110 TextMetrics measureText(DOMString text); | 106 TextMetrics measureText(DOMString text); |
111 | 107 |
112 // drawing images | 108 // drawing images |
113 [RaisesException] void drawImage(HTMLImageElement image, unrestricted float
x, unrestricted float y); | 109 [RaisesException] void drawImage(CanvasImageSource image, unrestricted float
x, unrestricted float y); |
114 [RaisesException] void drawImage(HTMLImageElement image, unrestricted float
x, unrestricted float y, unrestricted float width, unrestricted float height); | 110 [RaisesException] void drawImage(CanvasImageSource image, unrestricted float
x, unrestricted float y, unrestricted float width, unrestricted float height); |
115 [RaisesException] void drawImage(HTMLImageElement image, unrestricted float
sx, unrestricted float sy, unrestricted float sw, unrestricted float sh, unrestr
icted float dx, unrestricted float dy, unrestricted float dw, unrestricted float
dh); | 111 [RaisesException] void drawImage(CanvasImageSource image, unrestricted float
sx, unrestricted float sy, unrestricted float sw, unrestricted float sh, unrest
ricted float dx, unrestricted float dy, unrestricted float dw, unrestricted floa
t dh); |
116 [RaisesException] void drawImage(HTMLCanvasElement canvas, unrestricted floa
t x, unrestricted float y); | |
117 [RaisesException] void drawImage(HTMLCanvasElement canvas, unrestricted floa
t x, unrestricted float y, unrestricted float width, unrestricted float height); | |
118 [RaisesException] void drawImage(HTMLCanvasElement canvas, unrestricted floa
t sx, unrestricted float sy, unrestricted float sw, unrestricted float sh, unres
tricted float dx, unrestricted float dy, unrestricted float dw, unrestricted flo
at dh); | |
119 [RaisesException] void drawImage(HTMLVideoElement video, unrestricted float
x, unrestricted float y); | |
120 [RaisesException] void drawImage(HTMLVideoElement video, unrestricted float
x, unrestricted float y, unrestricted float width, unrestricted float height); | |
121 [RaisesException] void drawImage(HTMLVideoElement video, unrestricted float
sx, unrestricted float sy, unrestricted float sw, unrestricted float sh, unrestr
icted float dx, unrestricted float dy, unrestricted float dw, unrestricted float
dh); | |
122 [RuntimeEnabled=ExperimentalCanvasFeatures, RaisesException] void drawImage(
ImageBitmap imageBitmap, unrestricted float x, unrestricted float y); | |
123 [RuntimeEnabled=ExperimentalCanvasFeatures, RaisesException] void drawImage(
ImageBitmap imageBitmap, unrestricted float x, unrestricted float y, unrestricte
d float width, unrestricted float height); | |
124 [RuntimeEnabled=ExperimentalCanvasFeatures, RaisesException] void drawImage(
ImageBitmap imageBitmap, unrestricted float sx, unrestricted float sy, unrestric
ted float sw, unrestricted float sh, unrestricted float dx, unrestricted float d
y, unrestricted float dw, unrestricted float dh); | |
125 | 112 |
126 // hit regions | 113 // hit regions |
127 [RuntimeEnabled=ExperimentalCanvasFeatures, RaisesException] void addHitRegi
on(optional HitRegionOptions options); | 114 [RuntimeEnabled=ExperimentalCanvasFeatures, RaisesException] void addHitRegi
on(optional HitRegionOptions options); |
128 [RuntimeEnabled=ExperimentalCanvasFeatures] void removeHitRegion(DOMString i
d); | 115 [RuntimeEnabled=ExperimentalCanvasFeatures] void removeHitRegion(DOMString i
d); |
129 [RuntimeEnabled=ExperimentalCanvasFeatures] void clearHitRegions(); | 116 [RuntimeEnabled=ExperimentalCanvasFeatures] void clearHitRegions(); |
130 | 117 |
131 // pixel manipulation | 118 // pixel manipulation |
132 [DartName=createImageDataFromImageData] ImageData createImageData(ImageData
imagedata); | 119 ImageData createImageData(ImageData imagedata); |
133 [RaisesException] ImageData createImageData(float sw, float sh); | 120 [RaisesException] ImageData createImageData(float sw, float sh); |
134 [RaisesException] ImageData getImageData(float sx, float sy, float sw, float
sh); | 121 [RaisesException] ImageData getImageData(float sx, float sy, float sw, float
sh); |
135 void putImageData(ImageData imagedata, float dx, float dy); | 122 void putImageData(ImageData imagedata, float dx, float dy); |
136 void putImageData(ImageData imagedata, float dx, float dy, float dirtyX, flo
at dirtyY, float dirtyWidth, float dirtyHeight); | 123 void putImageData(ImageData imagedata, float dx, float dy, float dirtyX, flo
at dirtyY, float dirtyWidth, float dirtyHeight); |
137 | 124 |
138 // Context state | 125 // Context state |
139 // Should be merged with WebGL counterpart in CanvasRenderingContext, once n
o-longer experimental | 126 // Should be merged with WebGL counterpart in CanvasRenderingContext, once n
o-longer experimental |
140 [RuntimeEnabled=ExperimentalCanvasFeatures] boolean isContextLost(); | 127 [RuntimeEnabled=ExperimentalCanvasFeatures] boolean isContextLost(); |
141 | 128 |
142 Canvas2DContextAttributes getContextAttributes(); | 129 Canvas2DContextAttributes getContextAttributes(); |
143 | 130 |
144 // FIXME: factor out to CanvasDrawingStyles | 131 // FIXME: factor out to CanvasDrawingStyles |
145 // line caps/joins | 132 // line caps/joins |
146 attribute unrestricted float lineWidth; // (default 1) | 133 attribute unrestricted float lineWidth; // (default 1) |
147 [TreatNullAs=NullString] attribute DOMString lineCap; // "butt", "round", "s
quare" (default "butt") | 134 [TreatNullAs=NullString] attribute DOMString lineCap; // "butt", "round", "s
quare" (default "butt") |
148 [TreatNullAs=NullString] attribute DOMString lineJoin; // "round", "bevel",
"miter" (default "miter") | 135 [TreatNullAs=NullString] attribute DOMString lineJoin; // "round", "bevel",
"miter" (default "miter") |
149 attribute unrestricted float miterLimit; // (default 10) | 136 attribute unrestricted float miterLimit; // (default 10) |
150 | 137 |
151 // dashed lines | 138 // dashed lines |
152 void setLineDash(sequence<unrestricted float> dash); | 139 void setLineDash(sequence<unrestricted float> dash); |
153 sequence<unrestricted float> getLineDash(); | 140 sequence<unrestricted float> getLineDash(); |
154 attribute unrestricted float lineDashOffset; | 141 attribute unrestricted float lineDashOffset; |
155 | 142 |
156 // text | 143 // text |
157 attribute DOMString font; // (default 10px sans-serif) | 144 attribute DOMString font; // (default 10px sans-serif) |
158 attribute DOMString textAlign; // "start", "end", "left", "right", "center"
(default: "start") | 145 attribute DOMString textAlign; // "start", "end", "left", "right", "center"
(default: "start") |
159 attribute DOMString textBaseline; // "top", "hanging", "middle", "alphabetic
", "ideographic", "bottom" (default: "alphabetic") | 146 attribute DOMString textBaseline; // "top", "hanging", "middle", "alphabetic
", "ideographic", "bottom" (default: "alphabetic") |
160 [RuntimeEnabled=ExperimentalCanvasFeatures] attribute DOMString direction; /
/ "inherit", "rtl", "ltr" (default: "inherit") | 147 [RuntimeEnabled=ExperimentalCanvasFeatures] attribute DOMString direction; /
/ "inherit", "rtl", "ltr" (default: "inherit") |
161 | 148 |
162 // Non-standard APIs. Candidates for deprecation | |
163 // https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D | |
164 [MeasureAs=CanvasRenderingContext2DSetAlpha] void setAlpha(unrestricted floa
t alpha); | |
165 [MeasureAs=CanvasRenderingContext2DSetCompositeOperation] void setCompositeO
peration(DOMString compositeOperation); | |
166 [MeasureAs=CanvasRenderingContext2DSetLineWidth] void setLineWidth(unrestric
ted float width); | |
167 [MeasureAs=CanvasRenderingContext2DSetLineCap] void setLineCap(DOMString cap
); | |
168 [MeasureAs=CanvasRenderingContext2DSetLineJoin] void setLineJoin(DOMString j
oin); | |
169 [MeasureAs=CanvasRenderingContext2DSetMiterLimit] void setMiterLimit(unrestr
icted float limit); | |
170 [MeasureAs=CanvasRenderingContext2DClearShadow] void clearShadow(); | |
171 [MeasureAs=CanvasRenderingContext2DSetStrokeColor] void setStrokeColor(DOMSt
ring color, optional unrestricted float alpha); | |
172 [MeasureAs=CanvasRenderingContext2DSetStrokeColor] void setStrokeColor(unres
tricted float grayLevel, optional unrestricted float alpha); | |
173 [MeasureAs=CanvasRenderingContext2DSetStrokeColor] void setStrokeColor(unres
tricted float r, unrestricted float g, unrestricted float b, unrestricted float
a); | |
174 [MeasureAs=CanvasRenderingContext2DSetStrokeColor] void setStrokeColor(unres
tricted float c, unrestricted float m, unrestricted float y, unrestricted float
k, unrestricted float a); | |
175 [MeasureAs=CanvasRenderingContext2DSetFillColor] void setFillColor(DOMString
color, optional unrestricted float alpha); | |
176 [MeasureAs=CanvasRenderingContext2DSetFillColor] void setFillColor(unrestric
ted float grayLevel, optional unrestricted float alpha); | |
177 [MeasureAs=CanvasRenderingContext2DSetFillColor] void setFillColor(unrestric
ted float r, unrestricted float g, unrestricted float b, unrestricted float a); | |
178 [MeasureAs=CanvasRenderingContext2DSetFillColor] void setFillColor(unrestric
ted float c, unrestricted float m, unrestricted float y, unrestricted float k, u
nrestricted float a); | |
179 [MeasureAs=CanvasRenderingContext2DDrawImageFromRect] void drawImageFromRect
( | |
180 HTMLImageElement? image, optional unrestricted float sx, optional unrest
ricted float sy, optional unrestricted float sw, optional unrestricted float sh, | |
181 optional unrestricted float dx, optional unrestricted float dy, optional
unrestricted float dw, optional unrestricted float dh, optional DOMString compo
siteOperation); | |
182 [MeasureAs=CanvasRenderingContext2DSetShadow] void setShadow(unrestricted fl
oat width, unrestricted float height, unrestricted float blur, optional DOMStrin
g color, optional unrestricted float alpha); | |
183 [MeasureAs=CanvasRenderingContext2DSetShadow] void setShadow(unrestricted fl
oat width, unrestricted float height, unrestricted float blur, unrestricted floa
t grayLevel, optional unrestricted float alpha); | |
184 [MeasureAs=CanvasRenderingContext2DSetShadow] void setShadow(unrestricted fl
oat width, unrestricted float height, unrestricted float blur, unrestricted floa
t r, unrestricted float g, unrestricted float b, unrestricted float a); | |
185 [MeasureAs=CanvasRenderingContext2DSetShadow] void setShadow(unrestricted fl
oat width, unrestricted float height, unrestricted float blur, unrestricted floa
t c, unrestricted float m, unrestricted float y, unrestricted float k, unrestric
ted float a); | |
186 }; | 149 }; |
187 | 150 |
188 CanvasRenderingContext2D implements CanvasPathMethods; | 151 CanvasRenderingContext2D implements CanvasPathMethods; |
OLD | NEW |