Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VRDisplay

Package version

This WebVR API interface represents any VR device supported by this API. It includes generic information such as device IDs and descriptions, as well as methods for starting to present a VR scene, retrieving eye parameters and display capabilities, and other important functionality.

Hierarchy

Index

Properties

EventTarget

EventTarget: { constructor: any; prototype: EventTarget }

Type declaration

  • constructor: function
    • Returns EventTarget

  • prototype: EventTarget

capabilities

capabilities: VRDisplayCapabilities

depthFar

depthFar: number

depthNear

depthNear: number

displayId

displayId: number

displayName

displayName: string

isConnected

isConnected: boolean

isPresenting

isPresenting: boolean

stageParameters

stageParameters: VRStageParameters | null

Methods

addEventListener

  • 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.

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

    Parameters

    Returns void

cancelAnimationFrame

  • cancelAnimationFrame(handle: number): void
  • Parameters

    • handle: number

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean
  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    Returns boolean

exitPresent

  • Returns Promise<void>

getEyeParameters

  • Parameters

    • whichEye: string

    Returns VREyeParameters

getFrameData

  • Parameters

    Returns boolean

getLayers

  • Returns VRLayer[]

getPose

  • deprecated

    Returns VRPose

removeEventListener

requestAnimationFrame

  • Parameters

    Returns number

requestPresent

  • Parameters

    Returns Promise<void>

resetPose

  • resetPose(): void
  • Returns void

submitFrame

  • submitFrame(pose?: VRPose): void
  • Parameters

    Returns void

Generated using TypeDoc