d0d9a9acb6d23a92346501edd2f59a2fa35c1e80
[WebKit-https.git] / Source / WebCore / html / canvas / WebGLRenderingContextBase.h
1 /*
2  * Copyright (C) 2015 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 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 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 WebGLRenderingContextBase_h
27 #define WebGLRenderingContextBase_h
28
29 #include "ActiveDOMObject.h"
30 #include "CanvasRenderingContext.h"
31 #include "GraphicsContext3D.h"
32 #include "ImageBuffer.h"
33 #include "Timer.h"
34 #include "WebGLGetInfo.h"
35 #include "WebGLObject.h"
36 #include <memory>
37 #include <runtime/Float32Array.h>
38 #include <runtime/Int32Array.h>
39 #include <wtf/text/WTFString.h>
40
41 namespace WebCore {
42
43 class ANGLEInstancedArrays;
44 class EXTBlendMinMax;
45 class EXTTextureFilterAnisotropic;
46 class EXTShaderTextureLOD;
47 class EXTsRGB;
48 class EXTFragDepth;
49 class HTMLImageElement;
50 class HTMLVideoElement;
51 class ImageBuffer;
52 class ImageData;
53 class IntSize;
54 class OESStandardDerivatives;
55 class OESTextureFloat;
56 class OESTextureFloatLinear;
57 class OESTextureHalfFloat;
58 class OESTextureHalfFloatLinear;
59 class OESVertexArrayObject;
60 class OESElementIndexUint;
61 class WebGLActiveInfo;
62 class WebGLBuffer;
63 class WebGLContextGroup;
64 class WebGLContextObject;
65 class WebGLCompressedTextureATC;
66 class WebGLCompressedTexturePVRTC;
67 class WebGLCompressedTextureS3TC;
68 class WebGLContextAttributes;
69 class WebGLDebugRendererInfo;
70 class WebGLDebugShaders;
71 class WebGLDepthTexture;
72 class WebGLDrawBuffers;
73 class WebGLExtension;
74 class WebGLFramebuffer;
75 class WebGLLoseContext;
76 class WebGLObject;
77 class WebGLProgram;
78 class WebGLRenderbuffer;
79 class WebGLShader;
80 class WebGLSharedObject;
81 class WebGLShaderPrecisionFormat;
82 class WebGLTexture;
83 class WebGLUniformLocation;
84 class WebGLVertexArrayObjectOES;
85
86 typedef int ExceptionCode;
87
88 inline void clip1D(GC3Dint start, GC3Dsizei range, GC3Dsizei sourceRange, GC3Dint* clippedStart, GC3Dsizei* clippedRange)
89 {
90     ASSERT(clippedStart && clippedRange);
91     if (start < 0) {
92         range += start;
93         start = 0;
94     }
95     GC3Dint end = start + range;
96     if (end > sourceRange)
97         range -= end - sourceRange;
98     *clippedStart = start;
99     *clippedRange = range;
100 }
101
102 // Returns false if no clipping is necessary, i.e., x, y, width, height stay the same.
103 inline bool clip2D(GC3Dint x, GC3Dint y, GC3Dsizei width, GC3Dsizei height,
104     GC3Dsizei sourceWidth, GC3Dsizei sourceHeight,
105     GC3Dint* clippedX, GC3Dint* clippedY, GC3Dsizei* clippedWidth, GC3Dsizei*clippedHeight)
106 {
107     ASSERT(clippedX && clippedY && clippedWidth && clippedHeight);
108     clip1D(x, width, sourceWidth, clippedX, clippedWidth);
109     clip1D(y, height, sourceHeight, clippedY, clippedHeight);
110     return (*clippedX != x || *clippedY != y || *clippedWidth != width || *clippedHeight != height);
111 }
112
113 class WebGLRenderingContextBase : public CanvasRenderingContext, public ActiveDOMObject {
114 public:
115     static std::unique_ptr<WebGLRenderingContextBase> create(HTMLCanvasElement*, WebGLContextAttributes*, const String&);
116     virtual ~WebGLRenderingContextBase();
117
118 #if PLATFORM(WIN)
119     // FIXME: Implement accelerated 3d canvas on Windows.
120     virtual bool isAccelerated() const override { return false; }
121 #else
122     virtual bool isAccelerated() const override { return true; }
123 #endif
124
125     int drawingBufferWidth() const;
126     int drawingBufferHeight() const;
127
128     void activeTexture(GC3Denum texture, ExceptionCode&);
129     void attachShader(WebGLProgram*, WebGLShader*, ExceptionCode&);
130     void bindAttribLocation(WebGLProgram*, GC3Duint index, const String& name, ExceptionCode&);
131     void bindBuffer(GC3Denum target, WebGLBuffer*, ExceptionCode&);
132     void bindFramebuffer(GC3Denum target, WebGLFramebuffer*, ExceptionCode&);
133     void bindRenderbuffer(GC3Denum target, WebGLRenderbuffer*, ExceptionCode&);
134     void bindTexture(GC3Denum target, WebGLTexture*, ExceptionCode&);
135     void blendColor(GC3Dfloat red, GC3Dfloat green, GC3Dfloat blue, GC3Dfloat alpha);
136     void blendEquation(GC3Denum mode);
137     void blendEquationSeparate(GC3Denum modeRGB, GC3Denum modeAlpha);
138     void blendFunc(GC3Denum sfactor, GC3Denum dfactor);
139     void blendFuncSeparate(GC3Denum srcRGB, GC3Denum dstRGB, GC3Denum srcAlpha, GC3Denum dstAlpha);
140
141     void bufferData(GC3Denum target, long long size, GC3Denum usage, ExceptionCode&);
142     void bufferData(GC3Denum target, ArrayBuffer* data, GC3Denum usage, ExceptionCode&);
143     void bufferData(GC3Denum target, ArrayBufferView* data, GC3Denum usage, ExceptionCode&);
144     void bufferSubData(GC3Denum target, long long offset, ArrayBuffer* data, ExceptionCode&);
145     void bufferSubData(GC3Denum target, long long offset, ArrayBufferView* data, ExceptionCode&);
146
147     GC3Denum checkFramebufferStatus(GC3Denum target);
148     void clear(GC3Dbitfield mask);
149     void clearColor(GC3Dfloat red, GC3Dfloat green, GC3Dfloat blue, GC3Dfloat alpha);
150     void clearDepth(GC3Dfloat);
151     void clearStencil(GC3Dint);
152     void colorMask(GC3Dboolean red, GC3Dboolean green, GC3Dboolean blue, GC3Dboolean alpha);
153     void compileShader(WebGLShader*, ExceptionCode&);
154
155     void compressedTexImage2D(GC3Denum target, GC3Dint level, GC3Denum internalformat, GC3Dsizei width,
156                               GC3Dsizei height, GC3Dint border, ArrayBufferView* data);
157     void compressedTexSubImage2D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset,
158                                  GC3Dsizei width, GC3Dsizei height, GC3Denum format, ArrayBufferView* data);
159
160     virtual void copyTexImage2D(GC3Denum target, GC3Dint level, GC3Denum internalformat, GC3Dint x, GC3Dint y, GC3Dsizei width, GC3Dsizei height, GC3Dint border) = 0;
161     void copyTexSubImage2D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset, GC3Dint x, GC3Dint y, GC3Dsizei width, GC3Dsizei height);
162
163     PassRefPtr<WebGLBuffer> createBuffer();
164     PassRefPtr<WebGLFramebuffer> createFramebuffer();
165     PassRefPtr<WebGLProgram> createProgram();
166     PassRefPtr<WebGLRenderbuffer> createRenderbuffer();
167     PassRefPtr<WebGLShader> createShader(GC3Denum type, ExceptionCode&);
168     PassRefPtr<WebGLTexture> createTexture();
169
170     void cullFace(GC3Denum mode);
171
172     void deleteBuffer(WebGLBuffer*);
173     void deleteFramebuffer(WebGLFramebuffer*);
174     void deleteProgram(WebGLProgram*);
175     void deleteRenderbuffer(WebGLRenderbuffer*);
176     void deleteShader(WebGLShader*);
177     void deleteTexture(WebGLTexture*);
178
179     void depthFunc(GC3Denum);
180     void depthMask(GC3Dboolean);
181     void depthRange(GC3Dfloat zNear, GC3Dfloat zFar);
182     void detachShader(WebGLProgram*, WebGLShader*, ExceptionCode&);
183     void disable(GC3Denum cap);
184     void disableVertexAttribArray(GC3Duint index, ExceptionCode&);
185     void drawArrays(GC3Denum mode, GC3Dint first, GC3Dsizei count, ExceptionCode&);
186     void drawElements(GC3Denum mode, GC3Dsizei count, GC3Denum type, long long offset, ExceptionCode&);
187
188     void enable(GC3Denum cap);
189     void enableVertexAttribArray(GC3Duint index, ExceptionCode&);
190     void finish();
191     void flush();
192     void framebufferRenderbuffer(GC3Denum target, GC3Denum attachment, GC3Denum renderbuffertarget, WebGLRenderbuffer*, ExceptionCode&);
193     void framebufferTexture2D(GC3Denum target, GC3Denum attachment, GC3Denum textarget, WebGLTexture*, GC3Dint level, ExceptionCode&);
194     void frontFace(GC3Denum mode);
195     void generateMipmap(GC3Denum target);
196
197     PassRefPtr<WebGLActiveInfo> getActiveAttrib(WebGLProgram*, GC3Duint index, ExceptionCode&);
198     PassRefPtr<WebGLActiveInfo> getActiveUniform(WebGLProgram*, GC3Duint index, ExceptionCode&);
199     bool getAttachedShaders(WebGLProgram*, Vector<RefPtr<WebGLShader>>&, ExceptionCode&);
200     GC3Dint getAttribLocation(WebGLProgram*, const String& name);
201     WebGLGetInfo getBufferParameter(GC3Denum target, GC3Denum pname, ExceptionCode&);
202     PassRefPtr<WebGLContextAttributes> getContextAttributes();
203     GC3Denum getError();
204     virtual WebGLExtension* getExtension(const String& name) = 0;
205     virtual WebGLGetInfo getFramebufferAttachmentParameter(GC3Denum target, GC3Denum attachment, GC3Denum pname, ExceptionCode&) = 0;
206     virtual WebGLGetInfo getParameter(GC3Denum pname, ExceptionCode&) = 0;
207     WebGLGetInfo getProgramParameter(WebGLProgram*, GC3Denum pname, ExceptionCode&);
208     String getProgramInfoLog(WebGLProgram*, ExceptionCode&);
209     WebGLGetInfo getRenderbufferParameter(GC3Denum target, GC3Denum pname, ExceptionCode&);
210     WebGLGetInfo getShaderParameter(WebGLShader*, GC3Denum pname, ExceptionCode&);
211     String getShaderInfoLog(WebGLShader*, ExceptionCode&);
212     PassRefPtr<WebGLShaderPrecisionFormat> getShaderPrecisionFormat(GC3Denum shaderType, GC3Denum precisionType, ExceptionCode&);
213     String getShaderSource(WebGLShader*, ExceptionCode&);
214     virtual Vector<String> getSupportedExtensions() = 0;
215     WebGLGetInfo getTexParameter(GC3Denum target, GC3Denum pname, ExceptionCode&);
216     WebGLGetInfo getUniform(WebGLProgram*, const WebGLUniformLocation*, ExceptionCode&);
217     PassRefPtr<WebGLUniformLocation> getUniformLocation(WebGLProgram*, const String&, ExceptionCode&);
218     WebGLGetInfo getVertexAttrib(GC3Duint index, GC3Denum pname, ExceptionCode&);
219     long long getVertexAttribOffset(GC3Duint index, GC3Denum pname);
220
221     virtual void hint(GC3Denum target, GC3Denum mode) = 0;
222     GC3Dboolean isBuffer(WebGLBuffer*);
223     bool isContextLost() const;
224     GC3Dboolean isEnabled(GC3Denum cap);
225     GC3Dboolean isFramebuffer(WebGLFramebuffer*);
226     GC3Dboolean isProgram(WebGLProgram*);
227     GC3Dboolean isRenderbuffer(WebGLRenderbuffer*);
228     GC3Dboolean isShader(WebGLShader*);
229     GC3Dboolean isTexture(WebGLTexture*);
230
231     void lineWidth(GC3Dfloat);
232     void linkProgram(WebGLProgram*, ExceptionCode&);
233     void pixelStorei(GC3Denum pname, GC3Dint param);
234     void polygonOffset(GC3Dfloat factor, GC3Dfloat units);
235     void readPixels(GC3Dint x, GC3Dint y, GC3Dsizei width, GC3Dsizei height, GC3Denum format, GC3Denum type, ArrayBufferView* pixels, ExceptionCode&);
236     void releaseShaderCompiler();
237     virtual void renderbufferStorage(GC3Denum target, GC3Denum internalformat, GC3Dsizei width, GC3Dsizei height) = 0;
238     void sampleCoverage(GC3Dfloat value, GC3Dboolean invert);
239     void scissor(GC3Dint x, GC3Dint y, GC3Dsizei width, GC3Dsizei height);
240     void shaderSource(WebGLShader*, const String&, ExceptionCode&);
241     void stencilFunc(GC3Denum func, GC3Dint ref, GC3Duint mask);
242     void stencilFuncSeparate(GC3Denum face, GC3Denum func, GC3Dint ref, GC3Duint mask);
243     void stencilMask(GC3Duint);
244     void stencilMaskSeparate(GC3Denum face, GC3Duint mask);
245     void stencilOp(GC3Denum fail, GC3Denum zfail, GC3Denum zpass);
246     void stencilOpSeparate(GC3Denum face, GC3Denum fail, GC3Denum zfail, GC3Denum zpass);
247
248     void texImage2D(GC3Denum target, GC3Dint level, GC3Denum internalformat,
249                     GC3Dsizei width, GC3Dsizei height, GC3Dint border,
250                     GC3Denum format, GC3Denum type, ArrayBufferView*, ExceptionCode&);
251     void texImage2D(GC3Denum target, GC3Dint level, GC3Denum internalformat,
252                     GC3Denum format, GC3Denum type, ImageData*, ExceptionCode&);
253     void texImage2D(GC3Denum target, GC3Dint level, GC3Denum internalformat,
254                     GC3Denum format, GC3Denum type, HTMLImageElement*, ExceptionCode&);
255     void texImage2D(GC3Denum target, GC3Dint level, GC3Denum internalformat,
256                     GC3Denum format, GC3Denum type, HTMLCanvasElement*, ExceptionCode&);
257 #if ENABLE(VIDEO)
258     void texImage2D(GC3Denum target, GC3Dint level, GC3Denum internalformat,
259                     GC3Denum format, GC3Denum type, HTMLVideoElement*, ExceptionCode&);
260 #endif
261
262     void texParameterf(GC3Denum target, GC3Denum pname, GC3Dfloat param);
263     void texParameteri(GC3Denum target, GC3Denum pname, GC3Dint param);
264
265     virtual void texSubImage2D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset,
266         GC3Dsizei width, GC3Dsizei height,
267         GC3Denum format, GC3Denum type, ArrayBufferView*, ExceptionCode&) = 0;
268     virtual void texSubImage2D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset,
269         GC3Denum format, GC3Denum type, ImageData*, ExceptionCode&) = 0;
270     virtual void texSubImage2D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset,
271         GC3Denum format, GC3Denum type, HTMLImageElement*, ExceptionCode&) = 0;
272     virtual void texSubImage2D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset,
273         GC3Denum format, GC3Denum type, HTMLCanvasElement*, ExceptionCode&) = 0;
274 #if ENABLE(VIDEO)
275     virtual void texSubImage2D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset,
276         GC3Denum format, GC3Denum type, HTMLVideoElement*, ExceptionCode&) = 0;
277 #endif
278
279     void uniform1f(const WebGLUniformLocation* location, GC3Dfloat x, ExceptionCode&);
280     void uniform1fv(const WebGLUniformLocation* location, Float32Array* v, ExceptionCode&);
281     void uniform1fv(const WebGLUniformLocation* location, GC3Dfloat* v, GC3Dsizei size, ExceptionCode&);
282     void uniform1i(const WebGLUniformLocation* location, GC3Dint x, ExceptionCode&);
283     void uniform1iv(const WebGLUniformLocation* location, Int32Array* v, ExceptionCode&);
284     void uniform1iv(const WebGLUniformLocation* location, GC3Dint* v, GC3Dsizei size, ExceptionCode&);
285     void uniform2f(const WebGLUniformLocation* location, GC3Dfloat x, GC3Dfloat y, ExceptionCode&);
286     void uniform2fv(const WebGLUniformLocation* location, Float32Array* v, ExceptionCode&);
287     void uniform2fv(const WebGLUniformLocation* location, GC3Dfloat* v, GC3Dsizei size, ExceptionCode&);
288     void uniform2i(const WebGLUniformLocation* location, GC3Dint x, GC3Dint y, ExceptionCode&);
289     void uniform2iv(const WebGLUniformLocation* location, Int32Array* v, ExceptionCode&);
290     void uniform2iv(const WebGLUniformLocation* location, GC3Dint* v, GC3Dsizei size, ExceptionCode&);
291     void uniform3f(const WebGLUniformLocation* location, GC3Dfloat x, GC3Dfloat y, GC3Dfloat z, ExceptionCode&);
292     void uniform3fv(const WebGLUniformLocation* location, Float32Array* v, ExceptionCode&);
293     void uniform3fv(const WebGLUniformLocation* location, GC3Dfloat* v, GC3Dsizei size, ExceptionCode&);
294     void uniform3i(const WebGLUniformLocation* location, GC3Dint x, GC3Dint y, GC3Dint z, ExceptionCode&);
295     void uniform3iv(const WebGLUniformLocation* location, Int32Array* v, ExceptionCode&);
296     void uniform3iv(const WebGLUniformLocation* location, GC3Dint* v, GC3Dsizei size, ExceptionCode&);
297     void uniform4f(const WebGLUniformLocation* location, GC3Dfloat x, GC3Dfloat y, GC3Dfloat z, GC3Dfloat w, ExceptionCode&);
298     void uniform4fv(const WebGLUniformLocation* location, Float32Array* v, ExceptionCode&);
299     void uniform4fv(const WebGLUniformLocation* location, GC3Dfloat* v, GC3Dsizei size, ExceptionCode&);
300     void uniform4i(const WebGLUniformLocation* location, GC3Dint x, GC3Dint y, GC3Dint z, GC3Dint w, ExceptionCode&);
301     void uniform4iv(const WebGLUniformLocation* location, Int32Array* v, ExceptionCode&);
302     void uniform4iv(const WebGLUniformLocation* location, GC3Dint* v, GC3Dsizei size, ExceptionCode&);
303     void uniformMatrix2fv(const WebGLUniformLocation* location, GC3Dboolean transpose, Float32Array* value, ExceptionCode&);
304     void uniformMatrix2fv(const WebGLUniformLocation* location, GC3Dboolean transpose, GC3Dfloat* value, GC3Dsizei size, ExceptionCode&);
305     void uniformMatrix3fv(const WebGLUniformLocation* location, GC3Dboolean transpose, Float32Array* value, ExceptionCode&);
306     void uniformMatrix3fv(const WebGLUniformLocation* location, GC3Dboolean transpose, GC3Dfloat* value, GC3Dsizei size, ExceptionCode&);
307     void uniformMatrix4fv(const WebGLUniformLocation* location, GC3Dboolean transpose, Float32Array* value, ExceptionCode&);
308     void uniformMatrix4fv(const WebGLUniformLocation* location, GC3Dboolean transpose, GC3Dfloat* value, GC3Dsizei size, ExceptionCode&);
309
310     void useProgram(WebGLProgram*, ExceptionCode&);
311     void validateProgram(WebGLProgram*, ExceptionCode&);
312
313     void vertexAttrib1f(GC3Duint index, GC3Dfloat x);
314     void vertexAttrib1fv(GC3Duint index, Float32Array* values);
315     void vertexAttrib1fv(GC3Duint index, GC3Dfloat* values, GC3Dsizei size);
316     void vertexAttrib2f(GC3Duint index, GC3Dfloat x, GC3Dfloat y);
317     void vertexAttrib2fv(GC3Duint index, Float32Array* values);
318     void vertexAttrib2fv(GC3Duint index, GC3Dfloat* values, GC3Dsizei size);
319     void vertexAttrib3f(GC3Duint index, GC3Dfloat x, GC3Dfloat y, GC3Dfloat z);
320     void vertexAttrib3fv(GC3Duint index, Float32Array* values);
321     void vertexAttrib3fv(GC3Duint index, GC3Dfloat* values, GC3Dsizei size);
322     void vertexAttrib4f(GC3Duint index, GC3Dfloat x, GC3Dfloat y, GC3Dfloat z, GC3Dfloat w);
323     void vertexAttrib4fv(GC3Duint index, Float32Array* values);
324     void vertexAttrib4fv(GC3Duint index, GC3Dfloat* values, GC3Dsizei size);
325     void vertexAttribPointer(GC3Duint index, GC3Dint size, GC3Denum type, GC3Dboolean normalized,
326                              GC3Dsizei stride, long long offset, ExceptionCode&);
327
328     void viewport(GC3Dint x, GC3Dint y, GC3Dsizei width, GC3Dsizei height);
329
330     // WEBKIT_lose_context support
331     enum LostContextMode {
332         // Lost context occurred at the graphics system level.
333         RealLostContext,
334
335         // Lost context provoked by WEBKIT_lose_context.
336         SyntheticLostContext
337     };
338     void forceLostContext(LostContextMode);
339     void forceRestoreContext();
340     void loseContextImpl(LostContextMode);
341
342     GraphicsContext3D* graphicsContext3D() const { return m_context.get(); }
343     WebGLContextGroup* contextGroup() const { return m_contextGroup.get(); }
344     virtual PlatformLayer* platformLayer() const override;
345
346     void reshape(int width, int height);
347
348     void markLayerComposited();
349     virtual void paintRenderingResultsToCanvas() override;
350     PassRefPtr<ImageData> paintRenderingResultsToImageData();
351
352     void removeSharedObject(WebGLSharedObject*);
353     void removeContextObject(WebGLContextObject*);
354     
355     unsigned getMaxVertexAttribs() const { return m_maxVertexAttribs; }
356
357     // ANGLE_instanced_arrays extension functions.
358     void drawArraysInstanced(GC3Denum mode, GC3Dint first, GC3Dsizei count, GC3Dsizei primcount);
359     void drawElementsInstanced(GC3Denum mode, GC3Dsizei count, GC3Denum type, long long offset, GC3Dsizei primcount);
360     void vertexAttribDivisor(GC3Duint index, GC3Duint divisor);
361
362 protected:
363     WebGLRenderingContextBase(HTMLCanvasElement*, GraphicsContext3D::Attributes);
364     WebGLRenderingContextBase(HTMLCanvasElement*, PassRefPtr<GraphicsContext3D>, GraphicsContext3D::Attributes);
365
366     friend class WebGLDrawBuffers;
367     friend class WebGLFramebuffer;
368     friend class WebGLObject;
369     friend class OESVertexArrayObject;
370     friend class WebGLDebugShaders;
371     friend class WebGLCompressedTextureATC;
372     friend class WebGLCompressedTexturePVRTC;
373     friend class WebGLCompressedTextureS3TC;
374     friend class WebGLRenderingContextErrorMessageCallback;
375     friend class WebGLVertexArrayObjectOES;
376
377     virtual void initializeNewContext();
378     void setupFlags();
379
380     // ActiveDOMObject
381     virtual bool hasPendingActivity() const override;
382     virtual void stop() override;
383     virtual const char* activeDOMObjectName() const override;
384     bool canSuspend() const override;
385
386     void addSharedObject(WebGLSharedObject*);
387     void addContextObject(WebGLContextObject*);
388     void detachAndRemoveAllObjects();
389
390     void destroyGraphicsContext3D();
391     void markContextChanged();
392
393     // Query whether it is built on top of compliant GLES2 implementation.
394     bool isGLES2Compliant() { return m_isGLES2Compliant; }
395     // Query if the GL implementation is NPOT strict.
396     bool isGLES2NPOTStrict() { return m_isGLES2NPOTStrict; }
397     // Query if the GL implementation generates errors on out-of-bounds buffer accesses.
398     bool isErrorGeneratedOnOutOfBoundsAccesses() { return m_isErrorGeneratedOnOutOfBoundsAccesses; }
399     // Query if the GL implementation initializes textures/renderbuffers to 0.
400     bool isResourceSafe() { return m_isResourceSafe; }
401     // Query if depth_stencil buffer is supported.
402     bool isDepthStencilSupported() { return m_isDepthStencilSupported; }
403
404     // Helper to return the size in bytes of OpenGL data types
405     // like GL_FLOAT, GL_INT, etc.
406     unsigned int sizeInBytes(GC3Denum type);
407
408     // Basic validation of count and offset against number of elements in element array buffer
409     bool validateElementArraySize(GC3Dsizei count, GC3Denum type, GC3Dintptr offset);
410
411     // Conservative but quick index validation
412     virtual bool validateIndexArrayConservative(GC3Denum type, unsigned& numElementsRequired) = 0;
413
414     // Precise but slow index validation -- only done if conservative checks fail
415     bool validateIndexArrayPrecise(GC3Dsizei count, GC3Denum type, GC3Dintptr offset, unsigned& numElementsRequired);
416     bool validateVertexAttributes(unsigned elementCount, unsigned primitiveCount = 0);
417
418     bool validateWebGLObject(const char*, WebGLObject*);
419
420     bool validateDrawArrays(const char* functionName, GC3Denum mode, GC3Dint first, GC3Dsizei count, GC3Dsizei primcount);
421     virtual bool validateDrawElements(const char* functionName, GC3Denum mode, GC3Dsizei count, GC3Denum type, long long offset, unsigned& numElements, GC3Dsizei primcount) = 0;
422
423     // Adds a compressed texture format.
424     void addCompressedTextureFormat(GC3Denum);
425
426     PassRefPtr<Image> drawImageIntoBuffer(Image*, int width, int height, int deviceScaleFactor);
427
428 #if ENABLE(VIDEO)
429     PassRefPtr<Image> videoFrameToImage(HTMLVideoElement*, BackingStoreCopy, ExceptionCode&);
430 #endif
431
432     RefPtr<GraphicsContext3D> m_context;
433     RefPtr<WebGLContextGroup> m_contextGroup;
434
435     // Dispatches a context lost event once it is determined that one is needed.
436     // This is used both for synthetic and real context losses. For real ones, it's
437     // likely that there's no JavaScript on the stack, but that might be dependent
438     // on how exactly the platform discovers that the context was lost. For better
439     // portability we always defer the dispatch of the event.
440     Timer m_dispatchContextLostEventTimer;
441     bool m_restoreAllowed;
442     Timer m_restoreTimer;
443
444     bool m_needsUpdate;
445     bool m_markedCanvasDirty;
446     HashSet<WebGLContextObject*> m_contextObjects;
447
448     // List of bound VBO's. Used to maintain info about sizes for ARRAY_BUFFER and stored values for ELEMENT_ARRAY_BUFFER
449     RefPtr<WebGLBuffer> m_boundArrayBuffer;
450     
451     RefPtr<WebGLVertexArrayObjectOES> m_defaultVertexArrayObject;
452     RefPtr<WebGLVertexArrayObjectOES> m_boundVertexArrayObject;
453     void setBoundVertexArrayObject(PassRefPtr<WebGLVertexArrayObjectOES> arrayObject)
454     {
455         if (arrayObject)
456             m_boundVertexArrayObject = arrayObject;
457         else
458             m_boundVertexArrayObject = m_defaultVertexArrayObject;
459     }
460     
461     class VertexAttribValue {
462     public:
463         VertexAttribValue()
464         {
465             initValue();
466         }
467         
468         void initValue()
469         {
470             value[0] = 0.0f;
471             value[1] = 0.0f;
472             value[2] = 0.0f;
473             value[3] = 1.0f;
474         }
475         
476         GC3Dfloat value[4];
477     };
478     Vector<VertexAttribValue> m_vertexAttribValue;
479     unsigned m_maxVertexAttribs;
480     RefPtr<WebGLBuffer> m_vertexAttrib0Buffer;
481     long m_vertexAttrib0BufferSize;
482     GC3Dfloat m_vertexAttrib0BufferValue[4];
483     bool m_forceAttrib0BufferRefill;
484     bool m_vertexAttrib0UsedBefore;
485
486     RefPtr<WebGLProgram> m_currentProgram;
487     RefPtr<WebGLFramebuffer> m_framebufferBinding;
488     RefPtr<WebGLRenderbuffer> m_renderbufferBinding;
489     struct TextureUnitState {
490         RefPtr<WebGLTexture> texture2DBinding;
491         RefPtr<WebGLTexture> textureCubeMapBinding;
492     };
493     Vector<TextureUnitState> m_textureUnits;
494     unsigned long m_activeTextureUnit;
495
496     RefPtr<WebGLTexture> m_blackTexture2D;
497     RefPtr<WebGLTexture> m_blackTextureCubeMap;
498
499     Vector<GC3Denum> m_compressedTextureFormats;
500
501     // Fixed-size cache of reusable image buffers for video texImage2D calls.
502     class LRUImageBufferCache {
503     public:
504         LRUImageBufferCache(int capacity);
505         // The pointer returned is owned by the image buffer map.
506         ImageBuffer* imageBuffer(const IntSize& size);
507     private:
508         void bubbleToFront(int idx);
509         std::unique_ptr<std::unique_ptr<ImageBuffer>[]> m_buffers;
510         int m_capacity;
511     };
512     LRUImageBufferCache m_generatedImageCache;
513
514     GC3Dint m_maxTextureSize;
515     GC3Dint m_maxCubeMapTextureSize;
516     GC3Dint m_maxRenderbufferSize;
517     GC3Dint m_maxViewportDims[2];
518     GC3Dint m_maxTextureLevel;
519     GC3Dint m_maxCubeMapTextureLevel;
520
521     GC3Dint m_maxDrawBuffers;
522     GC3Dint m_maxColorAttachments;
523     GC3Denum m_backDrawBuffer;
524     bool m_drawBuffersWebGLRequirementsChecked;
525     bool m_drawBuffersSupported;
526
527     GC3Dint m_packAlignment;
528     GC3Dint m_unpackAlignment;
529     bool m_unpackFlipY;
530     bool m_unpackPremultiplyAlpha;
531     GC3Denum m_unpackColorspaceConversion;
532     bool m_contextLost;
533     LostContextMode m_contextLostMode;
534     GraphicsContext3D::Attributes m_attributes;
535
536     bool m_layerCleared;
537     GC3Dfloat m_clearColor[4];
538     bool m_scissorEnabled;
539     GC3Dfloat m_clearDepth;
540     GC3Dint m_clearStencil;
541     GC3Dboolean m_colorMask[4];
542     GC3Dboolean m_depthMask;
543
544     bool m_stencilEnabled;
545     GC3Duint m_stencilMask, m_stencilMaskBack;
546     GC3Dint m_stencilFuncRef, m_stencilFuncRefBack; // Note that these are the user specified values, not the internal clamped value.
547     GC3Duint m_stencilFuncMask, m_stencilFuncMaskBack;
548
549     bool m_isGLES2Compliant;
550     bool m_isGLES2NPOTStrict;
551     bool m_isErrorGeneratedOnOutOfBoundsAccesses;
552     bool m_isResourceSafe;
553     bool m_isDepthStencilSupported;
554     bool m_isRobustnessEXTSupported;
555
556     bool m_synthesizedErrorsToConsole;
557     int m_numGLErrorsToConsoleAllowed;
558
559     // A WebGLRenderingContext can be created in a state where it appears as
560     // a valid and active context, but will not execute any important operations
561     // until its load policy is completely resolved.
562     bool m_isPendingPolicyResolution;
563     bool m_hasRequestedPolicyResolution;
564     bool isContextLostOrPending();
565
566     // Enabled extension objects.
567     std::unique_ptr<EXTFragDepth> m_extFragDepth;
568     std::unique_ptr<EXTBlendMinMax> m_extBlendMinMax;
569     std::unique_ptr<EXTsRGB> m_extsRGB;
570     std::unique_ptr<EXTTextureFilterAnisotropic> m_extTextureFilterAnisotropic;
571     std::unique_ptr<EXTShaderTextureLOD> m_extShaderTextureLOD;
572     std::unique_ptr<OESTextureFloat> m_oesTextureFloat;
573     std::unique_ptr<OESTextureFloatLinear> m_oesTextureFloatLinear;
574     std::unique_ptr<OESTextureHalfFloat> m_oesTextureHalfFloat;
575     std::unique_ptr<OESTextureHalfFloatLinear> m_oesTextureHalfFloatLinear;
576     std::unique_ptr<OESStandardDerivatives> m_oesStandardDerivatives;
577     std::unique_ptr<OESVertexArrayObject> m_oesVertexArrayObject;
578     std::unique_ptr<OESElementIndexUint> m_oesElementIndexUint;
579     std::unique_ptr<WebGLLoseContext> m_webglLoseContext;
580     std::unique_ptr<WebGLDebugRendererInfo> m_webglDebugRendererInfo;
581     std::unique_ptr<WebGLDebugShaders> m_webglDebugShaders;
582     std::unique_ptr<WebGLCompressedTextureATC> m_webglCompressedTextureATC;
583     std::unique_ptr<WebGLCompressedTexturePVRTC> m_webglCompressedTexturePVRTC;
584     std::unique_ptr<WebGLCompressedTextureS3TC> m_webglCompressedTextureS3TC;
585     std::unique_ptr<WebGLDepthTexture> m_webglDepthTexture;
586     std::unique_ptr<WebGLDrawBuffers> m_webglDrawBuffers;
587     std::unique_ptr<ANGLEInstancedArrays> m_angleInstancedArrays;
588
589     // Helpers for getParameter and others
590     WebGLGetInfo getBooleanParameter(GC3Denum);
591     WebGLGetInfo getBooleanArrayParameter(GC3Denum);
592     WebGLGetInfo getFloatParameter(GC3Denum);
593     WebGLGetInfo getIntParameter(GC3Denum);
594     WebGLGetInfo getUnsignedIntParameter(GC3Denum);
595     WebGLGetInfo getInt64Parameter(GC3Denum);
596     WebGLGetInfo getWebGLFloatArrayParameter(GC3Denum);
597     WebGLGetInfo getWebGLIntArrayParameter(GC3Denum);
598
599     // Clear the backbuffer if it was composited since the last operation.
600     // clearMask is set to the bitfield of any clear that would happen anyway at this time
601     // and the function returns true if that clear is now unnecessary.
602     bool clearIfComposited(GC3Dbitfield clearMask = 0);
603
604     // Helper to restore state that clearing the framebuffer may destroy.
605     void restoreStateAfterClear();
606
607     void texImage2DBase(GC3Denum target, GC3Dint level, GC3Denum internalformat, GC3Dsizei width, GC3Dsizei height, GC3Dint border, GC3Denum format, GC3Denum type, const void* pixels, ExceptionCode&);
608     void texImage2DImpl(GC3Denum target, GC3Dint level, GC3Denum internalformat, GC3Denum format, GC3Denum type, Image*, GraphicsContext3D::ImageHtmlDomSource, bool flipY, bool premultiplyAlpha, ExceptionCode&);
609     virtual void texSubImage2DBase(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset, GC3Dsizei width, GC3Dsizei height, GC3Denum internalformat, GC3Denum format, GC3Denum type, const void* pixels, ExceptionCode&) = 0;
610     virtual void texSubImage2DImpl(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset, GC3Denum format, GC3Denum type, Image*, GraphicsContext3D::ImageHtmlDomSource, bool flipY, bool premultiplyAlpha, ExceptionCode&) = 0;
611
612     void checkTextureCompleteness(const char*, bool);
613
614     void createFallbackBlackTextures1x1();
615
616     // Helper function for copyTex{Sub}Image, check whether the internalformat
617     // and the color buffer format of the current bound framebuffer combination
618     // is valid.
619     bool isTexInternalFormatColorBufferCombinationValid(GC3Denum texInternalFormat,
620                                                         GC3Denum colorBufferFormat);
621
622     // Helper function to get the bound framebuffer's color buffer format.
623     GC3Denum getBoundFramebufferColorFormat();
624
625     // Helper function to get the bound framebuffer's width.
626     int getBoundFramebufferWidth();
627
628     // Helper function to get the bound framebuffer's height.
629     int getBoundFramebufferHeight();
630
631     // Helper function to verify limits on the length of uniform and attribute locations.
632     bool validateLocationLength(const char* functionName, const String&);
633
634     // Helper function to check if size is non-negative.
635     // Generate GL error and return false for negative inputs; otherwise, return true.
636     bool validateSize(const char* functionName, GC3Dint x, GC3Dint y);
637
638     // Helper function to check if all characters in the string belong to the
639     // ASCII subset as defined in GLSL ES 1.0 spec section 3.1.
640     bool validateString(const char* functionName, const String&);
641
642     // Helper function to check target and texture bound to the target.
643     // Generate GL errors and return 0 if target is invalid or texture bound is
644     // null.  Otherwise, return the texture bound to the target.
645     WebGLTexture* validateTextureBinding(const char* functionName, GC3Denum target, bool useSixEnumsForCubeMap);
646
647     // Helper function to check input format/type for functions {copy}Tex{Sub}Image.
648     // Generates GL error and returns false if parameters are invalid.
649     virtual bool validateTexFuncFormatAndType(const char* functionName, GC3Denum internalformat, GC3Denum format, GC3Denum type, GC3Dint level) = 0;
650
651     // Helper function to check input level for functions {copy}Tex{Sub}Image.
652     // Generates GL error and returns false if level is invalid.
653     bool validateTexFuncLevel(const char* functionName, GC3Denum target, GC3Dint level);
654
655     enum TexFuncValidationFunctionType {
656         TexImage,
657         TexSubImage,
658         CopyTexImage
659     };
660
661     enum TexFuncValidationSourceType {
662         SourceArrayBufferView,
663         SourceImageData,
664         SourceHTMLImageElement,
665         SourceHTMLCanvasElement,
666         SourceHTMLVideoElement,
667     };
668
669     // Helper function for tex{Sub}Image2D to check if the input format/type/level/target/width/height/border/xoffset/yoffset are valid.
670     // Otherwise, it would return quickly without doing other work.
671     bool validateTexFunc(const char* functionName, TexFuncValidationFunctionType, TexFuncValidationSourceType, GC3Denum target, GC3Dint level, GC3Denum internalformat, GC3Dsizei width,
672         GC3Dsizei height, GC3Dint border, GC3Denum format, GC3Denum type, GC3Dint xoffset, GC3Dint yoffset);
673
674     // Helper function to check input parameters for functions {copy}Tex{Sub}Image.
675     // Generates GL error and returns false if parameters are invalid.
676     virtual bool validateTexFuncParameters(const char* functionName,
677         TexFuncValidationFunctionType,
678         GC3Denum target, GC3Dint level,
679         GC3Denum internalformat,
680         GC3Dsizei width, GC3Dsizei height, GC3Dint border,
681         GC3Denum format, GC3Denum type) = 0;
682
683     enum NullDisposition {
684         NullAllowed,
685         NullNotAllowed
686     };
687
688     // Helper function to validate that the given ArrayBufferView
689     // is of the correct type and contains enough data for the texImage call.
690     // Generates GL error and returns false if parameters are invalid.
691     virtual bool validateTexFuncData(const char* functionName, GC3Dint level,
692         GC3Dsizei width, GC3Dsizei height,
693         GC3Denum internalformat, GC3Denum format, GC3Denum type,
694         ArrayBufferView* pixels,
695         NullDisposition) = 0;
696
697     // Helper function to validate a given texture format is settable as in
698     // you can supply data to texImage2D, or call texImage2D, copyTexImage2D and
699     // copyTexSubImage2D.
700     // Generates GL error and returns false if the format is not settable.
701     bool validateSettableTexFormat(const char* functionName, GC3Denum format);
702
703     // Helper function to validate compressed texture data is correct size
704     // for the given format and dimensions.
705     bool validateCompressedTexFuncData(const char* functionName,
706                                        GC3Dsizei width, GC3Dsizei height,
707                                        GC3Denum format, ArrayBufferView* pixels);
708
709     // Helper function for validating compressed texture formats.
710     bool validateCompressedTexFormat(GC3Denum format);
711
712     // Helper function to validate compressed texture dimensions are valid for
713     // the given format.
714     bool validateCompressedTexDimensions(const char* functionName, GC3Denum target, GC3Dint level, GC3Dsizei width, GC3Dsizei height, GC3Denum format);
715
716     // Helper function to validate compressed texture dimensions are valid for
717     // the given format.
718     bool validateCompressedTexSubDimensions(const char* functionName, GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset,
719                                             GC3Dsizei width, GC3Dsizei height, GC3Denum format, WebGLTexture*);
720
721     // Helper function to validate mode for draw{Arrays/Elements}.
722     bool validateDrawMode(const char* functionName, GC3Denum);
723
724     // Helper function to validate if front/back stencilMask and stencilFunc settings are the same.
725     bool validateStencilSettings(const char* functionName);
726
727     // Helper function to validate stencil func.
728     bool validateStencilFunc(const char* functionName, GC3Denum);
729
730     // Helper function for texParameterf and texParameteri.
731     void texParameter(GC3Denum target, GC3Denum pname, GC3Dfloat parami, GC3Dint paramf, bool isFloat);
732
733     // Helper function to print GL errors to console.
734     void printGLErrorToConsole(const String&);
735     void printGLWarningToConsole(const char* function, const char* reason);
736
737     // Helper function to print warnings to console. Currently
738     // used only to warn about use of obsolete functions.
739     void printWarningToConsole(const String&);
740
741     // Helper function to validate input parameters for framebuffer functions.
742     // Generate GL error if parameters are illegal.
743     bool validateFramebufferFuncParameters(const char* functionName, GC3Denum target, GC3Denum attachment);
744
745     // Helper function to validate blend equation mode.
746     virtual bool validateBlendEquation(const char* functionName, GC3Denum) = 0;
747
748     // Helper function to validate blend func factors.
749     bool validateBlendFuncFactors(const char* functionName, GC3Denum src, GC3Denum dst);
750
751     // Helper function to validate a GL capability.
752     virtual bool validateCapability(const char* functionName, GC3Denum) = 0;
753
754     // Helper function to validate input parameters for uniform functions.
755     bool validateUniformParameters(const char* functionName, const WebGLUniformLocation*, Float32Array*, GC3Dsizei mod);
756     bool validateUniformParameters(const char* functionName, const WebGLUniformLocation*, Int32Array*, GC3Dsizei mod);
757     bool validateUniformParameters(const char* functionName, const WebGLUniformLocation*, void*, GC3Dsizei, GC3Dsizei mod);
758     bool validateUniformMatrixParameters(const char* functionName, const WebGLUniformLocation*, GC3Dboolean transpose, Float32Array*, GC3Dsizei mod);
759     bool validateUniformMatrixParameters(const char* functionName, const WebGLUniformLocation*, GC3Dboolean transpose, void*, GC3Dsizei, GC3Dsizei mod);
760
761     // Helper function to validate parameters for bufferData.
762     // Return the current bound buffer to target, or 0 if parameters are invalid.
763     WebGLBuffer* validateBufferDataParameters(const char* functionName, GC3Denum target, GC3Denum usage);
764
765     // Helper function for tex{Sub}Image2D to make sure image is ready and wouldn't taint Origin.
766     bool validateHTMLImageElement(const char* functionName, HTMLImageElement*, ExceptionCode&);
767
768     // Helper function for tex{Sub}Image2D to make sure canvas is ready and wouldn't taint Origin.
769     bool validateHTMLCanvasElement(const char* functionName, HTMLCanvasElement*, ExceptionCode&);
770
771 #if ENABLE(VIDEO)
772     // Helper function for tex{Sub}Image2D to make sure video is ready wouldn't taint Origin.
773     bool validateHTMLVideoElement(const char* functionName, HTMLVideoElement*, ExceptionCode&);
774 #endif
775
776     // Helper functions for vertexAttribNf{v}.
777     void vertexAttribfImpl(const char* functionName, GC3Duint index, GC3Dsizei expectedSize, GC3Dfloat, GC3Dfloat, GC3Dfloat, GC3Dfloat);
778     void vertexAttribfvImpl(const char* functionName, GC3Duint index, Float32Array*, GC3Dsizei expectedSize);
779     void vertexAttribfvImpl(const char* functionName, GC3Duint index, GC3Dfloat*, GC3Dsizei, GC3Dsizei expectedSize);
780
781     // Helper function for delete* (deleteBuffer, deleteProgram, etc) functions.
782     // Return false if caller should return without further processing.
783     bool deleteObject(WebGLObject*);
784
785     // Helper function for bind* (bindBuffer, bindTexture, etc) and useProgram.
786     // If the object has already been deleted, set deleted to true upon return.
787     // Return false if caller should return without further processing.
788     bool checkObjectToBeBound(const char* functionName, WebGLObject*, bool& deleted);
789
790     // Helpers for simulating vertexAttrib0
791     void initVertexAttrib0();
792     bool simulateVertexAttrib0(GC3Dsizei numVertex);
793     void restoreStatesAfterVertexAttrib0Simulation();
794
795     void dispatchContextLostEvent();
796     // Helper for restoration after context lost.
797     void maybeRestoreContext();
798
799     // Determine if we are running privileged code in the browser, for example,
800     // a Safari or Chrome extension.
801     bool allowPrivilegedExtensions() const;
802
803     enum ConsoleDisplayPreference {
804         DisplayInConsole,
805         DontDisplayInConsole
806     };
807
808     // Wrapper for GraphicsContext3D::synthesizeGLError that sends a message
809     // to the JavaScript console.
810     void synthesizeGLError(GC3Denum, const char* functionName, const char* description, ConsoleDisplayPreference = DisplayInConsole);
811
812     String ensureNotNull(const String&) const;
813
814     // Enable or disable stencil test based on user setting and
815     // whether the current FBO has a stencil buffer.
816     void applyStencilTest();
817
818     // Helper for enabling or disabling a capability.
819     void enableOrDisable(GC3Denum capability, bool enable);
820
821     // Clamp the width and height to GL_MAX_VIEWPORT_DIMS.
822     IntSize clampedCanvasSize();
823
824     // First time called, if EXT_draw_buffers is supported, query the value; otherwise return 0.
825     // Later, return the cached value.
826     GC3Dint getMaxDrawBuffers();
827     GC3Dint getMaxColorAttachments();
828
829     void setBackDrawBuffer(GC3Denum);
830
831     void restoreCurrentFramebuffer();
832     void restoreCurrentTexture2D();
833
834     // Check if EXT_draw_buffers extension is supported and if it satisfies the WebGL requirements.
835     bool supportsDrawBuffers();
836 };
837
838 } // namespace WebCore
839
840 #endif