XRSession | Babylon.js API documentation

Class XRSession`Abstract`

Hierarchy

EventTarget
- XRSession

Implements

XRSession

Implemented by

XRSession

Constructors

constructor

new XRSession(): XRSession
Returns XRSession

Properties

`Readonly`depthDataFormat

depthDataFormat: XRDepthDataFormat

`Readonly`depthUsage

depthUsage: XRDepthUsage

`Optional` `Readonly`domOverlayState

domOverlayState?: XRDOMOverlayState

enabledFeatures

enabledFeatures: string[]

`Readonly`environmentBlendMode

environmentBlendMode: XREnvironmentBlendMode

`Optional` `Readonly`frameRate

frameRate?: number

`Readonly`inputSources

inputSources: XRInputSourceArray

Returns a list of this session's XRInputSources, each representing an input device used to control the camera and/or scene.

`Optional` `Readonly`preferredReflectionFormat

preferredReflectionFormat?: XRReflectionFormat

`Readonly`renderState

renderState: XRRenderState

object which contains options affecting how the imagery is rendered. This includes things such as the near and far clipping planes

`Optional`requestHitTest

requestHitTest?: (
ray: XRRay,
referenceSpace: XRReferenceSpace,
) => Promise<XRHitResult[]>

`Optional`requestHitTestSource

requestHitTestSource?: (
options: XRHitTestOptionsInit,
) => Promise<XRHitTestSource>

`Optional`requestHitTestSourceForTransientInput

requestHitTestSourceForTransientInput?: (
options: XRTransientInputHitTestOptionsInit,
) => Promise<XRTransientInputHitTestSource>

`Optional` `Readonly`supportedFrameRates

supportedFrameRates?: Float32Array

`Optional`updateWorldTrackingState

updateWorldTrackingState?: (
options: { planeDetectionState?: { enabled: boolean } },
) => undefined | void

`Readonly`visibilityState

visibilityState: XRVisibilityState

Methods

addEventListener

addEventListener<K extends keyof XRSessionEventMap>(
    type: K,
    listener: (this: XRSession, ev: XRSessionEventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Type Parameters
- K extends keyof XRSessionEventMap
Parameters
- type: K
- listener: (this: XRSession, ev: XRSessionEventMap[K]) => any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141800
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141801

cancelAnimationFrame

cancelAnimationFrame(id: number): void
Removes a callback from the animation frame painting callback from XRSession's set of animation frame rendering callbacks, given the identifying handle returned by a previous call to requestAnimationFrame().
Parameters
- id: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141760

end

end(): Promise<void>
Ends the WebXR session. Returns a promise which resolves when the session has been shut down.

Returns Promise<void>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141766

`Optional`getTrackedImageScores

getTrackedImageScores(): Promise<XRImageTrackingScore[]>
Returns Promise<XRImageTrackingScore[]>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:142465

`Optional`initiateRoomCapture

initiateRoomCapture(): Promise<void>
Returns Promise<void>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:142424

removeEventListener

removeEventListener<K extends keyof XRSessionEventMap>(
    type: K,
    listener: (this: XRSession, ev: XRSessionEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Type Parameters
- K extends keyof XRSessionEventMap
Parameters
- type: K
- listener: (this: XRSession, ev: XRSessionEventMap[K]) => any
- Optionaloptions: boolean | EventListenerOptions
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141802
removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141803

requestAnimationFrame

requestAnimationFrame(callback: XRFrameRequestCallback): number
Schedules the specified method to be called the next time the user agent is working on rendering an animation frame for the WebXR device. Returns an integer value which can be used to identify the request for the purposes of canceling the callback using cancelAnimationFrame(). This method is comparable to the Window.requestAnimationFrame() method.
Parameters
- callback: XRFrameRequestCallback
Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141775

requestLightProbe

requestLightProbe(options?: XRLightProbeInit): Promise<XRLightProbe>
The XRSession interface is extended with the ability to create new XRLightProbe instances. XRLightProbe instances have a session object, which is the XRSession that created this XRLightProbe.

Can reject with with a "NotSupportedError" DOMException
Parameters
- Optionaloptions: XRLightProbeInit
Returns Promise<XRLightProbe>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:142463

requestReferenceSpace

requestReferenceSpace(
type: XRReferenceSpaceType,
): Promise<XRReferenceSpace | XRBoundedReferenceSpace>
Requests that a new XRReferenceSpace of the specified type be created. Returns a promise which resolves with the XRReferenceSpace or XRBoundedReferenceSpace which was requested, or throws a NotSupportedError if the requested space type isn't supported by the device.
Parameters
- type: XRReferenceSpaceType
Returns Promise<XRReferenceSpace | XRBoundedReferenceSpace>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141783

trySetFeaturePointCloudEnabled

trySetFeaturePointCloudEnabled(enabled: boolean): boolean
Parameters
- enabled: boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141329

trySetMeshDetectorEnabled

trySetMeshDetectorEnabled(enabled: boolean): boolean
Parameters
- enabled: boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141331

trySetPreferredMeshDetectorOptions

trySetPreferredMeshDetectorOptions(
preferredOptions: XRGeometryDetectorOptions,
): boolean
Parameters
- preferredOptions: XRGeometryDetectorOptions
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141332

trySetPreferredPlaneDetectorOptions

trySetPreferredPlaneDetectorOptions(
preferredOptions: XRGeometryDetectorOptions,
): boolean
Parameters
- preferredOptions: XRGeometryDetectorOptions
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141330

updateRenderState

updateRenderState(renderStateInit?: XRRenderStateInit): Promise<void>
Parameters
- OptionalrenderStateInit: XRRenderStateInit
Returns Promise<void>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141785

updateTargetFrameRate

updateTargetFrameRate(rate: number): Promise<void>
Parameters
- rate: number
Returns Promise<void>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141787

Class XRSessionAbstract

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Returns XRSession

Properties

ReadonlydepthDataFormat

ReadonlydepthUsage

Optional ReadonlydomOverlayState

enabledFeatures

ReadonlyenvironmentBlendMode

Optional ReadonlyframeRate

ReadonlyinputSources

onend

onframeratechange

oninputsourceschange

onselect

onselectend

onselectstart

onsqueeze

onsqueezeend

onsqueezestart

onvisibilitychange

Optional ReadonlypreferredReflectionFormat

ReadonlyrenderState

OptionalrequestHitTest

OptionalrequestHitTestSource

OptionalrequestHitTestSourceForTransientInput

Optional ReadonlysupportedFrameRates

OptionalupdateWorldTrackingState

ReadonlyvisibilityState

Methods

addEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

cancelAnimationFrame

Parameters

Returns void

end

Returns Promise<void>

OptionalgetTrackedImageScores

Returns Promise<XRImageTrackingScore[]>

OptionalinitiateRoomCapture

Returns Promise<void>

removeEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

requestAnimationFrame

Parameters

Returns number

requestLightProbe

Parameters

Returns Promise<XRLightProbe>

requestReferenceSpace

Parameters

Returns Promise<XRReferenceSpace | XRBoundedReferenceSpace>

trySetFeaturePointCloudEnabled

Parameters

Returns boolean

trySetMeshDetectorEnabled

Parameters

Returns boolean

trySetPreferredMeshDetectorOptions

Parameters

Returns boolean

trySetPreferredPlaneDetectorOptions

Parameters

Returns boolean

Class XRSession`Abstract`

`Readonly`depthDataFormat

`Readonly`depthUsage

`Optional` `Readonly`domOverlayState

`Readonly`environmentBlendMode

`Optional` `Readonly`frameRate

`Readonly`inputSources

`Optional` `Readonly`preferredReflectionFormat

`Readonly`renderState

`Optional`requestHitTest

`Optional`requestHitTestSource

`Optional`requestHitTestSourceForTransientInput

`Optional` `Readonly`supportedFrameRates

`Optional`updateWorldTrackingState

`Readonly`visibilityState

`Optional`getTrackedImageScores

`Optional`initiateRoomCapture