W3cubDocs

/Web APIs

WebGL2RenderingContext: invalidateSubFramebuffer() method

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

Syntax

js

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 (undefined).

Examples

js

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

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
invalidateSubFramebuffer 56 79 51 No 43 15 58 58 51 43 15 7.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/invalidateSubFramebuffer