CVRSystem Class

    Namespace: Valve.VR
    Assembly: Stride.VirtualReality.dll
    System.Object → CVRSystem
    Derived from CVRSystem: 

    public class CVRSystem
    Name Description
    Methods
    AcknowledgeQuit_Exiting()
    ApplyTransform(ref TrackedDevicePose_t, ref TrackedDevicePose_t, ref HmdMatrix34_t)
    ComputeDistortion(EVREye, Single, Single, ref DistortionCoordinates_t)
    GetAppContainerFilePaths(StringBuilder, UInt32)
    GetArrayTrackedDeviceProperty(UInt32, ETrackedDeviceProperty, UInt32, IntPtr, UInt32, ref ETrackedPropertyError)
    GetBoolTrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)
    GetButtonIdNameFromEnum(EVRButtonId)
    GetControllerAxisTypeNameFromEnum(EVRControllerAxisType)
    GetControllerRoleForTrackedDeviceIndex(UInt32)
    GetControllerState(UInt32, ref VRControllerState_t, UInt32)
    GetControllerStateWithPose(ETrackingUniverseOrigin, UInt32, ref VRControllerState_t, UInt32, ref TrackedDevicePose_t)
    GetD3D9AdapterIndex()
    GetDeviceToAbsoluteTrackingPose(ETrackingUniverseOrigin, Single, TrackedDevicePose_t[])
    GetDXGIOutputInfo(ref Int32)
    GetEventTypeNameFromEnum(EVREventType)
    GetEyeToHeadTransform(EVREye)
    GetFloatTrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)
    GetHiddenAreaMesh(EVREye, EHiddenAreaMeshType)
    GetInt32TrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)
    GetMatrix34TrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)
    GetOutputDevice(ref UInt64, ETextureType, IntPtr)
    GetProjectionMatrix(EVREye, Single, Single)
    GetProjectionRaw(EVREye, ref Single, ref Single, ref Single, ref Single)
    GetPropErrorNameFromEnum(ETrackedPropertyError)
    GetRawZeroPoseToStandingAbsoluteTrackingPose()
    GetRecommendedRenderTargetSize(ref UInt32, ref UInt32)
    GetRuntimeVersion()
    GetSeatedZeroPoseToStandingAbsoluteTrackingPose()
    GetSortedTrackedDeviceIndicesOfClass(ETrackedDeviceClass, UInt32[], UInt32)
    GetStringTrackedDeviceProperty(UInt32, ETrackedDeviceProperty, StringBuilder, UInt32, ref ETrackedPropertyError)
    GetTimeSinceLastVsync(ref Single, ref UInt64)
    GetTrackedDeviceActivityLevel(UInt32)
    GetTrackedDeviceClass(UInt32)
    GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole)
    GetUint64TrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)
    IsDisplayOnDesktop()
    IsInputAvailable()
    IsSteamVRDrawingControllers()
    IsTrackedDeviceConnected(UInt32)
    PerformFirmwareUpdate(UInt32)
    PollNextEvent(ref VREvent_t, UInt32)
    PollNextEventWithPose(ETrackingUniverseOrigin, ref VREvent_t, UInt32, ref TrackedDevicePose_t)
    SetDisplayVisibility(Boolean)
    ShouldApplicationPause()
    ShouldApplicationReduceRenderingWork()
    TriggerHapticPulse(UInt32, UInt32, UInt16)
    | Improve this Doc View Source

    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
    Type Name Description
    TrackedDevicePose_t pOutputPose
    TrackedDevicePose_t pTrackedDevicePose
    HmdMatrix34_t pTransform

    ComputeDistortion(EVREye, Single, Single, ref DistortionCoordinates_t)

    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

    GetAppContainerFilePaths(StringBuilder, UInt32)

    public uint GetAppContainerFilePaths(StringBuilder pchBuffer, uint unBufferSize)
    Parameters
    Type Name Description
    System.Text.StringBuilder pchBuffer
    System.UInt32 unBufferSize
    Returns
    Type Description
    System.UInt32

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

    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)

    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)

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

    GetControllerAxisTypeNameFromEnum(EVRControllerAxisType)

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

    GetControllerRoleForTrackedDeviceIndex(UInt32)

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

    GetControllerState(UInt32, ref VRControllerState_t, UInt32)

    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)

    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()

    public int GetD3D9AdapterIndex()
    Returns
    Type Description
    System.Int32

    GetDeviceToAbsoluteTrackingPose(ETrackingUniverseOrigin, Single, TrackedDevicePose_t[])

    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)

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

    GetEventTypeNameFromEnum(EVREventType)

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

    GetEyeToHeadTransform(EVREye)

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

    GetFloatTrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)

    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)

    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)

    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)

    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)

    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)

    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)

    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)

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

    GetRawZeroPoseToStandingAbsoluteTrackingPose()

    public HmdMatrix34_t GetRawZeroPoseToStandingAbsoluteTrackingPose()
    Returns
    Type Description
    HmdMatrix34_t

    GetRecommendedRenderTargetSize(ref UInt32, ref UInt32)

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

    GetRuntimeVersion()

    public string GetRuntimeVersion()
    Returns
    Type Description
    System.String

    GetSeatedZeroPoseToStandingAbsoluteTrackingPose()

    public HmdMatrix34_t GetSeatedZeroPoseToStandingAbsoluteTrackingPose()
    Returns
    Type Description
    HmdMatrix34_t

    GetSortedTrackedDeviceIndicesOfClass(ETrackedDeviceClass, UInt32[], UInt32)

    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)

    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)

    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)

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

    GetTrackedDeviceClass(UInt32)

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

    GetTrackedDeviceIndexForControllerRole(ETrackedControllerRole)

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

    GetUint64TrackedDeviceProperty(UInt32, ETrackedDeviceProperty, ref ETrackedPropertyError)

    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()

    public bool IsDisplayOnDesktop()
    Returns
    Type Description
    System.Boolean

    IsInputAvailable()

    public bool IsInputAvailable()
    Returns
    Type Description
    System.Boolean

    IsSteamVRDrawingControllers()

    public bool IsSteamVRDrawingControllers()
    Returns
    Type Description
    System.Boolean

    IsTrackedDeviceConnected(UInt32)

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

    PerformFirmwareUpdate(UInt32)

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

    PollNextEvent(ref VREvent_t, UInt32)

    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)

    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

    SetDisplayVisibility(Boolean)

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

    ShouldApplicationPause()

    public bool ShouldApplicationPause()
    Returns
    Type Description
    System.Boolean

    ShouldApplicationReduceRenderingWork()

    public bool ShouldApplicationReduceRenderingWork()
    Returns
    Type Description
    System.Boolean

    TriggerHapticPulse(UInt32, UInt32, UInt16)

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

    Extension Methods