Class CVRSystem

Inheritance
Object
CVRSystem
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.OpenVR.Headers
Assembly: cs.temp.dll.dll
Syntax
public class CVRSystem

Methods

AcknowledgeQuit_Exiting()

Declaration
public void AcknowledgeQuit_Exiting()

AcknowledgeQuit_UserPrompt()

Declaration
public void AcknowledgeQuit_UserPrompt()

ApplyTransform(ref TrackedDevicePose_t, ref TrackedDevicePose_t, ref HmdMatrix34_t)

Declaration
public void ApplyTransform(ref TrackedDevicePose_t pOutputPose, ref TrackedDevicePose_t pTrackedDevicePose, ref HmdMatrix34_t pTransform)
Parameters
Type Name Description
TrackedDevicePose_t pOutputPose
TrackedDevicePose_t pTrackedDevicePose
HmdMatrix34_t pTransform

ComputeDistortion(EVREye, Single, Single, ref DistortionCoordinates_t)

Declaration
public bool ComputeDistortion(EVREye eEye, float fU, float fV, ref DistortionCoordinates_t pDistortionCoordinates)
Parameters
Type Name Description
EVREye eEye
Single fU
Single fV
DistortionCoordinates_t pDistortionCoordinates
Returns
Type Description
Boolean

DriverDebugRequest(UInt32, String, StringBuilder, UInt32)

Declaration
public uint DriverDebugRequest(uint unDeviceIndex, string pchRequest, StringBuilder pchResponseBuffer, uint unResponseBufferSize)
Parameters
Type Name Description
UInt32 unDeviceIndex
String pchRequest
StringBuilder pchResponseBuffer
UInt32 unResponseBufferSize
Returns
Type Description
UInt32

GetArrayTrackedDeviceProperty(UInt32, ETrackedDeviceProperty, UInt32, IntPtr, UInt32, ref ETrackedPropertyError)

Declaration
public uint GetArrayTrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, uint propType, IntPtr pBuffer, uint unBufferSize, ref ETrackedPropertyError pError)
Parameters
Type Name Description
UInt32 unDeviceIndex
ETrackedDeviceProperty prop
UInt32 propType
IntPtr pBuffer
UInt32 unBufferSize
ETrackedPropertyError pError
Returns
Type Description
UInt32

GetBoolTrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)

Declaration
public bool GetBoolTrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, ref ETrackedPropertyError pError)
Parameters
Type Name Description
UInt32 unDeviceIndex
ETrackedDeviceProperty prop
ETrackedPropertyError pError
Returns
Type Description
Boolean

GetButtonIdNameFromEnum(EVRButtonId)

Declaration
public string GetButtonIdNameFromEnum(EVRButtonId eButtonId)
Parameters
Type Name Description
EVRButtonId eButtonId
Returns
Type Description
String

GetControllerAxisTypeNameFromEnum(EVRControllerAxisType)

Declaration
public string GetControllerAxisTypeNameFromEnum(EVRControllerAxisType eAxisType)
Parameters
Type Name Description
EVRControllerAxisType eAxisType
Returns
Type Description
String

GetControllerRoleForTrackedDeviceIndex(UInt32)

Declaration
public ETrackedControllerRole GetControllerRoleForTrackedDeviceIndex(uint unDeviceIndex)
Parameters
Type Name Description
UInt32 unDeviceIndex
Returns
Type Description
ETrackedControllerRole

GetControllerState(UInt32, ref VRControllerState_t, UInt32)

Declaration
public bool GetControllerState(uint unControllerDeviceIndex, ref VRControllerState_t pControllerState, uint unControllerStateSize)
Parameters
Type Name Description
UInt32 unControllerDeviceIndex
VRControllerState_t pControllerState
UInt32 unControllerStateSize
Returns
Type Description
Boolean

GetControllerStateWithPose(ETrackingUniverseOrigin, UInt32, ref VRControllerState_t, UInt32, ref TrackedDevicePose_t)

Declaration
public bool GetControllerStateWithPose(ETrackingUniverseOrigin eOrigin, uint unControllerDeviceIndex, ref VRControllerState_t pControllerState, uint unControllerStateSize, ref TrackedDevicePose_t pTrackedDevicePose)
Parameters
Type Name Description
ETrackingUniverseOrigin eOrigin
UInt32 unControllerDeviceIndex
VRControllerState_t pControllerState
UInt32 unControllerStateSize
TrackedDevicePose_t pTrackedDevicePose
Returns
Type Description
Boolean

GetD3D9AdapterIndex()

Declaration
public int GetD3D9AdapterIndex()
Returns
Type Description
Int32

GetDeviceToAbsoluteTrackingPose(ETrackingUniverseOrigin, Single, TrackedDevicePose_t[])

Declaration
public void GetDeviceToAbsoluteTrackingPose(ETrackingUniverseOrigin eOrigin, float fPredictedSecondsToPhotonsFromNow, TrackedDevicePose_t[] pTrackedDevicePoseArray)
Parameters
Type Name Description
ETrackingUniverseOrigin eOrigin
Single fPredictedSecondsToPhotonsFromNow
TrackedDevicePose_t[] pTrackedDevicePoseArray

GetDXGIOutputInfo(ref Int32)

Declaration
public void GetDXGIOutputInfo(ref int pnAdapterIndex)
Parameters
Type Name Description
Int32 pnAdapterIndex

GetEventTypeNameFromEnum(EVREventType)

Declaration
public string GetEventTypeNameFromEnum(EVREventType eType)
Parameters
Type Name Description
EVREventType eType
Returns
Type Description
String

GetEyeToHeadTransform(EVREye)

Declaration
public HmdMatrix34_t GetEyeToHeadTransform(EVREye eEye)
Parameters
Type Name Description
EVREye eEye
Returns
Type Description
HmdMatrix34_t

GetFloatTrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)

Declaration
public float GetFloatTrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, ref ETrackedPropertyError pError)
Parameters
Type Name Description
UInt32 unDeviceIndex
ETrackedDeviceProperty prop
ETrackedPropertyError pError
Returns
Type Description
Single

GetHiddenAreaMesh(EVREye, EHiddenAreaMeshType)

Declaration
public HiddenAreaMesh_t GetHiddenAreaMesh(EVREye eEye, EHiddenAreaMeshType type)
Parameters
Type Name Description
EVREye eEye
EHiddenAreaMeshType type
Returns
Type Description
HiddenAreaMesh_t

GetInt32TrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)

Declaration
public int GetInt32TrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, ref ETrackedPropertyError pError)
Parameters
Type Name Description
UInt32 unDeviceIndex
ETrackedDeviceProperty prop
ETrackedPropertyError pError
Returns
Type Description
Int32

GetMatrix34TrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)

Declaration
public HmdMatrix34_t GetMatrix34TrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, ref ETrackedPropertyError pError)
Parameters
Type Name Description
UInt32 unDeviceIndex
ETrackedDeviceProperty prop
ETrackedPropertyError pError
Returns
Type Description
HmdMatrix34_t

GetOutputDevice(ref UInt64, ETextureType, IntPtr)

Declaration
public void GetOutputDevice(ref ulong pnDevice, ETextureType textureType, IntPtr pInstance)
Parameters
Type Name Description
UInt64 pnDevice
ETextureType textureType
IntPtr pInstance

GetProjectionMatrix(EVREye, Single, Single)

Declaration
public HmdMatrix44_t GetProjectionMatrix(EVREye eEye, float fNearZ, float fFarZ)
Parameters
Type Name Description
EVREye eEye
Single fNearZ
Single fFarZ
Returns
Type Description
HmdMatrix44_t

GetProjectionRaw(EVREye, ref Single, ref Single, ref Single, ref Single)

Declaration
public void GetProjectionRaw(EVREye eEye, ref float pfLeft, ref float pfRight, ref float pfTop, ref float pfBottom)
Parameters
Type Name Description
EVREye eEye
Single pfLeft
Single pfRight
Single pfTop
Single pfBottom

GetPropErrorNameFromEnum(ETrackedPropertyError)

Declaration
public string GetPropErrorNameFromEnum(ETrackedPropertyError error)
Parameters
Type Name Description
ETrackedPropertyError error
Returns
Type Description
String

GetRawZeroPoseToStandingAbsoluteTrackingPose()

Declaration
public HmdMatrix34_t GetRawZeroPoseToStandingAbsoluteTrackingPose()
Returns
Type Description
HmdMatrix34_t

GetRecommendedRenderTargetSize(ref UInt32, ref UInt32)

Declaration
public void GetRecommendedRenderTargetSize(ref uint pnWidth, ref uint pnHeight)
Parameters
Type Name Description
UInt32 pnWidth
UInt32 pnHeight

GetSeatedZeroPoseToStandingAbsoluteTrackingPose()

Declaration
public HmdMatrix34_t GetSeatedZeroPoseToStandingAbsoluteTrackingPose()
Returns
Type Description
HmdMatrix34_t

GetSortedTrackedDeviceIndicesOfClass(ETrackedDeviceClass, UInt32[], UInt32)

Declaration
public uint GetSortedTrackedDeviceIndicesOfClass(ETrackedDeviceClass eTrackedDeviceClass, uint[] punTrackedDeviceIndexArray, uint unRelativeToTrackedDeviceIndex)
Parameters
Type Name Description
ETrackedDeviceClass eTrackedDeviceClass
UInt32[] punTrackedDeviceIndexArray
UInt32 unRelativeToTrackedDeviceIndex
Returns
Type Description
UInt32

GetStringTrackedDeviceProperty(UInt32, ETrackedDeviceProperty, StringBuilder, UInt32, ref ETrackedPropertyError)

Declaration
public uint GetStringTrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, StringBuilder pchValue, uint unBufferSize, ref ETrackedPropertyError pError)
Parameters
Type Name Description
UInt32 unDeviceIndex
ETrackedDeviceProperty prop
StringBuilder pchValue
UInt32 unBufferSize
ETrackedPropertyError pError
Returns
Type Description
UInt32

GetTimeSinceLastVsync(ref Single, ref UInt64)

Declaration
public bool GetTimeSinceLastVsync(ref float pfSecondsSinceLastVsync, ref ulong pulFrameCounter)
Parameters
Type Name Description
Single pfSecondsSinceLastVsync
UInt64 pulFrameCounter
Returns
Type Description
Boolean

GetTrackedDeviceActivityLevel(UInt32)

Declaration
public EDeviceActivityLevel GetTrackedDeviceActivityLevel(uint unDeviceId)
Parameters
Type Name Description
UInt32 unDeviceId
Returns
Type Description
EDeviceActivityLevel

GetTrackedDeviceClass(UInt32)

Declaration
public ETrackedDeviceClass GetTrackedDeviceClass(uint unDeviceIndex)
Parameters
Type Name Description
UInt32 unDeviceIndex
Returns
Type Description
ETrackedDeviceClass

GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole)

Declaration
public uint GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole unDeviceType)
Parameters
Type Name Description
ETrackedControllerRole unDeviceType
Returns
Type Description
UInt32

GetUint64TrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)

Declaration
public ulong GetUint64TrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, ref ETrackedPropertyError pError)
Parameters
Type Name Description
UInt32 unDeviceIndex
ETrackedDeviceProperty prop
ETrackedPropertyError pError
Returns
Type Description
UInt64

IsDisplayOnDesktop()

Declaration
public bool IsDisplayOnDesktop()
Returns
Type Description
Boolean

IsInputAvailable()

Declaration
public bool IsInputAvailable()
Returns
Type Description
Boolean

IsSteamVRDrawingControllers()

Declaration
public bool IsSteamVRDrawingControllers()
Returns
Type Description
Boolean

IsTrackedDeviceConnected(UInt32)

Declaration
public bool IsTrackedDeviceConnected(uint unDeviceIndex)
Parameters
Type Name Description
UInt32 unDeviceIndex
Returns
Type Description
Boolean

PerformFirmwareUpdate(UInt32)

Declaration
public EVRFirmwareError PerformFirmwareUpdate(uint unDeviceIndex)
Parameters
Type Name Description
UInt32 unDeviceIndex
Returns
Type Description
EVRFirmwareError

PollNextEvent(ref VREvent_t, UInt32)

Declaration
public bool PollNextEvent(ref VREvent_t pEvent, uint uncbVREvent)
Parameters
Type Name Description
VREvent_t pEvent
UInt32 uncbVREvent
Returns
Type Description
Boolean

PollNextEventWithPose(ETrackingUniverseOrigin, ref VREvent_t, UInt32, ref TrackedDevicePose_t)

Declaration
public bool PollNextEventWithPose(ETrackingUniverseOrigin eOrigin, ref VREvent_t pEvent, uint uncbVREvent, ref TrackedDevicePose_t pTrackedDevicePose)
Parameters
Type Name Description
ETrackingUniverseOrigin eOrigin
VREvent_t pEvent
UInt32 uncbVREvent
TrackedDevicePose_t pTrackedDevicePose
Returns
Type Description
Boolean

ResetSeatedZeroPose()

Declaration
public void ResetSeatedZeroPose()

SetDisplayVisibility(Boolean)

Declaration
public bool SetDisplayVisibility(bool bIsVisibleOnDesktop)
Parameters
Type Name Description
Boolean bIsVisibleOnDesktop
Returns
Type Description
Boolean

ShouldApplicationPause()

Declaration
public bool ShouldApplicationPause()
Returns
Type Description
Boolean

ShouldApplicationReduceRenderingWork()

Declaration
public bool ShouldApplicationReduceRenderingWork()
Returns
Type Description
Boolean

TriggerHapticPulse(UInt32, UInt32, UInt16)

Declaration
public void TriggerHapticPulse(uint unControllerDeviceIndex, uint unAxisId, ushort usDurationMicroSec)
Parameters
Type Name Description
UInt32 unControllerDeviceIndex
UInt32 unAxisId
UInt16 usDurationMicroSec