[WebGL2] Teach WebGLRenderingContextBase about new texture internal formats
[WebKit-https.git] / Source / WebCore / html / canvas / WebGL2RenderingContext.h
1 /*
2  * Copyright (C) 2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(WEBGL2)
29
30 #include "WebGLRenderingContextBase.h"
31 #include <wtf/Variant.h>
32
33 namespace WebCore {
34
35 class WebGLQuery;
36 class WebGLSampler;
37 class WebGLSync;
38 class WebGLTransformFeedback;
39 class WebGLVertexArrayObject;
40
41 class WebGL2RenderingContext final : public WebGLRenderingContextBase {
42 public:
43     WebGL2RenderingContext(HTMLCanvasElement&, GraphicsContext3D::Attributes);
44     WebGL2RenderingContext(HTMLCanvasElement&, RefPtr<GraphicsContext3D>&&, GraphicsContext3D::Attributes);
45
46     /* Buffer objects */
47     using WebGLRenderingContextBase::bufferData;
48     using WebGLRenderingContextBase::bufferSubData;
49     void bufferData(GC3Denum target, const ArrayBufferView& data, GC3Denum usage, GC3Duint srcOffset, GC3Duint length);
50     void bufferSubData(GC3Denum target, long long offset, const ArrayBufferView& data, GC3Duint srcOffset, GC3Duint length);
51     void copyBufferSubData(GC3Denum readTarget, GC3Denum writeTarget, GC3Dint64 readOffset, GC3Dint64 writeOffset, GC3Dint64 size);
52     void getBufferSubData(GC3Denum target, long long srcByteOffset, RefPtr<ArrayBufferView>&& dstData, GC3Duint dstOffset = 0, GC3Duint length = 0);
53     
54     /* Framebuffer objects */
55     WebGLGetInfo getFramebufferAttachmentParameter(GC3Denum target, GC3Denum attachment, GC3Denum pname) final;
56     void blitFramebuffer(GC3Dint srcX0, GC3Dint srcY0, GC3Dint srcX1, GC3Dint srcY1, GC3Dint dstX0, GC3Dint dstY0, GC3Dint dstX1, GC3Dint dstY1, GC3Dbitfield mask, GC3Denum filter);
57     void framebufferTextureLayer(GC3Denum target, GC3Denum attachment, GC3Duint texture, GC3Dint level, GC3Dint layer);
58     WebGLGetInfo getInternalformatParameter(GC3Denum target, GC3Denum internalformat, GC3Denum pname);
59     void invalidateFramebuffer(GC3Denum target, Vector<GC3Denum> attachments);
60     void invalidateSubFramebuffer(GC3Denum target, Vector<GC3Denum> attachments, GC3Dint x, GC3Dint y, GC3Dsizei width, GC3Dsizei height);
61     void readBuffer(GC3Denum src);
62     
63     /* Renderbuffer objects */
64     void renderbufferStorageMultisample(GC3Denum target, GC3Dsizei samples, GC3Denum internalformat, GC3Dsizei width, GC3Dsizei height);
65     
66     /* Texture objects */
67     void texStorage2D(GC3Denum target, GC3Dsizei levels, GC3Denum internalformat, GC3Dsizei width, GC3Dsizei height);
68     void texStorage3D(GC3Denum target, GC3Dsizei levels, GC3Denum internalformat, GC3Dsizei width, GC3Dsizei height, GC3Dsizei depth);
69     void texImage3D(GC3Denum target, GC3Dint level, GC3Dint internalformat, GC3Dsizei width, GC3Dsizei height, GC3Dsizei depth, GC3Dint border, GC3Denum format, GC3Denum type, RefPtr<ArrayBufferView>&& pixels);
70
71     void texSubImage3D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset, GC3Dint zoffset, GC3Dsizei width, GC3Dsizei height, GC3Dsizei depth, GC3Denum format, GC3Denum type, RefPtr<ArrayBufferView>&& pixels);
72     using TexImageSource = WTF::Variant<RefPtr<ImageData>, RefPtr<HTMLImageElement>, RefPtr<HTMLCanvasElement>, RefPtr<HTMLVideoElement>>;
73     void texSubImage3D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset, GC3Dint zoffset, GC3Denum format, GC3Denum type, TexImageSource&&);
74
75     void copyTexSubImage3D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset, GC3Dint zoffset, GC3Dint x, GC3Dint y, GC3Dsizei width, GC3Dsizei height);
76     void compressedTexImage3D(GC3Denum target, GC3Dint level, GC3Denum internalformat, GC3Dsizei width, GC3Dsizei height, GC3Dsizei depth, GC3Dint border, GC3Dsizei imageSize, RefPtr<ArrayBufferView>&& data);
77     void compressedTexSubImage3D(GC3Denum target, GC3Dint level, GC3Dint xoffset, GC3Dint yoffset, GC3Dint zoffset, GC3Dsizei width, GC3Dsizei height, GC3Dsizei depth, GC3Denum format, GC3Dsizei imageSize, RefPtr<ArrayBufferView>&& data);
78     
79     /* Programs and shaders */
80     GC3Dint getFragDataLocation(WebGLProgram* program, String name);
81     
82     /* Uniforms and attributes */
83     void uniform1ui(WebGLUniformLocation*, GC3Duint v0);
84     void uniform2ui(WebGLUniformLocation*, GC3Duint v0, GC3Duint v1);
85     void uniform3ui(WebGLUniformLocation*, GC3Duint v0, GC3Duint v1, GC3Duint v2);
86     void uniform4ui(WebGLUniformLocation*, GC3Duint v0, GC3Duint v1, GC3Duint v2, GC3Duint v3);
87     void uniform1uiv(WebGLUniformLocation*, RefPtr<Uint32Array>&& value);
88     void uniform2uiv(WebGLUniformLocation*, RefPtr<Uint32Array>&& value);
89     void uniform3uiv(WebGLUniformLocation*, RefPtr<Uint32Array>&& value);
90     void uniform4uiv(WebGLUniformLocation*, RefPtr<Uint32Array>&& value);
91     void uniformMatrix2x3fv(WebGLUniformLocation*, GC3Dboolean transpose, RefPtr<Float32Array>&& value);
92     void uniformMatrix3x2fv(WebGLUniformLocation*, GC3Dboolean transpose, RefPtr<Float32Array>&& value);
93     void uniformMatrix2x4fv(WebGLUniformLocation*, GC3Dboolean transpose, RefPtr<Float32Array>&& value);
94     void uniformMatrix4x2fv(WebGLUniformLocation*, GC3Dboolean transpose, RefPtr<Float32Array>&& value);
95     void uniformMatrix3x4fv(WebGLUniformLocation*, GC3Dboolean transpose, RefPtr<Float32Array>&& value);
96     void uniformMatrix4x3fv(WebGLUniformLocation*, GC3Dboolean transpose, RefPtr<Float32Array>&& value);
97     void vertexAttribI4i(GC3Duint index, GC3Dint x, GC3Dint y, GC3Dint z, GC3Dint w);
98     void vertexAttribI4iv(GC3Duint index, RefPtr<Int32Array>&& v);
99     void vertexAttribI4ui(GC3Duint index, GC3Duint x, GC3Duint y, GC3Duint z, GC3Duint w);
100     void vertexAttribI4uiv(GC3Duint index, RefPtr<Uint32Array>&& v);
101     void vertexAttribIPointer(GC3Duint index, GC3Dint size, GC3Denum type, GC3Dsizei stride, GC3Dint64 offset);
102     
103     /* Writing to the drawing buffer */
104     void clear(GC3Dbitfield mask) final;
105     void vertexAttribDivisor(GC3Duint index, GC3Duint divisor);
106     void drawArraysInstanced(GC3Denum mode, GC3Dint first, GC3Dsizei count, GC3Dsizei instanceCount);
107     void drawElementsInstanced(GC3Denum mode, GC3Dsizei count, GC3Denum type, GC3Dint64 offset, GC3Dsizei instanceCount);
108     void drawRangeElements(GC3Denum mode, GC3Duint start, GC3Duint end, GC3Dsizei count, GC3Denum type, GC3Dint64 offset);
109     
110     /* Multiple Render Targets */
111     void drawBuffers(Vector<GC3Denum> buffers);
112     void clearBufferiv(GC3Denum buffer, GC3Dint drawbuffer, RefPtr<Int32Array>&& value);
113     void clearBufferuiv(GC3Denum buffer, GC3Dint drawbuffer, RefPtr<Uint32Array>&& value);
114     void clearBufferfv(GC3Denum buffer, GC3Dint drawbuffer, RefPtr<Float32Array>&& value);
115     void clearBufferfi(GC3Denum buffer, GC3Dint drawbuffer, GC3Dfloat depth, GC3Dint stencil);
116     
117     /* Query Objects */
118     RefPtr<WebGLQuery> createQuery();
119     void deleteQuery(WebGLQuery* query);
120     GC3Dboolean isQuery(WebGLQuery* query);
121     void beginQuery(GC3Denum target, WebGLQuery* query);
122     void endQuery(GC3Denum target);
123     RefPtr<WebGLQuery> getQuery(GC3Denum target, GC3Denum pname);
124     WebGLGetInfo getQueryParameter(WebGLQuery* query, GC3Denum pname);
125     
126     /* Sampler Objects */
127     RefPtr<WebGLSampler> createSampler();
128     void deleteSampler(WebGLSampler* sampler);
129     GC3Dboolean isSampler(WebGLSampler* sampler);
130     void bindSampler(GC3Duint unit, WebGLSampler* sampler);
131     void samplerParameteri(WebGLSampler* sampler, GC3Denum pname, GC3Dint param);
132     void samplerParameterf(WebGLSampler* sampler, GC3Denum pname, GC3Dfloat param);
133     WebGLGetInfo getSamplerParameter(WebGLSampler* sampler, GC3Denum pname);
134     
135     /* Sync objects */
136     RefPtr<WebGLSync> fenceSync(GC3Denum condition, GC3Dbitfield flags);
137     GC3Dboolean isSync(WebGLSync* sync);
138     void deleteSync(WebGLSync* sync);
139     GC3Denum clientWaitSync(WebGLSync* sync, GC3Dbitfield flags, GC3Duint64 timeout);
140     void waitSync(WebGLSync* sync, GC3Dbitfield flags, GC3Duint64 timeout);
141     WebGLGetInfo getSyncParameter(WebGLSync* sync, GC3Denum pname);
142     
143     /* Transform Feedback */
144     RefPtr<WebGLTransformFeedback> createTransformFeedback();
145     void deleteTransformFeedback(WebGLTransformFeedback* id);
146     GC3Dboolean isTransformFeedback(WebGLTransformFeedback* id);
147     void bindTransformFeedback(GC3Denum target, WebGLTransformFeedback* id);
148     void beginTransformFeedback(GC3Denum primitiveMode);
149     void endTransformFeedback();
150     void transformFeedbackVaryings(WebGLProgram*, Vector<String> varyings, GC3Denum bufferMode);
151     RefPtr<WebGLActiveInfo> getTransformFeedbackVarying(WebGLProgram*, GC3Duint index);
152     void pauseTransformFeedback();
153     void resumeTransformFeedback();
154     
155     /* Uniform Buffer Objects and Transform Feedback Buffers */
156     void bindBufferBase(GC3Denum target, GC3Duint index, WebGLBuffer* buffer);
157     void bindBufferRange(GC3Denum target, GC3Duint index, WebGLBuffer* buffer, GC3Dint64 offset, GC3Dint64 size);
158     WebGLGetInfo getIndexedParameter(GC3Denum target, GC3Duint index);
159     Uint32Array* getUniformIndices(WebGLProgram*, Vector<String> uniformNames);
160     Int32Array* getActiveUniforms(WebGLProgram*, RefPtr<Uint32Array>&& uniformIndices, GC3Denum pname);
161     GC3Duint getUniformBlockIndex(WebGLProgram*, String uniformBlockName);
162     WebGLGetInfo getActiveUniformBlockParameter(WebGLProgram*, GC3Duint uniformBlockIndex, GC3Denum pname);
163     WebGLGetInfo getActiveUniformBlockName(WebGLProgram*, GC3Duint uniformBlockIndex);
164     void uniformBlockBinding(WebGLProgram*, GC3Duint uniformBlockIndex, GC3Duint uniformBlockBinding);
165     
166     /* Vertex Array Objects */
167     RefPtr<WebGLVertexArrayObject> createVertexArray();
168     void deleteVertexArray(WebGLVertexArrayObject* vertexArray);
169     GC3Dboolean isVertexArray(WebGLVertexArrayObject* vertexArray);
170     void bindVertexArray(WebGLVertexArrayObject* vertexArray);
171     
172 private:
173     bool isWebGL2() const final { return true; }
174
175     /* Extensions */
176     WebGLExtension* getExtension(const String&) final;
177     Vector<String> getSupportedExtensions() final;
178     WebGLGetInfo getParameter(GC3Denum pname) final;
179
180     void renderbufferStorage(GC3Denum target, GC3Denum internalformat, GC3Dsizei width, GC3Dsizei height) final;
181     void hint(GC3Denum target, GC3Denum mode) final;
182
183     void initializeVertexArrayObjects() final;
184     GC3Dint getMaxDrawBuffers() final;
185     GC3Dint getMaxColorAttachments() final;
186     bool validateIndexArrayConservative(GC3Denum type, unsigned& numElementsRequired) final;
187     bool validateBlendEquation(const char* functionName, GC3Denum mode) final;
188     bool validateCapability(const char* functionName, GC3Denum cap) final;
189     bool validateFramebufferFuncParameters(const char* functionName, GC3Denum target, GC3Denum attachment) final;
190     
191     GC3Denum baseInternalFormatFromInternalFormat(GC3Denum internalformat);
192     bool isIntegerFormat(GC3Denum internalformat);
193     void initializeShaderExtensions();
194 };
195
196 } // namespace WebCore
197
198 SPECIALIZE_TYPE_TRAITS_CANVASRENDERINGCONTEXT(WebCore::WebGL2RenderingContext, isWebGL2())
199
200 #endif // WEBGL2