WebIDLpedia

Definition

WebXR Device API defines XRFrame

[SecureContext, Exposed=Window] interface XRFrame {
  [SameObject] readonly attribute XRSession session;
  readonly attribute DOMHighResTimeStamp predictedDisplayTime;

  XRViewerPose? getViewerPose(XRReferenceSpace referenceSpace);
  XRPose? getPose(XRSpace space, XRSpace baseSpace);
};

This interface is extended in the following specifications:

• WebXR Anchors Module

  
  
  partial interface XRFrame {
    Promise<XRAnchor> createAnchor(XRRigidTransform pose, XRSpace space);
  };
  
  partial interface XRFrame {
    [SameObject] readonly attribute XRAnchorSet trackedAnchors;
  };

• WebXR Plane Detection Module

  
  
  partial interface XRFrame {
    readonly attribute XRPlaneSet detectedPlanes;
  };

• WebXR Mesh Detection Module

  
  
  partial interface XRFrame {
    readonly attribute XRMeshSet detectedMeshes;
  };

• WebXR Depth Sensing Module

  
  
  partial interface XRFrame {
    XRCPUDepthInformation? getDepthInformation(XRView view);
  };

• WebXR Hand Input Module - Level 1

  
  
  partial interface XRFrame {
      XRJointPose? getJointPose(XRJointSpace joint, XRSpace baseSpace);
      boolean fillJointRadii(sequence<XRJointSpace> jointSpaces, Float32Array radii);
  
      boolean fillPoses(sequence<XRSpace> spaces, XRSpace baseSpace, Float32Array transforms);
  };

• WebXR Hit Test Module

  
  
  partial interface XRFrame {
    sequence<XRHitTestResult> getHitTestResults(XRHitTestSource hitTestSource);
    sequence<XRTransientInputHitTestResult> getHitTestResultsForTransientInput(XRTransientInputHitTestSource hitTestSource);
  };

• WebXR Lighting Estimation API Level 1

  
  
  partial interface XRFrame {
    XRLightEstimate? getLightEstimate(XRLightProbe lightProbe);
  };

[SecureContext, Exposed=Window] interface XRFrame {
  [SameObject] readonly attribute XRSession session;
  readonly attribute DOMHighResTimeStamp predictedDisplayTime;

  XRViewerPose? getViewerPose(XRReferenceSpace referenceSpace);
  XRPose? getPose(XRSpace space, XRSpace baseSpace);
  Promise<XRAnchor> createAnchor(XRRigidTransform pose, XRSpace space);
  [SameObject] readonly attribute XRAnchorSet trackedAnchors;
  readonly attribute XRPlaneSet detectedPlanes;
  readonly attribute XRMeshSet detectedMeshes;
  XRCPUDepthInformation? getDepthInformation(XRView view);
    XRJointPose? getJointPose(XRJointSpace joint, XRSpace baseSpace);
    boolean fillJointRadii(sequence<XRJointSpace> jointSpaces, Float32Array radii);

    boolean fillPoses(sequence<XRSpace> spaces, XRSpace baseSpace, Float32Array transforms);
  sequence<XRHitTestResult> getHitTestResults(XRHitTestSource hitTestSource);
  sequence<XRTransientInputHitTestResult> getHitTestResultsForTransientInput(XRTransientInputHitTestSource hitTestSource);
  XRLightEstimate? getLightEstimate(XRLightProbe lightProbe);
};

Methods and attributes that return objects implementing XRFrame

• XRInputSourceEvent.frame

Referring IDL interfaces/dictionaries

• XRInputSourceEvent
• XRInputSourceEventInit
• XRWebGLBinding

Referring specifications

• WebXR Anchors Module refers to XRFrame
• WebXR Plane Detection Module refers to XRFrame
• WebXR Mesh Detection Module refers to XRFrame
• WebXR Depth Sensing Module refers to XRFrame
• WebXR Hand Input Module - Level 1 refers to XRFrame
• WebXR Hit Test Module refers to XRFrame
• WebXR Lighting Estimation API Level 1 refers to XRFrame
• WebXR Layers API Level 1 refers to XRFrame