XRWebGLLayer.framebufferWidth

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.

Syntax

let bufferWidth = xrWebGLLayer.framebufferWidth;

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 Status Comment
WebXR Device API
The definition of 'XRWebGLLayer.framebufferWidth' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser

See also