Modulesdl2-2.5.5.0Haskell2010

SDL.Input.Joystick

5 types
13 values

Packagesdl2-2.5.5.0
Exports18
LanguageHaskell2010
LicenceBSD-3-Clause
SourceJoystick.hs

valuenumJoysticks :: MonadIO m => m CInt

Count the number of joysticks attached to the system.

See SDL_NumJoysticks for C documentation.

valueavailableJoysticks :: MonadIO m => m (Vector JoystickDevice)

Enumerate all connected joysticks, retrieving a description of each.

datadata JoystickDevice

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

Constructors

JoystickDevice
- joystickDeviceName :: Text
- joystickDeviceId :: CInt

Instances6Eq, Ord, Read, Show, Generic, Rep

Eq JoystickDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Ord JoystickDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Read JoystickDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Show JoystickDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Generic JoystickDeviceDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
type Rep JoystickDevice = D1 ('MetaData "JoystickDevice" "SDL.Input.Joystick" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "JoystickDevice" 'PrefixI 'True) (S1 ('MetaSel ('Just "joystickDeviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "joystickDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt)))Defined in sdl2-2.5.5.0 · SDL.Input.Joystick

valueopenJoystick

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

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

See SDL_JoystickOpen for C documentation.

valuecloseJoystick :: MonadIO m => Joystick -> m ()

Close a joystick previously opened with openJoystick.

See SDL_JoystickClose for C documentation.

valuegetJoystickID :: MonadIO m => Joystick -> m JoystickID

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.

newtypenewtype Joystick

Instances6Eq, Data, Ord, Show, Generic, Rep

Eq JoystickDefined in sdl2-2.5.5.0 · SDL.Internal.Types
Data JoystickDefined in sdl2-2.5.5.0 · SDL.Internal.Types
Ord JoystickDefined in sdl2-2.5.5.0 · SDL.Internal.Types
Show JoystickDefined in sdl2-2.5.5.0 · SDL.Internal.Types
Generic JoystickDefined in sdl2-2.5.5.0 · SDL.Internal.Types
type Rep Joystick = D1 ('MetaData "Joystick" "SDL.Internal.Types" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'True) (C1 ('MetaCons "Joystick" 'PrefixI 'True) (S1 ('MetaSel ('Just "joystickPtr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Joystick)))Defined in sdl2-2.5.5.0 · SDL.Internal.Types

datadata JoyButtonState

Identifies the state of a joystick button.

JoyButtonPressed JoyButtonReleased

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

Eq JoyButtonStateDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Data JoyButtonStateDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Ord JoyButtonStateDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Read JoyButtonStateDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Show JoyButtonStateDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Generic JoyButtonStateDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
FromNumber JoyButtonState Word8Defined in sdl2-2.5.5.0 · SDL.Input.Joystick
type Rep JoyButtonState = D1 ('MetaData "JoyButtonState" "SDL.Input.Joystick" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "JoyButtonPressed" 'PrefixI 'False) U1 :+: C1 ('MetaCons "JoyButtonReleased" 'PrefixI 'False) U1)Defined in sdl2-2.5.5.0 · SDL.Input.Joystick

valuebuttonPressed

:: (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.

valueballDelta

:: 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.

valueaxisPosition :: MonadIO m => Joystick -> CInt -> m Int16

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.

valuenumAxes :: MonadIO m => Joystick -> m CInt

Get the number of general axis controls on a joystick.

See SDL_JoystickNumAxes for C documentation.

valuenumButtons :: MonadIO m => Joystick -> m CInt

Get the number of buttons on a joystick.

See SDL_JoystickNumButtons for C documentation.

valuenumBalls :: MonadIO m => Joystick -> m CInt

Get the number of trackballs on a joystick.

See SDL_JoystickNumBalls for C documentation.

datadata JoyHatPosition

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

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

Eq JoyHatPositionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Data JoyHatPositionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Ord JoyHatPositionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Read JoyHatPositionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Show JoyHatPositionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Generic JoyHatPositionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
FromNumber JoyHatPosition Word8Defined in sdl2-2.5.5.0 · SDL.Input.Joystick
type Rep JoyHatPosition = D1 ('MetaData "JoyHatPosition" "SDL.Input.Joystick" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (((C1 ('MetaCons "HatCentered" 'PrefixI 'False) U1 :+: C1 ('MetaCons "HatUp" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "HatRight" 'PrefixI 'False) U1 :+: C1 ('MetaCons "HatDown" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "HatLeft" 'PrefixI 'False) U1 :+: C1 ('MetaCons "HatRightUp" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "HatRightDown" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "HatLeftUp" 'PrefixI 'False) U1 :+: C1 ('MetaCons "HatLeftDown" 'PrefixI 'False) U1))))Defined in sdl2-2.5.5.0 · SDL.Input.Joystick

valuegetHat

:: (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.

valuenumHats :: MonadIO m => Joystick -> m CInt

Get the number of POV hats on a joystick.

See SDL_JoystickNumHats for C documentation.

datadata JoyDeviceConnection

Identifies whether a joystick has been connected or disconnected.

JoyDeviceAdded JoyDeviceRemoved

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

Eq JoyDeviceConnectionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Data JoyDeviceConnectionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Ord JoyDeviceConnectionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Read JoyDeviceConnectionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Show JoyDeviceConnectionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
Generic JoyDeviceConnectionDefined in sdl2-2.5.5.0 · SDL.Input.Joystick
FromNumber JoyDeviceConnection Word32Defined in sdl2-2.5.5.0 · SDL.Input.Joystick
type Rep JoyDeviceConnection = D1 ('MetaData "JoyDeviceConnection" "SDL.Input.Joystick" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "JoyDeviceAdded" 'PrefixI 'False) U1 :+: C1 ('MetaCons "JoyDeviceRemoved" 'PrefixI 'False) U1)Defined in sdl2-2.5.5.0 · SDL.Input.Joystick