Class ISteamInput

Namespace

MarymoorStudios.Core.Steamworks

Assembly

MarymoorStudios.Core.Steamworks.dll

public sealed class ISteamInput : SteamNativeObject

Inheritance

object

SteamNativeObject

ISteamInput

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

INTERFACE_VERSION

public const string INTERFACE_VERSION = "SteamInput006"

Field Value

string

Methods

ActivateActionSet(InputHandle, InputActionSetHandle)

public void ActivateActionSet(InputHandle inputHandle, InputActionSetHandle actionSetHandle)

Parameters

inputHandle InputHandle

actionSetHandle InputActionSetHandle

ActivateActionSetLayer(InputHandle, InputActionSetHandle)

public void ActivateActionSetLayer(InputHandle inputHandle, InputActionSetHandle actionSetLayerHandle)

Parameters

inputHandle InputHandle

actionSetLayerHandle InputActionSetHandle

BNewDataAvailable()

public bool BNewDataAvailable()

Returns

bool

BWaitForData(bool, uint)

public bool BWaitForData(bool waitForever, uint timeout)

Parameters

waitForever bool

timeout uint

Returns

bool

DeactivateActionSetLayer(InputHandle, InputActionSetHandle)

public void DeactivateActionSetLayer(InputHandle inputHandle, InputActionSetHandle actionSetLayerHandle)

Parameters

inputHandle InputHandle

actionSetLayerHandle InputActionSetHandle

DeactivateAllActionSetLayers(InputHandle)

public void DeactivateAllActionSetLayers(InputHandle inputHandle)

Parameters

inputHandle InputHandle

EnableActionEventCallbacks(SteamEventAction<SteamInputActionEvent>)

public IDisposable EnableActionEventCallbacks(SteamEventAction<SteamInputActionEvent> callback)

Parameters

callback SteamEventAction<SteamInputActionEvent>

Returns

IDisposable

EnableDeviceCallbacks()

public void EnableDeviceCallbacks()

GetActionOriginFromXboxOrigin(InputHandle, EXboxOrigin)

public EInputActionOrigin GetActionOriginFromXboxOrigin(InputHandle inputHandle, EXboxOrigin origin)

Parameters

inputHandle InputHandle

origin EXboxOrigin

Returns

EInputActionOrigin

GetActionSetHandle(string)

public InputActionSetHandle GetActionSetHandle(string pszActionSetName)

Parameters

pszActionSetName string

Returns

InputActionSetHandle

GetActiveActionSetLayers(InputHandle, Span<InputActionSetHandle>)

public int GetActiveActionSetLayers(InputHandle inputHandle, Span<InputActionSetHandle> handlesOut)

Parameters

inputHandle InputHandle

handlesOut Span<InputActionSetHandle>

Returns

int

GetAnalogActionData(InputHandle, InputAnalogActionHandle)

public InputAnalogActionData GetAnalogActionData(InputHandle inputHandle, InputAnalogActionHandle analogActionHandle)

Parameters

inputHandle InputHandle

analogActionHandle InputAnalogActionHandle

Returns

InputAnalogActionData

GetAnalogActionHandle(string)

public InputAnalogActionHandle GetAnalogActionHandle(string pszActionName)

Parameters

pszActionName string

Returns

InputAnalogActionHandle

GetAnalogActionOrigins(InputHandle, InputActionSetHandle, InputAnalogActionHandle, Span<EInputActionOrigin>)

public int GetAnalogActionOrigins(InputHandle inputHandle, InputActionSetHandle actionSetHandle, InputAnalogActionHandle analogActionHandle, Span<EInputActionOrigin> originsOut)

Parameters

inputHandle InputHandle

actionSetHandle InputActionSetHandle

analogActionHandle InputAnalogActionHandle

originsOut Span<EInputActionOrigin>

Returns

int

GetConnectedControllers(Span<InputHandle>)

public int GetConnectedControllers(Span<InputHandle> handlesOut)

Parameters

handlesOut Span<InputHandle>

Returns

int

GetControllerForGamepadIndex(int)

public InputHandle GetControllerForGamepadIndex(int index)

Parameters

index int

Returns

InputHandle

GetCurrentActionSet(InputHandle)

public InputActionSetHandle GetCurrentActionSet(InputHandle inputHandle)

Parameters

inputHandle InputHandle

Returns

InputActionSetHandle

GetDeviceBindingRevision(InputHandle, out int, out int)

public bool GetDeviceBindingRevision(InputHandle inputHandle, out int major, out int minor)

Parameters

inputHandle InputHandle

major int

minor int

Returns

bool

GetDigitalActionData(InputHandle, InputDigitalActionHandle)

public InputDigitalActionData GetDigitalActionData(InputHandle inputHandle, InputDigitalActionHandle digitalActionHandle)

Parameters

inputHandle InputHandle

digitalActionHandle InputDigitalActionHandle

Returns

InputDigitalActionData

GetDigitalActionHandle(string)

public InputDigitalActionHandle GetDigitalActionHandle(string pszActionName)

Parameters

pszActionName string

Returns

InputDigitalActionHandle

GetDigitalActionOrigins(InputHandle, InputActionSetHandle, InputDigitalActionHandle, Span<EInputActionOrigin>)

public int GetDigitalActionOrigins(InputHandle inputHandle, InputActionSetHandle actionSetHandle, InputDigitalActionHandle digitalActionHandle, Span<EInputActionOrigin> originsOut)

Parameters

inputHandle InputHandle

actionSetHandle InputActionSetHandle

digitalActionHandle InputDigitalActionHandle

originsOut Span<EInputActionOrigin>

Returns

int

GetGamepadIndexForController(InputHandle)

public int GetGamepadIndexForController(InputHandle ulinputHandle)

Parameters

ulinputHandle InputHandle

Returns

int

GetGlyphForActionOrigin_Legacy(EInputActionOrigin)

public string GetGlyphForActionOrigin_Legacy(EInputActionOrigin origin)

Parameters

origin EInputActionOrigin

Returns

string

GetGlyphForXboxOrigin(EXboxOrigin)

public string GetGlyphForXboxOrigin(EXboxOrigin origin)

Parameters

origin EXboxOrigin

Returns

string

GetGlyphPNGForActionOrigin(EInputActionOrigin, ESteamInputGlyphSize, uint)

public string GetGlyphPNGForActionOrigin(EInputActionOrigin origin, ESteamInputGlyphSize size, uint flags)

Parameters

origin EInputActionOrigin

size ESteamInputGlyphSize

flags uint

Returns

string

GetGlyphSVGForActionOrigin(EInputActionOrigin, uint)

public string GetGlyphSVGForActionOrigin(EInputActionOrigin origin, uint flags)

Parameters

origin EInputActionOrigin

flags uint

Returns

string

GetInputTypeForHandle(InputHandle)

public ESteamInputType GetInputTypeForHandle(InputHandle inputHandle)

Parameters

inputHandle InputHandle

Returns

ESteamInputType

GetMotionData(InputHandle)

public InputMotionData GetMotionData(InputHandle inputHandle)

Parameters

inputHandle InputHandle

Returns

InputMotionData

GetRemotePlaySessionID(InputHandle)

public uint GetRemotePlaySessionID(InputHandle inputHandle)

Parameters

inputHandle InputHandle

Returns

uint

GetSessionInputConfigurationSettings()

public ushort GetSessionInputConfigurationSettings()

Returns

ushort

GetStringForActionOrigin(EInputActionOrigin)

public string GetStringForActionOrigin(EInputActionOrigin origin)

Parameters

origin EInputActionOrigin

Returns

string

GetStringForAnalogActionName(InputAnalogActionHandle)

public string GetStringForAnalogActionName(InputAnalogActionHandle actionHandle)

Parameters

actionHandle InputAnalogActionHandle

Returns

string

GetStringForDigitalActionName(InputDigitalActionHandle)

public string GetStringForDigitalActionName(InputDigitalActionHandle actionHandle)

Parameters

actionHandle InputDigitalActionHandle

Returns

string

GetStringForXboxOrigin(EXboxOrigin)

public string GetStringForXboxOrigin(EXboxOrigin origin)

Parameters

origin EXboxOrigin

Returns

string

Init(bool)

public bool Init(bool explicitlyCallRunFrame)

Parameters

explicitlyCallRunFrame bool

Returns

bool

Legacy_TriggerHapticPulse(InputHandle, ESteamControllerPad, ushort)

public void Legacy_TriggerHapticPulse(InputHandle inputHandle, ESteamControllerPad targetPad, ushort durationMicroSec)

Parameters

inputHandle InputHandle

targetPad ESteamControllerPad

durationMicroSec ushort

Legacy_TriggerRepeatedHapticPulse(InputHandle, ESteamControllerPad, ushort, ushort, ushort, uint)

public void Legacy_TriggerRepeatedHapticPulse(InputHandle inputHandle, ESteamControllerPad targetPad, ushort durationMicroSec, ushort offMicroSec, ushort repeat, uint flags)

Parameters

inputHandle InputHandle

targetPad ESteamControllerPad

durationMicroSec ushort

offMicroSec ushort

repeat ushort

flags uint

RunFrame(bool)

public void RunFrame(bool reservedValue)

Parameters

reservedValue bool

SetDualSenseTriggerEffect(InputHandle, in ScePadTriggerEffectParam)

public void SetDualSenseTriggerEffect(InputHandle inputHandle, in ScePadTriggerEffectParam param)

Parameters

inputHandle InputHandle

param ScePadTriggerEffectParam

SetInputActionManifestFilePath(string)

public bool SetInputActionManifestFilePath(string inputActionManifestAbsolutePath)

Parameters

inputActionManifestAbsolutePath string

Returns

bool

SetLEDColor(InputHandle, byte, byte, byte, uint)

public void SetLEDColor(InputHandle inputHandle, byte colorR, byte colorG, byte colorB, uint flags)

Parameters

inputHandle InputHandle

colorR byte

colorG byte

colorB byte

flags uint

ShowBindingPanel(InputHandle)

public bool ShowBindingPanel(InputHandle inputHandle)

Parameters

inputHandle InputHandle

Returns

bool

Shutdown()

public bool Shutdown()

Returns

bool

StopAnalogActionMomentum(InputHandle, InputAnalogActionHandle)

public void StopAnalogActionMomentum(InputHandle inputHandle, InputAnalogActionHandle action)

Parameters

inputHandle InputHandle

action InputAnalogActionHandle

TranslateActionOrigin(ESteamInputType, EInputActionOrigin)

public EInputActionOrigin TranslateActionOrigin(ESteamInputType destinationInputType, EInputActionOrigin sourceOrigin)

Parameters

destinationInputType ESteamInputType

sourceOrigin EInputActionOrigin

Returns

EInputActionOrigin

TriggerSimpleHapticEvent(InputHandle, EControllerHapticLocation, byte, sbyte, byte, sbyte)

public void TriggerSimpleHapticEvent(InputHandle inputHandle, EControllerHapticLocation hapticLocation, byte intensity, sbyte gainDB, byte otherIntensity, sbyte otherGainDB)

Parameters

inputHandle InputHandle

hapticLocation EControllerHapticLocation

intensity byte

gainDB sbyte

otherIntensity byte

otherGainDB sbyte

TriggerVibration(InputHandle, ushort, ushort)

public void TriggerVibration(InputHandle inputHandle, ushort leftSpeed, ushort rightSpeed)

Parameters

inputHandle InputHandle

leftSpeed ushort

rightSpeed ushort

TriggerVibrationExtended(InputHandle, ushort, ushort, ushort, ushort)

public void TriggerVibrationExtended(InputHandle inputHandle, ushort leftSpeed, ushort rightSpeed, ushort leftTriggerSpeed, ushort rightTriggerSpeed)

Parameters

inputHandle InputHandle

leftSpeed ushort

rightSpeed ushort

leftTriggerSpeed ushort

rightTriggerSpeed ushort