d9b16f8542f21adaeba771d4d5179976efc8acaa
[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     RefPtr<WebGLBuffer> m_boundCopyReadBuffer;
431     RefPtr<WebGLBuffer> m_boundCopyWriteBuffer;
432     RefPtr<WebGLBuffer> m_boundPixelPackBuffer;
433     RefPtr<WebGLBuffer> m_boundPixelUnpackBuffer;
434     RefPtr<WebGLBuffer> m_boundTransformFeedbackBuffer;
435     RefPtr<WebGLBuffer> m_boundUniformBuffer;
436
437     RefPtr<WebGLVertexArrayObjectBase> m_defaultVertexArrayObject;
438     RefPtr<WebGLVertexArrayObjectBase> m_boundVertexArrayObject;
439     void setBoundVertexArrayObject(PassRefPtr<WebGLVertexArrayObjectBase> arrayObject)
440     {
441         if (arrayObject)
442             m_boundVertexArrayObject = arrayObject;
443         else
444             m_boundVertexArrayObject = m_defaultVertexArrayObject;
445     }
446     
447     class VertexAttribValue {
448     public:
449         VertexAttribValue()
450         {
451             initValue();
452         }
453         
454         void initValue()
455         {
456             value[0] = 0.0f;
457             value[1] = 0.0f;
458             value[2] = 0.0f;
459             value[3] = 1.0f;
460         }
461         
462         GC3Dfloat value[4];
463     };
464     Vector<VertexAttribValue> m_vertexAttribValue;
465     unsigned m_maxVertexAttribs;
466     RefPtr<WebGLBuffer> m_vertexAttrib0Buffer;
467     long m_vertexAttrib0BufferSize;
468     GC3Dfloat m_vertexAttrib0BufferValue[4];
469     bool m_forceAttrib0BufferRefill;
470     bool m_vertexAttrib0UsedBefore;
471
472     RefPtr<WebGLProgram> m_currentProgram;
473     RefPtr<WebGLFramebuffer> m_framebufferBinding;
474     RefPtr<WebGLRenderbuffer> m_renderbufferBinding;
475     struct TextureUnitState {
476         RefPtr<WebGLTexture> texture2DBinding;
477         RefPtr<WebGLTexture> textureCubeMapBinding;
478     };
479     Vector<TextureUnitState> m_textureUnits;
480     HashSet<unsigned, DefaultHash<unsigned>::Hash, WTF::UnsignedWithZeroKeyHashTraits<unsigned>> m_unrenderableTextureUnits;
481
482     unsigned long m_activeTextureUnit;
483
484     RefPtr<WebGLTexture> m_blackTexture2D;
485     RefPtr<WebGLTexture> m_blackTextureCubeMap;
486
487     Vector<GC3Denum> m_compressedTextureFormats;
488
489     // Fixed-size cache of reusable image buffers for video texImage2D calls.
490     class LRUImageBufferCache {
491     public:
492         LRUImageBufferCache(int capacity);
493         // The pointer returned is owned by the image buffer map.
494         ImageBuffer* imageBuffer(const IntSize& size);
495     private:
496         void bubbleToFront(int idx);
497         std::unique_ptr<std::unique_ptr<ImageBuffer>[]> m_buffers;
498         int m_capacity;
499     };
500     LRUImageBufferCache m_generatedImageCache;
501
502     GC3Dint m_maxTextureSize;
503     GC3Dint m_maxCubeMapTextureSize;
504     GC3Dint m_maxRenderbufferSize;
505     GC3Dint m_maxViewportDims[2];
506     GC3Dint m_maxTextureLevel;
507     GC3Dint m_maxCubeMapTextureLevel;
508
509     GC3Dint m_maxDrawBuffers;
510     GC3Dint m_maxColorAttachments;
511     GC3Denum m_backDrawBuffer;
512     bool m_drawBuffersWebGLRequirementsChecked;
513     bool m_drawBuffersSupported;
514
515     GC3Dint m_packAlignment;
516     GC3Dint m_unpackAlignment;
517     bool m_unpackFlipY;
518     bool m_unpackPremultiplyAlpha;
519     GC3Denum m_unpackColorspaceConversion;
520     bool m_contextLost;
521     LostContextMode m_contextLostMode;
522     GraphicsContext3D::Attributes m_attributes;
523
524     bool m_layerCleared;
525     GC3Dfloat m_clearColor[4];
526     bool m_scissorEnabled;
527     GC3Dfloat m_clearDepth;
528     GC3Dint m_clearStencil;
529     GC3Dboolean m_colorMask[4];
530     GC3Dboolean m_depthMask;
531
532     bool m_stencilEnabled;
533     GC3Duint m_stencilMask, m_stencilMaskBack;
534     GC3Dint m_stencilFuncRef, m_stencilFuncRefBack; // Note that these are the user specified values, not the internal clamped value.
535     GC3Duint m_stencilFuncMask, m_stencilFuncMaskBack;
536
537     bool m_isGLES2Compliant;
538     bool m_isGLES2NPOTStrict;
539     bool m_isErrorGeneratedOnOutOfBoundsAccesses;
540     bool m_isResourceSafe;
541     bool m_isDepthStencilSupported;
542     bool m_isRobustnessEXTSupported;
543
544     bool m_synthesizedErrorsToConsole;
545     int m_numGLErrorsToConsoleAllowed;
546
547     // A WebGLRenderingContext can be created in a state where it appears as
548     // a valid and active context, but will not execute any important operations
549     // until its load policy is completely resolved.
550     bool m_isPendingPolicyResolution;
551     bool m_hasRequestedPolicyResolution;
552     bool isContextLostOrPending();
553
554     // Enabled extension objects. FIXME: Move these to WebGL1RenderingContext, not needed for WebGL2
555     std::unique_ptr<EXTFragDepth> m_extFragDepth;
556     std::unique_ptr<EXTBlendMinMax> m_extBlendMinMax;
557     std::unique_ptr<EXTsRGB> m_extsRGB;
558     std::unique_ptr<EXTTextureFilterAnisotropic> m_extTextureFilterAnisotropic;
559     std::unique_ptr<EXTShaderTextureLOD> m_extShaderTextureLOD;
560     std::unique_ptr<OESTextureFloat> m_oesTextureFloat;
561     std::unique_ptr<OESTextureFloatLinear> m_oesTextureFloatLinear;
562     std::unique_ptr<OESTextureHalfFloat> m_oesTextureHalfFloat;
563     std::unique_ptr<OESTextureHalfFloatLinear> m_oesTextureHalfFloatLinear;
564     std::unique_ptr<OESStandardDerivatives> m_oesStandardDerivatives;
565     std::unique_ptr<OESVertexArrayObject> m_oesVertexArrayObject;
566     std::unique_ptr<OESElementIndexUint> m_oesElementIndexUint;
567     std::unique_ptr<WebGLLoseContext> m_webglLoseContext;
568     std::unique_ptr<WebGLDebugRendererInfo> m_webglDebugRendererInfo;
569     std::unique_ptr<WebGLDebugShaders> m_webglDebugShaders;
570     std::unique_ptr<WebGLCompressedTextureATC> m_webglCompressedTextureATC;
571     std::unique_ptr<WebGLCompressedTexturePVRTC> m_webglCompressedTexturePVRTC;
572     std::unique_ptr<WebGLCompressedTextureS3TC> m_webglCompressedTextureS3TC;
573     std::unique_ptr<WebGLDepthTexture> m_webglDepthTexture;
574     std::unique_ptr<WebGLDrawBuffers> m_webglDrawBuffers;
575     std::unique_ptr<ANGLEInstancedArrays> m_angleInstancedArrays;
576
577     // Helpers for getParameter and others
578     WebGLGetInfo getBooleanParameter(GC3Denum);
579     WebGLGetInfo getBooleanArrayParameter(GC3Denum);
580     WebGLGetInfo getFloatParameter(GC3Denum);
581     WebGLGetInfo getIntParameter(GC3Denum);
582     WebGLGetInfo getUnsignedIntParameter(GC3Denum);
583     WebGLGetInfo getInt64Parameter(GC3Denum);
584     WebGLGetInfo getWebGLFloatArrayParameter(GC3Denum);
585     WebGLGetInfo getWebGLIntArrayParameter(GC3Denum);
586
587     // Clear the backbuffer if it was composited since the last operation.
588     // clearMask is set to the bitfield of any clear that would happen anyway at this time
589     // and the function returns true if that clear is now unnecessary.
590     bool clearIfComposited(GC3Dbitfield clearMask = 0);
591
592     // Helper to restore state that clearing the framebuffer may destroy.
593     void restoreStateAfterClear();
594
595     void texImage2DBase(GC3Denum target, GC3Dint level, GC3Denum internalformat, GC3Dsizei width, GC3Dsizei height, GC3Dint border, GC3Denum format, GC3Denum type, const void* pixels);
596     void texImage2DImpl(GC3Denum target, GC3Dint level, GC3Denum internalformat, GC3Denum format, GC3Denum type, Image*, GraphicsContext3D::ImageHtmlDomSource, bool flipY, bool premultiplyAlpha);
597     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;
598     virtual void texSubImage2DImpl(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset, GC3Denum format, GC3Denum type, Image*, GraphicsContext3D::ImageHtmlDomSource, bool flipY, bool premultiplyAlpha) = 0;
599
600     bool checkTextureCompleteness(const char*, bool);
601
602     void createFallbackBlackTextures1x1();
603
604     // Helper function for copyTex{Sub}Image, check whether the internalformat
605     // and the color buffer format of the current bound framebuffer combination
606     // is valid.
607     bool isTexInternalFormatColorBufferCombinationValid(GC3Denum texInternalFormat,
608                                                         GC3Denum colorBufferFormat);
609
610     // Helper function to get the bound framebuffer's color buffer format.
611     GC3Denum getBoundFramebufferColorFormat();
612
613     // Helper function to get the bound framebuffer's width.
614     int getBoundFramebufferWidth();
615
616     // Helper function to get the bound framebuffer's height.
617     int getBoundFramebufferHeight();
618
619     // Helper function to verify limits on the length of uniform and attribute locations.
620     bool validateLocationLength(const char* functionName, const String&);
621
622     // Helper function to check if size is non-negative.
623     // Generate GL error and return false for negative inputs; otherwise, return true.
624     bool validateSize(const char* functionName, GC3Dint x, GC3Dint y);
625
626     // Helper function to check if all characters in the string belong to the
627     // ASCII subset as defined in GLSL ES 1.0 spec section 3.1.
628     bool validateString(const char* functionName, const String&);
629
630     // Helper function to check target and texture bound to the target.
631     // Generate GL errors and return 0 if target is invalid or texture bound is
632     // null.  Otherwise, return the texture bound to the target.
633     WebGLTexture* validateTextureBinding(const char* functionName, GC3Denum target, bool useSixEnumsForCubeMap);
634
635     // Helper function to check input format/type for functions {copy}Tex{Sub}Image.
636     // Generates GL error and returns false if parameters are invalid.
637     virtual bool validateTexFuncFormatAndType(const char* functionName, GC3Denum internalformat, GC3Denum format, GC3Denum type, GC3Dint level) = 0;
638
639     // Helper function to check input level for functions {copy}Tex{Sub}Image.
640     // Generates GL error and returns false if level is invalid.
641     bool validateTexFuncLevel(const char* functionName, GC3Denum target, GC3Dint level);
642
643     enum TexFuncValidationFunctionType {
644         TexImage,
645         TexSubImage,
646         CopyTexImage
647     };
648
649     enum TexFuncValidationSourceType {
650         SourceArrayBufferView,
651         SourceImageData,
652         SourceHTMLImageElement,
653         SourceHTMLCanvasElement,
654         SourceHTMLVideoElement,
655     };
656
657     // Helper function for tex{Sub}Image2D to check if the input format/type/level/target/width/height/border/xoffset/yoffset are valid.
658     // Otherwise, it would return quickly without doing other work.
659     bool validateTexFunc(const char* functionName, TexFuncValidationFunctionType, TexFuncValidationSourceType, GC3Denum target, GC3Dint level, GC3Denum internalformat, GC3Dsizei width,
660         GC3Dsizei height, GC3Dint border, GC3Denum format, GC3Denum type, GC3Dint xoffset, GC3Dint yoffset);
661
662     // Helper function to check input parameters for functions {copy}Tex{Sub}Image.
663     // Generates GL error and returns false if parameters are invalid.
664     virtual bool validateTexFuncParameters(const char* functionName,
665         TexFuncValidationFunctionType,
666         GC3Denum target, GC3Dint level,
667         GC3Denum internalformat,
668         GC3Dsizei width, GC3Dsizei height, GC3Dint border,
669         GC3Denum format, GC3Denum type) = 0;
670
671     enum NullDisposition {
672         NullAllowed,
673         NullNotAllowed
674     };
675
676     // Helper function to validate that the given ArrayBufferView
677     // is of the correct type and contains enough data for the texImage call.
678     // Generates GL error and returns false if parameters are invalid.
679     virtual bool validateTexFuncData(const char* functionName, GC3Dint level,
680         GC3Dsizei width, GC3Dsizei height,
681         GC3Denum internalformat, GC3Denum format, GC3Denum type,
682         ArrayBufferView* pixels,
683         NullDisposition) = 0;
684
685     // Helper function to validate a given texture format is settable as in
686     // you can supply data to texImage2D, or call texImage2D, copyTexImage2D and
687     // copyTexSubImage2D.
688     // Generates GL error and returns false if the format is not settable.
689     bool validateSettableTexFormat(const char* functionName, GC3Denum format);
690
691     // Helper function to validate compressed texture data is correct size
692     // for the given format and dimensions.
693     bool validateCompressedTexFuncData(const char* functionName, GC3Dsizei width, GC3Dsizei height, GC3Denum format, ArrayBufferView& pixels);
694
695     // Helper function for validating compressed texture formats.
696     bool validateCompressedTexFormat(GC3Denum format);
697
698     // Helper function to validate compressed texture dimensions are valid for
699     // the given format.
700     bool validateCompressedTexDimensions(const char* functionName, GC3Denum target, GC3Dint level, GC3Dsizei width, GC3Dsizei height, GC3Denum format);
701
702     // Helper function to validate compressed texture dimensions are valid for
703     // the given format.
704     bool validateCompressedTexSubDimensions(const char* functionName, GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset,
705                                             GC3Dsizei width, GC3Dsizei height, GC3Denum format, WebGLTexture*);
706
707     // Helper function to validate mode for draw{Arrays/Elements}.
708     bool validateDrawMode(const char* functionName, GC3Denum);
709
710     // Helper function to validate if front/back stencilMask and stencilFunc settings are the same.
711     bool validateStencilSettings(const char* functionName);
712
713     // Helper function to validate stencil func.
714     bool validateStencilFunc(const char* functionName, GC3Denum);
715
716     // Helper function for texParameterf and texParameteri.
717     void texParameter(GC3Denum target, GC3Denum pname, GC3Dfloat parami, GC3Dint paramf, bool isFloat);
718
719     // Helper function to print GL errors to console.
720     void printGLErrorToConsole(const String&);
721     void printGLWarningToConsole(const char* function, const char* reason);
722
723     // Helper function to print warnings to console. Currently
724     // used only to warn about use of obsolete functions.
725     void printWarningToConsole(const String&);
726
727     // Helper function to validate input parameters for framebuffer functions.
728     // Generate GL error if parameters are illegal.
729     virtual bool validateFramebufferFuncParameters(const char* functionName, GC3Denum target, GC3Denum attachment) = 0;
730
731     // Helper function to validate blend equation mode.
732     virtual bool validateBlendEquation(const char* functionName, GC3Denum) = 0;
733
734     // Helper function to validate blend func factors.
735     bool validateBlendFuncFactors(const char* functionName, GC3Denum src, GC3Denum dst);
736
737     // Helper function to validate a GL capability.
738     virtual bool validateCapability(const char* functionName, GC3Denum) = 0;
739
740     // Helper function to validate input parameters for uniform functions.
741     bool validateUniformParameters(const char* functionName, const WebGLUniformLocation*, Float32Array&, GC3Dsizei mod);
742     bool validateUniformParameters(const char* functionName, const WebGLUniformLocation*, Int32Array&, GC3Dsizei mod);
743     bool validateUniformParameters(const char* functionName, const WebGLUniformLocation*, void*, GC3Dsizei, GC3Dsizei mod);
744     bool validateUniformMatrixParameters(const char* functionName, const WebGLUniformLocation*, GC3Dboolean transpose, Float32Array&, GC3Dsizei mod);
745     bool validateUniformMatrixParameters(const char* functionName, const WebGLUniformLocation*, GC3Dboolean transpose, void*, GC3Dsizei, GC3Dsizei mod);
746
747     // Helper function to validate parameters for bufferData.
748     // Return the current bound buffer to target, or 0 if parameters are invalid.
749     WebGLBuffer* validateBufferDataParameters(const char* functionName, GC3Denum target, GC3Denum usage);
750
751     // Helper function for tex{Sub}Image2D to make sure image is ready.
752     bool validateHTMLImageElement(const char* functionName, HTMLImageElement*);
753     bool validateHTMLCanvasElement(const char* functionName, HTMLCanvasElement*);
754 #if ENABLE(VIDEO)
755     bool validateHTMLVideoElement(const char* functionName, HTMLVideoElement*);
756 #endif
757
758     // Helper functions for vertexAttribNf{v}.
759     void vertexAttribfImpl(const char* functionName, GC3Duint index, GC3Dsizei expectedSize, GC3Dfloat, GC3Dfloat, GC3Dfloat, GC3Dfloat);
760     void vertexAttribfvImpl(const char* functionName, GC3Duint index, Float32Array&, GC3Dsizei expectedSize);
761     void vertexAttribfvImpl(const char* functionName, GC3Duint index, GC3Dfloat*, GC3Dsizei, GC3Dsizei expectedSize);
762
763     // Helper function for delete* (deleteBuffer, deleteProgram, etc) functions.
764     // Return false if caller should return without further processing.
765     bool deleteObject(WebGLObject*);
766
767     // Helper function for bind* (bindBuffer, bindTexture, etc) and useProgram.
768     // If the object has already been deleted, set deleted to true upon return.
769     // Return false if caller should return without further processing.
770     bool checkObjectToBeBound(const char* functionName, WebGLObject*, bool& deleted);
771
772     // Helpers for simulating vertexAttrib0.
773     void initVertexAttrib0();
774     bool simulateVertexAttrib0(GC3Dsizei numVertex);
775     bool validateSimulatedVertexAttrib0(GC3Dsizei numVertex);
776     void restoreStatesAfterVertexAttrib0Simulation();
777
778     void dispatchContextLostEvent();
779     // Helper for restoration after context lost.
780     void maybeRestoreContext();
781
782     // Wrapper for GraphicsContext3D::synthesizeGLError that sends a message to the JavaScript console.
783     enum ConsoleDisplayPreference { DisplayInConsole, DontDisplayInConsole };
784     void synthesizeGLError(GC3Denum, const char* functionName, const char* description, ConsoleDisplayPreference = DisplayInConsole);
785
786     String ensureNotNull(const String&) const;
787
788     // Enable or disable stencil test based on user setting and whether the current FBO has a stencil buffer.
789     void applyStencilTest();
790
791     // Helper for enabling or disabling a capability.
792     void enableOrDisable(GC3Denum capability, bool enable);
793
794     // Clamp the width and height to GL_MAX_VIEWPORT_DIMS.
795     IntSize clampedCanvasSize();
796
797     virtual GC3Dint getMaxDrawBuffers() = 0;
798     virtual GC3Dint getMaxColorAttachments() = 0;
799
800     void setBackDrawBuffer(GC3Denum);
801
802     void restoreCurrentFramebuffer();
803     void restoreCurrentTexture2D();
804
805     // Check if EXT_draw_buffers extension is supported and if it satisfies the WebGL requirements.
806     bool supportsDrawBuffers();
807 };
808
809 } // namespace WebCore
810
811 SPECIALIZE_TYPE_TRAITS_CANVASRENDERINGCONTEXT(WebCore::WebGLRenderingContextBase, is3d())