Web/API/WebGL2RenderingContext/invalidateSubFramebuffer

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The WebGL2RenderingContext.invalidateSubFramebuffer() method of the WebGL 2 API invalidates portions of the contents of attachments in a framebuffer.

Syntax

void gl.invalidateSubFramebuffer(target, attachments, x, y, width, height);

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.

attachments: An Array of GLenum specifying the attachment points to invalidate. Possible values:

gl.COLOR_ATTACHMENT{0-15}

Invalidates one of the framebuffer's color buffers.
gl.DEPTH_ATTACHMENT: Invalidates the framebuffer's depth buffer.
gl.STENCIL_ATTACHMENT: Invalidates the framebuffer's stencil buffer.
gl.DEPTH_STENCIL_ATTACHMENT: Invalidates both the framebuffer's depth and stencil buffer.

x: A GLint specifying the left origin of the pixel rectangle to invalidate.
y: A GLint specifying the bottom origin of the pixel rectangle to invalidate.
width: A GLsizei specifying the width of the pixel rectangle to invalidate.
height: A GLsizei specifying the height of the pixel rectangle to invalidate.

Return value

None.

Examples

gl.invalidateSubFramebuffer(gl.READ_FRAMEBUFFER, 
                            [gl.COLOR_ATTACHMENT0, gl.COLOR_ATTACHMENT1],
                            0, 0, 256, 256);

Specifications

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

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`invalidateSubFramebuffer`	Chrome Full support 56	Edge Full support 79	Firefox Full support 51	IE No support No	Opera Full support 43	Safari No support No	WebView Android Full support 58	Chrome Android Full support 58	Firefox Android Full support 51	Opera Android Full support 43	Safari iOS No support No	Samsung Internet Android Full support 7.0

Legend

Full support: Full support
No support: No support