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