ContextQMD
Back to Content

WEBGL_depth_texture extension

files/en-us/web/api/webgl_depth_texture/index.md

latest1.9 KB
Original Source

{{APIRef("WebGL")}}

The WEBGL_depth_texture extension is part of the WebGL API and defines 2D depth and depth-stencil textures.

WebGL extensions are available using the {{domxref("WebGLRenderingContext.getExtension()")}} method. For more information, see also Using Extensions in the WebGL tutorial.

[!NOTE] This extension is only available to {{domxref("WebGLRenderingContext", "WebGL1", "", 1)}} contexts. In {{domxref("WebGL2RenderingContext", "WebGL2", "", 1)}}, the functionality of this extension is available on the WebGL2 context by default. The constant in WebGL2 is gl.UNSIGNED_INT_24_8.

Constants

This extension adds a new constant:

  • ext.UNSIGNED_INT_24_8_WEBGL
    • : Unsigned integer type for 24-bit depth texture data.

Extended methods

This extension extends {{domxref("WebGLRenderingContext.texImage2D()")}}:

  • The format and internalformat parameters now accept gl.DEPTH_COMPONENT and gl.DEPTH_STENCIL.
  • The type parameter now accepts gl.UNSIGNED_SHORT, gl.UNSIGNED_INT, and ext.UNSIGNED_INT_24_8_WEBGL.
  • The pixels parameter now accepts a {{jsxref("Uint16Array")}} or a {{jsxref("Uint32Array")}} object.

This extension extends {{domxref("WebGLRenderingContext.framebufferTexture2D()")}}:

  • The attachment parameter now accepts gl.DEPTH_STENCIL_ATTACHMENT.

Examples

js
const ext = gl.getExtension("WEBGL_depth_texture");

gl.texImage2D(
  gl.TEXTURE_2D,
  0,
  gl.DEPTH_COMPONENT,
  512,
  512,
  0,
  gl.DEPTH_COMPONENT,
  gl.UNSIGNED_SHORT,
  null,
);

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("WebGLRenderingContext.getExtension()")}}
  • {{domxref("WebGLRenderingContext.texImage2D()")}}
  • {{domxref("WebGLRenderingContext.framebufferTexture2D()")}}