WebXR Device API
The getLightEstimate() method of the XRFrame interface returns an XRLightEstimate object containing estimated lighting values for a given XRLightProbe.
Syntax
getLightEstimate(lightProbe)
Parameters
lightProbe- : An XRLightProbe object containing the current lighting state for the frame.
Return value
An XRLightEstimate object or null if the device cannot estimate lighting for this frame.
Examples
Getting light estimates for each frame
Given a session's XRLightProbe, the getLightEstimate() method gets an 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
- XRLightEstimate
- XRLightProbe
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
