SteamInput
public struct SteamInput: Sendable
Steamworks ISteamInput
Access via input
.
Topics
func activateActionSet(handle: InputHandle, setHandle: InputActionSetHandle)
func activateActionSet(handle: InputHandle, setHandle: InputActionSetHandle)
Steamworks ISteamInput::ActivateActionSet()
Declaration
public func activateActionSet(
handle: InputHandle, setHandle: InputActionSetHandle)
func activateActionSetLayer(handle: InputHandle, setLayerHandle: InputActionSetHandle)
func activateActionSetLayer(handle: InputHandle, setLayerHandle: InputActionSetHandle)
Steamworks ISteamInput::ActivateActionSetLayer()
Declaration
public func activateActionSetLayer(
handle: InputHandle, setLayerHandle: InputActionSetHandle)
func newDataAvailable() -> Bool
func newDataAvailable() -> Bool
Steamworks ISteamInput::BNewDataAvailable()
Declaration
public func newDataAvailable() -> Bool
func waitForData(waitForever: Bool, timeout: Int) -> Bool
func waitForData(waitForever: Bool, timeout: Int) -> Bool
func deactivateActionSetLayer(handle: InputHandle, setLayerHandle: InputActionSetHandle)
func deactivateActionSetLayer(handle: InputHandle, setLayerHandle: InputActionSetHandle)
Steamworks ISteamInput::DeactivateActionSetLayer()
Declaration
public func deactivateActionSetLayer(
handle: InputHandle, setLayerHandle: InputActionSetHandle)
func deactivateAllActionSetLayers(handle: InputHandle)
func deactivateAllActionSetLayers(handle: InputHandle)
Steamworks ISteamInput::DeactivateAllActionSetLayers()
Declaration
public func deactivateAllActionSetLayers(handle: InputHandle)
func enableDeviceCallbacks()
func enableDeviceCallbacks()
Steamworks ISteamInput::EnableDeviceCallbacks()
Declaration
public func enableDeviceCallbacks()
func getActionOriginFromXboxOrigin(handle: InputHandle, origin: XboxOrigin) -> InputActionOrigin
func getActionOriginFromXboxOrigin(handle: InputHandle, origin: XboxOrigin) -> InputActionOrigin
Steamworks ISteamInput::GetActionOriginFromXboxOrigin()
Declaration
public func getActionOriginFromXboxOrigin(
handle: InputHandle, origin: XboxOrigin
) -> InputActionOrigin
func getActionSetHandle(actionSetName: String) -> InputActionSetHandle
func getActionSetHandle(actionSetName: String) -> InputActionSetHandle
Steamworks ISteamInput::GetActionSetHandle()
Declaration
public func getActionSetHandle(actionSetName: String) -> InputActionSetHandle
func getActiveActionSetLayers(handle: InputHandle) -> (rc: Int, handles: [InputActionSetHandle])
func getActiveActionSetLayers(handle: InputHandle) -> (rc: Int, handles: [InputActionSetHandle])
Steamworks ISteamInput::GetActiveActionSetLayers()
Declaration
public func getActiveActionSetLayers(handle: InputHandle) -> (
rc: Int, handles: [InputActionSetHandle]
)
func getAnalogActionData(handle: InputHandle, actionHandle: InputAnalogActionHandle) -> InputAnalogActionData
func getAnalogActionData(handle: InputHandle, actionHandle: InputAnalogActionHandle) -> InputAnalogActionData
Steamworks ISteamInput::GetAnalogActionData()
Declaration
public func getAnalogActionData(
handle: InputHandle, actionHandle: InputAnalogActionHandle
) -> InputAnalogActionData
func getAnalogActionHandle(actionName: String) -> InputAnalogActionHandle
func getAnalogActionHandle(actionName: String) -> InputAnalogActionHandle
Steamworks ISteamInput::GetAnalogActionHandle()
Declaration
public func getAnalogActionHandle(actionName: String) -> InputAnalogActionHandle
func getAnalogActionOrigins(handle: InputHandle, setHandle: InputActionSetHandle, actionHandle: InputAnalogActionHandle) -> (rc: Int, origins: [InputActionOrigin])
func getAnalogActionOrigins(handle: InputHandle, setHandle: InputActionSetHandle, actionHandle: InputAnalogActionHandle) -> (rc: Int, origins: [InputActionOrigin])
Steamworks ISteamInput::GetAnalogActionOrigins()
Declaration
public func getAnalogActionOrigins(
handle: InputHandle, setHandle: InputActionSetHandle,
actionHandle: InputAnalogActionHandle
) -> (rc: Int, origins: [InputActionOrigin])
func getConnectedControllers() -> (rc: Int, handles: [InputHandle])
func getConnectedControllers() -> (rc: Int, handles: [InputHandle])
Steamworks ISteamInput::GetConnectedControllers()
Declaration
public func getConnectedControllers() -> (rc: Int, handles: [InputHandle])
func getControllerForGamepadIndex(index: Int) -> InputHandle
func getControllerForGamepadIndex(index: Int) -> InputHandle
Steamworks ISteamInput::GetControllerForGamepadIndex()
Declaration
public func getControllerForGamepadIndex(index: Int) -> InputHandle
func getCurrentActionSet(handle: InputHandle) -> InputActionSetHandle
func getCurrentActionSet(handle: InputHandle) -> InputActionSetHandle
Steamworks ISteamInput::GetCurrentActionSet()
Declaration
public func getCurrentActionSet(handle: InputHandle) -> InputActionSetHandle
func getDeviceBindingRevision(handle: InputHandle) -> (rc: Bool, major: Int, minor: Int)
func getDeviceBindingRevision(handle: InputHandle) -> (rc: Bool, major: Int, minor: Int)
Steamworks ISteamInput::GetDeviceBindingRevision()
Declaration
public func getDeviceBindingRevision(handle: InputHandle) -> (
rc: Bool, major: Int, minor: Int
)
func getDigitalActionData(handle: InputHandle, actionHandle: InputDigitalActionHandle) -> InputDigitalActionData
func getDigitalActionData(handle: InputHandle, actionHandle: InputDigitalActionHandle) -> InputDigitalActionData
Steamworks ISteamInput::GetDigitalActionData()
Declaration
public func getDigitalActionData(
handle: InputHandle, actionHandle: InputDigitalActionHandle
) -> InputDigitalActionData
func getDigitalActionHandle(actionName: String) -> InputDigitalActionHandle
func getDigitalActionHandle(actionName: String) -> InputDigitalActionHandle
Steamworks ISteamInput::GetDigitalActionHandle()
Declaration
public func getDigitalActionHandle(actionName: String)
-> InputDigitalActionHandle
func getDigitalActionOrigins(handle: InputHandle, setHandle: InputActionSetHandle, actionHandle: InputDigitalActionHandle) -> (rc: Int, origins: [InputActionOrigin])
func getDigitalActionOrigins(handle: InputHandle, setHandle: InputActionSetHandle, actionHandle: InputDigitalActionHandle) -> (rc: Int, origins: [InputActionOrigin])
Steamworks ISteamInput::GetDigitalActionOrigins()
Declaration
public func getDigitalActionOrigins(
handle: InputHandle, setHandle: InputActionSetHandle,
actionHandle: InputDigitalActionHandle
) -> (rc: Int, origins: [InputActionOrigin])
func getGamepadIndexForController(handle: InputHandle) -> Int
func getGamepadIndexForController(handle: InputHandle) -> Int
Steamworks ISteamInput::GetGamepadIndexForController()
Declaration
public func getGamepadIndexForController(handle: InputHandle) -> Int
func getGlyphForActionOriginLegacy(origin: InputActionOrigin) -> String
func getGlyphForActionOriginLegacy(origin: InputActionOrigin) -> String
Steamworks ISteamInput::GetGlyphForActionOrigin_Legacy()
Declaration
public func getGlyphForActionOriginLegacy(origin: InputActionOrigin) -> String
func getGlyphForXboxOrigin(origin: XboxOrigin) -> String
func getGlyphForXboxOrigin(origin: XboxOrigin) -> String
Steamworks ISteamInput::GetGlyphForXboxOrigin()
Declaration
public func getGlyphForXboxOrigin(origin: XboxOrigin) -> String
func getGlyphPNGForActionOrigin(origin: InputActionOrigin, size: SteamInputGlyphSize, flags: Int) -> String
func getGlyphPNGForActionOrigin(origin: InputActionOrigin, size: SteamInputGlyphSize, flags: Int) -> String
Steamworks ISteamInput::GetGlyphPNGForActionOrigin()
Declaration
public func getGlyphPNGForActionOrigin(
origin: InputActionOrigin, size: SteamInputGlyphSize, flags: Int
) -> String
func getGlyphSVGForActionOrigin(origin: InputActionOrigin, flags: Int) -> String
func getGlyphSVGForActionOrigin(origin: InputActionOrigin, flags: Int) -> String
Steamworks ISteamInput::GetGlyphSVGForActionOrigin()
Declaration
public func getGlyphSVGForActionOrigin(origin: InputActionOrigin, flags: Int)
-> String
func getInputTypeForHandle(handle: InputHandle) -> SteamInputType
func getInputTypeForHandle(handle: InputHandle) -> SteamInputType
Steamworks ISteamInput::GetInputTypeForHandle()
Declaration
public func getInputTypeForHandle(handle: InputHandle) -> SteamInputType
func getMotionData(handle: InputHandle) -> InputMotionData
func getMotionData(handle: InputHandle) -> InputMotionData
Steamworks ISteamInput::GetMotionData()
Declaration
public func getMotionData(handle: InputHandle) -> InputMotionData
func getRemotePlaySessionID(handle: InputHandle) -> RemotePlaySessionID
func getRemotePlaySessionID(handle: InputHandle) -> RemotePlaySessionID
Steamworks ISteamInput::GetRemotePlaySessionID()
Declaration
public func getRemotePlaySessionID(handle: InputHandle) -> RemotePlaySessionID
func getSessionInputConfigurationSettings() -> SteamInputConfigurationEnableType
func getSessionInputConfigurationSettings() -> SteamInputConfigurationEnableType
Steamworks ISteamInput::GetSessionInputConfigurationSettings()
Declaration
public func getSessionInputConfigurationSettings()
-> SteamInputConfigurationEnableType
func getStringForActionOrigin(origin: InputActionOrigin) -> String
func getStringForActionOrigin(origin: InputActionOrigin) -> String
Steamworks ISteamInput::GetStringForActionOrigin()
Declaration
public func getStringForActionOrigin(origin: InputActionOrigin) -> String
func getStringForAnalogActionName(actionHandle: InputAnalogActionHandle) -> String
func getStringForAnalogActionName(actionHandle: InputAnalogActionHandle) -> String
Steamworks ISteamInput::GetStringForAnalogActionName()
Declaration
public func getStringForAnalogActionName(actionHandle: InputAnalogActionHandle)
-> String
func getStringForDigitalActionName(actionHandle: InputDigitalActionHandle) -> String
func getStringForDigitalActionName(actionHandle: InputDigitalActionHandle) -> String
Steamworks ISteamInput::GetStringForDigitalActionName()
Declaration
public func getStringForDigitalActionName(
actionHandle: InputDigitalActionHandle
) -> String
func getStringForXboxOrigin(origin: XboxOrigin) -> String
func getStringForXboxOrigin(origin: XboxOrigin) -> String
Steamworks ISteamInput::GetStringForXboxOrigin()
Declaration
public func getStringForXboxOrigin(origin: XboxOrigin) -> String
func initialize(explicitlyCallRunFrame: Bool) -> Bool
func initialize(explicitlyCallRunFrame: Bool) -> Bool
func legacyTriggerHapticPulse(handle: InputHandle, targetPad: SteamControllerPad, durationMicroSec: UInt16)
func legacyTriggerHapticPulse(handle: InputHandle, targetPad: SteamControllerPad, durationMicroSec: UInt16)
Steamworks ISteamInput::Legacy_TriggerHapticPulse()
Declaration
public func legacyTriggerHapticPulse(
handle: InputHandle, targetPad: SteamControllerPad, durationMicroSec: UInt16
)
func legacyTriggerRepeatedHapticPulse(handle: InputHandle, targetPad: SteamControllerPad, durationMicroSec: UInt16, offMicroSec: UInt16, repeat: UInt16, flags: UInt32)
func legacyTriggerRepeatedHapticPulse(handle: InputHandle, targetPad: SteamControllerPad, durationMicroSec: UInt16, offMicroSec: UInt16, repeat: UInt16, flags: UInt32)
Steamworks ISteamInput::Legacy_TriggerRepeatedHapticPulse()
Declaration
public func legacyTriggerRepeatedHapticPulse(
handle: InputHandle, targetPad: SteamControllerPad,
durationMicroSec: UInt16, offMicroSec: UInt16, repeat: UInt16,
flags: UInt32 = 0)
func runFrame(reservedValue: Bool)
func runFrame(reservedValue: Bool)
Steamworks ISteamInput::RunFrame()
Declaration
public func runFrame(reservedValue: Bool = true)
func setInputActionManifestFilePath(inputActionManifestAbsolutePath: String) -> Bool
func setInputActionManifestFilePath(inputActionManifestAbsolutePath: String) -> Bool
func setLEDColor(handle: InputHandle, colorR: UInt8, colorG: UInt8, colorB: UInt8, flags: SteamInputLEDFlag)
func setLEDColor(handle: InputHandle, colorR: UInt8, colorG: UInt8, colorB: UInt8, flags: SteamInputLEDFlag)
Steamworks ISteamInput::SetLEDColor()
Declaration
public func setLEDColor(
handle: InputHandle, colorR: UInt8, colorG: UInt8, colorB: UInt8,
flags: SteamInputLEDFlag)
func showBindingPanel(handle: InputHandle) -> Bool
func showBindingPanel(handle: InputHandle) -> Bool
Steamworks ISteamInput::ShowBindingPanel()
Declaration
public func showBindingPanel(handle: InputHandle) -> Bool
func shutdown() -> Bool
func shutdown() -> Bool
Steamworks ISteamInput::Shutdown()
Declaration
@discardableResult
public func shutdown() -> Bool
func stopAnalogActionMomentum(handle: InputHandle, action: InputAnalogActionHandle)
func stopAnalogActionMomentum(handle: InputHandle, action: InputAnalogActionHandle)
Steamworks ISteamInput::StopAnalogActionMomentum()
Declaration
public func stopAnalogActionMomentum(
handle: InputHandle, action: InputAnalogActionHandle)
func translateActionOrigin(destinationInputType: SteamInputType, sourceOrigin: InputActionOrigin) -> InputActionOrigin
func translateActionOrigin(destinationInputType: SteamInputType, sourceOrigin: InputActionOrigin) -> InputActionOrigin
Steamworks ISteamInput::TranslateActionOrigin()
Declaration
public func translateActionOrigin(
destinationInputType: SteamInputType, sourceOrigin: InputActionOrigin
) -> InputActionOrigin
func triggerSimpleHapticEvent(handle: InputHandle, hapticLocation: ControllerHapticLocation, intensity: UInt8, gainDB: Int8, otherIntensity: UInt8, otherGainDB: Int8)
func triggerSimpleHapticEvent(handle: InputHandle, hapticLocation: ControllerHapticLocation, intensity: UInt8, gainDB: Int8, otherIntensity: UInt8, otherGainDB: Int8)
Steamworks ISteamInput::TriggerSimpleHapticEvent()
Declaration
public func triggerSimpleHapticEvent(
handle: InputHandle, hapticLocation: ControllerHapticLocation,
intensity: UInt8, gainDB: Int8, otherIntensity: UInt8, otherGainDB: Int8)
func triggerVibration(handle: InputHandle, leftSpeed: UInt16, rightSpeed: UInt16)
func triggerVibration(handle: InputHandle, leftSpeed: UInt16, rightSpeed: UInt16)
Steamworks ISteamInput::TriggerVibration()
Declaration
public func triggerVibration(
handle: InputHandle, leftSpeed: UInt16, rightSpeed: UInt16)
func triggerVibrationExtended(handle: InputHandle, leftSpeed: UInt16, rightSpeed: UInt16, leftTriggerSpeed: UInt16, rightTriggerSpeed: UInt16)
func triggerVibrationExtended(handle: InputHandle, leftSpeed: UInt16, rightSpeed: UInt16, leftTriggerSpeed: UInt16, rightTriggerSpeed: UInt16)
Steamworks ISteamInput::TriggerVibrationExtended()
Declaration
public func triggerVibrationExtended(
handle: InputHandle, leftSpeed: UInt16, rightSpeed: UInt16,
leftTriggerSpeed: UInt16, rightTriggerSpeed: UInt16)
func enableActionEventCallbacks(callback: SteamInputActionEventCallbackPointer?)
func enableActionEventCallbacks(callback: SteamInputActionEventCallbackPointer?)
Steamworks ISteamInput::EnableActionEventCallbacks()
Declaration
public func enableActionEventCallbacks(
callback: SteamInputActionEventCallbackPointer?)