XRVisibilityMaskChangeEvent: index property

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

The index read-only property of the XRVisibilityMaskChangeEvent interface indicates the index of the current XRView in the XRViewerPose.views array.

For a stereo view, there will be two views in the array. The index property allows you to identify the correct view to re-render, rather than having to re-render all views unnecessarily.

Value

A number.

Examples

This example indicates how you might render a display update for a particular XRView by querying the index value of the event object when a visibilitymaskchange event is fired.

js
xrSession.addEventListener("visibilitymaskchange", (e) => {
  renderNewView(e.index);
});

Specifications

Specification
WebXR Device API
# dom-xrvisibilitymaskchangeevent-index

Browser compatibility

See also