Replace use of OwnArrayPtr<Foo> with std::unique_ptr<Foo[]> in WebCore
[WebKit-https.git] / Source / WebCore / html / canvas / CanvasRenderingContext2D.idl
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 enum CanvasWindingRule { "nonzero", "evenodd" };
27
28 interface CanvasRenderingContext2D : CanvasRenderingContext {
29
30     void save();
31     void restore();
32
33     void scale(float sx, float sy);
34     void rotate(float angle);
35     void translate(float tx, float ty);
36     void transform(float m11, float m12, float m21, float m22, float dx, float dy);
37     void setTransform(float m11, float m12, float m21, float m22, float dx, float dy);
38
39     attribute float globalAlpha;
40     [TreatNullAs=NullString] attribute DOMString globalCompositeOperation;
41
42     [RaisesException] CanvasGradient createLinearGradient(float x0, float y0, float x1, float y1);
43     [RaisesException] CanvasGradient createRadialGradient(float x0, float y0, float r0, float x1, float y1, float r1);
44
45     attribute float lineWidth;
46     [TreatNullAs=NullString] attribute DOMString lineCap;
47     [TreatNullAs=NullString] attribute DOMString lineJoin;
48     attribute float miterLimit;
49
50     attribute float shadowOffsetX;
51     attribute float shadowOffsetY;
52     attribute float shadowBlur;
53     [TreatNullAs=NullString] attribute DOMString shadowColor;
54
55     void setLineDash(sequence<float> dash);
56     sequence<float> getLineDash();
57     attribute float lineDashOffset;
58
59     [Custom] attribute Array webkitLineDash;
60     attribute float webkitLineDashOffset;
61
62     void clearRect(float x, float y, float width, float height);
63     void fillRect(float x, float y, float width, float height);
64
65     void beginPath();
66
67 #if defined(ENABLE_CANVAS_PATH) && ENABLE_CANVAS_PATH
68     attribute DOMPath currentPath;
69 #endif
70
71     // FIXME: These methods should be shared with CanvasRenderingContext2D in the CanvasPathMethods interface.
72     void closePath();
73     void moveTo(float x, float y);
74     void lineTo(float x, float y);
75     void quadraticCurveTo(float cpx, float cpy, float x, float y);
76     void bezierCurveTo(float cp1x, float cp1y, float cp2x, float cp2y, float x, float y);
77     [RaisesException] void arcTo(float x1, float y1, float x2, float y2, float radius);
78     void rect(float x, float y, float width, float height);
79     [RaisesException] void arc(float x, float y, float radius, float startAngle, float endAngle, [Default=Undefined] optional boolean anticlockwise);
80
81     void fill(optional CanvasWindingRule winding);
82     void stroke();
83     void clip(optional CanvasWindingRule winding);
84     boolean isPointInPath(float x, float y, optional CanvasWindingRule winding);
85     boolean isPointInStroke(float x, float y);
86
87     // text
88     attribute DOMString font;
89     attribute DOMString textAlign;
90     attribute DOMString textBaseline;
91
92     TextMetrics measureText(DOMString text);
93
94     // other
95
96     void setAlpha([Default=Undefined] optional float alpha);
97     void setCompositeOperation([Default=Undefined] optional DOMString compositeOperation);
98
99 #if !defined(LANGUAGE_CPP) || !LANGUAGE_CPP
100     void setLineWidth([Default=Undefined] optional float width);
101     void setLineCap([Default=Undefined] optional DOMString cap);
102     void setLineJoin([Default=Undefined] optional DOMString join);
103     void setMiterLimit([Default=Undefined] optional float limit);
104 #endif
105
106     void clearShadow();
107
108     void fillText(DOMString text, float x, float y, optional float maxWidth);
109     void strokeText(DOMString text, float x, float y, optional float maxWidth);
110
111     void setStrokeColor([StrictTypeChecking] DOMString color, optional float alpha);
112     void setStrokeColor(float grayLevel, optional float alpha);
113     void setStrokeColor(float r, float g, float b, float a);
114     void setStrokeColor(float c, float m, float y, float k, float a);
115
116     void setFillColor([StrictTypeChecking] DOMString color, optional float alpha);
117     void setFillColor(float grayLevel, optional float alpha);
118     void setFillColor(float r, float g, float b, float a);
119     void setFillColor(float c, float m, float y, float k, float a);
120
121     void strokeRect(float x, float y, float width, float height);
122
123     [RaisesException] void drawImage(HTMLImageElement? image, float x, float y);
124     [RaisesException] void drawImage(HTMLImageElement? image, float x, float y, float width, float height);
125     [RaisesException] void drawImage(HTMLImageElement? image, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh);
126     [RaisesException] void drawImage(HTMLCanvasElement? canvas, float x, float y);
127     [RaisesException] void drawImage(HTMLCanvasElement? canvas, float x, float y, float width, float height);
128     [RaisesException] void drawImage(HTMLCanvasElement? canvas, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh);
129 #if defined(ENABLE_VIDEO) && ENABLE_VIDEO
130     [RaisesException] void drawImage(HTMLVideoElement? video, float x, float y);
131     [RaisesException] void drawImage(HTMLVideoElement? video, float x, float y, float width, float height);
132     [RaisesException] void drawImage(HTMLVideoElement? video, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh);
133 #endif
134
135     void drawImageFromRect(HTMLImageElement image,
136                            optional float sx, optional float sy, optional float sw, optional float sh,
137                            optional float dx, optional float dy, optional float dw, optional float dh,
138                            optional DOMString compositeOperation);
139
140     void setShadow(float width, float height, float blur, [StrictTypeChecking] optional DOMString color, optional float alpha);
141     void setShadow(float width, float height, float blur, float grayLevel, optional float alpha);
142     void setShadow(float width, float height, float blur, float r, float g, float b, float a);
143     void setShadow(float width, float height, float blur, float c, float m, float y, float k, float a);
144
145     [RaisesException] void putImageData(ImageData? imagedata, float dx, float dy);
146     [RaisesException] void putImageData(ImageData? imagedata, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight);
147
148     [RaisesException] void webkitPutImageDataHD(ImageData? imagedata, float dx, float dy);
149     [RaisesException] void webkitPutImageDataHD(ImageData? imagedata, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight);
150
151     [RaisesException] CanvasPattern createPattern(HTMLCanvasElement? canvas, [TreatNullAs=NullString] DOMString repetitionType);
152     [RaisesException] CanvasPattern createPattern(HTMLImageElement? image, [TreatNullAs=NullString] DOMString repetitionType);
153     [RaisesException] ImageData createImageData(ImageData? imagedata);
154     [RaisesException] ImageData createImageData(float sw, float sh);
155
156     [Custom] attribute custom strokeStyle;
157     [Custom] attribute custom fillStyle;
158
159     // pixel manipulation
160     [RaisesException] ImageData getImageData(float sx, float sy, float sw, float sh);
161
162     [RaisesException] ImageData webkitGetImageDataHD(float sx, float sy, float sw, float sh);
163
164     readonly attribute float webkitBackingStorePixelRatio;
165
166     attribute boolean webkitImageSmoothingEnabled;
167 };
168