mischief-input
Safe HaskellNone
LanguageGHC2024

Mischief.Input.Keys

Synopsis

Resource

data Keys Source #

Instances

Instances details
Default Keys Source # 
Instance details

Defined in Mischief.Input.Keys

Methods

def :: Keys #

Generic Keys Source # 
Instance details

Defined in Mischief.Input.Keys

Associated Types

type Rep Keys 
Instance details

Defined in Mischief.Input.Keys

type Rep Keys = D1 ('MetaData "Keys" "Mischief.Input.Keys" "mischief-input-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Keys" 'PrefixI 'True) (S1 ('MetaSel ('Just "currentKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CBool]) :*: S1 ('MetaSel ('Just "previousKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CBool])))

Methods

from :: Keys -> Rep Keys x #

to :: Rep Keys x -> Keys #

Component Keys Source # 
Instance details

Defined in Mischief.Input.Keys

Associated Types

type IsExclusiveRel Keys 
Instance details

Defined in Mischief.Input.Keys

type IsExclusiveRel Keys = 'False

Methods

required :: Set DefaultComponentType

onAdd :: [Hook Keys]

onSet :: [Hook Keys]

onRemove :: [Hook Keys]

onAddRel :: [HookRel Keys]

onSetRel :: [HookRel Keys]

onRemoveRel :: [HookRel Keys]

type Rep Keys Source # 
Instance details

Defined in Mischief.Input.Keys

type Rep Keys = D1 ('MetaData "Keys" "Mischief.Input.Keys" "mischief-input-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Keys" 'PrefixI 'True) (S1 ('MetaSel ('Just "currentKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CBool]) :*: S1 ('MetaSel ('Just "previousKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CBool])))
type IsExclusiveRel Keys Source # 
Instance details

Defined in Mischief.Input.Keys

type IsExclusiveRel Keys = 'False

Functions

pressed :: Keys -> SDL_Scancode -> Bool Source #

released :: Keys -> SDL_Scancode -> Bool Source #

justPressed :: Keys -> SDL_Scancode -> Bool Source #

justReleased :: Keys -> SDL_Scancode -> Bool Source #

Plugin

data KeysPlugin Source #

Plugin which keeps track of key inputs and updates the Keys resource.

Instances

Instances details
Plugin KeysPlugin Source # 
Instance details

Defined in Mischief.Input.Keys

Methods

deps :: [Dependency]

init :: System ()

Keys

Below is an opinionated collection of keys selected from SDL3's scancodes. These can be used with pressed, justPressed, and so on.

Most key names are the same as SDL's, the only significant exception is Return which has been renamed to Enter.

If you wish to access a key that's not defined here, you can grab it directly from SDL3.Sys.Bindgen.Scancode.

pattern A :: SDL_Scancode Source #

pattern B :: SDL_Scancode Source #

pattern C :: SDL_Scancode Source #

pattern D :: SDL_Scancode Source #

pattern E :: SDL_Scancode Source #

pattern F :: SDL_Scancode Source #

pattern G :: SDL_Scancode Source #

pattern H :: SDL_Scancode Source #

pattern I :: SDL_Scancode Source #

pattern J :: SDL_Scancode Source #

pattern K :: SDL_Scancode Source #

pattern L :: SDL_Scancode Source #

pattern M :: SDL_Scancode Source #

pattern N :: SDL_Scancode Source #

pattern O :: SDL_Scancode Source #

pattern P :: SDL_Scancode Source #

pattern Q :: SDL_Scancode Source #

pattern R :: SDL_Scancode Source #

pattern S :: SDL_Scancode Source #

pattern T :: SDL_Scancode Source #

pattern U :: SDL_Scancode Source #

pattern V :: SDL_Scancode Source #

pattern W :: SDL_Scancode Source #

pattern X :: SDL_Scancode Source #

pattern Y :: SDL_Scancode Source #

pattern Z :: SDL_Scancode Source #

pattern Key0 :: SDL_Scancode Source #

pattern Key1 :: SDL_Scancode Source #

pattern Key2 :: SDL_Scancode Source #

pattern Key3 :: SDL_Scancode Source #

pattern Key4 :: SDL_Scancode Source #

pattern Key5 :: SDL_Scancode Source #

pattern Key6 :: SDL_Scancode Source #

pattern Key7 :: SDL_Scancode Source #

pattern Key8 :: SDL_Scancode Source #

pattern Key9 :: SDL_Scancode Source #

pattern Enter :: SDL_Scancode Source #

pattern Escape :: SDL_Scancode Source #

pattern Backspace :: SDL_Scancode Source #

pattern Tab :: SDL_Scancode Source #

pattern Space :: SDL_Scancode Source #

pattern Minus :: SDL_Scancode Source #

pattern Equals :: SDL_Scancode Source #

pattern LeftBracket :: SDL_Scancode Source #

pattern RightBracket :: SDL_Scancode Source #

pattern BackSlash :: SDL_Scancode Source #

pattern Semicolon :: SDL_Scancode Source #

pattern Apostrophe :: SDL_Scancode Source #

pattern Grave :: SDL_Scancode Source #

pattern Comma :: SDL_Scancode Source #

pattern Period :: SDL_Scancode Source #

pattern Slash :: SDL_Scancode Source #

pattern Capslock :: SDL_Scancode Source #

pattern F1 :: SDL_Scancode Source #

pattern F2 :: SDL_Scancode Source #

pattern F3 :: SDL_Scancode Source #

pattern F4 :: SDL_Scancode Source #

pattern F5 :: SDL_Scancode Source #

pattern F6 :: SDL_Scancode Source #

pattern F7 :: SDL_Scancode Source #

pattern F8 :: SDL_Scancode Source #

pattern F9 :: SDL_Scancode Source #

pattern F10 :: SDL_Scancode Source #

pattern F11 :: SDL_Scancode Source #

pattern F12 :: SDL_Scancode Source #

pattern Printscreen :: SDL_Scancode Source #

pattern Scrolllock :: SDL_Scancode Source #

pattern Pause :: SDL_Scancode Source #

pattern Insert :: SDL_Scancode Source #

pattern Home :: SDL_Scancode Source #

pattern PageUp :: SDL_Scancode Source #

pattern PageDown :: SDL_Scancode Source #

pattern Delete :: SDL_Scancode Source #

pattern End :: SDL_Scancode Source #

pattern Right :: SDL_Scancode Source #

pattern Left :: SDL_Scancode Source #

pattern Down :: SDL_Scancode Source #

pattern Up :: SDL_Scancode Source #

pattern Numlockclear :: SDL_Scancode Source #

pattern KeypadDivide :: SDL_Scancode Source #

pattern KeypadMultiply :: SDL_Scancode Source #

pattern Keypad0 :: SDL_Scancode Source #

pattern Keypad1 :: SDL_Scancode Source #

pattern Keypad2 :: SDL_Scancode Source #

pattern Keypad3 :: SDL_Scancode Source #

pattern Keypad4 :: SDL_Scancode Source #

pattern Keypad5 :: SDL_Scancode Source #

pattern Keypad6 :: SDL_Scancode Source #

pattern Keypad7 :: SDL_Scancode Source #

pattern Keypad8 :: SDL_Scancode Source #

pattern Keypad9 :: SDL_Scancode Source #

pattern KeypadPeriod :: SDL_Scancode Source #

pattern KeypadComma :: SDL_Scancode Source #

pattern KeypadEnter :: SDL_Scancode Source #

pattern KeypadEquals :: SDL_Scancode Source #

pattern KeypadMinus :: SDL_Scancode Source #

pattern KeypadPlus :: SDL_Scancode Source #

pattern LCtrl :: SDL_Scancode Source #

pattern LShift :: SDL_Scancode Source #

pattern LAlt :: SDL_Scancode Source #

pattern RCtrl :: SDL_Scancode Source #

pattern RShift :: SDL_Scancode Source #

pattern RAlt :: SDL_Scancode Source #

pattern Application :: SDL_Scancode Source #