This website uses cookies to improve our services and deliver relevant ads.
By interacting with this site, you agree to this use. For more information, see our Cookies Policy

Unity 1.36 Reference Guide

OVRManager Class Reference

Configuration data for Oculus virtual reality.

MonoBehaviour inherited by OVRManager.

Public Types

enum	TrackingOrigin { TrackingOrigin.EyeLevel = OVRPlugin.TrackingOrigin.EyeLevel, TrackingOrigin.FloorLevel = OVRPlugin.TrackingOrigin.FloorLevel }
enum	EyeTextureFormat { EyeTextureFormat.Default = OVRPlugin.EyeTextureFormat.Default, EyeTextureFormat.R16G16B16A16_FP = OVRPlugin.EyeTextureFormat.R16G16B16A16_FP, EyeTextureFormat.R11G11B10_FP = OVRPlugin.EyeTextureFormat.R11G11B10_FP }
enum	TiledMultiResLevel { TiledMultiResLevel.Off = OVRPlugin.TiledMultiResLevel.Off, TiledMultiResLevel.LMSLow = OVRPlugin.TiledMultiResLevel.LMSLow, TiledMultiResLevel.LMSMedium = OVRPlugin.TiledMultiResLevel.LMSMedium, TiledMultiResLevel.LMSHigh = OVRPlugin.TiledMultiResLevel.LMSHigh, TiledMultiResLevel.LMSHighTop = OVRPlugin.TiledMultiResLevel.LMSHighTop }
enum	XRDevice { XRDevice.Unknown = 0, XRDevice.Oculus = 1, XRDevice.OpenVR = 2 }

Properties

static OVRManager	instance ( ) `[Get]` Gets the singleton instance.
static OVRDisplay	display ( ) `[Get]` Gets a reference to the active display.
static OVRTracker	tracker ( ) `[Get]` Gets a reference to the active sensor.
static OVRBoundary	boundary ( ) `[Get]` Gets a reference to the active boundary system.
static OVRProfile	profile ( ) `[Get]` Gets the current profile, which contains information about the user's settings and body dimensions.
static bool	isHmdPresent ( ) `[Get]` If true, a head-mounted display is connected and present.
static string	audioOutId ( ) `[Get]` Gets the audio output device identifier.
static string	audioInId ( ) `[Get]` Gets the audio input device identifier.
static bool	hasVrFocus ( ) `[Get]` If true, the app has VR Focus.
static bool	hasInputFocus ( ) `[Get]` If true, the app has Input Focus.
bool	chromatic ( ) `[Get]` If true, chromatic de-aberration will be applied, improving the image at the cost of texture bandwidth.
bool	monoscopic ( ) `[Get]`
Vector3	headPoseRelativeOffsetRotation ( ) `[Get]`
Vector3	headPoseRelativeOffsetTranslation ( ) `[Get]`
int	vsyncCount ( ) `[Get]` The number of expected display frames per rendered frame.
static float	batteryLevel ( ) `[Get]` Gets the current battery level.
static float	batteryTemperature ( ) `[Get]` Gets the current battery temperature.
static int	batteryStatus ( ) `[Get]` Gets the current battery status.
static float	volumeLevel ( ) `[Get]` Gets the current volume level.
static int	cpuLevel ( ) `[Get]` Gets or sets the current CPU performance level (0-2).
static int	gpuLevel ( ) `[Get]` Gets or sets the current GPU performance level (0-2).
static bool	isPowerSavingActive ( ) `[Get]` If true, the CPU and GPU are currently throttled to save power and/or reduce the temperature.
static EyeTextureFormat	eyeTextureFormat ( ) `[Get]` Gets or sets the eye texture format.
static bool	tiledMultiResSupported ( ) `[Get]` Gets if tiled-based multi-resolution technique is supported This feature is only supported on QCOMM-based Android devices
static TiledMultiResLevel	tiledMultiResLevel ( ) `[Get]` Gets or sets the tiled-based multi-resolution level This feature is only supported on QCOMM-based Android devices
static bool	gpuUtilSupported ( ) `[Get]` Gets if the GPU Utility is supported This feature is only supported on QCOMM-based Android devices
static float	gpuUtilLevel ( ) `[Get]` Gets the GPU Utilised Level (0.0 - 1.0) This feature is only supported on QCOMM-based Android devices
OVRManager.TrackingOrigin	trackingOriginType ( ) `[Get]` Defines the current tracking origin type.
bool	reorientHMDOnControllerRecenter ( ) `[Get]` Defines the recentering mode specified in the tooltip above.
bool	isSupportedPlatform ( ) `[Get]` True if the current platform supports virtual reality.
bool	isUserPresent ( ) `[Get]` True if the user is currently wearing the display.
static System.Version	utilitiesVersion ( ) `[Get]`
static System.Version	pluginVersion ( ) `[Get]`
static System.Version	sdkVersion ( ) `[Get]`

Private Static Fields

static OVRProfile	_profile ( )
static bool	_isHmdPresentCached ( )
static bool	_isHmdPresent ( )
static bool	_wasHmdPresent ( )
static bool	_hasVrFocusCached ( )
static bool	_hasVrFocus ( )
static bool	_hadVrFocus ( )
static bool	_hadInputFocus ( )
static Vector3	OpenVRTouchRotationOffsetEulerLeft ( )
static Vector3	OpenVRTouchRotationOffsetEulerRight ( )
static Vector3	OpenVRTouchPositionOffsetLeft ( )
static Vector3	OpenVRTouchPositionOffsetRight ( )
static bool	_isUserPresentCached ( )
static bool	_isUserPresent ( )
static bool	_wasUserPresent ( )
static bool	prevAudioOutIdIsCached ( )
static bool	prevAudioInIdIsCached ( )
static string	prevAudioOutId ( )
static string	prevAudioInId ( )
static bool	wasPositionTracked ( )

Private Data Fields

IEnumerable< Camera >	disabledCameras ( )
float	prevTimeScale ( )
bool	_monoscopic ( ) If true, both eyes will see the same image, rendered from the center eye pose, saving performance.
Vector3	_headPoseRelativeOffsetRotation ( ) Set the relative offset rotation of head poses
Vector3	_headPoseRelativeOffsetTranslation ( ) Set the relative offset translation of head poses
OVRManager.TrackingOrigin	_trackingOriginType ( )
bool	_reorientHMDOnControllerRecenter ( )
bool	multipleMainCameraWarningPresented ( )

Events

static Action	HMDAcquired ( ) Occurs when an HMD attached.
static Action	HMDLost ( ) Occurs when an HMD detached.
static Action	HMDMounted ( ) Occurs when an HMD is put on the user's head.
static Action	HMDUnmounted ( ) Occurs when an HMD is taken off the user's head.
static Action	VrFocusAcquired ( ) Occurs when VR Focus is acquired.
static Action	VrFocusLost ( ) Occurs when VR Focus is lost.
static Action	InputFocusAcquired ( ) Occurs when Input Focus is acquired.
static Action	InputFocusLost ( ) Occurs when Input Focus is lost.
static Action	AudioOutChanged ( ) Occurs when the active Audio Out device has changed and a restart is needed.
static Action	AudioInChanged ( ) Occurs when the active Audio In device has changed and a restart is needed.
static Action	TrackingAcquired ( ) Occurs when the sensor gained tracking.
static Action	TrackingLost ( ) Occurs when the sensor lost tracking.
static Action	HSWDismissed ( ) Occurs when Health & Safety Warning is dismissed.

Data Fields

bool	queueAhead ( ) If true, distortion rendering work is submitted a quarter-frame early to avoid pipeline stalls and increase CPU-GPU parallelism.
bool	useRecommendedMSAALevel ( ) If true, Unity will use the optimal antialiasing level for quality/performance on the current hardware.
bool	enableAdaptiveResolution ( ) If true, dynamic resolution will be enabled
float	minRenderScale ( ) Min RenderScale the app can reach under adaptive resolution mode ( enableAdaptiveResolution = true );
float	maxRenderScale ( ) Max RenderScale the app can reach under adaptive resolution mode ( enableAdaptiveResolution = true );
int	profilerTcpPort ( ) The TCP listening port of Oculus Profiler Service, which will be activated in Debug/Developerment builds When the app is running on editor or device, open "Tools/Oculus/Oculus Profiler Panel" to view the realtime system metrics
bool	usePositionTracking ( ) If true, head tracking will affect the position of each OVRCameraRig's cameras.
bool	useRotationTracking ( ) If true, head tracking will affect the rotation of each OVRCameraRig's cameras.
bool	useIPDInPositionTracking ( ) If true, the distance between the user's eyes will affect the position of each OVRCameraRig's cameras.
bool	resetTrackerOnLoad ( ) If true, each scene load will cause the head pose to reset.
bool	AllowRecenter ( ) If true, the Reset View in the universal menu will cause the pose to be reset.

Static Fields

static string	OCULUS_UNITY_NAME_STR ( )
static string	OPENVR_UNITY_NAME_STR ( )
static XRDevice	loadedXRDevice ( )

Object Data

static string

UnityAlphaOrBetaVersionWarningMessage ( )

Static Public Member Functions

static bool	IsAdaptiveResSupportedByEngine ( ) Adaptive Resolution is based on Unity engine's renderViewportScale/eyeTextureResolutionScale feature But renderViewportScale was broken in an array of Unity engines, this function help to filter out those broken engines
static void	SetColorScaleAndOffset ( Vector4 colorScale, Vector4 colorOffset, bool applyToAllLayers ) Sets the Color Scale and Offset which is commonly used for effects like fade-to-black.
static void	SetOpenVRLocalPose ( Vector3 leftPos, Vector3 rightPos, Quaternion leftRot, Quaternion rightRot ) Specifies OpenVR pose local to tracking space
static OVRPose	GetOpenVRControllerOffset ( Node hand ) Specifies the pose offset required to make an OpenVR controller's reported pose match the virtual pose.
static void	PlatformUIConfirmQuit ( )

Object Data

static bool

IsUnityAlphaOrBetaVersion ( )

Private Member Functions

void	Awake ( )
void	SetCurrentXRDevice ( )
void	Initialize ( )
void	Update ( )
Camera	FindMainCamera ( )
void	OnDisable ( )
void	LateUpdate ( )
void	FixedUpdate ( )

Public Member Functions

void	ReturnToLauncher ( ) Leaves the application/game and returns to the launcher/dashboard

Member Enumeration Documentation

enum OVRManager.TrackingOrigin

Enumerator

EyeLevel	= OVRPlugin.TrackingOrigin.EyeLevel
FloorLevel	= OVRPlugin.TrackingOrigin.FloorLevel

enum OVRManager.EyeTextureFormat

Enumerator

Default	= OVRPlugin.EyeTextureFormat.Default
R16G16B16A16_FP	= OVRPlugin.EyeTextureFormat.R16G16B16A16_FP
R11G11B10_FP	= OVRPlugin.EyeTextureFormat.R11G11B10_FP

enum OVRManager.TiledMultiResLevel

Enumerator

Off	= OVRPlugin.TiledMultiResLevel.Off
LMSLow	= OVRPlugin.TiledMultiResLevel.LMSLow
LMSMedium	= OVRPlugin.TiledMultiResLevel.LMSMedium
LMSHigh	= OVRPlugin.TiledMultiResLevel.LMSHigh
LMSHighTop	= OVRPlugin.TiledMultiResLevel.LMSHighTop

enum OVRManager.XRDevice

Enumerator

Unknown	= 0
Oculus	= 1
OpenVR	= 2

Property Documentation

OVRManager OVRManager.instance ( )

Gets the singleton instance.

OVRDisplay OVRManager.display ( )

Gets a reference to the active display.

OVRTracker OVRManager.tracker ( )

Gets a reference to the active sensor.

OVRBoundary OVRManager.boundary ( )

Gets a reference to the active boundary system.

OVRProfile OVRManager.profile ( )

Gets the current profile, which contains information about the user's settings and body dimensions.

bool OVRManager.isHmdPresent ( )

If true, a head-mounted display is connected and present.

string OVRManager.audioOutId ( )

Gets the audio output device identifier.

On Windows, this is a string containing the GUID of the IMMDevice for the Windows audio endpoint to use.

string OVRManager.audioInId ( )

Gets the audio input device identifier.

On Windows, this is a string containing the GUID of the IMMDevice for the Windows audio endpoint to use.

bool OVRManager.hasVrFocus ( )

If true, the app has VR Focus.

bool OVRManager.hasInputFocus ( )

If true, the app has Input Focus.

bool OVRManager.chromatic ( )

If true, chromatic de-aberration will be applied, improving the image at the cost of texture bandwidth.

bool OVRManager.monoscopic ( )

Vector3 OVRManager.headPoseRelativeOffsetRotation ( )

Vector3 OVRManager.headPoseRelativeOffsetTranslation ( )

int OVRManager.vsyncCount ( )

The number of expected display frames per rendered frame.

float OVRManager.batteryLevel ( )

Gets the current battery level.

battery level in the range [0.0,1.0]

Parameters

batteryLevel

Battery level.

float OVRManager.batteryTemperature ( )

Gets the current battery temperature.

battery temperature in Celsius

Parameters

batteryTemperature

Battery temperature.

int OVRManager.batteryStatus ( )

Gets the current battery status.

battery status

Parameters

batteryStatus

Battery status.

float OVRManager.volumeLevel ( )

Gets the current volume level.

volume level in the range [0,1].

int OVRManager.cpuLevel ( )

Gets or sets the current CPU performance level (0-2).

Lower performance levels save more power.

int OVRManager.gpuLevel ( )

Gets or sets the current GPU performance level (0-2).

Lower performance levels save more power.

bool OVRManager.isPowerSavingActive ( )

If true, the CPU and GPU are currently throttled to save power and/or reduce the temperature.

EyeTextureFormat OVRManager.eyeTextureFormat ( )

Gets or sets the eye texture format.

bool OVRManager.tiledMultiResSupported ( )

Gets if tiled-based multi-resolution technique is supported This feature is only supported on QCOMM-based Android devices

TiledMultiResLevel OVRManager.tiledMultiResLevel ( )

Gets or sets the tiled-based multi-resolution level This feature is only supported on QCOMM-based Android devices

bool OVRManager.gpuUtilSupported ( )

Gets if the GPU Utility is supported This feature is only supported on QCOMM-based Android devices

float OVRManager.gpuUtilLevel ( )

Gets the GPU Utilised Level (0.0 - 1.0) This feature is only supported on QCOMM-based Android devices

OVRManager.TrackingOrigin OVRManager.trackingOriginType ( )

Defines the current tracking origin type.

bool OVRManager.reorientHMDOnControllerRecenter ( )

Defines the recentering mode specified in the tooltip above.

bool OVRManager.isSupportedPlatform ( )

True if the current platform supports virtual reality.

bool OVRManager.isUserPresent ( )

True if the user is currently wearing the display.

System.Version OVRManager.utilitiesVersion ( )

System.Version OVRManager.pluginVersion ( )

System.Version OVRManager.sdkVersion ( )

Private Static Field Documentation

OVRProfile OVRManager._profile ( )

bool OVRManager._isHmdPresentCached ( )

bool OVRManager._isHmdPresent ( )

bool OVRManager._wasHmdPresent ( )

bool OVRManager._hasVrFocusCached ( )

bool OVRManager._hasVrFocus ( )

bool OVRManager._hadVrFocus ( )

bool OVRManager._hadInputFocus ( )

Vector3 OVRManager.OpenVRTouchRotationOffsetEulerLeft ( )

Vector3 OVRManager.OpenVRTouchRotationOffsetEulerRight ( )

Vector3 OVRManager.OpenVRTouchPositionOffsetLeft ( )

Vector3 OVRManager.OpenVRTouchPositionOffsetRight ( )

bool OVRManager._isUserPresentCached ( )

bool OVRManager._isUserPresent ( )

bool OVRManager._wasUserPresent ( )

bool OVRManager.prevAudioOutIdIsCached ( )

bool OVRManager.prevAudioInIdIsCached ( )

string OVRManager.prevAudioOutId ( )

string OVRManager.prevAudioInId ( )

bool OVRManager.wasPositionTracked ( )

Object Data Documentation

IEnumerable<Camera> OVRManager.disabledCameras ( )

float OVRManager.prevTimeScale ( )

bool OVRManager._monoscopic ( )

If true, both eyes will see the same image, rendered from the center eye pose, saving performance.

Vector3 OVRManager._headPoseRelativeOffsetRotation ( )

Set the relative offset rotation of head poses

Vector3 OVRManager._headPoseRelativeOffsetTranslation ( )

Set the relative offset translation of head poses

OVRManager.TrackingOrigin OVRManager._trackingOriginType ( )

bool OVRManager._reorientHMDOnControllerRecenter ( )

bool OVRManager.multipleMainCameraWarningPresented ( )

Event Documentation

Action OVRManager.HMDAcquired ( )

Occurs when an HMD attached.

Action OVRManager.HMDLost ( )

Occurs when an HMD detached.

Action OVRManager.HMDMounted ( )

Occurs when an HMD is put on the user's head.

Action OVRManager.HMDUnmounted ( )

Occurs when an HMD is taken off the user's head.

Action OVRManager.VrFocusAcquired ( )

Occurs when VR Focus is acquired.

Action OVRManager.VrFocusLost ( )

Occurs when VR Focus is lost.

Action OVRManager.InputFocusAcquired ( )

Occurs when Input Focus is acquired.

Action OVRManager.InputFocusLost ( )

Occurs when Input Focus is lost.

Action OVRManager.AudioOutChanged ( )

Occurs when the active Audio Out device has changed and a restart is needed.

Action OVRManager.AudioInChanged ( )

Occurs when the active Audio In device has changed and a restart is needed.

Action OVRManager.TrackingAcquired ( )

Occurs when the sensor gained tracking.

Action OVRManager.TrackingLost ( )

Occurs when the sensor lost tracking.

Action OVRManager.HSWDismissed ( )

Occurs when Health & Safety Warning is dismissed.

Field Documentation

bool OVRManager.queueAhead ( )

If true, distortion rendering work is submitted a quarter-frame early to avoid pipeline stalls and increase CPU-GPU parallelism.

bool OVRManager.useRecommendedMSAALevel ( )

If true, Unity will use the optimal antialiasing level for quality/performance on the current hardware.

bool OVRManager.enableAdaptiveResolution ( )

If true, dynamic resolution will be enabled

float OVRManager.minRenderScale ( )

Min RenderScale the app can reach under adaptive resolution mode ( enableAdaptiveResolution = true );

float OVRManager.maxRenderScale ( )

Max RenderScale the app can reach under adaptive resolution mode ( enableAdaptiveResolution = true );

int OVRManager.profilerTcpPort ( )

The TCP listening port of Oculus Profiler Service, which will be activated in Debug/Developerment builds When the app is running on editor or device, open "Tools/Oculus/Oculus Profiler Panel" to view the realtime system metrics

bool OVRManager.usePositionTracking ( )

If true, head tracking will affect the position of each OVRCameraRig's cameras.

bool OVRManager.useRotationTracking ( )

If true, head tracking will affect the rotation of each OVRCameraRig's cameras.

bool OVRManager.useIPDInPositionTracking ( )

If true, the distance between the user's eyes will affect the position of each OVRCameraRig's cameras.

bool OVRManager.resetTrackerOnLoad ( )

If true, each scene load will cause the head pose to reset.

bool OVRManager.AllowRecenter ( )

If true, the Reset View in the universal menu will cause the pose to be reset.

This should generally be enabled for applications with a stationary position in the virtual world and will allow the View Reset command to place the person back to a predefined location (such as a cockpit seat). Set this to false if you have a locomotion system because resetting the view would effectively teleport the player to potentially invalid locations.

Public Static Documentation

string OVRManager.OCULUS_UNITY_NAME_STR ( )

string OVRManager.OPENVR_UNITY_NAME_STR ( )

XRDevice OVRManager.loadedXRDevice ( )

Object Data Documentation

string OVRManager.UnityAlphaOrBetaVersionWarningMessage ( )

Static Member Function Documentation

static bool OVRManager.IsAdaptiveResSupportedByEngine ( )

Adaptive Resolution is based on Unity engine's renderViewportScale/eyeTextureResolutionScale feature But renderViewportScale was broken in an array of Unity engines, this function help to filter out those broken engines

static void OVRManager.SetColorScaleAndOffset ( Vector4 colorScale, Vector4 colorOffset, bool applyToAllLayers )

Sets the Color Scale and Offset which is commonly used for effects like fade-to-black.

In our compositor, once a given frame is rendered, warped, and ready to be displayed, we then multiply each pixel by colorScale and add it to colorOffset, whereby newPixel = oldPixel * colorScale + colorOffset. Note that for mobile devices (Quest, Go, etc.), colorOffset is not supported, so colorScale is all that can be used. A colorScale of (1, 1, 1, 1) and colorOffset of (0, 0, 0, 0) will lead to an identity multiplication and have no effect.

static void OVRManager.SetOpenVRLocalPose ( Vector3 leftPos, Vector3 rightPos, Quaternion leftRot, Quaternion rightRot )

Specifies OpenVR pose local to tracking space

static OVRPose OVRManager.GetOpenVRControllerOffset ( Node hand )

Specifies the pose offset required to make an OpenVR controller's reported pose match the virtual pose.

Currently we only specify this offset for Oculus Touch on OpenVR.

static void OVRManager.PlatformUIConfirmQuit ( )

Object Data Documentation

static bool OVRManager.IsUnityAlphaOrBetaVersion ( )

Object Data Documentation

void OVRManager.Awake ( )

void OVRManager.SetCurrentXRDevice ( )

void OVRManager.Initialize ( )

void OVRManager.Update ( )

Camera OVRManager.FindMainCamera ( )

void OVRManager.OnDisable ( )

void OVRManager.LateUpdate ( )

void OVRManager.FixedUpdate ( )

Member Function Documentation

void OVRManager.ReturnToLauncher ( )

Leaves the application/game and returns to the launcher/dashboard

The documentation for this class was generated from the following file: Oculus/VR/Scripts/OVRManager.cs