Safe Haskell	None
Language	Haskell2010

SDL.Input.Keyboard

Contents

Keyboard Modifiers
Text Input
Screen Keyboard
Scancodes
Keycodes
Keysym
Keycodes and Scancodes

Synopsis

Keyboard Modifiers

getModState :: (Functor m, MonadIO m) => m KeyModifier Source

Get the current key modifier state for the keyboard. The key modifier state is a mask special keys that are held down.

See SDL_GetModState for C documentation.

data KeyModifier Source

Information about which keys are currently held down. Use getModState to generate this information.

Constructors

KeyModifier
Fields keyModifierLeftShift :: Bool keyModifierRightShift :: Bool keyModifierLeftCtrl :: Bool keyModifierRightCtrl :: Bool keyModifierLeftAlt :: Bool keyModifierRightAlt :: Bool keyModifierLeftGUI :: Bool keyModifierRightGUI :: Bool keyModifierNumLock :: Bool keyModifierCapsLock :: Bool keyModifierAltGr :: Bool

Instances

Eq KeyModifier Source
Data KeyModifier Source
Ord KeyModifier Source
Read KeyModifier Source
Show KeyModifier Source
Generic KeyModifier Source
type Rep KeyModifier Source

getKeyboardState :: MonadIO m => m (Scancode -> Bool) Source

Get a snapshot of the current state of the keyboard.

This computation generates a mapping from Scancode to Bool - evaluating the function at specific Scancodes will inform you as to whether or not that key was held down when getKeyboardState was called.

See SDL_GetKeyboardState for C documentation.

Text Input

startTextInput :: MonadIO m => Rect -> m () Source

Set the rectangle used to type text inputs and start accepting text input events.

See SDL_StartTextInput for C documentation.

stopTextInput :: MonadIO m => m () Source

Stop receiving any text input events.

See SDL_StopTextInput for C documentation.

Screen Keyboard

hasScreenKeyboardSupport :: MonadIO m => m Bool Source

Check whether the platform has screen keyboard support.

See SDL_HasScreenKeyboardSupport for C documentation.

isScreenKeyboardShown :: MonadIO m => Window -> m Bool Source

Check whether the screen keyboard is shown for the given window.

See SDL_IsScreenKeyboardShown for C documentation.

Scancodes

getScancodeName :: MonadIO m => Scancode -> m String Source

Get a human-readable name for a scancode. If the scancode doesn't have a name this function returns the empty string.

See SDL_GetScancodeName for C documentation.

newtype Scancode Source

Constructors

Scancode
Fields unwrapScancode :: Word32

Instances

Bounded Scancode Source
Eq Scancode Source
Data Scancode Source
Ord Scancode Source
Read Scancode Source
Show Scancode Source
Generic Scancode Source
type Rep Scancode Source

Keycodes

newtype Keycode Source

Constructors

Keycode
Fields unwrapKeycode :: Int32

Instances

Bounded Keycode Source
Eq Keycode Source
Data Keycode Source
Ord Keycode Source
Read Keycode Source
Show Keycode Source
Generic Keycode Source
type Rep Keycode Source

Keysym

data Keysym Source

Information about a key press or key release event.

Constructors

Keysym
Fields keysymScancode :: Scancode The keyboard `Scancode` keysymKeycode :: Keycode SDL's virtual key representation for this key keysymModifier :: KeyModifier A set of modifiers that were held at the time this data was generated

Instances

Eq Keysym Source
Data Keysym Source
Ord Keysym Source
Read Keysym Source
Show Keysym Source
Generic Keysym Source
type Rep Keysym Source

Keycodes and Scancodes

module SDL.Input.Keyboard.Codes