Search

Search something to see results

GitHub

XRFrame

Implements

Implemented by

Index

Constructors

<internal>.XRFrame.constructor

Properties

<internal>.XRFrame.session<internal>.XRFrame.predictedDisplayTime<internal>.XRFrame.trackedAnchors<internal>.XRFrame.createAnchor<internal>.XRFrame.detectedPlanes<internal>.XRFrame.detectedMeshes<internal>.XRFrame.getJointPose

Methods

<internal>.XRFrame.getPose<internal>.XRFrame.getViewerPose<internal>.XRFrame.getHitTestResults<internal>.XRFrame.getHitTestResultsForTransientInput<internal>.XRFrame.getDepthInformation

Constructors

new XRFrame(): XRFrame

Returns XRFrame

Properties

session: XRSession
predictedDisplayTime: number
trackedAnchors?: XRAnchorSet
createAnchor?: (
    pose: XRRigidTransform,
    space: XRSpace,
) => undefined | Promise<XRAnchor>
detectedPlanes?: XRPlaneSet

XRFrame is extended to contain detectedPlanes attribute which contains all planes that are still tracked in the frame.

The set is initially empty and will be populated by the update planes algorithm. If this attribute is accessed when the frame is not active, the user agent MUST throw InvalidStateError.

https://immersive-web.github.io/real-world-geometry/plane-detection.html#plane-set

detectedMeshes?: XRMeshSet

XRFrame is extended to contain detectedMeshes attribute which contains all meshes that are still tracked in the frame.

The set is initially empty and will be populated by the update meshes algorithm. If this attribute is accessed when the frame is not active, the user agent MUST throw InvalidStateError.

https://immersive-web.github.io/real-world-meshing/#mesh-set

getJointPose?: (
    joint: XRJointSpace,
    baseSpace: XRSpace,
) => undefined | XRJointPose

Methods

getPose(space: XRSpace, baseSpace: XRSpace): undefined | XRPose

Provides the pose of space relative to baseSpace as an XRPose, at the time represented by the XRFrame.

Parameters

Returns undefined | XRPose

getViewerPose(referenceSpace: XRReferenceSpace): undefined | XRViewerPose

Provides the pose of the viewer relative to referenceSpace as an XRViewerPose, at the XRFrame's time.

Parameters

Returns undefined | XRViewerPose

getHitTestResults(hitTestSource: XRHitTestSource): XRHitTestResult[]

Parameters

Returns XRHitTestResult[]

getHitTestResultsForTransientInput(
    hitTestSource: XRTransientInputHitTestSource,
): XRTransientInputHitTestResult[]

Parameters

Returns XRTransientInputHitTestResult[]

getDepthInformation(view: XRView): undefined | null | XRCPUDepthInformation

Parameters

Returns undefined | null | XRCPUDepthInformation