Interface INeedleXRSessionEventReceiver

interface INeedleXRSessionEventReceiver {
    get activeAndEnabled(): boolean;
    onBeforeXR(mode: XRSessionMode, args: XRSessionInit): void | Promise<void>;
    onEnterXR(args: NeedleXREventArgs): void;
    onLeaveXR(args: NeedleXREventArgs): void;
    onUpdateXR(args: NeedleXREventArgs): void;
    onXRControllerAdded(args: NeedleXRControllerEventArgs): void;
    onXRControllerRemoved(args: NeedleXRControllerEventArgs): void;
    supportsXR(mode: XRSessionMode): boolean;
}

Hierarchy

Pick<IComponent, "destroyed">
- INeedleXRSessionEventReceiver

Index

Accessors

activeAndEnabled

Methods

onBeforeXR? onEnterXR? onLeaveXR? onUpdateXR? onXRControllerAdded? onXRControllerRemoved? supportsXR?

Accessors

activeAndEnabled

get activeAndEnabled(): boolean
Returns boolean

Methods

`Optional`onBeforeXR

onBeforeXR(mode: XRSessionMode, args: XRSessionInit): void | Promise<void>
Called before requesting a XR session. May return a promise that is awaited before requesting.
Parameters
- mode: XRSessionMode
- args: XRSessionInit
Returns void | Promise<void>

`Optional`onEnterXR

onEnterXR(args: NeedleXREventArgs): void
Parameters
- args: NeedleXREventArgs
Returns void

`Optional`onLeaveXR

onLeaveXR(args: NeedleXREventArgs): void
Parameters
- args: NeedleXREventArgs
Returns void

`Optional`onUpdateXR

onUpdateXR(args: NeedleXREventArgs): void
Parameters
- args: NeedleXREventArgs
Returns void

`Optional`onXRControllerAdded

onXRControllerAdded(args: NeedleXRControllerEventArgs): void
Parameters
- args: NeedleXRControllerEventArgs
Returns void

`Optional`onXRControllerRemoved

onXRControllerRemoved(args: NeedleXRControllerEventArgs): void
Parameters
- args: NeedleXRControllerEventArgs
Returns void

`Optional`supportsXR

supportsXR(mode: XRSessionMode): boolean
Parameters
- mode: XRSessionMode
Returns boolean