SteamInput

Swift
public struct SteamInput: Sendable

Steamworks ISteamInput

Access via input.


Topics

func activateActionSet(handle: InputHandle, setHandle: InputActionSetHandle)

Steamworks ISteamInput::ActivateActionSet()

Declaration
Swift
public func activateActionSet(
    handle: InputHandle, setHandle: InputActionSetHandle)

func activateActionSetLayer(handle: InputHandle, setLayerHandle: InputActionSetHandle)

Steamworks ISteamInput::ActivateActionSetLayer()

Declaration
Swift
public func activateActionSetLayer(
    handle: InputHandle, setLayerHandle: InputActionSetHandle)

func newDataAvailable() -> Bool

Steamworks ISteamInput::BNewDataAvailable()

Declaration
Swift
public func newDataAvailable() -> Bool

func waitForData(waitForever: Bool, timeout: Int) -> Bool

Steamworks ISteamInput::BWaitForData()

Declaration
Swift
public func waitForData(waitForever: Bool, timeout: Int) -> Bool

func deactivateActionSetLayer(handle: InputHandle, setLayerHandle: InputActionSetHandle)

Steamworks ISteamInput::DeactivateActionSetLayer()

Declaration
Swift
public func deactivateActionSetLayer(
    handle: InputHandle, setLayerHandle: InputActionSetHandle)

func deactivateAllActionSetLayers(handle: InputHandle)

Steamworks ISteamInput::DeactivateAllActionSetLayers()

Declaration
Swift
public func deactivateAllActionSetLayers(handle: InputHandle)

func enableDeviceCallbacks()

Steamworks ISteamInput::EnableDeviceCallbacks()

Declaration
Swift
public func enableDeviceCallbacks()

func getActionOriginFromXboxOrigin(handle: InputHandle, origin: XboxOrigin) -> InputActionOrigin

Steamworks ISteamInput::GetActionOriginFromXboxOrigin()

Declaration
Swift
public func getActionOriginFromXboxOrigin(
    handle: InputHandle, origin: XboxOrigin
) -> InputActionOrigin

func getActionSetHandle(actionSetName: String) -> InputActionSetHandle

Steamworks ISteamInput::GetActionSetHandle()

Declaration
Swift
public func getActionSetHandle(actionSetName: String) -> InputActionSetHandle

func getActiveActionSetLayers(handle: InputHandle) -> (rc: Int, handles: [InputActionSetHandle])

Steamworks ISteamInput::GetActiveActionSetLayers()

Declaration
Swift
public func getActiveActionSetLayers(handle: InputHandle) -> (
    rc: Int, handles: [InputActionSetHandle]
)

func getAnalogActionData(handle: InputHandle, actionHandle: InputAnalogActionHandle) -> InputAnalogActionData

Steamworks ISteamInput::GetAnalogActionData()

Declaration
Swift
public func getAnalogActionData(
    handle: InputHandle, actionHandle: InputAnalogActionHandle
) -> InputAnalogActionData

func getAnalogActionHandle(actionName: String) -> InputAnalogActionHandle

Steamworks ISteamInput::GetAnalogActionHandle()

Declaration
Swift
public func getAnalogActionHandle(actionName: String) -> InputAnalogActionHandle

func getAnalogActionOrigins(handle: InputHandle, setHandle: InputActionSetHandle, actionHandle: InputAnalogActionHandle) -> (rc: Int, origins: [InputActionOrigin])

Steamworks ISteamInput::GetAnalogActionOrigins()

Declaration
Swift
public func getAnalogActionOrigins(
    handle: InputHandle, setHandle: InputActionSetHandle,
    actionHandle: InputAnalogActionHandle
) -> (rc: Int, origins: [InputActionOrigin])

func getConnectedControllers() -> (rc: Int, handles: [InputHandle])

Steamworks ISteamInput::GetConnectedControllers()

Declaration
Swift
public func getConnectedControllers() -> (rc: Int, handles: [InputHandle])

func getControllerForGamepadIndex(index: Int) -> InputHandle

Steamworks ISteamInput::GetControllerForGamepadIndex()

Declaration
Swift
public func getControllerForGamepadIndex(index: Int) -> InputHandle

func getCurrentActionSet(handle: InputHandle) -> InputActionSetHandle

Steamworks ISteamInput::GetCurrentActionSet()

Declaration
Swift
public func getCurrentActionSet(handle: InputHandle) -> InputActionSetHandle

func getDeviceBindingRevision(handle: InputHandle) -> (rc: Bool, major: Int, minor: Int)

Steamworks ISteamInput::GetDeviceBindingRevision()

Declaration
Swift
public func getDeviceBindingRevision(handle: InputHandle) -> (
    rc: Bool, major: Int, minor: Int
)

func getDigitalActionData(handle: InputHandle, actionHandle: InputDigitalActionHandle) -> InputDigitalActionData

Steamworks ISteamInput::GetDigitalActionData()

Declaration
Swift
public func getDigitalActionData(
    handle: InputHandle, actionHandle: InputDigitalActionHandle
) -> InputDigitalActionData

func getDigitalActionHandle(actionName: String) -> InputDigitalActionHandle

Steamworks ISteamInput::GetDigitalActionHandle()

Declaration
Swift
public func getDigitalActionHandle(actionName: String)
    -> InputDigitalActionHandle

func getDigitalActionOrigins(handle: InputHandle, setHandle: InputActionSetHandle, actionHandle: InputDigitalActionHandle) -> (rc: Int, origins: [InputActionOrigin])

Steamworks ISteamInput::GetDigitalActionOrigins()

Declaration
Swift
public func getDigitalActionOrigins(
    handle: InputHandle, setHandle: InputActionSetHandle,
    actionHandle: InputDigitalActionHandle
) -> (rc: Int, origins: [InputActionOrigin])

func getGamepadIndexForController(handle: InputHandle) -> Int

Steamworks ISteamInput::GetGamepadIndexForController()

Declaration
Swift
public func getGamepadIndexForController(handle: InputHandle) -> Int

func getGlyphForActionOriginLegacy(origin: InputActionOrigin) -> String

Steamworks ISteamInput::GetGlyphForActionOrigin_Legacy()

Declaration
Swift
public func getGlyphForActionOriginLegacy(origin: InputActionOrigin) -> String

func getGlyphForXboxOrigin(origin: XboxOrigin) -> String

Steamworks ISteamInput::GetGlyphForXboxOrigin()

Declaration
Swift
public func getGlyphForXboxOrigin(origin: XboxOrigin) -> String

func getGlyphPNGForActionOrigin(origin: InputActionOrigin, size: SteamInputGlyphSize, flags: Int) -> String

Steamworks ISteamInput::GetGlyphPNGForActionOrigin()

Declaration
Swift
public func getGlyphPNGForActionOrigin(
    origin: InputActionOrigin, size: SteamInputGlyphSize, flags: Int
) -> String

func getGlyphSVGForActionOrigin(origin: InputActionOrigin, flags: Int) -> String

Steamworks ISteamInput::GetGlyphSVGForActionOrigin()

Declaration
Swift
public func getGlyphSVGForActionOrigin(origin: InputActionOrigin, flags: Int)
    -> String

func getInputTypeForHandle(handle: InputHandle) -> SteamInputType

Steamworks ISteamInput::GetInputTypeForHandle()

Declaration
Swift
public func getInputTypeForHandle(handle: InputHandle) -> SteamInputType

func getMotionData(handle: InputHandle) -> InputMotionData

Steamworks ISteamInput::GetMotionData()

Declaration
Swift
public func getMotionData(handle: InputHandle) -> InputMotionData

func getRemotePlaySessionID(handle: InputHandle) -> RemotePlaySessionID

Steamworks ISteamInput::GetRemotePlaySessionID()

Declaration
Swift
public func getRemotePlaySessionID(handle: InputHandle) -> RemotePlaySessionID

func getSessionInputConfigurationSettings() -> SteamInputConfigurationEnableType

Steamworks ISteamInput::GetSessionInputConfigurationSettings()

Declaration
Swift
public func getSessionInputConfigurationSettings()
    -> SteamInputConfigurationEnableType

func getStringForActionOrigin(origin: InputActionOrigin) -> String

Steamworks ISteamInput::GetStringForActionOrigin()

Declaration
Swift
public func getStringForActionOrigin(origin: InputActionOrigin) -> String

func getStringForAnalogActionName(actionHandle: InputAnalogActionHandle) -> String

Steamworks ISteamInput::GetStringForAnalogActionName()

Declaration
Swift
public func getStringForAnalogActionName(actionHandle: InputAnalogActionHandle)
    -> String

func getStringForDigitalActionName(actionHandle: InputDigitalActionHandle) -> String

Steamworks ISteamInput::GetStringForDigitalActionName()

Declaration
Swift
public func getStringForDigitalActionName(
    actionHandle: InputDigitalActionHandle
) -> String

func getStringForXboxOrigin(origin: XboxOrigin) -> String

Steamworks ISteamInput::GetStringForXboxOrigin()

Declaration
Swift
public func getStringForXboxOrigin(origin: XboxOrigin) -> String

func initialize(explicitlyCallRunFrame: Bool) -> Bool

Steamworks ISteamInput::Initialize()

Declaration
Swift
public func initialize(explicitlyCallRunFrame: Bool) -> Bool

func legacyTriggerHapticPulse(handle: InputHandle, targetPad: SteamControllerPad, durationMicroSec: UInt16)

Steamworks ISteamInput::Legacy_TriggerHapticPulse()

Declaration
Swift
public func legacyTriggerHapticPulse(
    handle: InputHandle, targetPad: SteamControllerPad, durationMicroSec: UInt16
)

func legacyTriggerRepeatedHapticPulse(handle: InputHandle, targetPad: SteamControllerPad, durationMicroSec: UInt16, offMicroSec: UInt16, repeat: UInt16, flags: UInt32)

Steamworks ISteamInput::Legacy_TriggerRepeatedHapticPulse()

Declaration
Swift
public func legacyTriggerRepeatedHapticPulse(
    handle: InputHandle, targetPad: SteamControllerPad,
    durationMicroSec: UInt16, offMicroSec: UInt16, repeat: UInt16,
    flags: UInt32 = 0)

func runFrame(reservedValue: Bool)

Steamworks ISteamInput::RunFrame()

Declaration
Swift
public func runFrame(reservedValue: Bool = true)

func setInputActionManifestFilePath(inputActionManifestAbsolutePath: String) -> Bool

Steamworks ISteamInput::SetInputActionManifestFilePath()

Declaration
Swift
public func setInputActionManifestFilePath(
    inputActionManifestAbsolutePath: String
) -> Bool

func setLEDColor(handle: InputHandle, colorR: UInt8, colorG: UInt8, colorB: UInt8, flags: SteamInputLEDFlag)

Steamworks ISteamInput::SetLEDColor()

Declaration
Swift
public func setLEDColor(
    handle: InputHandle, colorR: UInt8, colorG: UInt8, colorB: UInt8,
    flags: SteamInputLEDFlag)

func showBindingPanel(handle: InputHandle) -> Bool

Steamworks ISteamInput::ShowBindingPanel()

Declaration
Swift
public func showBindingPanel(handle: InputHandle) -> Bool

func shutdown() -> Bool

Steamworks ISteamInput::Shutdown()

Declaration
Swift
@discardableResult
public func shutdown() -> Bool

func stopAnalogActionMomentum(handle: InputHandle, action: InputAnalogActionHandle)

Steamworks ISteamInput::StopAnalogActionMomentum()

Declaration
Swift
public func stopAnalogActionMomentum(
    handle: InputHandle, action: InputAnalogActionHandle)

func translateActionOrigin(destinationInputType: SteamInputType, sourceOrigin: InputActionOrigin) -> InputActionOrigin

Steamworks ISteamInput::TranslateActionOrigin()

Declaration
Swift
public func translateActionOrigin(
    destinationInputType: SteamInputType, sourceOrigin: InputActionOrigin
) -> InputActionOrigin

func triggerSimpleHapticEvent(handle: InputHandle, hapticLocation: ControllerHapticLocation, intensity: UInt8, gainDB: Int8, otherIntensity: UInt8, otherGainDB: Int8)

Steamworks ISteamInput::TriggerSimpleHapticEvent()

Declaration
Swift
public func triggerSimpleHapticEvent(
    handle: InputHandle, hapticLocation: ControllerHapticLocation,
    intensity: UInt8, gainDB: Int8, otherIntensity: UInt8, otherGainDB: Int8)

func triggerVibration(handle: InputHandle, leftSpeed: UInt16, rightSpeed: UInt16)

Steamworks ISteamInput::TriggerVibration()

Declaration
Swift
public func triggerVibration(
    handle: InputHandle, leftSpeed: UInt16, rightSpeed: UInt16)

func triggerVibrationExtended(handle: InputHandle, leftSpeed: UInt16, rightSpeed: UInt16, leftTriggerSpeed: UInt16, rightTriggerSpeed: UInt16)

Steamworks ISteamInput::TriggerVibrationExtended()

Declaration
Swift
public func triggerVibrationExtended(
    handle: InputHandle, leftSpeed: UInt16, rightSpeed: UInt16,
    leftTriggerSpeed: UInt16, rightTriggerSpeed: UInt16)

func enableActionEventCallbacks(callback: SteamInputActionEventCallbackPointer?)

Steamworks ISteamInput::EnableActionEventCallbacks()

Declaration
Swift
public func enableActionEventCallbacks(
    callback: SteamInputActionEventCallbackPointer?)