Class ISteamController

Namespace

MarymoorStudios.Core.Steamworks

Assembly

MarymoorStudios.Core.Steamworks.dll

public sealed class ISteamController : SteamNativeObject

Inheritance

object

SteamNativeObject

ISteamController

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 = "SteamController008"

Field Value

string

Methods

ActivateActionSet(ControllerHandle, ControllerActionSetHandle)

public void ActivateActionSet(ControllerHandle controllerHandle, ControllerActionSetHandle actionSetHandle)

Parameters

controllerHandle ControllerHandle

actionSetHandle ControllerActionSetHandle

ActivateActionSetLayer(ControllerHandle, ControllerActionSetHandle)

public void ActivateActionSetLayer(ControllerHandle controllerHandle, ControllerActionSetHandle actionSetLayerHandle)

Parameters

controllerHandle ControllerHandle

actionSetLayerHandle ControllerActionSetHandle

DeactivateActionSetLayer(ControllerHandle, ControllerActionSetHandle)

public void DeactivateActionSetLayer(ControllerHandle controllerHandle, ControllerActionSetHandle actionSetLayerHandle)

Parameters

controllerHandle ControllerHandle

actionSetLayerHandle ControllerActionSetHandle

DeactivateAllActionSetLayers(ControllerHandle)

public void DeactivateAllActionSetLayers(ControllerHandle controllerHandle)

Parameters

controllerHandle ControllerHandle

GetActionOriginFromXboxOrigin(ControllerHandle, EXboxOrigin)

public EControllerActionOrigin GetActionOriginFromXboxOrigin(ControllerHandle controllerHandle, EXboxOrigin origin)

Parameters

controllerHandle ControllerHandle

origin EXboxOrigin

Returns

EControllerActionOrigin

GetActionSetHandle(string)

public ControllerActionSetHandle GetActionSetHandle(string pszActionSetName)

Parameters

pszActionSetName string

Returns

ControllerActionSetHandle

GetActiveActionSetLayers(ControllerHandle, Span<ControllerActionSetHandle>)

public int GetActiveActionSetLayers(ControllerHandle controllerHandle, Span<ControllerActionSetHandle> handlesOut)

Parameters

controllerHandle ControllerHandle

handlesOut Span<ControllerActionSetHandle>

Returns

int

GetAnalogActionData(ControllerHandle, ControllerAnalogActionHandle)

public InputAnalogActionData GetAnalogActionData(ControllerHandle controllerHandle, ControllerAnalogActionHandle analogActionHandle)

Parameters

controllerHandle ControllerHandle

analogActionHandle ControllerAnalogActionHandle

Returns

InputAnalogActionData

GetAnalogActionHandle(string)

public ControllerAnalogActionHandle GetAnalogActionHandle(string pszActionName)

Parameters

pszActionName string

Returns

ControllerAnalogActionHandle

GetAnalogActionOrigins(ControllerHandle, ControllerActionSetHandle, ControllerAnalogActionHandle, Span<EControllerActionOrigin>)

public int GetAnalogActionOrigins(ControllerHandle controllerHandle, ControllerActionSetHandle actionSetHandle, ControllerAnalogActionHandle analogActionHandle, Span<EControllerActionOrigin> originsOut)

Parameters

controllerHandle ControllerHandle

actionSetHandle ControllerActionSetHandle

analogActionHandle ControllerAnalogActionHandle

originsOut Span<EControllerActionOrigin>

Returns

int

GetConnectedControllers(Span<ControllerHandle>)

public int GetConnectedControllers(Span<ControllerHandle> handlesOut)

Parameters

handlesOut Span<ControllerHandle>

Returns

int

GetControllerBindingRevision(ControllerHandle, out int, out int)

public bool GetControllerBindingRevision(ControllerHandle controllerHandle, out int major, out int minor)

Parameters

controllerHandle ControllerHandle

major int

minor int

Returns

bool

GetControllerForGamepadIndex(int)

public ControllerHandle GetControllerForGamepadIndex(int index)

Parameters

index int

Returns

ControllerHandle

GetCurrentActionSet(ControllerHandle)

public ControllerActionSetHandle GetCurrentActionSet(ControllerHandle controllerHandle)

Parameters

controllerHandle ControllerHandle

Returns

ControllerActionSetHandle

GetDigitalActionData(ControllerHandle, ControllerDigitalActionHandle)

public InputDigitalActionData GetDigitalActionData(ControllerHandle controllerHandle, ControllerDigitalActionHandle digitalActionHandle)

Parameters

controllerHandle ControllerHandle

digitalActionHandle ControllerDigitalActionHandle

Returns

InputDigitalActionData

GetDigitalActionHandle(string)

public ControllerDigitalActionHandle GetDigitalActionHandle(string pszActionName)

Parameters

pszActionName string

Returns

ControllerDigitalActionHandle

GetDigitalActionOrigins(ControllerHandle, ControllerActionSetHandle, ControllerDigitalActionHandle, Span<EControllerActionOrigin>)

public int GetDigitalActionOrigins(ControllerHandle controllerHandle, ControllerActionSetHandle actionSetHandle, ControllerDigitalActionHandle digitalActionHandle, Span<EControllerActionOrigin> originsOut)

Parameters

controllerHandle ControllerHandle

actionSetHandle ControllerActionSetHandle

digitalActionHandle ControllerDigitalActionHandle

originsOut Span<EControllerActionOrigin>

Returns

int

GetGamepadIndexForController(ControllerHandle)

public int GetGamepadIndexForController(ControllerHandle controllerHandle)

Parameters

controllerHandle ControllerHandle

Returns

int

GetGlyphForActionOrigin(EControllerActionOrigin)

public string GetGlyphForActionOrigin(EControllerActionOrigin origin)

Parameters

origin EControllerActionOrigin

Returns

string

GetGlyphForXboxOrigin(EXboxOrigin)

public string GetGlyphForXboxOrigin(EXboxOrigin origin)

Parameters

origin EXboxOrigin

Returns

string

GetInputTypeForHandle(ControllerHandle)

public ESteamInputType GetInputTypeForHandle(ControllerHandle controllerHandle)

Parameters

controllerHandle ControllerHandle

Returns

ESteamInputType

GetMotionData(ControllerHandle)

public InputMotionData GetMotionData(ControllerHandle controllerHandle)

Parameters

controllerHandle ControllerHandle

Returns

InputMotionData

GetStringForActionOrigin(EControllerActionOrigin)

public string GetStringForActionOrigin(EControllerActionOrigin origin)

Parameters

origin EControllerActionOrigin

Returns

string

GetStringForXboxOrigin(EXboxOrigin)

public string GetStringForXboxOrigin(EXboxOrigin origin)

Parameters

origin EXboxOrigin

Returns

string

Init()

public bool Init()

Returns

bool

OnSteamInputConfigurationLoaded(CallbackAction<SteamInputConfigurationLoaded>)

public IDisposable OnSteamInputConfigurationLoaded(CallbackAction<SteamInputConfigurationLoaded> func)

Parameters

func CallbackAction<SteamInputConfigurationLoaded>

Returns

IDisposable

OnSteamInputDeviceConnected(CallbackAction<SteamInputDeviceConnected>)

public IDisposable OnSteamInputDeviceConnected(CallbackAction<SteamInputDeviceConnected> func)

Parameters

func CallbackAction<SteamInputDeviceConnected>

Returns

IDisposable

OnSteamInputDeviceDisconnected(CallbackAction<SteamInputDeviceDisconnected>)

public IDisposable OnSteamInputDeviceDisconnected(CallbackAction<SteamInputDeviceDisconnected> func)

Parameters

func CallbackAction<SteamInputDeviceDisconnected>

Returns

IDisposable

OnSteamInputGamepadSlotChange(CallbackAction<SteamInputGamepadSlotChange>)

public IDisposable OnSteamInputGamepadSlotChange(CallbackAction<SteamInputGamepadSlotChange> func)

Parameters

func CallbackAction<SteamInputGamepadSlotChange>

Returns

IDisposable

RunFrame()

public void RunFrame()

SetLEDColor(ControllerHandle, byte, byte, byte, uint)

public void SetLEDColor(ControllerHandle controllerHandle, byte colorR, byte colorG, byte colorB, uint flags)

Parameters

controllerHandle ControllerHandle

colorR byte

colorG byte

colorB byte

flags uint

ShowBindingPanel(ControllerHandle)

public bool ShowBindingPanel(ControllerHandle controllerHandle)

Parameters

controllerHandle ControllerHandle

Returns

bool

Shutdown()

public bool Shutdown()

Returns

bool

StopAnalogActionMomentum(ControllerHandle, ControllerAnalogActionHandle)

public void StopAnalogActionMomentum(ControllerHandle controllerHandle, ControllerAnalogActionHandle action)

Parameters

controllerHandle ControllerHandle

action ControllerAnalogActionHandle

TranslateActionOrigin(ESteamInputType, EControllerActionOrigin)

public EControllerActionOrigin TranslateActionOrigin(ESteamInputType destinationInputType, EControllerActionOrigin sourceOrigin)

Parameters

destinationInputType ESteamInputType

sourceOrigin EControllerActionOrigin

Returns

EControllerActionOrigin

TriggerHapticPulse(ControllerHandle, ESteamControllerPad, ushort)

public void TriggerHapticPulse(ControllerHandle controllerHandle, ESteamControllerPad targetPad, ushort durationMicroSec)

Parameters

controllerHandle ControllerHandle

targetPad ESteamControllerPad

durationMicroSec ushort

TriggerRepeatedHapticPulse(ControllerHandle, ESteamControllerPad, ushort, ushort, ushort, uint)

public void TriggerRepeatedHapticPulse(ControllerHandle controllerHandle, ESteamControllerPad targetPad, ushort durationMicroSec, ushort offMicroSec, ushort repeat, uint flags)

Parameters

controllerHandle ControllerHandle

targetPad ESteamControllerPad

durationMicroSec ushort

offMicroSec ushort

repeat ushort

flags uint

TriggerVibration(ControllerHandle, ushort, ushort)

public void TriggerVibration(ControllerHandle controllerHandle, ushort leftSpeed, ushort rightSpeed)

Parameters

controllerHandle ControllerHandle

leftSpeed ushort

rightSpeed ushort