Fully implement WebGL 1.0

[emilio]

This is intended to be a meta-bug.

Some of the remaining methods are blocked on #5014 (those that receive ArrayBufferView or BufferDataSource and have overrides), but some others can be implemented without problems.

I'll try to file individual issues for each remaining deficiency, since some of them can be E-Easy.

General information for WebGL bugs

Click to expand

Spec

The WebGL 1.0 spec is here.

GLES 2.0 spec

WebGL is based on the GLES 2.0 spec, so the WebGL spec often leverages details to it. You can find a PDF version here.

Current Code

DOM

The DOM side of the WebGL code can be found in the following files:

• components/script/dom/webglrenderingcontext.rs
• components/script/dom/webglactiveinfo.rs
• components/script/dom/webglbuffer.rs
• components/script/dom/webglcontextevent.rs
• components/script/dom/webglframebuffer.rs
• components/script/dom/webglobject.rs
• components/script/dom/webglprogram.rs
• components/script/dom/webglrenderbuffer.rs
• components/script/dom/webglrenderingcontext.rs
• components/script/dom/webglshader.rs
• components/script/dom/webglshaderprecisionformat.rs
• components/script/dom/webgltexture.rs
• components/script/dom/webgluniformlocation.rs

WebGL thread

The WebGL thread is the thread that receives the WebGL messages from the DOM, and either executes it or dispatchs it to the WebRender backend.

You probably don't need to touch anything here, but in case you want to take a look, the file is:

• components/canvas/webgl_paint_thread.rs

WebGL command definition, execution, and other types

The rest of the WebGL definitions and the command implementations are in webrender_traits's webgl.rs file, in order to be shared by both Servo and WebRender.

You'll want to take a look to the WebGLCommand definition and to the apply function.

To work actively with it the best is to use a Cargo override.

Note that WebGLCommand is re-exported from canvas_traits as CanvasWebGLMessage for legacy reasons (to avoid extra rebase pain while webrender hadn't merged yet).

Missing safety checks

• Properly implement "Enabled Vertex Attributes and Range Checking" (Properly implement "Enabled Vertex Attributes and Range Checking" #20599)
• Check that we implement all GLSL constraints properly (Check that we implement all GLSL constraints properly #20601)
• Properly implement "Completeness of Cube Map Framebuffer Attachments" (Properly implement "Completeness of Cube Map Framebuffer Attachments" #20654)
• Implement WebGL checks against feedback loops (Implement WebGL checks against feedback loops #21288)
• Properly implement stencil checks (Properly implement stencil checks #20555)
• Initialize textures to transparent black in some cases (Initialize textures to transparent black in some cases #21716)
• Validate source passed to gl.shaderSource() (Validate source passed to gl.shaderSource() #21754)

Pending implementations

• Support antialiasing's WebGL context option (Support antialiasing's WebGL context option #21285)
• Support discarding and recreating WebGL contexts (Support discarding and recreating WebGL contexts #15266)
• Implement compressed textures in WebGL (Implement compressed textures in WebGL #20594)
• Implement drawing a WebGL canvas into a 2D canvas (Implement drawing a WebGL canvas into a 2D canvas #21556)
• Implement ImageBitmap (Implement ImageBitmap #20650)
• Create smaller-than-requested drawing buffer when necessary (Create smaller-than-requested drawing buffer when necessary #21718)
• WebGL canvas is scaled when made fullscreen (WebGL canvas is scaled when made fullscreen #21290)
• Properly defend against overflows in WebGLRenderingContext.bufferSubData (Properly defend against overflows in WebGLRenderingContext.bufferSubData #20558)

Other pending things and improvements

• Steal Firefox knowledge about WebGL context robustness (Steal Firefox knowledge about WebGL context robustness #21144)
• Properly support WebIDL extended attribute [AllowShared] (Properly support WebIDL extended attribute [AllowShared] #20515)
• Cache drawingBufferWidth/drawingBufferHeight in WebGLRenderingContext (Cache drawingBufferWidth/drawingBufferHeight in WebGLRenderingContext #20530)
• Cache result of WebGLRenderingContext.getContextAttributes (Cache result of WebGLRenderingContext.getContextAttributes #20532)
• Don't allocate an empty buffer for nothing in WebGLRenderingContext.bufferData (Don't allocate an empty buffer for nothing in WebGLRenderingContext.bufferData #20557)
• Remove indirections for WebGL texture parameters (Remove indirections for WebGL texture parameters #20596)
• Clean up the WebGL extension infrastructure (Clean up the WebGL extension infrastructure #20642)
• Maybe introduce a new task source specific to WebGL (Maybe introduce a new task source specific to WebGL #20643)
• Khronos tests for WebGL shouldn't use an index in the test name (Khronos tests for WebGL shouldn't use an index in the test name #20668)
• [Throws] does not apply per-overload ([Throws] does not apply per-overload #20516)
• Crash when loading shader on html5test.com (Crash when loading shader on html5test.com #21191)
• WebGL water demo doesn't display anything (Overflow doesn't account for absolutely-positioned replaced content #21173)
• Firefox reports larger "max varying vectors", "max color buffer", and "max combined texture units" limits than Servo (Firefox reports larger "max varying vectors", "max color buffer", and "max combined texture units" limits than Servo #21172)
• Investigate real webgl-based apps (Investigate real webgl-based apps #21151)
• Build a WebGL profiler (Build a webgl profiler #21150)

Done stuff

• Check for invalid characters in WebGL location and attrib names (Check for invalid characters in WebGL location and attrib names #21287)
• Audit the behaviour of WebGLRenderingContext.getProgramInfoLog (Audit the behaviour of WebGLRenderingContext.getProgramInfoLog #20561)
• handle_object_deletion may be wrong (handle_object_deletion(webglrenderingcontext.rs) may be wrong #21352)
• Clear the framebuffer when initializing and resizing WebGL canvas (Clear the framebuffer when initializing and resizing webgl canvas #21475)
• Support unions as distinguishing WebIDL parameter (Support unions as distinguishing WebIDL parameter #20513)
• Implement the pending texImage2D overload (webgl: Implement the pending texImage2D overload, and add more validation #10443)
• Implement copyTexImage2D (Impl copyTexImage2D and copyTexSubImage2D #11147)
• Implement copyTexSubImage2D (Impl copyTexImage2D and copyTexSubImage2D #11147)
• Implement detachShader (WebGL: Finish, Flush, DetachShader, GenerateMipmap #10215)
• Implement finish (Implement WebGLRenderingContext.finish() #10212, WebGL: Finish, Flush, DetachShader, GenerateMipmap #10215)
• Implement flush (Implement WebGLRenderingContext.flush() #10213, WebGL: Finish, Flush, DetachShader, GenerateMipmap #10215)
• Implement framebufferRenderbuffer (webgl: Add support for framebuffer objects #13639)
• Implement framebufferTexture2D (webgl: Add support for framebuffer objects #13639)
• Implement generateMipmap (WebGL: Finish, Flush, DetachShader, GenerateMipmap #10215)
• Implement getActiveAttrib (Implement GetActiveAttrib #10379)
• Implement getActiveUniform (Implement WebGLRenderingContext.getActiveUniform() #10397)
• Implement getAttachedShaders (Implement WebGLRenderingContextBase.getAttachedShaders #20411)
• Implement getFramebufferAttachmentParameter (Implement WebGL getFrameBufferAttachmentParameter API #20317)
• Implement getProgramInfoLog (Implement WebGLRenderingContext::{validateProgram, getProgramInfoLog} #13199)
• Implement getRenderbufferParameter (Implement WebGLRenderingContext.getRenderbufferParameter #20514)
• Implement getTexParameter (Add WebGL function glGetTexParameter #20144)
• Implement getShaderPrecisionFormat (Implement WebGL::GetShaderPrecisionFormat #16544)
• Implement getUniform (Implement gl.getUniform() #21202)
• Implement getVertexAttrib
• Implement getVertexAttribOffset (Implement WebGL extensions #16893)
• Implement isBuffer (Implement WebGLRenderingContext.{isBuffer, isFramebuffer, isRenderbuffer}() #11357)
• Implement isEnabled (Implement WebGLRenderingContext::isEnabled #13040)
• Implement isFramebuffer (Implement WebGLRenderingContext.{isBuffer, isFramebuffer, isRenderbuffer}() #11357)
• Implement isRenderBuffer (Implement WebGLRenderingContext.{isBuffer, isFramebuffer, isRenderbuffer}() #11357)
• Implement isShader (Implement IsShader fn and IsTexture fn for WebGLRenderingContext #11072)
• Implement isTexture (Implement IsShader fn and IsTexture fn for WebGLRenderingContext #11072)
• Implement readPixels (Implement WebGLRenderingContextBase::readPixels(). #10668)
• Implement renderbufferStorage (webgl: Add basic support for framebuffer attachments #13872)
• Implement sampleCoverage
• Implement stencilFunc (Implement WebGLRenderingContext::stencil* #10659)
• Implement stencilFuncSeparate (Implement WebGLRenderingContext::stencil* #10659)
• Implement stencilMask (Implement WebGLRenderingContext::stencil* #10659)
• Implement stencilMaskSeparate (Implement WebGLRenderingContext::stencil* #10659)
• Implement stencilOp (Implement WebGLRenderingContext::stencil* #10659)
• Implement stencilOpSeparate (Implement WebGLRenderingContext::stencil* #10659)
• Implement texSubImage2D (Implement WebGL TexSubImage2D #11168)
• Implement uniform1i (Implement the remaining WebGLRenderingContext uniform methods #10417)
• Implement uniform1iv (Implement the remaining WebGLRenderingContext uniform methods #10417)
• Implement uniform2f (WebGL: add Uniform2f #10356)
• Implement uniform2fv (Implement the remaining WebGLRenderingContext uniform methods #10417)
• Implement uniform2i (Implement the remaining WebGLRenderingContext uniform methods #10417)
• Implement uniform2iv (Implement the remaining WebGLRenderingContext uniform methods #10417)
• Implement uniform3f (Implement the remaining WebGLRenderingContext uniform methods #10417)
• Implement uniform3fv (Implement the remaining WebGLRenderingContext uniform methods #10417)
• Implement uniform3i (Implement the remaining WebGLRenderingContext uniform methods #10417)
• Implement uniform3iv (Implement the remaining WebGLRenderingContext uniform methods #10417)
• Implement uniform4i (Implement WebGLRenderingContext.{uniform4iv(), uniform4i()} #10368)
• Implement uniform4iv (Implement WebGLRenderingContext.{uniform4iv(), uniform4i()} #10368)
• Implement uniformMatrix2fv (Implement uniformMatrix*v #10671)
• Implement uniformMatrix3fv (Implement uniformMatrix*v #10671)
• Implement uniformMatrix4fv (Implement uniformMatrix*v #10671)
• Implement validateProgram (Implement WebGLRenderingContext::{validateProgram, getProgramInfoLog} #13199)
• Properly check for limit in WebGLRenderingContext.activeTexture (Properly check for limit in WebGLRenderingContext.activeTexture #20531)
• Implement gl.getParameter(gl.ALIASED_LINE_WIDTH_RANGE) (Implement gl.getParameter(gl.ALIASED_LINE_WIDTH_RANGE) #20535)
• Implement gl.getParameter(gl.BLEND_COLOR) (Implement gl.getParameter(gl.BLEND_COLOR) #20536)
• Implement gl.getParameter(gl.COLOR_CLEAR_VALUE) (Implement gl.getParameter(gl.COLOR_CLEAR_VALUE) #20537)
• Implement gl.getParameter(gl.COLOR_WRITEMASK) (Implement gl.getParameter(gl.COLOR_WRITEMASK) #20538)
• Implement gl.getParameter(gl.COMPRESSED_TEXTURE_FORMATS) (Implement gl.getParameter(gl.COMPRESSED_TEXTURE_FORMATS) #20544)
• Implement gl.getParameter(gl.DEPTH_RANGE) (Implement gl.getParameter(gl.DEPTH_RANGE) #20545)
• Implement gl.getParameter(gl.GENERATE_MIPMAP_HINT) (Implement gl.getParameter(gl.GENERATE_MIPMAP_HINT) #20546)
• Support IMPLEMENTATION_COLOR_READ_FORMAT and IMPLEMENTATION_COLOR_READ_TYPE (Support IMPLEMENTATION_COLOR_READ_FORMAT and IMPLEMENTATION_COLOR_READ_TYPE #20547)
• Support MAX_FRAGMENT_UNIFORM_VECTORS and MAX_VERTEX_UNIFORM_VECTORS (Support MAX_FRAGMENT_UNIFORM_VECTORS and MAX_VERTEX_UNIFORM_VECTORS #20548)
• Implement gl.getParameter(gl.MAX_VARYING_VECTORS) (Implement gl.getParameter(gl.MAX_VARYING_VECTORS) #20549)
• Support SCISSOR_TEST and SCISSOR_BOX (Support SCISSOR_TEST and SCISSOR_BOX #20551)
• Implement gl.getParameter(gl.UNPACK_COLORSPACE_CONVERSION_WEBGL) (Implement gl.getParameter(gl.UNPACK_COLORSPACE_CONVERSION_WEBGL) #20552)
• Implement gl.getParameter(gl.UNPACK_FLIP_Y_WEBGL) (Implement gl.getParameter(gl.UNPACK_FLIP_Y_WEBGL) #20553)
• Implement gl.getParameter(gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL) (Implement gl.getParameter(gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL) #20554)
• Properly implement WebGLRenderingContext.bindBuffer checks (Properly implement WebGLRenderingContext.bindBuffer checks #20556)
• Properly implement the checks for gl.renderbufferStorage (Properly implement the checks for gl.renderbufferStorage #20563)
• Audit the checks in WebGLRenderingContext.getFramebufferAttachmentParameter (Audit the checks in WebGLRenderingContext.getFramebufferAttachmentParameter #20593)
• Properly check the argument of WebGLRenderingContext.clear (Properly check the argument of WebGLRenderingContext.clear #20623)
• Check whether we bind GLclampf correctly (Check whether we bind GLclampf correctly #20652)
• Return the correct types in gl.getParameter and friends (Return the correct types in gl.getParameter and friends #20655)
• Properly check that WebGL objects are passed to the right WebGL context (Properly check that WebGL objects are passed to the right WebGL context #21133)
• Implement attribute aliasing check in WebGL (Implement attribute aliasing check in WebGL #21136)
• Fix uninitialized data leak from renderbufferStorage (webgl: uninitialized data leak from renderbufferStorage() #13710)
• WebGLShader destructor frequently asserts when closing webgl pages (WebGLShader destructor frequently asserts when closing webgl pages #21177)
• Re-check our validations when there are multiple WebGLRenderingContexts in the same page.
• Create tests for the changes in Four nondescript WebGL improvements #20598 (Create tests for the changes in #20598 #20607)
• Make our validations strongly-typed (webgl: Implement a type safe wrapper for WebGL-related validations #10693)
• Remove indirections for some WebGL parameters (Remove indirections for some WebGL parameters #20550)
• Stop re-exporting WebGLCommand as CanvasWebGLMessage (Stop re-exporting webrender_traits WebGL types from canvas_traits #10211)
• Update our angle dependency
• Test using the WebGL conformance test suite (Enable WebGL tests #10373)
• Update our interpretation of the spec to match other browser engines (Mimic other browser vendors when passing unexpected null values to WebGL methods #8753)
• Cache which server-side GL capabilities are enabled (Cache which server-side GL capabilities are enabled #20534)
• Remove indirections for WebGL program parameters (Remove indirections for WebGL program parameters #20560)
• Remove indirections for WebGL shader parameters (Remove indirections for WebGL shader parameters #20562)
• Audit that the framebuffer status is properly updated in WebGL (Audit that the framebuffer status is properly updated in WebGL #20570)
• Cache the info needed for gl.getActiveAttrib and gl.getActiveUniform (Cache the info needed for gl.getActiveAttrib and gl.getActiveUniform #20600)
• Cache info needed for gl.getVertexAttrib and gl.getVertexAttribOffset (Cache info needed for gl.getVertexAttrib and gl.getVertexAttribOffset #20608)
• Only mark canvas as dirty when no framebuffer is bound (Only mark canvas as dirty when no framebuffer is bound #21691)
• Check for renderbuffer storage exceeding max renderbuffer size (Check for renderbuffer storage exceeding max renderbuffer size #21485)
• gl-pointcoord.html doesn't draw anything (gl-pointcoord.html doesn't draw anything #21719)
• oes-texture-half-float.html panics with a GL error when running in desktop mode (oes-texture-half-float.html panics with a GL error when running in desktop mode #21663)
• Implement component check in Image2D methods (Implement component check in Image2D methods #20595)
• Support preserveDrawingBuffer's WebGL context option (Support preserveDrawingBuffer's WebGL context option #21132)

[emilio]

cc @dmarcos

[cbrewster]

I will be working on implementing generateMipmap

[emilio]

@ConnorGBrewster I opened #10226, let's discuss there :)

[saurvs]

I'd like to work on getActiveUniform

[emilio]

@saurvs I opened #10397 for you, feel free to ask any question you might have there :)

[autrilla]

I'd like to work on all of the remaining uniform methods, if that's okay

[emilio]

@autrilla They're yours! I've opened #10417 to keep track of them, feel free to leave any questions there :)

[KiChjang]

I'm looking at the stencil* functions.

[dlrobertson]

I'm taking a crack at copyTex* and texSubImage2D

[ddefisher]

Attempting

Implement isShader
Implement isTexture

[daoshengmu]

I would like to help texSubImage2D

[emilio]

@daoshengmu: sounds great!

@danlrobertson, are you still working on texSubImage2D?

[daoshengmu]

@danlrobertson Sorry for I didn't notice you are working on texSubImage2D. I just want to help some implementation of WebGL. If you are still working on it, I can pick copyTexImage2D and copyTexSubImage2D @emilio

[dlrobertson]

@daoshengmu No problem! It's totally okay! It's my bad for taking so long to get a PR in, but alas life happens 😄...

Are you okay with taking texSubImage2D? I already implemented the necesary components in wr_traits. I should have a PR in shortly for copyTex*, but I actually hadn't started on texSubImage2D. If you want texSubImage2D, go for it! I have no particular attachment to it. Just wanted to learn a bit about webgl code...

[daoshengmu]

@danlrobertson Sure. I will take texSubImage2D. Thanks! 😄

[gootorov]

Working on getFramebufferAttachmentParameter().

[fnune]

I'd like to do getRenderbufferParameter

[atouchet]

This issue no longer seems to be keeping a record of edits anymore for some reason.

Edit: It looks to be working now.

[nox]

I added a bunch of issues.