Safe Haskell	None
Language	GHC2021

SDL3.Sys.Bindgen.Gamepad

Description

SDL provides a low-level joystick API, which just treats joysticks as an arbitrary pile of buttons, axes, and hat switches. If you're planning to write your own control configuration screen, this can give you a lot of flexibility, but that's a lot of work, and most things that we consider "joysticks" now are actually console-style gamepads. So SDL provides the gamepad API on top of the lower-level joystick functionality.

The difference between a joystick and a gamepad is that a gamepad tells you where a button or axis is on the device. You don't speak to gamepads in terms of arbitrary numbers like "button 3" or "axis 2" but in standard locations: the d-pad, the shoulder buttons, triggers, A/B/X/Y (or X/O/Square/Triangle, if you will).

One turns a joystick into a gamepad by providing a magic configuration string, which tells SDL the details of a specific device: when you see this specific hardware, if button 2 gets pressed, this is actually D-Pad Up, etc.

SDL has many popular controllers configured out of the box, and users can add their own controller details through an environment variable if it's otherwise unknown to SDL.

In order to use these functions, SDL_Init() must have been called with the SDL_INIT_GAMEPAD flag. This causes SDL to scan the system for gamepads, and load appropriate drivers.

If you're using SDL gamepad support in a Steam game, you must call SteamAPI_InitEx() before calling SDL_Init().

If you would like to receive gamepad updates while the application is in the background, you should set the following hint before calling SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS

Gamepads support various optional features such as rumble, color LEDs, touchpad, gyro, etc. The support for these features varies depending on the controller and OS support available. You can check for LED and rumble capabilities at runtime by calling SDL_GetGamepadProperties() and checking the various capability properties. You can check for touchpad by calling SDL_GetNumGamepadTouchpads() and check for gyro and accelerometer by calling SDL_GamepadHasSensor().

By default SDL will try to use the most capable driver available, but you can tune which OS drivers to use with the various joystick hints in SDL_hints.h.

Your application should always support gamepad hotplugging. On some platforms like Xbox, Steam Deck, etc., this is a requirement for certification. On other platforms, like macOS and Windows when using Windows.Gaming.Input, controllers may not be available at startup and will come in at some point after you've started processing events. The structure used to identify an SDL gamepad

Since: 3.2.0

Synopsis

data SDL_Gamepad
newtype SDL_GamepadType = SDL_GamepadType {
- unwrap :: CUInt
}
pattern SDL_GAMEPAD_TYPE_UNKNOWN :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_STANDARD :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_XBOX360 :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_XBOXONE :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_PS3 :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_PS4 :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_PS5 :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_PRO :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_LEFT :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_RIGHT :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_NINTENDO_SWITCH_JOYCON_PAIR :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_GAMECUBE :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_STEAM :: SDL_GamepadType
pattern SDL_GAMEPAD_TYPE_COUNT :: SDL_GamepadType
newtype SDL_GamepadButton = SDL_GamepadButton {
- unwrap :: CInt
}
pattern SDL_GAMEPAD_BUTTON_INVALID :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_SOUTH :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_EAST :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_WEST :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_NORTH :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_BACK :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_GUIDE :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_START :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_LEFT_STICK :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_RIGHT_STICK :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_LEFT_SHOULDER :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_RIGHT_SHOULDER :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_DPAD_UP :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_DPAD_DOWN :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_DPAD_LEFT :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_DPAD_RIGHT :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_MISC1 :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_RIGHT_PADDLE1 :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_LEFT_PADDLE1 :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_RIGHT_PADDLE2 :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_LEFT_PADDLE2 :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_TOUCHPAD :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_MISC2 :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_MISC3 :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_MISC4 :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_MISC5 :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_MISC6 :: SDL_GamepadButton
pattern SDL_GAMEPAD_BUTTON_COUNT :: SDL_GamepadButton
newtype SDL_GamepadButtonLabel = SDL_GamepadButtonLabel {
- unwrap :: CUInt
}
pattern SDL_GAMEPAD_BUTTON_LABEL_UNKNOWN :: SDL_GamepadButtonLabel
pattern SDL_GAMEPAD_BUTTON_LABEL_A :: SDL_GamepadButtonLabel
pattern SDL_GAMEPAD_BUTTON_LABEL_B :: SDL_GamepadButtonLabel
pattern SDL_GAMEPAD_BUTTON_LABEL_X :: SDL_GamepadButtonLabel
pattern SDL_GAMEPAD_BUTTON_LABEL_Y :: SDL_GamepadButtonLabel
pattern SDL_GAMEPAD_BUTTON_LABEL_CROSS :: SDL_GamepadButtonLabel
pattern SDL_GAMEPAD_BUTTON_LABEL_CIRCLE :: SDL_GamepadButtonLabel
pattern SDL_GAMEPAD_BUTTON_LABEL_SQUARE :: SDL_GamepadButtonLabel
pattern SDL_GAMEPAD_BUTTON_LABEL_TRIANGLE :: SDL_GamepadButtonLabel
newtype SDL_GamepadAxis = SDL_GamepadAxis {
- unwrap :: CInt
}
pattern SDL_GAMEPAD_AXIS_INVALID :: SDL_GamepadAxis
pattern SDL_GAMEPAD_AXIS_LEFTX :: SDL_GamepadAxis
pattern SDL_GAMEPAD_AXIS_LEFTY :: SDL_GamepadAxis
pattern SDL_GAMEPAD_AXIS_RIGHTX :: SDL_GamepadAxis
pattern SDL_GAMEPAD_AXIS_RIGHTY :: SDL_GamepadAxis
pattern SDL_GAMEPAD_AXIS_LEFT_TRIGGER :: SDL_GamepadAxis
pattern SDL_GAMEPAD_AXIS_RIGHT_TRIGGER :: SDL_GamepadAxis
pattern SDL_GAMEPAD_AXIS_COUNT :: SDL_GamepadAxis
newtype SDL_GamepadBindingType = SDL_GamepadBindingType {
- unwrap :: CUInt
}
pattern SDL_GAMEPAD_BINDTYPE_NONE :: SDL_GamepadBindingType
pattern SDL_GAMEPAD_BINDTYPE_BUTTON :: SDL_GamepadBindingType
pattern SDL_GAMEPAD_BINDTYPE_AXIS :: SDL_GamepadBindingType
pattern SDL_GAMEPAD_BINDTYPE_HAT :: SDL_GamepadBindingType
data SDL_GamepadBinding_input_axis = SDL_GamepadBinding_input_axis {
- axis :: CInt
- axis_min :: CInt
- axis_max :: CInt
}
data SDL_GamepadBinding_input_hat = SDL_GamepadBinding_input_hat {
- hat :: CInt
- hat_mask :: CInt
}
newtype SDL_GamepadBinding_input = SDL_GamepadBinding_input {
- unwrap :: ByteArray
}
data SDL_GamepadBinding_output_axis = SDL_GamepadBinding_output_axis {
- axis :: SDL_GamepadAxis
- axis_min :: CInt
- axis_max :: CInt
}
newtype SDL_GamepadBinding_output = SDL_GamepadBinding_output {
- unwrap :: ByteArray
}
data SDL_GamepadBinding = SDL_GamepadBinding {
- input_type :: SDL_GamepadBindingType
- input :: SDL_GamepadBinding_input
- output_type :: SDL_GamepadBindingType
- output :: SDL_GamepadBinding_output
}

Documentation

data SDL_Gamepad Source #

C declaration: struct SDL_Gamepad, defined at SDL3/SDL_gamepad.h 100:16

newtype SDL_GamepadType Source #

Standard gamepad types.

This type does not necessarily map to first-party controllers from Microsoft/Sony/Nintendo; in many cases, third-party controllers can report as these, either because they were designed for a specific console, or they simply most closely match that console's controllers (does it have A/B/X/Y buttons or X/O/Square/Triangle? Does it have a touchpad? etc).

C declaration: enum SDL_GamepadType, defined at SDL3/SDL_gamepad.h 111:14

Constructors

SDL_GamepadType
Fields unwrap :: CUInt

Instances

Instances details

Storable SDL_GamepadType Source #

Instance details

SDL_GamepadBinding_input_axis
Fields axis :: CInt C declaration `axis`, defined at `SDL3/SDL_gamepad.h 277:17` axis_min :: CInt C declaration `axis_min`, defined at `SDL3/SDL_gamepad.h 278:17` axis_max :: CInt C declaration `axis_max`, defined at `SDL3/SDL_gamepad.h 279:17`

SDL_GamepadBinding_input_hat
Fields hat :: CInt C declaration `hat`, defined at `SDL3/SDL_gamepad.h 284:17` hat_mask :: CInt C declaration `hat_mask`, defined at `SDL3/SDL_gamepad.h 285:17`

SDL_GamepadBinding_output_axis
Fields axis :: SDL_GamepadAxis C declaration `axis`, defined at `SDL3/SDL_gamepad.h 297:29` axis_min :: CInt C declaration `axis_min`, defined at `SDL3/SDL_gamepad.h 298:17` axis_max :: CInt C declaration `axis_max`, defined at `SDL3/SDL_gamepad.h 299:17`