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