Class CVRSystem

Inheritance

System.Object

CVRSystem

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Valve.VR

Assembly: Assembly-CSharp.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
System.Single	fU
System.Single	fV
DistortionCoordinates_t	pDistortionCoordinates

Returns

Type	Description
System.Boolean

DriverDebugRequest(UInt32, String, StringBuilder, UInt32)

Declaration

public uint DriverDebugRequest(uint unDeviceIndex, string pchRequest, StringBuilder pchResponseBuffer, uint unResponseBufferSize)

Parameters

Type	Name	Description
System.UInt32	unDeviceIndex
System.String	pchRequest
System.Text.StringBuilder	pchResponseBuffer
System.UInt32	unResponseBufferSize

Returns

Type	Description
System.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
System.UInt32	unDeviceIndex
ETrackedDeviceProperty	prop
System.UInt32	propType
System.IntPtr	pBuffer
System.UInt32	unBufferSize
ETrackedPropertyError	pError

Returns

Type	Description
System.UInt32

GetBoolTrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)

Declaration

public bool GetBoolTrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, ref ETrackedPropertyError pError)

Parameters

Type	Name	Description
System.UInt32	unDeviceIndex
ETrackedDeviceProperty	prop
ETrackedPropertyError	pError

Returns

Type	Description
System.Boolean

GetButtonIdNameFromEnum(EVRButtonId)

Declaration

public string GetButtonIdNameFromEnum(EVRButtonId eButtonId)

Parameters

Type	Name	Description
EVRButtonId	eButtonId

Returns

Type	Description
System.String

GetControllerAxisTypeNameFromEnum(EVRControllerAxisType)

Declaration

public string GetControllerAxisTypeNameFromEnum(EVRControllerAxisType eAxisType)

Parameters

Type	Name	Description
EVRControllerAxisType	eAxisType

Returns

Type	Description
System.String

GetControllerRoleForTrackedDeviceIndex(UInt32)

Declaration

public ETrackedControllerRole GetControllerRoleForTrackedDeviceIndex(uint unDeviceIndex)

Parameters

Type	Name	Description
System.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
System.UInt32	unControllerDeviceIndex
VRControllerState_t	pControllerState
System.UInt32	unControllerStateSize

Returns

Type	Description
System.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
System.UInt32	unControllerDeviceIndex
VRControllerState_t	pControllerState
System.UInt32	unControllerStateSize
TrackedDevicePose_t	pTrackedDevicePose

Returns

Type	Description
System.Boolean

GetD3D9AdapterIndex()

Declaration

public int GetD3D9AdapterIndex()

Returns

Type	Description
System.Int32

GetDeviceToAbsoluteTrackingPose(ETrackingUniverseOrigin, Single, TrackedDevicePose_t[])

Declaration

public void GetDeviceToAbsoluteTrackingPose(ETrackingUniverseOrigin eOrigin, float fPredictedSecondsToPhotonsFromNow, TrackedDevicePose_t[] pTrackedDevicePoseArray)

Parameters

Type	Name	Description
ETrackingUniverseOrigin	eOrigin
System.Single	fPredictedSecondsToPhotonsFromNow
TrackedDevicePose_t[]	pTrackedDevicePoseArray

GetDXGIOutputInfo(ref Int32)

Declaration

public void GetDXGIOutputInfo(ref int pnAdapterIndex)

Parameters

Type	Name	Description
System.Int32	pnAdapterIndex

GetEventTypeNameFromEnum(EVREventType)

Declaration

public string GetEventTypeNameFromEnum(EVREventType eType)

Parameters

Type	Name	Description
EVREventType	eType

Returns

Type	Description
System.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
System.UInt32	unDeviceIndex
ETrackedDeviceProperty	prop
ETrackedPropertyError	pError

Returns

Type	Description
System.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
System.UInt32	unDeviceIndex
ETrackedDeviceProperty	prop
ETrackedPropertyError	pError

Returns

Type	Description
System.Int32

GetMatrix34TrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)

Declaration

public HmdMatrix34_t GetMatrix34TrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, ref ETrackedPropertyError pError)

Parameters

Type	Name	Description
System.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
System.UInt64	pnDevice
ETextureType	textureType
System.IntPtr	pInstance

GetProjectionMatrix(EVREye, Single, Single)

Declaration

public HmdMatrix44_t GetProjectionMatrix(EVREye eEye, float fNearZ, float fFarZ)

Parameters

Type	Name	Description
EVREye	eEye
System.Single	fNearZ
System.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
System.Single	pfLeft
System.Single	pfRight
System.Single	pfTop
System.Single	pfBottom

GetPropErrorNameFromEnum(ETrackedPropertyError)

Declaration

public string GetPropErrorNameFromEnum(ETrackedPropertyError error)

Parameters

Type	Name	Description
ETrackedPropertyError	error

Returns

Type	Description
System.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
System.UInt32	pnWidth
System.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
System.UInt32[]	punTrackedDeviceIndexArray
System.UInt32	unRelativeToTrackedDeviceIndex

Returns

Type	Description
System.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
System.UInt32	unDeviceIndex
ETrackedDeviceProperty	prop
System.Text.StringBuilder	pchValue
System.UInt32	unBufferSize
ETrackedPropertyError	pError

Returns

Type	Description
System.UInt32

GetTimeSinceLastVsync(ref Single, ref UInt64)

Declaration

public bool GetTimeSinceLastVsync(ref float pfSecondsSinceLastVsync, ref ulong pulFrameCounter)

Parameters

Type	Name	Description
System.Single	pfSecondsSinceLastVsync
System.UInt64	pulFrameCounter

Returns

Type	Description
System.Boolean

GetTrackedDeviceActivityLevel(UInt32)

Declaration

public EDeviceActivityLevel GetTrackedDeviceActivityLevel(uint unDeviceId)

Parameters

Type	Name	Description
System.UInt32	unDeviceId

Returns

Type	Description
EDeviceActivityLevel

GetTrackedDeviceClass(UInt32)

Declaration

public ETrackedDeviceClass GetTrackedDeviceClass(uint unDeviceIndex)

Parameters

Type	Name	Description
System.UInt32	unDeviceIndex

Returns

Type	Description
ETrackedDeviceClass

GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole)

Declaration

public uint GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole unDeviceType)

Parameters

Type	Name	Description
ETrackedControllerRole	unDeviceType

Returns

Type	Description
System.UInt32

GetUint64TrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)

Declaration

public ulong GetUint64TrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, ref ETrackedPropertyError pError)

Parameters

Type	Name	Description
System.UInt32	unDeviceIndex
ETrackedDeviceProperty	prop
ETrackedPropertyError	pError

Returns

Type	Description
System.UInt64

IsDisplayOnDesktop()

Declaration

public bool IsDisplayOnDesktop()

Returns

Type	Description
System.Boolean

IsInputAvailable()

Declaration

public bool IsInputAvailable()

Returns

Type	Description
System.Boolean

IsSteamVRDrawingControllers()

Declaration

public bool IsSteamVRDrawingControllers()

Returns

Type	Description
System.Boolean

IsTrackedDeviceConnected(UInt32)

Declaration

public bool IsTrackedDeviceConnected(uint unDeviceIndex)

Parameters

Type	Name	Description
System.UInt32	unDeviceIndex

Returns

Type	Description
System.Boolean

PerformFirmwareUpdate(UInt32)

Declaration

public EVRFirmwareError PerformFirmwareUpdate(uint unDeviceIndex)

Parameters

Type	Name	Description
System.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
System.UInt32	uncbVREvent

Returns

Type	Description
System.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
System.UInt32	uncbVREvent
TrackedDevicePose_t	pTrackedDevicePose

Returns

Type	Description
System.Boolean

ResetSeatedZeroPose()

Declaration

public void ResetSeatedZeroPose()

SetDisplayVisibility(Boolean)

Declaration

public bool SetDisplayVisibility(bool bIsVisibleOnDesktop)

Parameters

Type	Name	Description
System.Boolean	bIsVisibleOnDesktop

Returns

Type	Description
System.Boolean

ShouldApplicationPause()

Declaration

public bool ShouldApplicationPause()

Returns

Type	Description
System.Boolean

ShouldApplicationReduceRenderingWork()

Declaration

public bool ShouldApplicationReduceRenderingWork()

Returns

Type	Description
System.Boolean

TriggerHapticPulse(UInt32, UInt32, UInt16)

Declaration

public void TriggerHapticPulse(uint unControllerDeviceIndex, uint unAxisId, ushort usDurationMicroSec)

Parameters

Type	Name	Description
System.UInt32	unControllerDeviceIndex
System.UInt32	unAxisId
System.UInt16	usDurationMicroSec