Safe Haskell	None
Language	GHC2021

SDL3.Sys.Bindgen.Joystick

Description

SDL joystick support.

This is the lower-level joystick handling. If you want the simpler option, where what each button does is well-defined, you should use the gamepad API instead.

The term "instance_id" is the current instantiation of a joystick device in the system. If the joystick is removed and then re-inserted then it will get a new instance_id. instance_id's are monotonically increasing identifiers of a joystick plugged in.

The term "player_index" is the number assigned to a player on a specific controller. For XInput controllers this returns the XInput user index. Many joysticks will not be able to supply this information.

SDL_GUID is used as a stable 128-bit identifier for a joystick device that does not change over time. It identifies class of the device (a X360 wired controller for example). This identifier is platform dependent.

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

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

SDL can provide virtual joysticks as well: the app defines an imaginary controller with SDL_AttachVirtualJoystick(), and then can provide inputs for it via SDL_SetJoystickVirtualAxis(), SDL_SetJoystickVirtualButton(), etc. As this data is supplied, it will look like a normal joystick to SDL, just not backed by a hardware driver. This has been used to make unusual devices, like VR headset controllers, look like normal joysticks, or provide recording/playback of game inputs, etc. The joystick structure used to identify an SDL joystick.

This is opaque data.

Since: 3.2.0

Synopsis

data SDL_Joystick
newtype SDL_JoystickID = SDL_JoystickID {
- unwrap :: Uint32
}
newtype SDL_JoystickType = SDL_JoystickType {
- unwrap :: CUInt
}
pattern SDL_JOYSTICK_TYPE_UNKNOWN :: SDL_JoystickType
pattern SDL_JOYSTICK_TYPE_GAMEPAD :: SDL_JoystickType
pattern SDL_JOYSTICK_TYPE_WHEEL :: SDL_JoystickType
pattern SDL_JOYSTICK_TYPE_ARCADE_STICK :: SDL_JoystickType
pattern SDL_JOYSTICK_TYPE_FLIGHT_STICK :: SDL_JoystickType
pattern SDL_JOYSTICK_TYPE_DANCE_PAD :: SDL_JoystickType
pattern SDL_JOYSTICK_TYPE_GUITAR :: SDL_JoystickType
pattern SDL_JOYSTICK_TYPE_DRUM_KIT :: SDL_JoystickType
pattern SDL_JOYSTICK_TYPE_ARCADE_PAD :: SDL_JoystickType
pattern SDL_JOYSTICK_TYPE_THROTTLE :: SDL_JoystickType
pattern SDL_JOYSTICK_TYPE_COUNT :: SDL_JoystickType
newtype SDL_JoystickConnectionState = SDL_JoystickConnectionState {
- unwrap :: CInt
}
pattern SDL_JOYSTICK_CONNECTION_INVALID :: SDL_JoystickConnectionState
pattern SDL_JOYSTICK_CONNECTION_UNKNOWN :: SDL_JoystickConnectionState
pattern SDL_JOYSTICK_CONNECTION_WIRED :: SDL_JoystickConnectionState
pattern SDL_JOYSTICK_CONNECTION_WIRELESS :: SDL_JoystickConnectionState
sDL_JOYSTICK_AXIS_MAX :: CInt
sDL_JOYSTICK_AXIS_MIN :: CInt
data SDL_VirtualJoystickTouchpadDesc = SDL_VirtualJoystickTouchpadDesc {
- nfingers :: Uint16
- padding :: ConstantArray 3 Uint16
}
data SDL_VirtualJoystickSensorDesc = SDL_VirtualJoystickSensorDesc {
- type' :: SDL_SensorType
- rate :: CFloat
}
data SDL_VirtualJoystickDesc = SDL_VirtualJoystickDesc {
- version :: Uint32
- type' :: Uint16
- padding :: Uint16
- vendor_id :: Uint16
- product_id :: Uint16
- naxes :: Uint16
- nbuttons :: Uint16
- nballs :: Uint16
- nhats :: Uint16
- ntouchpads :: Uint16
- nsensors :: Uint16
- padding2 :: ConstantArray 2 Uint16
- button_mask :: Uint32
- axis_mask :: Uint32
- name :: PtrConst CChar
- touchpads :: PtrConst SDL_VirtualJoystickTouchpadDesc
- sensors :: PtrConst SDL_VirtualJoystickSensorDesc
- userdata :: Ptr Void
- update :: FunPtr (Ptr Void -> IO ())
- setPlayerIndex :: FunPtr (Ptr Void -> CInt -> IO ())
- rumble :: FunPtr (Ptr Void -> Uint16 -> Uint16 -> IO CBool)
- rumbleTriggers :: FunPtr (Ptr Void -> Uint16 -> Uint16 -> IO CBool)
- setLED :: FunPtr (Ptr Void -> Uint8 -> Uint8 -> Uint8 -> IO CBool)
- sendEffect :: FunPtr (Ptr Void -> PtrConst Void -> CInt -> IO CBool)
- setSensorsEnabled :: FunPtr (Ptr Void -> CBool -> IO CBool)
- cleanup :: FunPtr (Ptr Void -> IO ())
}
sDL_PROP_JOYSTICK_CAP_MONO_LED_BOOLEAN :: ByteString
sDL_PROP_JOYSTICK_CAP_RGB_LED_BOOLEAN :: ByteString
sDL_PROP_JOYSTICK_CAP_PLAYER_LED_BOOLEAN :: ByteString
sDL_PROP_JOYSTICK_CAP_RUMBLE_BOOLEAN :: ByteString
sDL_PROP_JOYSTICK_CAP_TRIGGER_RUMBLE_BOOLEAN :: ByteString
sDL_HAT_CENTERED :: CUInt
sDL_HAT_UP :: CUInt
sDL_HAT_RIGHT :: CUInt
sDL_HAT_DOWN :: CUInt
sDL_HAT_LEFT :: CUInt
sDL_HAT_RIGHTUP :: CUInt
sDL_HAT_RIGHTDOWN :: CUInt
sDL_HAT_LEFTUP :: CUInt
sDL_HAT_LEFTDOWN :: CUInt

Documentation

data SDL_Joystick Source #

C declaration: struct SDL_Joystick, defined at SDL3/SDL_joystick.h 94:16

newtype SDL_JoystickID Source #

This is a unique ID for a joystick for the time it is connected to the system, and is never reused for the lifetime of the application.

If the joystick is disconnected and reconnected, it will get a new ID.

The value 0 is an invalid ID.

C declaration: SDL_JoystickID, defined at SDL3/SDL_joystick.h 106:16

Since: 3.2.0

Constructors

SDL_JoystickID
Fields unwrap :: Uint32

Instances

Instances details

Bits SDL_JoystickID Source #

Instance details

SDL_VirtualJoystickTouchpadDesc
Fields nfingers :: Uint16 the number of simultaneous fingers on this touchpad C declaration `nfingers`, defined at `SDL3/SDL_joystick.h 435:12` padding :: ConstantArray 3 Uint16 C declaration `padding`, defined at `SDL3/SDL_joystick.h 436:12`

SDL_VirtualJoystickSensorDesc
Fields type' :: SDL_SensorType the type of this sensor C declaration `type`, defined at `SDL3/SDL_joystick.h 448:20` rate :: CFloat the update frequency of this sensor, may be 0.0f C declaration `rate`, defined at `SDL3/SDL_joystick.h 449:11`