XRLightProbe
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The XRLightProbe
interface of the WebXR Device API contains lighting information at a given point in the user's environment. You can get an XRLighting
object using the XRSession.requestLightProbe()
method.
This object doesn't itself contain lighting values, but it is used to collect lighting states for each XRFrame
. See XRLightEstimate
for the estimated lighting values for an XRLightProbe
.
Instance properties
XRLightProbe.onreflectionchange
-
Event handler property for the
reflectionchange
event. XRLightProbe.probeSpace
Read only Experimental-
An
XRSpace
tracking the position and orientation the lighting estimations are relative to.
Instance methods
None.
Events
reflectionchange
Experimental-
Fired each time the estimated reflection cube map changes. (This happens when the user moves around and the environment's lighting changes.)
Examples
Getting an XRLightProbe
object for a session
Use the XRSession.requestLightProbe()
method to get a light probe.
js
const lightProbe = await xrSession.requestLightProbe();
Getting a probe pose within an XRFrame
Pass the light probe's probeSpace
to XRFrame.getPose()
to get a light probe for a pose.
js
const probePose = xrFrame.getPose(lightProbe.probeSpace, xrReferenceSpace);
Using the reflectionchange
event
Pass XRLightProbe
to get a reflection cube map whenever the reflectionchange
event fires. See also XRWebGLBinding.getReflectionCubeMap()
.
js
const glBinding = new XRWebGLBinding(xrSession, gl);
const lightProbe = await xrSession.requestLightProbe();
let glCubeMap = glBinding.getReflectionCubeMap(lightProbe);
lightProbe.addEventListener("reflectionchange", () => {
glCubeMap = glBinding.getReflectionCubeMap(lightProbe);
});
Specifications
Specification |
---|
WebXR Lighting Estimation API Level 1 # xrlightprobe-interface |
Browser compatibility
BCD tables only load in the browser