Interface IControlXR

interface IControlXR {
    getRuntimeXR(): IRuntimeXR | null;
    noActiveSessions(): boolean;
    noScreenRendering(): boolean;
    onPinch(event: CustomInputSourceEventXR): void;
    onPinchStart(event: CustomInputSourceEventXR): void;
    onSelect(event: CustomInputSourceEventXR): void;
    onSelectStart(event: CustomInputSourceEventXR): void;
    onThumbstick(
        event: CustomInputSourceEventXR,
        speedMultiplier?: number,
    ): void;
    release(): void;
    shouldBlitToScreen(): boolean;
    shouldRenderToScreen(): boolean;
}

Index

Methods

getRuntimeXR noActiveSessions noScreenRendering onPinch onPinchStart onSelect onSelectStart onThumbstick release shouldBlitToScreen shouldRenderToScreen

Methods

getRuntimeXR

getRuntimeXR(): IRuntimeXR | null
Gets the XR runtime used to blit the XR view to the on-screen canvas, or null when inactive.

Returns IRuntimeXR | null
- Defined in Source/Control.ts:23

noActiveSessions

noActiveSessions(): boolean
Returns true if no WebXR sessions are active

Returns boolean
- Defined in Source/Control.ts:18

noScreenRendering

noScreenRendering(): boolean
Returns boolean
- Defined in Source/Control.ts:19

onPinch

onPinch(event: CustomInputSourceEventXR): void
Client callback: pinch gesture released.
Parameters
- event: CustomInputSourceEventXR
Returns void
- Defined in Source/Control.ts:33

onPinchStart

onPinchStart(event: CustomInputSourceEventXR): void
Client callback: pinch gesture started.
Parameters
- event: CustomInputSourceEventXR
Returns void
- Defined in Source/Control.ts:31

onSelect

onSelect(event: CustomInputSourceEventXR): void
Client callback: trigger released.
Parameters
- event: CustomInputSourceEventXR
Returns void
- Defined in Source/Control.ts:29

onSelectStart

onSelectStart(event: CustomInputSourceEventXR): void
Client callback: trigger pressed.
Parameters
- event: CustomInputSourceEventXR
Returns void
- Defined in Source/Control.ts:27

onThumbstick

onThumbstick(event: CustomInputSourceEventXR, speedMultiplier?: number): void
Client callback: thumbstick moved.
Parameters
- event: CustomInputSourceEventXR
- OptionalspeedMultiplier: number
Returns void
- Defined in Source/Control.ts:25

release

release(): void
Returns void
- Defined in Source/Control.ts:16

shouldBlitToScreen

shouldBlitToScreen(): boolean
Returns boolean
- Defined in Source/Control.ts:21

shouldRenderToScreen

shouldRenderToScreen(): boolean
Returns boolean
- Defined in Source/Control.ts:20