XRWebGLLayer: framebufferWidth property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

experimental technology
Check the Browser compatibility table carefully before using this in production.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The read-only XRWebGLLayer property framebufferWidth specifies the width of the framebuffer, in pixels.

You can get the height of the framebuffer using the framebufferHeight property.

Value

The width in pixels of the XR device's framebuffer. Each of the framebuffer's attachments (pixel, depth, color, and/or stencil buffers, for example) are all this many pixels wide.

Examples

This snippet fetches the framebuffer's width and height for later use.

let glLayer = xrSession.renderState.baseLayer;
gl.bindFramebuffer(gl.FRAMEBUFFER, glLayer.framebuffer);

frameWidth = glLayer.framebufferWidth;
frameHeight = glLayer.framebufferHeight;

Specifications

Specification
WebXR Device API # dom-xrwebgllayer-framebufferwidth

Browser compatibility

BCD tables only load in the browser

Value

Examples

Specifications

Browser compatibility

See also