XRLightProbe.probeSpace

The read-only probeSpace property of the XRLightProbe interface returns an XRSpace tracking the position and orientation that the lighting estimations are relative to.

Value

An XRSpace object.

Examples

The probeSpace property returns the position and orientation in space that the lighting estimate is relative to. It may update over time as the user moves around. Use the XRFrame.getPose() method to get the current lighting state with each frame.

const lightProbe = await xrSession.requestLightProbe();
const probePose = xrFrame.getPose(lightProbe.probeSpace, xrReferenceSpace);

Specifications

Specification
WebXR Lighting Estimation API Level 1 (WebXR Lighting Estimation API 1)
# dom-xrlightprobe-probespace

Browser compatibility

BCD tables only load in the browser

See also