CVRInput Class

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

    public class CVRInput
    Name Description
    Methods
    DecompressSkeletalBoneData(IntPtr, UInt32, EVRSkeletalTransformSpace, VRBoneTransform_t[])
    GetActionBindingInfo(UInt64, ref InputBindingInfo_t, UInt32, UInt32, ref UInt32)
    GetActionHandle(String, ref UInt64)
    GetActionOrigins(UInt64, UInt64, UInt64[])
    GetActionSetHandle(String, ref UInt64)
    GetAnalogActionData(UInt64, ref InputAnalogActionData_t, UInt32, UInt64)
    GetBindingVariant(UInt64, StringBuilder, UInt32)
    GetBoneCount(UInt64, ref UInt32)
    GetBoneHierarchy(UInt64, Int32[])
    GetBoneName(UInt64, Int32, StringBuilder, UInt32)
    GetComponentStateForBinding(String, String, ref InputBindingInfo_t, UInt32, UInt32, ref RenderModel_ComponentState_t)
    GetDigitalActionData(UInt64, ref InputDigitalActionData_t, UInt32, UInt64)
    GetDominantHand(ref ETrackedControllerRole)
    GetInputSourceHandle(String, ref UInt64)
    GetOriginLocalizedName(UInt64, StringBuilder, UInt32, Int32)
    GetOriginTrackedDeviceInfo(UInt64, ref InputOriginInfo_t, UInt32)
    GetPoseActionDataForNextFrame(UInt64, ETrackingUniverseOrigin, ref InputPoseActionData_t, UInt32, UInt64)
    GetPoseActionDataRelativeToNow(UInt64, ETrackingUniverseOrigin, Single, ref InputPoseActionData_t, UInt32, UInt64)
    GetSkeletalActionData(UInt64, ref InputSkeletalActionData_t, UInt32)
    GetSkeletalBoneData(UInt64, EVRSkeletalTransformSpace, EVRSkeletalMotionRange, VRBoneTransform_t[])
    GetSkeletalBoneDataCompressed(UInt64, EVRSkeletalMotionRange, IntPtr, UInt32, ref UInt32)
    GetSkeletalReferenceTransforms(UInt64, EVRSkeletalTransformSpace, EVRSkeletalReferencePose, VRBoneTransform_t[])
    GetSkeletalSummaryData(UInt64, EVRSummaryType, ref VRSkeletalSummaryData_t)
    GetSkeletalTrackingLevel(UInt64, ref EVRSkeletalTrackingLevel)
    IsUsingLegacyInput()
    OpenBindingUI(String, UInt64, UInt64, Boolean)
    SetActionManifestPath(String)
    SetDominantHand(ETrackedControllerRole)
    ShowActionOrigins(UInt64, UInt64)
    ShowBindingsForActionSet(VRActiveActionSet_t[], UInt32, UInt64)
    TriggerHapticVibrationAction(UInt64, Single, Single, Single, Single, UInt64)
    UpdateActionState(VRActiveActionSet_t[], UInt32)
    | Improve this Doc View Source

    Methods

    DecompressSkeletalBoneData(IntPtr, UInt32, EVRSkeletalTransformSpace, VRBoneTransform_t[])

    public EVRInputError DecompressSkeletalBoneData(IntPtr pvCompressedBuffer, uint unCompressedBufferSize, EVRSkeletalTransformSpace eTransformSpace, VRBoneTransform_t[] pTransformArray)
    Parameters
    Type Name Description
    System.IntPtr pvCompressedBuffer
    System.UInt32 unCompressedBufferSize
    EVRSkeletalTransformSpace eTransformSpace
    VRBoneTransform_t[] pTransformArray
    Returns
    Type Description
    EVRInputError

    GetActionBindingInfo(UInt64, ref InputBindingInfo_t, UInt32, UInt32, ref UInt32)

    public EVRInputError GetActionBindingInfo(ulong action, ref InputBindingInfo_t pOriginInfo, uint unBindingInfoSize, uint unBindingInfoCount, ref uint punReturnedBindingInfoCount)
    Parameters
    Type Name Description
    System.UInt64 action
    InputBindingInfo_t pOriginInfo
    System.UInt32 unBindingInfoSize
    System.UInt32 unBindingInfoCount
    System.UInt32 punReturnedBindingInfoCount
    Returns
    Type Description
    EVRInputError

    GetActionHandle(String, ref UInt64)

    public EVRInputError GetActionHandle(string pchActionName, ref ulong pHandle)
    Parameters
    Type Name Description
    System.String pchActionName
    System.UInt64 pHandle
    Returns
    Type Description
    EVRInputError

    GetActionOrigins(UInt64, UInt64, UInt64[])

    public EVRInputError GetActionOrigins(ulong actionSetHandle, ulong digitalActionHandle, ulong[] originsOut)
    Parameters
    Type Name Description
    System.UInt64 actionSetHandle
    System.UInt64 digitalActionHandle
    System.UInt64[] originsOut
    Returns
    Type Description
    EVRInputError

    GetActionSetHandle(String, ref UInt64)

    public EVRInputError GetActionSetHandle(string pchActionSetName, ref ulong pHandle)
    Parameters
    Type Name Description
    System.String pchActionSetName
    System.UInt64 pHandle
    Returns
    Type Description
    EVRInputError

    GetAnalogActionData(UInt64, ref InputAnalogActionData_t, UInt32, UInt64)

    public EVRInputError GetAnalogActionData(ulong action, ref InputAnalogActionData_t pActionData, uint unActionDataSize, ulong ulRestrictToDevice)
    Parameters
    Type Name Description
    System.UInt64 action
    InputAnalogActionData_t pActionData
    System.UInt32 unActionDataSize
    System.UInt64 ulRestrictToDevice
    Returns
    Type Description
    EVRInputError

    GetBindingVariant(UInt64, StringBuilder, UInt32)

    public EVRInputError GetBindingVariant(ulong ulDevicePath, StringBuilder pchVariantArray, uint unVariantArraySize)
    Parameters
    Type Name Description
    System.UInt64 ulDevicePath
    System.Text.StringBuilder pchVariantArray
    System.UInt32 unVariantArraySize
    Returns
    Type Description
    EVRInputError

    GetBoneCount(UInt64, ref UInt32)

    public EVRInputError GetBoneCount(ulong action, ref uint pBoneCount)
    Parameters
    Type Name Description
    System.UInt64 action
    System.UInt32 pBoneCount
    Returns
    Type Description
    EVRInputError

    GetBoneHierarchy(UInt64, Int32[])

    public EVRInputError GetBoneHierarchy(ulong action, int[] pParentIndices)
    Parameters
    Type Name Description
    System.UInt64 action
    System.Int32[] pParentIndices
    Returns
    Type Description
    EVRInputError

    GetBoneName(UInt64, Int32, StringBuilder, UInt32)

    public EVRInputError GetBoneName(ulong action, int nBoneIndex, StringBuilder pchBoneName, uint unNameBufferSize)
    Parameters
    Type Name Description
    System.UInt64 action
    System.Int32 nBoneIndex
    System.Text.StringBuilder pchBoneName
    System.UInt32 unNameBufferSize
    Returns
    Type Description
    EVRInputError

    GetComponentStateForBinding(String, String, ref InputBindingInfo_t, UInt32, UInt32, ref RenderModel_ComponentState_t)

    public EVRInputError GetComponentStateForBinding(string pchRenderModelName, string pchComponentName, ref InputBindingInfo_t pOriginInfo, uint unBindingInfoSize, uint unBindingInfoCount, ref RenderModel_ComponentState_t pComponentState)
    Parameters
    Type Name Description
    System.String pchRenderModelName
    System.String pchComponentName
    InputBindingInfo_t pOriginInfo
    System.UInt32 unBindingInfoSize
    System.UInt32 unBindingInfoCount
    RenderModel_ComponentState_t pComponentState
    Returns
    Type Description
    EVRInputError

    GetDigitalActionData(UInt64, ref InputDigitalActionData_t, UInt32, UInt64)

    public EVRInputError GetDigitalActionData(ulong action, ref InputDigitalActionData_t pActionData, uint unActionDataSize, ulong ulRestrictToDevice)
    Parameters
    Type Name Description
    System.UInt64 action
    InputDigitalActionData_t pActionData
    System.UInt32 unActionDataSize
    System.UInt64 ulRestrictToDevice
    Returns
    Type Description
    EVRInputError

    GetDominantHand(ref ETrackedControllerRole)

    public EVRInputError GetDominantHand(ref ETrackedControllerRole peDominantHand)
    Parameters
    Type Name Description
    ETrackedControllerRole peDominantHand
    Returns
    Type Description
    EVRInputError

    GetInputSourceHandle(String, ref UInt64)

    public EVRInputError GetInputSourceHandle(string pchInputSourcePath, ref ulong pHandle)
    Parameters
    Type Name Description
    System.String pchInputSourcePath
    System.UInt64 pHandle
    Returns
    Type Description
    EVRInputError

    GetOriginLocalizedName(UInt64, StringBuilder, UInt32, Int32)

    public EVRInputError GetOriginLocalizedName(ulong origin, StringBuilder pchNameArray, uint unNameArraySize, int unStringSectionsToInclude)
    Parameters
    Type Name Description
    System.UInt64 origin
    System.Text.StringBuilder pchNameArray
    System.UInt32 unNameArraySize
    System.Int32 unStringSectionsToInclude
    Returns
    Type Description
    EVRInputError

    GetOriginTrackedDeviceInfo(UInt64, ref InputOriginInfo_t, UInt32)

    public EVRInputError GetOriginTrackedDeviceInfo(ulong origin, ref InputOriginInfo_t pOriginInfo, uint unOriginInfoSize)
    Parameters
    Type Name Description
    System.UInt64 origin
    InputOriginInfo_t pOriginInfo
    System.UInt32 unOriginInfoSize
    Returns
    Type Description
    EVRInputError

    GetPoseActionDataForNextFrame(UInt64, ETrackingUniverseOrigin, ref InputPoseActionData_t, UInt32, UInt64)

    public EVRInputError GetPoseActionDataForNextFrame(ulong action, ETrackingUniverseOrigin eOrigin, ref InputPoseActionData_t pActionData, uint unActionDataSize, ulong ulRestrictToDevice)
    Parameters
    Type Name Description
    System.UInt64 action
    ETrackingUniverseOrigin eOrigin
    InputPoseActionData_t pActionData
    System.UInt32 unActionDataSize
    System.UInt64 ulRestrictToDevice
    Returns
    Type Description
    EVRInputError

    GetPoseActionDataRelativeToNow(UInt64, ETrackingUniverseOrigin, Single, ref InputPoseActionData_t, UInt32, UInt64)

    public EVRInputError GetPoseActionDataRelativeToNow(ulong action, ETrackingUniverseOrigin eOrigin, float fPredictedSecondsFromNow, ref InputPoseActionData_t pActionData, uint unActionDataSize, ulong ulRestrictToDevice)
    Parameters
    Type Name Description
    System.UInt64 action
    ETrackingUniverseOrigin eOrigin
    System.Single fPredictedSecondsFromNow
    InputPoseActionData_t pActionData
    System.UInt32 unActionDataSize
    System.UInt64 ulRestrictToDevice
    Returns
    Type Description
    EVRInputError

    GetSkeletalActionData(UInt64, ref InputSkeletalActionData_t, UInt32)

    public EVRInputError GetSkeletalActionData(ulong action, ref InputSkeletalActionData_t pActionData, uint unActionDataSize)
    Parameters
    Type Name Description
    System.UInt64 action
    InputSkeletalActionData_t pActionData
    System.UInt32 unActionDataSize
    Returns
    Type Description
    EVRInputError

    GetSkeletalBoneData(UInt64, EVRSkeletalTransformSpace, EVRSkeletalMotionRange, VRBoneTransform_t[])

    public EVRInputError GetSkeletalBoneData(ulong action, EVRSkeletalTransformSpace eTransformSpace, EVRSkeletalMotionRange eMotionRange, VRBoneTransform_t[] pTransformArray)
    Parameters
    Type Name Description
    System.UInt64 action
    EVRSkeletalTransformSpace eTransformSpace
    EVRSkeletalMotionRange eMotionRange
    VRBoneTransform_t[] pTransformArray
    Returns
    Type Description
    EVRInputError

    GetSkeletalBoneDataCompressed(UInt64, EVRSkeletalMotionRange, IntPtr, UInt32, ref UInt32)

    public EVRInputError GetSkeletalBoneDataCompressed(ulong action, EVRSkeletalMotionRange eMotionRange, IntPtr pvCompressedData, uint unCompressedSize, ref uint punRequiredCompressedSize)
    Parameters
    Type Name Description
    System.UInt64 action
    EVRSkeletalMotionRange eMotionRange
    System.IntPtr pvCompressedData
    System.UInt32 unCompressedSize
    System.UInt32 punRequiredCompressedSize
    Returns
    Type Description
    EVRInputError

    GetSkeletalReferenceTransforms(UInt64, EVRSkeletalTransformSpace, EVRSkeletalReferencePose, VRBoneTransform_t[])

    public EVRInputError GetSkeletalReferenceTransforms(ulong action, EVRSkeletalTransformSpace eTransformSpace, EVRSkeletalReferencePose eReferencePose, VRBoneTransform_t[] pTransformArray)
    Parameters
    Type Name Description
    System.UInt64 action
    EVRSkeletalTransformSpace eTransformSpace
    EVRSkeletalReferencePose eReferencePose
    VRBoneTransform_t[] pTransformArray
    Returns
    Type Description
    EVRInputError

    GetSkeletalSummaryData(UInt64, EVRSummaryType, ref VRSkeletalSummaryData_t)

    public EVRInputError GetSkeletalSummaryData(ulong action, EVRSummaryType eSummaryType, ref VRSkeletalSummaryData_t pSkeletalSummaryData)
    Parameters
    Type Name Description
    System.UInt64 action
    EVRSummaryType eSummaryType
    VRSkeletalSummaryData_t pSkeletalSummaryData
    Returns
    Type Description
    EVRInputError

    GetSkeletalTrackingLevel(UInt64, ref EVRSkeletalTrackingLevel)

    public EVRInputError GetSkeletalTrackingLevel(ulong action, ref EVRSkeletalTrackingLevel pSkeletalTrackingLevel)
    Parameters
    Type Name Description
    System.UInt64 action
    EVRSkeletalTrackingLevel pSkeletalTrackingLevel
    Returns
    Type Description
    EVRInputError

    IsUsingLegacyInput()

    public bool IsUsingLegacyInput()
    Returns
    Type Description
    System.Boolean

    OpenBindingUI(String, UInt64, UInt64, Boolean)

    public EVRInputError OpenBindingUI(string pchAppKey, ulong ulActionSetHandle, ulong ulDeviceHandle, bool bShowOnDesktop)
    Parameters
    Type Name Description
    System.String pchAppKey
    System.UInt64 ulActionSetHandle
    System.UInt64 ulDeviceHandle
    System.Boolean bShowOnDesktop
    Returns
    Type Description
    EVRInputError

    SetActionManifestPath(String)

    public EVRInputError SetActionManifestPath(string pchActionManifestPath)
    Parameters
    Type Name Description
    System.String pchActionManifestPath
    Returns
    Type Description
    EVRInputError

    SetDominantHand(ETrackedControllerRole)

    public EVRInputError SetDominantHand(ETrackedControllerRole eDominantHand)
    Parameters
    Type Name Description
    ETrackedControllerRole eDominantHand
    Returns
    Type Description
    EVRInputError

    ShowActionOrigins(UInt64, UInt64)

    public EVRInputError ShowActionOrigins(ulong actionSetHandle, ulong ulActionHandle)
    Parameters
    Type Name Description
    System.UInt64 actionSetHandle
    System.UInt64 ulActionHandle
    Returns
    Type Description
    EVRInputError

    ShowBindingsForActionSet(VRActiveActionSet_t[], UInt32, UInt64)

    public EVRInputError ShowBindingsForActionSet(VRActiveActionSet_t[] pSets, uint unSizeOfVRSelectedActionSet_t, ulong originToHighlight)
    Parameters
    Type Name Description
    VRActiveActionSet_t[] pSets
    System.UInt32 unSizeOfVRSelectedActionSet_t
    System.UInt64 originToHighlight
    Returns
    Type Description
    EVRInputError

    TriggerHapticVibrationAction(UInt64, Single, Single, Single, Single, UInt64)

    public EVRInputError TriggerHapticVibrationAction(ulong action, float fStartSecondsFromNow, float fDurationSeconds, float fFrequency, float fAmplitude, ulong ulRestrictToDevice)
    Parameters
    Type Name Description
    System.UInt64 action
    System.Single fStartSecondsFromNow
    System.Single fDurationSeconds
    System.Single fFrequency
    System.Single fAmplitude
    System.UInt64 ulRestrictToDevice
    Returns
    Type Description
    EVRInputError

    UpdateActionState(VRActiveActionSet_t[], UInt32)

    public EVRInputError UpdateActionState(VRActiveActionSet_t[] pSets, uint unSizeOfVRSelectedActionSet_t)
    Parameters
    Type Name Description
    VRActiveActionSet_t[] pSets
    System.UInt32 unSizeOfVRSelectedActionSet_t
    Returns
    Type Description
    EVRInputError

    Extension Methods