Modulesdl2-2.5.6.1Haskell2010

SDL.Input.GameController

8 types
14 values

Packagesdl2-2.5.6.1
Exports22
LanguageHaskell2010
LicenceBSD-3-Clause
SourceGameController.hs

datadata ControllerDevice

A description of game controller that can be opened using openController. To retrieve a list of connected game controllers, use availableControllers.

Constructors

ControllerDevice
- gameControllerDeviceName :: Text
- gameControllerDeviceId :: JoystickIndex

Instances6Eq, Ord, Read, Show, Generic, Rep

Eq ControllerDeviceDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Ord ControllerDeviceDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Read ControllerDeviceDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Show ControllerDeviceDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Generic ControllerDeviceDefined in sdl2-2.5.6.1 · SDL.Input.GameController
type Rep ControllerDevice = D1 ('MetaData "ControllerDevice" "SDL.Input.GameController" "sdl2-2.5.6.1-2TSBjf6tiuTBgFp1NgDCkl" 'False) (C1 ('MetaCons "ControllerDevice" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameControllerDeviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "gameControllerDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JoystickIndex)))Defined in sdl2-2.5.6.1 · SDL.Input.GameController

newtypenewtype GameController

Instances6Eq, Data, Ord, Show, Generic, Rep

Eq GameControllerDefined in sdl2-2.5.6.1 · SDL.Internal.Types
Data GameControllerDefined in sdl2-2.5.6.1 · SDL.Internal.Types
Ord GameControllerDefined in sdl2-2.5.6.1 · SDL.Internal.Types
Show GameControllerDefined in sdl2-2.5.6.1 · SDL.Internal.Types
Generic GameControllerDefined in sdl2-2.5.6.1 · SDL.Internal.Types
type Rep GameController = D1 ('MetaData "GameController" "SDL.Internal.Types" "sdl2-2.5.6.1-2TSBjf6tiuTBgFp1NgDCkl" 'True) (C1 ('MetaCons "GameController" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameControllerPtr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GameController)))Defined in sdl2-2.5.6.1 · SDL.Internal.Types

typetype JoystickIndex = CInt

typetype JoystickID = Int32

valueisGameController :: MonadIO m => JoystickIndex -> m Bool

Check if the given joystick is supported by the game controller interface.

See SDL_IsGameController for C documentation.

valuemkControllerDevice

:: MonadIO m
=> JoystickIndex
-> m (Maybe ControllerDevice)

Create a ControllerDevice from a JoystickIndex. Returns Nothing if the JoystickIndex does not support the game controller interface.

valuemkControllerDevice' :: MonadIO m => JoystickIndex -> m ControllerDevice

Create a ControllerDevice from a JoystickIndex. Does not check whether the JoystickIndex supports the game controller interface.

valuecontrollerFromInstanceID :: MonadIO m => JoystickID -> m GameController

Get the GameController associated with a JoystickID.

See SDL_GameControllerFromInstanceID for C documentation.

valueavailableControllers :: MonadIO m => m (Vector ControllerDevice)

Enumerate all connected Controllers, retrieving a description of each.

valueopenController

:: (Functor m, MonadIO m)
=> ControllerDevice
The device to open. Use availableControllers to find JoystickDevicess
-> m GameController

Open a controller so that you can start receiving events from interaction with this controller.

See SDL_GameControllerOpen for C documentation.

valuecloseController :: MonadIO m => GameController -> m ()

Close a controller previously opened with openController.

See SDL_GameControllerClose for C documentation.

valuecontrollerAttached :: MonadIO m => GameController -> m Bool

Check if a controller has been opened and is currently connected.

See SDL_GameControllerGetAttached for C documentation.

valuegetControllerID :: MonadIO m => GameController -> m JoystickID

Get the instance ID of an opened controller. The instance ID is used to identify the controller in future SDL events.

See SDL_GameControllerInstanceID for C documentation.

valuecontrollerMapping :: MonadIO m => GameController -> m Text

Get the current mapping of a Game Controller.

See SDL_GameControllerMapping for C documentation.

valueaddControllerMapping :: MonadIO m => ByteString -> m ()

Add support for controllers that SDL is unaware of or to cause an existing controller to have a different binding.

See SDL_GameControllerAddMapping for C documentation.

valueaddControllerMappingsFromFile :: MonadIO m => FilePath -> m ()

Use this function to load a set of Game Controller mappings from a file, filtered by the current SDL_GetPlatform(). A community sourced database of controllers is available here (on GitHub).

See SDL_GameControllerAddMappingsFromFile for C documentation.

datadata ControllerButton

Identifies a gamepad button.

ControllerButtonInvalid ControllerButtonA ControllerButtonB ControllerButtonX ControllerButtonY ControllerButtonBack ControllerButtonGuide ControllerButtonStart ControllerButtonLeftStick ControllerButtonRightStick ControllerButtonLeftShoulder ControllerButtonRightShoulder ControllerButtonDpadUp ControllerButtonDpadDown ControllerButtonDpadLeft ControllerButtonDpadRight

Instances9Eq, Data, Ord, Read, Show, Generic, …

Eq ControllerButtonDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Data ControllerButtonDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Ord ControllerButtonDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Read ControllerButtonDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Show ControllerButtonDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Generic ControllerButtonDefined in sdl2-2.5.6.1 · SDL.Input.GameController
ToNumber ControllerButton Int32Defined in sdl2-2.5.6.1 · SDL.Input.GameController
FromNumber ControllerButton Int32Defined in sdl2-2.5.6.1 · SDL.Input.GameController
type Rep ControllerButton = D1 ('MetaData "ControllerButton" "SDL.Input.GameController" "sdl2-2.5.6.1-2TSBjf6tiuTBgFp1NgDCkl" 'False) ((((C1 ('MetaCons "ControllerButtonInvalid" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerButtonA" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "ControllerButtonB" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerButtonX" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "ControllerButtonY" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerButtonBack" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "ControllerButtonGuide" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerButtonStart" 'PrefixI 'False) U1))) :+: (((C1 ('MetaCons "ControllerButtonLeftStick" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerButtonRightStick" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "ControllerButtonLeftShoulder" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerButtonRightShoulder" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "ControllerButtonDpadUp" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerButtonDpadDown" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "ControllerButtonDpadLeft" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerButtonDpadRight" 'PrefixI 'False) U1))))Defined in sdl2-2.5.6.1 · SDL.Input.GameController

datadata ControllerButtonState

Identifies the state of a controller button.

ControllerButtonPressed ControllerButtonReleased ControllerButtonInvalidState

Instances8Eq, Data, Ord, Read, Show, Generic, …

Eq ControllerButtonStateDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Data ControllerButtonStateDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Ord ControllerButtonStateDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Read ControllerButtonStateDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Show ControllerButtonStateDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Generic ControllerButtonStateDefined in sdl2-2.5.6.1 · SDL.Input.GameController
FromNumber ControllerButtonState Word32Defined in sdl2-2.5.6.1 · SDL.Input.GameController
type Rep ControllerButtonState = D1 ('MetaData "ControllerButtonState" "SDL.Input.GameController" "sdl2-2.5.6.1-2TSBjf6tiuTBgFp1NgDCkl" 'False) (C1 ('MetaCons "ControllerButtonPressed" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "ControllerButtonReleased" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerButtonInvalidState" 'PrefixI 'False) U1))Defined in sdl2-2.5.6.1 · SDL.Input.GameController

valuecontrollerButton

:: MonadIO m
=> GameController
-> ControllerButton
-> m ControllerButtonState

Get the current state of a button on a game controller.

See SDL_GameControllerGetButton for C documentation.

datadata ControllerAxis

ControllerAxisInvalid ControllerAxisLeftX ControllerAxisLeftY ControllerAxisRightX ControllerAxisRightY ControllerAxisTriggerLeft ControllerAxisTriggerRight ControllerAxisMax

Instances9Eq, Data, Ord, Read, Show, Generic, …

Eq ControllerAxisDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Data ControllerAxisDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Ord ControllerAxisDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Read ControllerAxisDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Show ControllerAxisDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Generic ControllerAxisDefined in sdl2-2.5.6.1 · SDL.Input.GameController
ToNumber ControllerAxis Int32Defined in sdl2-2.5.6.1 · SDL.Input.GameController
FromNumber ControllerAxis Int32Defined in sdl2-2.5.6.1 · SDL.Input.GameController
type Rep ControllerAxis = D1 ('MetaData "ControllerAxis" "SDL.Input.GameController" "sdl2-2.5.6.1-2TSBjf6tiuTBgFp1NgDCkl" 'False) (((C1 ('MetaCons "ControllerAxisInvalid" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerAxisLeftX" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "ControllerAxisLeftY" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerAxisRightX" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "ControllerAxisRightY" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerAxisTriggerLeft" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "ControllerAxisTriggerRight" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerAxisMax" 'PrefixI 'False) U1)))Defined in sdl2-2.5.6.1 · SDL.Input.GameController

valuecontrollerAxis :: MonadIO m => GameController -> ControllerAxis -> m Int16

Get the current state of an axis control on a game controller.

See SDL_GameControllerGetAxis for C documentation.

datadata ControllerDeviceConnection

Identifies whether the game controller was added, removed, or remapped.

ControllerDeviceAdded ControllerDeviceRemoved ControllerDeviceRemapped

Instances8Eq, Data, Ord, Read, Show, Generic, …

Eq ControllerDeviceConnectionDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Data ControllerDeviceConnectionDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Ord ControllerDeviceConnectionDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Read ControllerDeviceConnectionDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Show ControllerDeviceConnectionDefined in sdl2-2.5.6.1 · SDL.Input.GameController
Generic ControllerDeviceConnectionDefined in sdl2-2.5.6.1 · SDL.Input.GameController
FromNumber ControllerDeviceConnection Word32Defined in sdl2-2.5.6.1 · SDL.Input.GameController
type Rep ControllerDeviceConnection = D1 ('MetaData "ControllerDeviceConnection" "SDL.Input.GameController" "sdl2-2.5.6.1-2TSBjf6tiuTBgFp1NgDCkl" 'False) (C1 ('MetaCons "ControllerDeviceAdded" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "ControllerDeviceRemoved" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ControllerDeviceRemapped" 'PrefixI 'False) U1))Defined in sdl2-2.5.6.1 · SDL.Input.GameController