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 simply 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

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
framebufferWidthChrome Full support 79Edge Full support 79Firefox No support NoIE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android Full support 79Firefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android Full support 11.2

Legend

Full support
Full support
No support
No support

See also