Table of Contents

Class CVRSystem

Namespace
Valve.VR
Assembly
Stride.VirtualReality.dll
public class CVRSystem
Inheritance
CVRSystem

Methods

AcknowledgeQuit_Exiting() 

public void AcknowledgeQuit_Exiting()

ApplyTransform(ref TrackedDevicePose_t, ref TrackedDevicePose_t, ref HmdMatrix34_t) 

public void ApplyTransform(ref TrackedDevicePose_t pOutputPose, ref TrackedDevicePose_t pTrackedDevicePose, ref HmdMatrix34_t pTransform)

Parameters

pOutputPose TrackedDevicePose_t
pTrackedDevicePose TrackedDevicePose_t
pTransform HmdMatrix34_t

ComputeDistortion(EVREye, float, float, ref DistortionCoordinates_t) 

public bool ComputeDistortion(EVREye eEye, float fU, float fV, ref DistortionCoordinates_t pDistortionCoordinates)

Parameters

eEye EVREye
fU float
fV float
pDistortionCoordinates DistortionCoordinates_t

Returns

bool

GetAppContainerFilePaths(StringBuilder, uint) 

public uint GetAppContainerFilePaths(StringBuilder pchBuffer, uint unBufferSize)

Parameters

pchBuffer StringBuilder
unBufferSize uint

Returns

uint

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

public uint GetArrayTrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, uint propType, IntPtr pBuffer, uint unBufferSize, ref ETrackedPropertyError pError)

Parameters

unDeviceIndex uint
prop ETrackedDeviceProperty
propType uint
pBuffer IntPtr
unBufferSize uint
pError ETrackedPropertyError

Returns

uint

GetBoolTrackedDeviceProperty(uint, ETrackedDeviceProperty, ref ETrackedPropertyError) 

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

Parameters

unDeviceIndex uint
prop ETrackedDeviceProperty
pError ETrackedPropertyError

Returns

bool

GetButtonIdNameFromEnum(EVRButtonId) 

public string GetButtonIdNameFromEnum(EVRButtonId eButtonId)

Parameters

eButtonId EVRButtonId

Returns

string

GetControllerAxisTypeNameFromEnum(EVRControllerAxisType) 

public string GetControllerAxisTypeNameFromEnum(EVRControllerAxisType eAxisType)

Parameters

eAxisType EVRControllerAxisType

Returns

string

GetControllerRoleForTrackedDeviceIndex(uint) 

public ETrackedControllerRole GetControllerRoleForTrackedDeviceIndex(uint unDeviceIndex)

Parameters

unDeviceIndex uint

Returns

ETrackedControllerRole

GetControllerState(uint, ref VRControllerState_t, uint) 

public bool GetControllerState(uint unControllerDeviceIndex, ref VRControllerState_t pControllerState, uint unControllerStateSize)

Parameters

unControllerDeviceIndex uint
pControllerState VRControllerState_t
unControllerStateSize uint

Returns

bool

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

public bool GetControllerStateWithPose(ETrackingUniverseOrigin eOrigin, uint unControllerDeviceIndex, ref VRControllerState_t pControllerState, uint unControllerStateSize, ref TrackedDevicePose_t pTrackedDevicePose)

Parameters

eOrigin ETrackingUniverseOrigin
unControllerDeviceIndex uint
pControllerState VRControllerState_t
unControllerStateSize uint
pTrackedDevicePose TrackedDevicePose_t

Returns

bool

GetD3D9AdapterIndex() 

public int GetD3D9AdapterIndex()

Returns

int

GetDXGIOutputInfo(ref int) 

public void GetDXGIOutputInfo(ref int pnAdapterIndex)

Parameters

pnAdapterIndex int

GetDeviceToAbsoluteTrackingPose(ETrackingUniverseOrigin, float, TrackedDevicePose_t[]) 

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

Parameters

eOrigin ETrackingUniverseOrigin
fPredictedSecondsToPhotonsFromNow float
pTrackedDevicePoseArray TrackedDevicePose_t[]

GetEventTypeNameFromEnum(EVREventType) 

public string GetEventTypeNameFromEnum(EVREventType eType)

Parameters

eType EVREventType

Returns

string

GetEyeToHeadTransform(EVREye) 

public HmdMatrix34_t GetEyeToHeadTransform(EVREye eEye)

Parameters

eEye EVREye

Returns

HmdMatrix34_t

GetFloatTrackedDeviceProperty(uint, ETrackedDeviceProperty, ref ETrackedPropertyError) 

public float GetFloatTrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, ref ETrackedPropertyError pError)

Parameters

unDeviceIndex uint
prop ETrackedDeviceProperty
pError ETrackedPropertyError

Returns

float

GetHiddenAreaMesh(EVREye, EHiddenAreaMeshType) 

public HiddenAreaMesh_t GetHiddenAreaMesh(EVREye eEye, EHiddenAreaMeshType type)

Parameters

eEye EVREye
type EHiddenAreaMeshType

Returns

HiddenAreaMesh_t

GetInt32TrackedDeviceProperty(uint, ETrackedDeviceProperty, ref ETrackedPropertyError) 

public int GetInt32TrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, ref ETrackedPropertyError pError)

Parameters

unDeviceIndex uint
prop ETrackedDeviceProperty
pError ETrackedPropertyError

Returns

int

GetMatrix34TrackedDeviceProperty(uint, ETrackedDeviceProperty, ref ETrackedPropertyError) 

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

Parameters

unDeviceIndex uint
prop ETrackedDeviceProperty
pError ETrackedPropertyError

Returns

HmdMatrix34_t

GetOutputDevice(ref ulong, ETextureType, IntPtr) 

public void GetOutputDevice(ref ulong pnDevice, ETextureType textureType, IntPtr pInstance)

Parameters

pnDevice ulong
textureType ETextureType
pInstance IntPtr

GetProjectionMatrix(EVREye, float, float) 

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

Parameters

eEye EVREye
fNearZ float
fFarZ float

Returns

HmdMatrix44_t

GetProjectionRaw(EVREye, ref float, ref float, ref float, ref float) 

public void GetProjectionRaw(EVREye eEye, ref float pfLeft, ref float pfRight, ref float pfTop, ref float pfBottom)

Parameters

eEye EVREye
pfLeft float
pfRight float
pfTop float
pfBottom float

GetPropErrorNameFromEnum(ETrackedPropertyError) 

public string GetPropErrorNameFromEnum(ETrackedPropertyError error)

Parameters

error ETrackedPropertyError

Returns

string

GetRawZeroPoseToStandingAbsoluteTrackingPose() 

public HmdMatrix34_t GetRawZeroPoseToStandingAbsoluteTrackingPose()

Returns

HmdMatrix34_t

GetRecommendedRenderTargetSize(ref uint, ref uint) 

public void GetRecommendedRenderTargetSize(ref uint pnWidth, ref uint pnHeight)

Parameters

pnWidth uint
pnHeight uint

GetRuntimeVersion() 

public string GetRuntimeVersion()

Returns

string

GetSeatedZeroPoseToStandingAbsoluteTrackingPose() 

public HmdMatrix34_t GetSeatedZeroPoseToStandingAbsoluteTrackingPose()

Returns

HmdMatrix34_t

GetSortedTrackedDeviceIndicesOfClass(ETrackedDeviceClass, uint[], uint) 

public uint GetSortedTrackedDeviceIndicesOfClass(ETrackedDeviceClass eTrackedDeviceClass, uint[] punTrackedDeviceIndexArray, uint unRelativeToTrackedDeviceIndex)

Parameters

eTrackedDeviceClass ETrackedDeviceClass
punTrackedDeviceIndexArray uint[]
unRelativeToTrackedDeviceIndex uint

Returns

uint

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

public uint GetStringTrackedDeviceProperty(uint unDeviceIndex, ETrackedDeviceProperty prop, StringBuilder pchValue, uint unBufferSize, ref ETrackedPropertyError pError)

Parameters

unDeviceIndex uint
prop ETrackedDeviceProperty
pchValue StringBuilder
unBufferSize uint
pError ETrackedPropertyError

Returns

uint

GetTimeSinceLastVsync(ref float, ref ulong) 

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

Parameters

pfSecondsSinceLastVsync float
pulFrameCounter ulong

Returns

bool

GetTrackedDeviceActivityLevel(uint) 

public EDeviceActivityLevel GetTrackedDeviceActivityLevel(uint unDeviceId)

Parameters

unDeviceId uint

Returns

EDeviceActivityLevel

GetTrackedDeviceClass(uint) 

public ETrackedDeviceClass GetTrackedDeviceClass(uint unDeviceIndex)

Parameters

unDeviceIndex uint

Returns

ETrackedDeviceClass

GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole) 

public uint GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole unDeviceType)

Parameters

unDeviceType ETrackedControllerRole

Returns

uint

GetUint64TrackedDeviceProperty(uint, ETrackedDeviceProperty, ref ETrackedPropertyError) 

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

Parameters

unDeviceIndex uint
prop ETrackedDeviceProperty
pError ETrackedPropertyError

Returns

ulong

IsDisplayOnDesktop() 

public bool IsDisplayOnDesktop()

Returns

bool

IsInputAvailable() 

public bool IsInputAvailable()

Returns

bool

IsSteamVRDrawingControllers() 

public bool IsSteamVRDrawingControllers()

Returns

bool

IsTrackedDeviceConnected(uint) 

public bool IsTrackedDeviceConnected(uint unDeviceIndex)

Parameters

unDeviceIndex uint

Returns

bool

PerformFirmwareUpdate(uint) 

public EVRFirmwareError PerformFirmwareUpdate(uint unDeviceIndex)

Parameters

unDeviceIndex uint

Returns

EVRFirmwareError

PollNextEvent(ref VREvent_t, uint) 

public bool PollNextEvent(ref VREvent_t pEvent, uint uncbVREvent)

Parameters

pEvent VREvent_t
uncbVREvent uint

Returns

bool

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

public bool PollNextEventWithPose(ETrackingUniverseOrigin eOrigin, ref VREvent_t pEvent, uint uncbVREvent, ref TrackedDevicePose_t pTrackedDevicePose)

Parameters

eOrigin ETrackingUniverseOrigin
pEvent VREvent_t
uncbVREvent uint
pTrackedDevicePose TrackedDevicePose_t

Returns

bool

SetDisplayVisibility(bool) 

public bool SetDisplayVisibility(bool bIsVisibleOnDesktop)

Parameters

bIsVisibleOnDesktop bool

Returns

bool

ShouldApplicationPause() 

public bool ShouldApplicationPause()

Returns

bool

ShouldApplicationReduceRenderingWork() 

public bool ShouldApplicationReduceRenderingWork()

Returns

bool

TriggerHapticPulse(uint, uint, ushort) 

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

Parameters

unControllerDeviceIndex uint
unAxisId uint
usDurationMicroSec ushort
Edit this page