| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
SDL3.Sys.Bindgen.Keyboard
Description
SDL keyboard management.
Please refer to the Best Keyboard Practices document for details on how best to accept keyboard input in various types of programs:
https://wiki.libsdl.org/SDL3/BestKeyboardPractices This is a unique ID for a keyboard for the time it is connected to the system, and is never reused for the lifetime of the application.
If the keyboard is disconnected and reconnected, it will get a new ID.
The value 0 is an invalid ID.
Since: 3.2.0
Synopsis
- newtype SDL_KeyboardID = SDL_KeyboardID {}
- newtype SDL_TextInputType = SDL_TextInputType {}
- pattern SDL_TEXTINPUT_TYPE_TEXT :: SDL_TextInputType
- pattern SDL_TEXTINPUT_TYPE_TEXT_NAME :: SDL_TextInputType
- pattern SDL_TEXTINPUT_TYPE_TEXT_EMAIL :: SDL_TextInputType
- pattern SDL_TEXTINPUT_TYPE_TEXT_USERNAME :: SDL_TextInputType
- pattern SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_HIDDEN :: SDL_TextInputType
- pattern SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_VISIBLE :: SDL_TextInputType
- pattern SDL_TEXTINPUT_TYPE_NUMBER :: SDL_TextInputType
- pattern SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_HIDDEN :: SDL_TextInputType
- pattern SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_VISIBLE :: SDL_TextInputType
- newtype SDL_Capitalization = SDL_Capitalization {}
- pattern SDL_CAPITALIZE_NONE :: SDL_Capitalization
- pattern SDL_CAPITALIZE_SENTENCES :: SDL_Capitalization
- pattern SDL_CAPITALIZE_WORDS :: SDL_Capitalization
- pattern SDL_CAPITALIZE_LETTERS :: SDL_Capitalization
- sDL_PROP_TEXTINPUT_TYPE_NUMBER :: ByteString
- sDL_PROP_TEXTINPUT_CAPITALIZATION_NUMBER :: ByteString
- sDL_PROP_TEXTINPUT_AUTOCORRECT_BOOLEAN :: ByteString
- sDL_PROP_TEXTINPUT_MULTILINE_BOOLEAN :: ByteString
- sDL_PROP_TEXTINPUT_ANDROID_INPUTTYPE_NUMBER :: ByteString
Documentation
newtype SDL_KeyboardID Source #
- C declaration
SDL_KeyboardID, defined atSDL3/SDL_keyboard.h 60:16
Constructors
| SDL_KeyboardID | |
Instances
newtype SDL_TextInputType Source #
Text input type.
These are the valid values for SDL_PROP_TEXTINPUT_TYPE_NUMBER. Not every value is valid on every platform, but where a value isn't supported, a reasonable fallback will be used.
- See also
sDL_StartTextInputWithProperties- C declaration
enum SDL_TextInputType, defined atSDL3/SDL_keyboard.h 391:14
Since: 3.2.0
Constructors
| SDL_TextInputType | |
Instances
| Storable SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods sizeOf :: SDL_TextInputType -> Int # alignment :: SDL_TextInputType -> Int # peekElemOff :: Ptr SDL_TextInputType -> Int -> IO SDL_TextInputType # pokeElemOff :: Ptr SDL_TextInputType -> Int -> SDL_TextInputType -> IO () # peekByteOff :: Ptr b -> Int -> IO SDL_TextInputType # pokeByteOff :: Ptr b -> Int -> SDL_TextInputType -> IO () # peek :: Ptr SDL_TextInputType -> IO SDL_TextInputType # poke :: Ptr SDL_TextInputType -> SDL_TextInputType -> IO () # | |||||
| Generic SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Associated Types
Methods from :: SDL_TextInputType -> Rep SDL_TextInputType x # to :: Rep SDL_TextInputType x -> SDL_TextInputType # | |||||
| Read SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods readsPrec :: Int -> ReadS SDL_TextInputType # readList :: ReadS [SDL_TextInputType] # | |||||
| Show SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods showsPrec :: Int -> SDL_TextInputType -> ShowS # show :: SDL_TextInputType -> String # showList :: [SDL_TextInputType] -> ShowS # | |||||
| Eq SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods (==) :: SDL_TextInputType -> SDL_TextInputType -> Bool # (/=) :: SDL_TextInputType -> SDL_TextInputType -> Bool # | |||||
| Ord SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods compare :: SDL_TextInputType -> SDL_TextInputType -> Ordering # (<) :: SDL_TextInputType -> SDL_TextInputType -> Bool # (<=) :: SDL_TextInputType -> SDL_TextInputType -> Bool # (>) :: SDL_TextInputType -> SDL_TextInputType -> Bool # (>=) :: SDL_TextInputType -> SDL_TextInputType -> Bool # max :: SDL_TextInputType -> SDL_TextInputType -> SDL_TextInputType # min :: SDL_TextInputType -> SDL_TextInputType -> SDL_TextInputType # | |||||
| Prim SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods sizeOfType# :: Proxy SDL_TextInputType -> Int# # sizeOf# :: SDL_TextInputType -> Int# # alignmentOfType# :: Proxy SDL_TextInputType -> Int# # alignment# :: SDL_TextInputType -> Int# # indexByteArray# :: ByteArray# -> Int# -> SDL_TextInputType # readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, SDL_TextInputType #) # writeByteArray# :: MutableByteArray# s -> Int# -> SDL_TextInputType -> State# s -> State# s # setByteArray# :: MutableByteArray# s -> Int# -> Int# -> SDL_TextInputType -> State# s -> State# s # indexOffAddr# :: Addr# -> Int# -> SDL_TextInputType # readOffAddr# :: Addr# -> Int# -> State# s -> (# State# s, SDL_TextInputType #) # writeOffAddr# :: Addr# -> Int# -> SDL_TextInputType -> State# s -> State# s # setOffAddr# :: Addr# -> Int# -> Int# -> SDL_TextInputType -> State# s -> State# s # | |||||
| CEnum SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Associated Types
Methods toCEnum :: CEnumZ SDL_TextInputType -> SDL_TextInputType # fromCEnum :: SDL_TextInputType -> CEnumZ SDL_TextInputType # declaredValues :: proxy SDL_TextInputType -> DeclaredValues SDL_TextInputType # showsUndeclared :: proxy SDL_TextInputType -> Int -> CEnumZ SDL_TextInputType -> ShowS # readPrecUndeclared :: ReadPrec SDL_TextInputType # isDeclared :: SDL_TextInputType -> Bool # mkDeclared :: CEnumZ SDL_TextInputType -> Maybe SDL_TextInputType # | |||||
| SequentialCEnum SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard | |||||
| HasFFIType SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Associated Types
Methods toFFIType :: SDL_TextInputType -> FFIType SDL_TextInputType # fromFFIType :: FFIType SDL_TextInputType -> SDL_TextInputType # | |||||
| ReadRaw SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods | |||||
| StaticSize SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods staticSizeOf :: Proxy SDL_TextInputType -> Int # | |||||
| WriteRaw SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods writeRaw :: Ptr SDL_TextInputType -> SDL_TextInputType -> IO () # | |||||
| HasCField SDL_TextInputType "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Associated Types
| |||||
| ty ~ CUInt => HasField "unwrap" SDL_TextInputType ty Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods hasField :: SDL_TextInputType -> (ty -> SDL_TextInputType, ty) # | |||||
| ty ~ CUInt => HasField "unwrap" (Ptr SDL_TextInputType) (Ptr ty :: Type) Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods getField :: Ptr SDL_TextInputType -> Ptr ty # | |||||
| type Rep SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard type Rep SDL_TextInputType = D1 ('MetaData "SDL_TextInputType" "SDL3.Sys.Bindgen.Keyboard" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_TextInputType" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt))) | |||||
| type CEnumZ SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard | |||||
| type FFIType SDL_TextInputType Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard | |||||
| type CFieldType SDL_TextInputType "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard | |||||
pattern SDL_TEXTINPUT_TYPE_TEXT :: SDL_TextInputType Source #
The input is text
- C declaration
SDL_TEXTINPUT_TYPE_TEXT, defined atSDL3/SDL_keyboard.h 393:5
pattern SDL_TEXTINPUT_TYPE_TEXT_NAME :: SDL_TextInputType Source #
The input is a person's name
- C declaration
SDL_TEXTINPUT_TYPE_TEXT_NAME, defined atSDL3/SDL_keyboard.h 394:5
pattern SDL_TEXTINPUT_TYPE_TEXT_EMAIL :: SDL_TextInputType Source #
The input is an e-mail address
- C declaration
SDL_TEXTINPUT_TYPE_TEXT_EMAIL, defined atSDL3/SDL_keyboard.h 395:5
pattern SDL_TEXTINPUT_TYPE_TEXT_USERNAME :: SDL_TextInputType Source #
The input is a username
- C declaration
SDL_TEXTINPUT_TYPE_TEXT_USERNAME, defined atSDL3/SDL_keyboard.h 396:5
pattern SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_HIDDEN :: SDL_TextInputType Source #
The input is a secure password that is hidden
- C declaration
SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_HIDDEN, defined atSDL3/SDL_keyboard.h 397:5
pattern SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_VISIBLE :: SDL_TextInputType Source #
The input is a secure password that is visible
- C declaration
SDL_TEXTINPUT_TYPE_TEXT_PASSWORD_VISIBLE, defined atSDL3/SDL_keyboard.h 398:5
pattern SDL_TEXTINPUT_TYPE_NUMBER :: SDL_TextInputType Source #
The input is a number
- C declaration
SDL_TEXTINPUT_TYPE_NUMBER, defined atSDL3/SDL_keyboard.h 399:5
pattern SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_HIDDEN :: SDL_TextInputType Source #
The input is a secure PIN that is hidden
- C declaration
SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_HIDDEN, defined atSDL3/SDL_keyboard.h 400:5
pattern SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_VISIBLE :: SDL_TextInputType Source #
The input is a secure PIN that is visible
- C declaration
SDL_TEXTINPUT_TYPE_NUMBER_PASSWORD_VISIBLE, defined atSDL3/SDL_keyboard.h 401:5
newtype SDL_Capitalization Source #
Auto capitalization type.
These are the valid values for SDL_PROP_TEXTINPUT_CAPITALIZATION_NUMBER. Not every value is valid on every platform, but where a value isn't supported, a reasonable fallback will be used.
- See also
sDL_StartTextInputWithProperties- C declaration
enum SDL_Capitalization, defined atSDL3/SDL_keyboard.h 415:14
Since: 3.2.0
Constructors
| SDL_Capitalization | |
Instances
| Storable SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods sizeOf :: SDL_Capitalization -> Int # alignment :: SDL_Capitalization -> Int # peekElemOff :: Ptr SDL_Capitalization -> Int -> IO SDL_Capitalization # pokeElemOff :: Ptr SDL_Capitalization -> Int -> SDL_Capitalization -> IO () # peekByteOff :: Ptr b -> Int -> IO SDL_Capitalization # pokeByteOff :: Ptr b -> Int -> SDL_Capitalization -> IO () # peek :: Ptr SDL_Capitalization -> IO SDL_Capitalization # poke :: Ptr SDL_Capitalization -> SDL_Capitalization -> IO () # | |||||
| Generic SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Associated Types
Methods from :: SDL_Capitalization -> Rep SDL_Capitalization x # to :: Rep SDL_Capitalization x -> SDL_Capitalization # | |||||
| Read SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods readsPrec :: Int -> ReadS SDL_Capitalization # readList :: ReadS [SDL_Capitalization] # | |||||
| Show SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods showsPrec :: Int -> SDL_Capitalization -> ShowS # show :: SDL_Capitalization -> String # showList :: [SDL_Capitalization] -> ShowS # | |||||
| Eq SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods (==) :: SDL_Capitalization -> SDL_Capitalization -> Bool # (/=) :: SDL_Capitalization -> SDL_Capitalization -> Bool # | |||||
| Ord SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods compare :: SDL_Capitalization -> SDL_Capitalization -> Ordering # (<) :: SDL_Capitalization -> SDL_Capitalization -> Bool # (<=) :: SDL_Capitalization -> SDL_Capitalization -> Bool # (>) :: SDL_Capitalization -> SDL_Capitalization -> Bool # (>=) :: SDL_Capitalization -> SDL_Capitalization -> Bool # max :: SDL_Capitalization -> SDL_Capitalization -> SDL_Capitalization # min :: SDL_Capitalization -> SDL_Capitalization -> SDL_Capitalization # | |||||
| Prim SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods sizeOfType# :: Proxy SDL_Capitalization -> Int# # sizeOf# :: SDL_Capitalization -> Int# # alignmentOfType# :: Proxy SDL_Capitalization -> Int# # alignment# :: SDL_Capitalization -> Int# # indexByteArray# :: ByteArray# -> Int# -> SDL_Capitalization # readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, SDL_Capitalization #) # writeByteArray# :: MutableByteArray# s -> Int# -> SDL_Capitalization -> State# s -> State# s # setByteArray# :: MutableByteArray# s -> Int# -> Int# -> SDL_Capitalization -> State# s -> State# s # indexOffAddr# :: Addr# -> Int# -> SDL_Capitalization # readOffAddr# :: Addr# -> Int# -> State# s -> (# State# s, SDL_Capitalization #) # writeOffAddr# :: Addr# -> Int# -> SDL_Capitalization -> State# s -> State# s # setOffAddr# :: Addr# -> Int# -> Int# -> SDL_Capitalization -> State# s -> State# s # | |||||
| CEnum SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Associated Types
Methods toCEnum :: CEnumZ SDL_Capitalization -> SDL_Capitalization # fromCEnum :: SDL_Capitalization -> CEnumZ SDL_Capitalization # declaredValues :: proxy SDL_Capitalization -> DeclaredValues SDL_Capitalization # showsUndeclared :: proxy SDL_Capitalization -> Int -> CEnumZ SDL_Capitalization -> ShowS # readPrecUndeclared :: ReadPrec SDL_Capitalization # isDeclared :: SDL_Capitalization -> Bool # mkDeclared :: CEnumZ SDL_Capitalization -> Maybe SDL_Capitalization # | |||||
| SequentialCEnum SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard | |||||
| HasFFIType SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Associated Types
Methods toFFIType :: SDL_Capitalization -> FFIType SDL_Capitalization # fromFFIType :: FFIType SDL_Capitalization -> SDL_Capitalization # | |||||
| ReadRaw SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods readRaw :: Ptr SDL_Capitalization -> IO SDL_Capitalization # | |||||
| StaticSize SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods staticSizeOf :: Proxy SDL_Capitalization -> Int # | |||||
| WriteRaw SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods writeRaw :: Ptr SDL_Capitalization -> SDL_Capitalization -> IO () # | |||||
| HasCField SDL_Capitalization "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Associated Types
| |||||
| ty ~ CUInt => HasField "unwrap" SDL_Capitalization ty Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods hasField :: SDL_Capitalization -> (ty -> SDL_Capitalization, ty) # | |||||
| ty ~ CUInt => HasField "unwrap" (Ptr SDL_Capitalization) (Ptr ty :: Type) Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard Methods getField :: Ptr SDL_Capitalization -> Ptr ty # | |||||
| type Rep SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard type Rep SDL_Capitalization = D1 ('MetaData "SDL_Capitalization" "SDL3.Sys.Bindgen.Keyboard" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_Capitalization" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt))) | |||||
| type CEnumZ SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard | |||||
| type FFIType SDL_Capitalization Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard | |||||
| type CFieldType SDL_Capitalization "unwrap" Source # | |||||
Defined in SDL3.Sys.Bindgen.Keyboard | |||||
pattern SDL_CAPITALIZE_NONE :: SDL_Capitalization Source #
No auto-capitalization will be done
- C declaration
SDL_CAPITALIZE_NONE, defined atSDL3/SDL_keyboard.h 417:5
pattern SDL_CAPITALIZE_SENTENCES :: SDL_Capitalization Source #
The first letter of sentences will be capitalized
- C declaration
SDL_CAPITALIZE_SENTENCES, defined atSDL3/SDL_keyboard.h 418:5
pattern SDL_CAPITALIZE_WORDS :: SDL_Capitalization Source #
The first letter of words will be capitalized
- C declaration
SDL_CAPITALIZE_WORDS, defined atSDL3/SDL_keyboard.h 419:5
pattern SDL_CAPITALIZE_LETTERS :: SDL_Capitalization Source #
All letters will be capitalized
- C declaration
SDL_CAPITALIZE_LETTERS, defined atSDL3/SDL_keyboard.h 420:5
sDL_PROP_TEXTINPUT_TYPE_NUMBER :: ByteString Source #
- C declaration
macro SDL_PROP_TEXTINPUT_TYPE_NUMBER, literal"SDL.textinput.type", defined atSDL3/SDL_keyboard.h 475:9
sDL_PROP_TEXTINPUT_CAPITALIZATION_NUMBER :: ByteString Source #
- C declaration
macro SDL_PROP_TEXTINPUT_CAPITALIZATION_NUMBER, literal"SDL.textinput.capitalization", defined atSDL3/SDL_keyboard.h 476:9
sDL_PROP_TEXTINPUT_AUTOCORRECT_BOOLEAN :: ByteString Source #
- C declaration
macro SDL_PROP_TEXTINPUT_AUTOCORRECT_BOOLEAN, literal"SDL.textinput.autocorrect", defined atSDL3/SDL_keyboard.h 477:9
sDL_PROP_TEXTINPUT_MULTILINE_BOOLEAN :: ByteString Source #
- C declaration
macro SDL_PROP_TEXTINPUT_MULTILINE_BOOLEAN, literal"SDL.textinput.multiline", defined atSDL3/SDL_keyboard.h 478:9
sDL_PROP_TEXTINPUT_ANDROID_INPUTTYPE_NUMBER :: ByteString Source #
- C declaration
macro SDL_PROP_TEXTINPUT_ANDROID_INPUTTYPE_NUMBER, literal"SDL.textinput.android.inputtype", defined atSDL3/SDL_keyboard.h 479:9