TheXRLightProbe interface of theWebXR Device API contains lighting information at a given point in the user's environment. You can get anXRLighting object using theXRSession.requestLightProbe() method.

This object doesn't itself contain lighting values, but it is used to collect lighting states for eachXRFrame. SeeXRLightEstimate for the estimated lighting values for anXRLightProbe.

Instance properties

XRLightProbe.onreflectionchange

Event handler property for thereflectionchange event.

XRLightProbe.probeSpaceRead onlyExperimental

AnXRSpace tracking the position and orientation the lighting estimations are relative to.

Instance methods

None.

Events

reflectionchangeExperimental

Fired each time the estimated reflection cube map changes. (This happens when the user moves around and the environment's lighting changes.)

Examples

Getting anXRLightProbe object for a session

Use theXRSession.requestLightProbe() method to get a light probe.

const lightProbe = await xrSession.requestLightProbe();

Getting a probe pose within anXRFrame

Pass the light probe'sprobeSpace toXRFrame.getPose() to get a light probe for a pose.

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

Using thereflectionchange event

PassXRLightProbe to get a reflection cube map whenever thereflectionchange event fires. See alsoXRWebGLBinding.getReflectionCubeMap().

const glBinding = new XRWebGLBinding(xrSession, gl);const lightProbe = await xrSession.requestLightProbe();let glCubeMap = glBinding.getReflectionCubeMap(lightProbe);lightProbe.addEventListener("reflectionchange", () => {  glCubeMap = glBinding.getReflectionCubeMap(lightProbe);});

Specifications

Browser compatibility

See also

• XRSession.requestLightProbe()