VrApi

interface VrApi
Content copied to clipboard

Offers VR-related functionality. Accessible through Player.vr

Properties

gyroscopicOrientationProvider
Link copied to clipboard
abstract var gyroscopicOrientationProvider: OrientationProvider?
Content copied to clipboard
The gyroscopic OrientationProvider that is used for VR control.
isGyroscopeEnabled
Link copied to clipboard
abstract var isGyroscopeEnabled: Boolean
Content copied to clipboard
Specifies whether the gyroscope of the device is enabled.
isStereo
Link copied to clipboard
abstract var isStereo: Boolean
Content copied to clipboard
Specifies whether stereo mode is enabled.
isTouchControlEnabled
Link copied to clipboard
abstract var isTouchControlEnabled: Boolean
Content copied to clipboard
Specifies whether the touch controls of the device are enabled.
touchOrientationProvider
Link copied to clipboard
abstract var touchOrientationProvider: OrientationProvider?
Content copied to clipboard
The touch OrientationProvider that is used for VR control.
viewingDirection
Link copied to clipboard
abstract var viewingDirection: ViewingDirection?
Content copied to clipboard
The current viewing direction.
viewingDirectionChangeEventInterval
Link copied to clipboard
abstract var viewingDirectionChangeEventInterval: Double
Content copied to clipboard
The minimal interval between consecutive VrViewingDirectionChanges.
viewingDirectionChangeThreshold
Link copied to clipboard
abstract var viewingDirectionChangeThreshold: Double
Content copied to clipboard
The number of degrees that the viewport can change before the VrViewingDirectionChange is triggered.

Functions

moveViewingDirection
Link copied to clipboard
abstract fun moveViewingDirection(direction: Vector3)
Content copied to clipboard
Moves the current VR viewing direction in the given direction with the given speed by passing a three-component Vector3.
setVrRenderer
Link copied to clipboard
abstract fun setVrRenderer(renderer: VrRenderer?)
Content copied to clipboard
Sets the VrRenderer that is used to modify VR properties.