sdl3-bindgen-sys
Safe HaskellNone
LanguageGHC2021

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

Documentation

newtype SDL_KeyboardID Source #

C declaration
SDL_KeyboardID, defined at SDL3/SDL_keyboard.h 60:16

Constructors

SDL_KeyboardID 

Fields

Instances

Instances details
Bits SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

FiniteBits SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Bounded SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Enum SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Storable SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Generic SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type Rep SDL_KeyboardID 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

type Rep SDL_KeyboardID = D1 ('MetaData "SDL_KeyboardID" "SDL3.Sys.Bindgen.Keyboard" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_KeyboardID" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uint32)))
Ix SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Num SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Read SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Integral SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Real SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Show SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Eq SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Ord SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Prim SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

HasFFIType SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type FFIType SDL_KeyboardID 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

ReadRaw SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

StaticSize SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

WriteRaw SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Bitfield SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

HasCField SDL_KeyboardID "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type CFieldType SDL_KeyboardID "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Methods

offset# :: Proxy# SDL_KeyboardID -> Proxy# "unwrap" -> Int #

ty ~ Uint32 => HasField "unwrap" SDL_KeyboardID ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Methods

hasField :: SDL_KeyboardID -> (ty -> SDL_KeyboardID, ty) #

ty ~ Uint32 => HasField "unwrap" (Ptr SDL_KeyboardID) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Methods

getField :: Ptr SDL_KeyboardID -> Ptr ty #

type Rep SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

type Rep SDL_KeyboardID = D1 ('MetaData "SDL_KeyboardID" "SDL3.Sys.Bindgen.Keyboard" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_KeyboardID" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uint32)))
type FFIType SDL_KeyboardID Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

type CFieldType SDL_KeyboardID "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

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 at SDL3/SDL_keyboard.h 391:14

Since: 3.2.0

Constructors

SDL_TextInputType 

Fields

Instances

Instances details
Storable SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Generic SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type Rep SDL_TextInputType 
Instance details

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)))
Read SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Show SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Eq SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Ord SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Prim SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

CEnum SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type CEnumZ SDL_TextInputType 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

SequentialCEnum SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

HasFFIType SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type FFIType SDL_TextInputType 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

ReadRaw SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

StaticSize SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

WriteRaw SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

HasCField SDL_TextInputType "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type CFieldType SDL_TextInputType "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Methods

offset# :: Proxy# SDL_TextInputType -> Proxy# "unwrap" -> Int #

ty ~ CUInt => HasField "unwrap" SDL_TextInputType ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

ty ~ CUInt => HasField "unwrap" (Ptr SDL_TextInputType) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

type Rep SDL_TextInputType Source # 
Instance details

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 # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

type FFIType SDL_TextInputType Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

type CFieldType SDL_TextInputType "unwrap" Source # 
Instance details

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 at SDL3/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 at SDL3/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 at SDL3/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 at SDL3/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 at SDL3/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 at SDL3/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 at SDL3/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 at SDL3/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 at SDL3/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 at SDL3/SDL_keyboard.h 415:14

Since: 3.2.0

Constructors

SDL_Capitalization 

Fields

Instances

Instances details
Storable SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Generic SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type Rep SDL_Capitalization 
Instance details

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)))
Read SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Show SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Eq SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Ord SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Prim SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

CEnum SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type CEnumZ SDL_Capitalization 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

SequentialCEnum SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

HasFFIType SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type FFIType SDL_Capitalization 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

ReadRaw SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

StaticSize SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

WriteRaw SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

HasCField SDL_Capitalization "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Associated Types

type CFieldType SDL_Capitalization "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

Methods

offset# :: Proxy# SDL_Capitalization -> Proxy# "unwrap" -> Int #

ty ~ CUInt => HasField "unwrap" SDL_Capitalization ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

ty ~ CUInt => HasField "unwrap" (Ptr SDL_Capitalization) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

type Rep SDL_Capitalization Source # 
Instance details

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 # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

type FFIType SDL_Capitalization Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Keyboard

type CFieldType SDL_Capitalization "unwrap" Source # 
Instance details

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 at SDL3/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 at SDL3/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 at SDL3/SDL_keyboard.h 419:5

pattern SDL_CAPITALIZE_LETTERS :: SDL_Capitalization Source #

All letters will be capitalized

C declaration
SDL_CAPITALIZE_LETTERS, defined at SDL3/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 at SDL3/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 at SDL3/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 at SDL3/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 at SDL3/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 at SDL3/SDL_keyboard.h 479:9