MDN self-hosted library · e01.org

XRLightProbe: reflectionchange event

WebXR Device API

WebXR Device API

The WebXR reflectionchange event fires each time the estimated reflection cube map changes. This happens in response to use movements through different lighting conditions or to direct changes to lighting itself. This event is not cancelable.

Syntax

Use the event name in addEventListener():

addEventListener("reflectionchange", (event) => { })

Alternatively, assign to the event handler property of the interface:

onreflectionchange = (event) => { }

Event type

Event.

Examples

Using the reflectionchange event

Whenever the reflectionchange event fires on a light probe, you can retrieve an updated cube map by calling XRWebGLBinding.getReflectionCubeMap(). This is less expensive than retrieving lighting information with every XRFrame.

const glBinding = new XRWebGLBinding(xrSession, gl);
const lightProbe = await xrSession.requestLightProbe();
let glCubeMap = glBinding.getReflectionCubeMap(lightProbe);

lightProbe.addEventListener("reflectionchange", () => {
  glCubeMap = glBinding.getReflectionCubeMap(lightProbe);
});

The onreflectionchange event handler property

The reflectionchange event is also available using the onreflectionchange event handler property (but note that this replaces other event listeners added using onreflectionchange, if any).

lightProbe.onreflectionchange = (event) => {
  glCubeMap = glBinding.getReflectionCubeMap(lightProbe);
};

Specifications

Browser compatibility

See also

  • addEventListener()