XRProjectionLayer: textureHeight property

Limited availability

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

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The read-only textureHeight property of the XRProjectionLayer interface indicates the height in pixels of the color textures of this layer.

The projection layer's texture height is determined by the user agent or the device. It is reported in the XRSubImage, which can only be accessed inside the frame loop. If you want to manage your own depth buffers and don't want to wait for first frame after layer creation to determine the required dimensions for those buffers, the textureHeight property allows access to layer texture height outside the frame loop. Allocation of these buffers can happen directly after layer creation.

Value

A number indicating the height in pixels.

Examples

Using textureHeight

The textureHeight of a layer is useful when creating render buffers for a layer. See also WebGL2RenderingContext.renderbufferStorageMultisample().

js
let glLayer = xrGLBinding.createProjectionLayer();

let color_rb = gl.createRenderbuffer();
gl.bindRenderbuffer(gl.RENDERBUFFER, color_rb);
gl.renderbufferStorageMultisample(
  gl.RENDERBUFFER,
  samples,
  gl.RGBA8,
  glLayer.textureWidth,
  glLayer.textureHeight,
);

Specifications

Specification
WebXR Layers API Level 1
# dom-xrprojectionlayer-textureheight

Browser compatibility

BCD tables only load in the browser

See also