sdl2-2.5.2.0: Both high- and low-level bindings to the SDL library (version 2.0.6+).

Safe Haskell | None
Language | Haskell2010

SDL.Input.Joystick

Synopsis

- numJoysticks :: MonadIO m => m CInt
- availableJoysticks :: MonadIO m => m (Vector JoystickDevice)
- data JoystickDevice = JoystickDevice {
  - joystickDeviceName :: Text
  - joystickDeviceId :: CInt
  }
- openJoystick :: (Functor m, MonadIO m) => JoystickDevice -> m Joystick
- closeJoystick :: MonadIO m => Joystick -> m ()
- getJoystickID :: MonadIO m => Joystick -> m Int32
- data Joystick
- data JoyButtonState
  - = JoyButtonPressed
  - | JoyButtonReleased
- buttonPressed :: (Functor m, MonadIO m) => Joystick -> CInt -> m Bool
- ballDelta :: MonadIO m => Joystick -> CInt -> m (V2 CInt)
- axisPosition :: MonadIO m => Joystick -> CInt -> m Int16
- numAxes :: MonadIO m => Joystick -> m CInt
- numButtons :: MonadIO m => Joystick -> m CInt
- numBalls :: MonadIO m => Joystick -> m CInt
- data JoyHatPosition
  - = HatCentered
  - | HatUp
  - | HatRight
  - | HatDown
  - | HatLeft
  - | HatRightUp
  - | HatRightDown
  - | HatLeftUp
  - | HatLeftDown
- getHat :: (Functor m, MonadIO m) => Joystick -> CInt -> m JoyHatPosition
- numHats :: MonadIO m => Joystick -> m CInt
- data JoyDeviceConnection
  - = JoyDeviceAdded
  - | JoyDeviceRemoved

# Documentation

numJoysticks :: MonadIO m => m CInt Source #

Count the number of joysticks attached to the system.

See `SDL_NumJoysticks` for C documentation.

availableJoysticks :: MonadIO m => m (Vector JoystickDevice) Source #

Enumerate all connected joysticks, retrieving a description of each.

data JoystickDevice Source #

A description of joystick that can be opened using `openJoystick`. To retrieve a list of connected joysticks, use `availableJoysticks`.

Constructors

JoystickDevice |

Fields

- joystickDeviceName :: Text
- joystickDeviceId :: CInt

#### Instances

Instances details

Eq JoystickDevice Source # |
Instance details Defined in SDL.Input.Joystick Methods (==) :: JoystickDevice -> JoystickDevice -> Bool (/=) :: JoystickDevice -> JoystickDevice -> Bool
Ord JoystickDevice Source # |

Instance details

Defined in SDL.Input.Joystick

Methods

compare :: JoystickDevice -> JoystickDevice -> Ordering

(<) :: JoystickDevice -> JoystickDevice -> Bool

(<=) :: JoystickDevice -> JoystickDevice -> Bool

(>) :: JoystickDevice -> JoystickDevice -> Bool

(>=) :: JoystickDevice -> JoystickDevice -> Bool

max :: JoystickDevice -> JoystickDevice -> JoystickDevice

min :: JoystickDevice -> JoystickDevice -> JoystickDevice

Read JoystickDevice Source # |
Instance details Defined in SDL.Input.Joystick Methods readsPrec :: Int -> ReadS JoystickDevice readList :: ReadS [JoystickDevice] readPrec :: ReadPrec JoystickDevice readListPrec :: ReadPrec [JoystickDevice]
Show JoystickDevice Source # |
Instance details Defined in SDL.Input.Joystick Methods showsPrec :: Int -> JoystickDevice -> ShowS show :: JoystickDevice -> String showList :: [JoystickDevice] -> ShowS
Generic JoystickDevice Source # |
Instance details Defined in SDL.Input.Joystick Associated Types type Rep JoystickDevice :: Type -> Type Methods from :: JoystickDevice -> Rep JoystickDevice x to :: Rep JoystickDevice x -> JoystickDevice
type Rep JoystickDevice Source # |

Instance details

Defined in SDL.Input.Joystick

type Rep JoystickDevice = D1 ('MetaData "JoystickDevice" "SDL.Input.Joystick" "sdl2-2.5.2.0-Cx4Ipj2keSJFpflqvJYEGr" 'False) (C1 ('MetaCons "JoystickDevice" 'PrefixI 'True) (S1 ('MetaSel ('Just "joystickDeviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "joystickDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt)))

openJoystick Source #

Arguments

:: (Functor m, MonadIO m) |
=> JoystickDevice | The device to open. Use `availableJoysticks` to find `JoystickDevices`s
-> m Joystick |

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

See `SDL_JoystickOpen` for C documentation.

closeJoystick :: MonadIO m => Joystick -> m () Source #

Close a joystick previously opened with `openJoystick`.

See `SDL_JoystickClose` for C documentation.

getJoystickID :: MonadIO m => Joystick -> m Int32 Source #

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

See `SDL_JoystickInstanceID` for C documentation.

data Joystick Source #

#### Instances

Instances details

Eq Joystick Source # |
Instance details Defined in SDL.Internal.Types Methods (==) :: Joystick -> Joystick -> Bool (/=) :: Joystick -> Joystick -> Bool
Data Joystick Source # |

Instance details

Defined in SDL.Internal.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Joystick -> c Joystick

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Joystick

toConstr :: Joystick -> Constr

dataTypeOf :: Joystick -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Joystick)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Joystick)

gmapT :: (forall b. Data b => b -> b) -> Joystick -> Joystick

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Joystick -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Joystick -> r

gmapQ :: (forall d. Data d => d -> u) -> Joystick -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Joystick -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Joystick -> m Joystick

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Joystick -> m Joystick

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Joystick -> m Joystick

Ord Joystick Source # |
Instance details Defined in SDL.Internal.Types Methods compare :: Joystick -> Joystick -> Ordering (<) :: Joystick -> Joystick -> Bool (<=) :: Joystick -> Joystick -> Bool (>) :: Joystick -> Joystick -> Bool (>=) :: Joystick -> Joystick -> Bool max :: Joystick -> Joystick -> Joystick min :: Joystick -> Joystick -> Joystick
Show Joystick Source # |
Instance details Defined in SDL.Internal.Types Methods showsPrec :: Int -> Joystick -> ShowS show :: Joystick -> String showList :: [Joystick] -> ShowS
Generic Joystick Source # |
Instance details Defined in SDL.Internal.Types Associated Types type Rep Joystick :: Type -> Type Methods from :: Joystick -> Rep Joystick x to :: Rep Joystick x -> Joystick
type Rep Joystick Source # |
Instance details Defined in SDL.Internal.Types type Rep Joystick = D1 ('MetaData "Joystick" "SDL.Internal.Types" "sdl2-2.5.2.0-Cx4Ipj2keSJFpflqvJYEGr" 'True) (C1 ('MetaCons "Joystick" 'PrefixI 'True) (S1 ('MetaSel ('Just "joystickPtr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Joystick)))

data JoyButtonState Source #

Identifies the state of a joystick button.

Constructors

JoyButtonPressed |
JoyButtonReleased |

#### Instances

Instances details

Eq JoyButtonState Source # |
Instance details Defined in SDL.Input.Joystick Methods (==) :: JoyButtonState -> JoyButtonState -> Bool (/=) :: JoyButtonState -> JoyButtonState -> Bool
Data JoyButtonState Source # |

Instance details

Defined in SDL.Input.Joystick

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JoyButtonState -> c JoyButtonState

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JoyButtonState

toConstr :: JoyButtonState -> Constr

dataTypeOf :: JoyButtonState -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c JoyButtonState)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JoyButtonState)

gmapT :: (forall b. Data b => b -> b) -> JoyButtonState -> JoyButtonState

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JoyButtonState -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JoyButtonState -> r

gmapQ :: (forall d. Data d => d -> u) -> JoyButtonState -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> JoyButtonState -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> JoyButtonState -> m JoyButtonState

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JoyButtonState -> m JoyButtonState

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JoyButtonState -> m JoyButtonState

Ord JoyButtonState Source # |

Instance details

Defined in SDL.Input.Joystick

Methods

compare :: JoyButtonState -> JoyButtonState -> Ordering

(<) :: JoyButtonState -> JoyButtonState -> Bool

(<=) :: JoyButtonState -> JoyButtonState -> Bool

(>) :: JoyButtonState -> JoyButtonState -> Bool

(>=) :: JoyButtonState -> JoyButtonState -> Bool

max :: JoyButtonState -> JoyButtonState -> JoyButtonState

min :: JoyButtonState -> JoyButtonState -> JoyButtonState

Read JoyButtonState Source # |
Instance details Defined in SDL.Input.Joystick Methods readsPrec :: Int -> ReadS JoyButtonState readList :: ReadS [JoyButtonState] readPrec :: ReadPrec JoyButtonState readListPrec :: ReadPrec [JoyButtonState]
Show JoyButtonState Source # |
Instance details Defined in SDL.Input.Joystick Methods showsPrec :: Int -> JoyButtonState -> ShowS show :: JoyButtonState -> String showList :: [JoyButtonState] -> ShowS
Generic JoyButtonState Source # |
Instance details Defined in SDL.Input.Joystick Associated Types type Rep JoyButtonState :: Type -> Type Methods from :: JoyButtonState -> Rep JoyButtonState x to :: Rep JoyButtonState x -> JoyButtonState
FromNumber JoyButtonState Word8 Source # |
Instance details Defined in SDL.Input.Joystick Methods fromNumber :: Word8 -> JoyButtonState Source #
type Rep JoyButtonState Source # |
Instance details Defined in SDL.Input.Joystick type Rep JoyButtonState = D1 ('MetaData "JoyButtonState" "SDL.Input.Joystick" "sdl2-2.5.2.0-Cx4Ipj2keSJFpflqvJYEGr" 'False) (C1 ('MetaCons "JoyButtonPressed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JoyButtonReleased" 'PrefixI 'False) (U1 :: Type -> Type))

buttonPressed Source #

Arguments

:: (Functor m, MonadIO m) |
=> Joystick |
-> CInt | The index of the button. You can use `numButtons` to determine how many buttons a given joystick has.
-> m Bool |

Determine if a given button is currently held.

See `SDL_JoystickGetButton` for C documentation.

ballDelta Source #

Arguments

:: MonadIO m |
=> Joystick |
-> CInt | The index of the joystick ball. You can use `numBalls` to determine how many balls a given joystick has.
-> m (V2 CInt) |

Get the ball axis change since the last poll.

See `SDL_JoystickGetBall` for C documentation.

axisPosition :: MonadIO m => Joystick -> CInt -> m Int16 Source #

Get the current state of an axis control on a joystick.

Returns a 16-bit signed integer representing the current position of the axis. The state is a value ranging from -32768 to 32767.

On most modern joysticks the x-axis is usually represented by axis 0 and the y-axis by axis 1. The value returned by `axisPosition` is a signed integer (-32768 to 32767) representing the current position of the axis. It may be necessary to impose certain tolerances on these values to account for jitter.

Some joysticks use axes 2 and 3 for extra buttons.

See `SDL_JoystickGetAxis` for C documentation.

numAxes :: MonadIO m => Joystick -> m CInt Source #

Get the number of general axis controls on a joystick.

See `SDL_JoystickNumAxes` for C documentation.

numButtons :: MonadIO m => Joystick -> m CInt Source #

Get the number of buttons on a joystick.

See `SDL_JoystickNumButtons` for C documentation.

numBalls :: MonadIO m => Joystick -> m CInt Source #

Get the number of trackballs on a joystick.

See `SDL_JoystickNumBalls` for C documentation.

data JoyHatPosition Source #

Identifies the state of the POV hat on a joystick.

Constructors

HatCentered | Centered position
HatUp | Up position
HatRight | Right position
HatDown | Down position
HatLeft | Left position
HatRightUp | Right-up position
HatRightDown | Right-down position
HatLeftUp | Left-up position
HatLeftDown | Left-down position

#### Instances

Instances details

Eq JoyHatPosition Source # |
Instance details Defined in SDL.Input.Joystick Methods (==) :: JoyHatPosition -> JoyHatPosition -> Bool (/=) :: JoyHatPosition -> JoyHatPosition -> Bool
Data JoyHatPosition Source # |

Instance details

Defined in SDL.Input.Joystick

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JoyHatPosition -> c JoyHatPosition

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JoyHatPosition

toConstr :: JoyHatPosition -> Constr

dataTypeOf :: JoyHatPosition -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c JoyHatPosition)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JoyHatPosition)

gmapT :: (forall b. Data b => b -> b) -> JoyHatPosition -> JoyHatPosition

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JoyHatPosition -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JoyHatPosition -> r

gmapQ :: (forall d. Data d => d -> u) -> JoyHatPosition -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> JoyHatPosition -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> JoyHatPosition -> m JoyHatPosition

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JoyHatPosition -> m JoyHatPosition

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JoyHatPosition -> m JoyHatPosition

Ord JoyHatPosition Source # |

Instance details

Defined in SDL.Input.Joystick

Methods

compare :: JoyHatPosition -> JoyHatPosition -> Ordering

(<) :: JoyHatPosition -> JoyHatPosition -> Bool

(<=) :: JoyHatPosition -> JoyHatPosition -> Bool

(>) :: JoyHatPosition -> JoyHatPosition -> Bool

(>=) :: JoyHatPosition -> JoyHatPosition -> Bool

max :: JoyHatPosition -> JoyHatPosition -> JoyHatPosition

min :: JoyHatPosition -> JoyHatPosition -> JoyHatPosition

Read JoyHatPosition Source # |
Instance details Defined in SDL.Input.Joystick Methods readsPrec :: Int -> ReadS JoyHatPosition readList :: ReadS [JoyHatPosition] readPrec :: ReadPrec JoyHatPosition readListPrec :: ReadPrec [JoyHatPosition]
Show JoyHatPosition Source # |
Instance details Defined in SDL.Input.Joystick Methods showsPrec :: Int -> JoyHatPosition -> ShowS show :: JoyHatPosition -> String showList :: [JoyHatPosition] -> ShowS
Generic JoyHatPosition Source # |
Instance details Defined in SDL.Input.Joystick Associated Types type Rep JoyHatPosition :: Type -> Type Methods from :: JoyHatPosition -> Rep JoyHatPosition x to :: Rep JoyHatPosition x -> JoyHatPosition
FromNumber JoyHatPosition Word8 Source # |
Instance details Defined in SDL.Input.Joystick Methods fromNumber :: Word8 -> JoyHatPosition Source #
type Rep JoyHatPosition Source # |

Instance details

Defined in SDL.Input.Joystick

type Rep JoyHatPosition = D1 ('MetaData "JoyHatPosition" "SDL.Input.Joystick" "sdl2-2.5.2.0-Cx4Ipj2keSJFpflqvJYEGr" 'False) (((C1 ('MetaCons "HatCentered" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HatUp" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HatRight" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HatDown" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "HatLeft" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HatRightUp" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HatRightDown" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "HatLeftUp" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HatLeftDown" 'PrefixI 'False) (U1 :: Type -> Type)))))

getHat Source #

Arguments

:: (Functor m, MonadIO m) |
=> Joystick |
-> CInt | The index of the POV hat. You can use `numHats` to determine how many POV hats a given joystick has.
-> m JoyHatPosition |

Get current position of a POV hat on a joystick.

See `SDL_JoystickGetHat` for C documentation.

numHats :: MonadIO m => Joystick -> m CInt Source #

Get the number of POV hats on a joystick.

See `SDL_JoystickNumHats` for C documentation.

data JoyDeviceConnection Source #

Identifies whether a joystick has been connected or disconnected.

Constructors

JoyDeviceAdded |
JoyDeviceRemoved |

#### Instances

Instances details

Eq JoyDeviceConnection Source # |
Instance details Defined in SDL.Input.Joystick Methods (==) :: JoyDeviceConnection -> JoyDeviceConnection -> Bool (/=) :: JoyDeviceConnection -> JoyDeviceConnection -> Bool
Data JoyDeviceConnection Source # |

Instance details

Defined in SDL.Input.Joystick

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JoyDeviceConnection -> c JoyDeviceConnection

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JoyDeviceConnection

toConstr :: JoyDeviceConnection -> Constr

dataTypeOf :: JoyDeviceConnection -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c JoyDeviceConnection)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JoyDeviceConnection)

gmapT :: (forall b. Data b => b -> b) -> JoyDeviceConnection -> JoyDeviceConnection

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JoyDeviceConnection -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JoyDeviceConnection -> r

gmapQ :: (forall d. Data d => d -> u) -> JoyDeviceConnection -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> JoyDeviceConnection -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> JoyDeviceConnection -> m JoyDeviceConnection

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JoyDeviceConnection -> m JoyDeviceConnection

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JoyDeviceConnection -> m JoyDeviceConnection

Ord JoyDeviceConnection Source # |

Instance details

Defined in SDL.Input.Joystick

Methods

compare :: JoyDeviceConnection -> JoyDeviceConnection -> Ordering

(<) :: JoyDeviceConnection -> JoyDeviceConnection -> Bool

(<=) :: JoyDeviceConnection -> JoyDeviceConnection -> Bool

(>) :: JoyDeviceConnection -> JoyDeviceConnection -> Bool

(>=) :: JoyDeviceConnection -> JoyDeviceConnection -> Bool

max :: JoyDeviceConnection -> JoyDeviceConnection -> JoyDeviceConnection

min :: JoyDeviceConnection -> JoyDeviceConnection -> JoyDeviceConnection

Read JoyDeviceConnection Source # |
Instance details Defined in SDL.Input.Joystick Methods readsPrec :: Int -> ReadS JoyDeviceConnection readList :: ReadS [JoyDeviceConnection] readPrec :: ReadPrec JoyDeviceConnection readListPrec :: ReadPrec [JoyDeviceConnection]
Show JoyDeviceConnection Source # |
Instance details Defined in SDL.Input.Joystick Methods showsPrec :: Int -> JoyDeviceConnection -> ShowS show :: JoyDeviceConnection -> String showList :: [JoyDeviceConnection] -> ShowS
Generic JoyDeviceConnection Source # |
Instance details Defined in SDL.Input.Joystick Associated Types type Rep JoyDeviceConnection :: Type -> Type Methods from :: JoyDeviceConnection -> Rep JoyDeviceConnection x to :: Rep JoyDeviceConnection x -> JoyDeviceConnection
FromNumber JoyDeviceConnection Word32 Source # |
Instance details Defined in SDL.Input.Joystick Methods fromNumber :: Word32 -> JoyDeviceConnection Source #
type Rep JoyDeviceConnection Source # |
Instance details Defined in SDL.Input.Joystick type Rep JoyDeviceConnection = D1 ('MetaData "JoyDeviceConnection" "SDL.Input.Joystick" "sdl2-2.5.2.0-Cx4Ipj2keSJFpflqvJYEGr" 'False) (C1 ('MetaCons "JoyDeviceAdded" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "JoyDeviceRemoved" 'PrefixI 'False) (U1 :: Type -> Type))