WebXR Device API
The XRLightEstimate interface of the WebXR Device API provides the estimated lighting values for an XRLightProbe at the time represented by an XRFrame.
To get an XRLightEstimate object, call the XRFrame.getLightEstimate() method.
Instance properties
- XRLightEstimate.primaryLightDirection
- : A DOMPointReadOnly representing the direction to the primary light source from the
probeSpaceof an XRLightProbe.
- : A DOMPointReadOnly representing the direction to the primary light source from the
- XRLightEstimate.primaryLightIntensity
- : A DOMPointReadOnly (with the
x,y,zvalues mapped to RGB) representing the intensity of the primary light source from theprobeSpaceof an XRLightProbe.
- : A DOMPointReadOnly (with the
- XRLightEstimate.sphericalHarmonicsCoefficients
- : A Float32Array containing 9 spherical harmonics coefficients.
Instance methods
None.
Examples
Getting an XRLightProbe object
First, use the XRSession.requestLightProbe() method to get a light probe from a session.
Then, within an XRFrame loop, the XRFrame.getLightEstimate method will return a XRLightEstimate object containing the lighting values for each frame.
const lightProbe = await xrSession.requestLightProbe();
// frame loop
function onXRFrame(time, xrFrame) {
let lightEstimate = xrFrame.getLightEstimate(lightProbe);
// Use light estimate data to light the scene
// Available properties
lightEstimate.sphericalHarmonicsCoefficients;
lightEstimate.primaryLightDirection;
lightEstimate.primaryLightIntensity;
}
Specifications
Browser compatibility
See also
- XRFrame.getLightEstimate()
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
