VRCameraRigComponent

VRCameraRigComponent

VRCameraRig component which contains all the data for a VR display

Constructor

new VRCameraRigComponent()

Members

loadGamepads

This indicate if we want to loadGamepads when VR is presenting

onlyShowWhenPresenting

This is the flag that indicate if we want to only rotate the camera with HMD when VR is presenting

Methods

clone() → {VRCameraRigComponent}

Clone this VRCameraRigComponent

copy(source) → {VRCameraRigComponent}

Copy the VRCameraRig from source to this.

Parameters:
Name Type Description
source VRCameraRigComponent

releaseMainCameraRig()

Release this entity from being the current cameraRig

setAsMainCameraRig()

Set this entity as main cameraRig

updateVRCameraRig(display, resolutionMultiplier)

Update VRCameraRigComponent display based on passed in display:

Parameters:
Name Type Description
display display

VRDisplay

resolutionMultiplier number

updateVRCameraRig(xrFrame, referenceSpace, resolutionMultiplier)

Update VRCameraRigComponent display based on the frame data and reference space

Parameters:
Name Type Description
xrFrame XRFrame
referenceSpace XRReferenceSpace
resolutionMultiplier number