WebGL2RenderingContext.framebufferTextureLayer()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The WebGL2RenderingContext.framebufferTextureLayer() method of the WebGL 2 API attaches a single layer of a texture to a framebuffer.

This method is similar to WebGLRenderingContext.framebufferTexture2D(), but only a given single layer of the texture level is attached to the attachment point.

Syntax

void gl.framebufferTextureLayer(target, attachment, texture, level, layer);

Parameters

target
A GLenum specifying the binding point (target). Possible values:
  • gl.FRAMEBUFFER: Collection buffer data storage of color, alpha, depth and stencil buffers used to render an image.
  • gl.DRAW_FRAMEBUFFER: Equivalent to gl.FRAMEBUFFER.
  • gl.READ_FRAMEBUFFER: Used as a source for reading operations.
attachment
A GLenum specifying the attachment point for the texture. Possible values:
  • gl.COLOR_ATTACHMENT{0-15}: Attaches the texture to one of the framebuffer's color buffers.
  • gl.DEPTH_ATTACHMENT: Attaches the texture to the framebuffer's depth buffer.
  • gl.STENCIL_ATTACHMENT: Attaches the texture to the framebuffer's stencil buffer.
  • gl.DEPTH_STENCIL_ATTACHMENT: depth and stencil buffer.
texture
A WebGLTexture object whose image to attach.
level
A GLint specifying the mipmap level of the texture image to attach.
layer
A GLint specifying the layer of the texture image to attach.

Return value

None.

Examples

gl.framebufferTextureLayer(gl.FRAMEBUFFER, gl.COLOR_ATTACHMENT0, 
                           texture, 0, 8);

Specifications

Specification Status Comment
WebGL 2.0
The definition of 'framebufferTextureLayer' in that specification.
Editor's Draft Initial definition for WebGL.
OpenGL ES 3.0
The definition of 'glFramebufferTextureLayer' in that specification.
Standard Man page of the (similar) OpenGL API.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support No support [2] Nightly build [1] No support No support No support
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support No support No support No support No support No support No support

[1] WebGL 2 is enabled by default in Firefox Nightly. To enable it in a release version of Firefox, set the preference webgl.enable-prototype-webgl2 to true in about:config.

[2] To use an experimental implementation of WebGL 2 in Chrome, you have to start Chrome with the runtime flag --enable-unsafe-es3-apis.

See also

Document Tags and Contributors

 Contributors to this page: fscholz
 Last updated by: fscholz,