Struct KeyboardState

Represents the state of the keyboard.

Implements

IController

Namespace: Evergine.Common.Input

Assembly: Evergine.Common.dll

Syntax

public struct KeyboardState : IController

Fields

A

The "A" key.

Declaration

public ButtonState A

Field Value

Type	Description
ButtonState

Accept

The accept button or key.

Declaration

public ButtonState Accept

Field Value

Type	Description
ButtonState

Add

The add (+) operation key located on a numeric pad.

Declaration

public ButtonState Add

Field Value

Type	Description
ButtonState

Apostrophe

The apostrophe key.

Declaration

public ButtonState Apostrophe

Field Value

Type	Description
ButtonState

Application

The application key or button.

Declaration

public ButtonState Application

Field Value

Type	Description
ButtonState

B

The "B" key.

Declaration

public ButtonState B

Field Value

Type	Description
ButtonState

Back

The virtual back key or button.

Declaration

public ButtonState Back

Field Value

Type	Description
ButtonState

BackSlash

The backslash key.

Declaration

public ButtonState BackSlash

Field Value

Type	Description
ButtonState

C

The "C" key.

Declaration

public ButtonState C

Field Value

Type	Description
ButtonState

Cancel

The cancel key or button.

Declaration

public ButtonState Cancel

Field Value

Type	Description
ButtonState

CapitalLock

The Caps Lock key or button.

Declaration

public ButtonState CapitalLock

Field Value

Type	Description
ButtonState

Clear

The Clear key or button.

Declaration

public ButtonState Clear

Field Value

Type	Description
ButtonState

Comma

Represents the comma key.

Declaration

public ButtonState Comma

Field Value

Type	Description
ButtonState

Control

The Ctrl key. This is the general Ctrl case, applicable to key layouts with only one Ctrl key or that do not need to differentiate between left Ctrl and right Ctrl keystrokes.

Declaration

public ButtonState Control

Field Value

Type	Description
ButtonState

Convert

The convert button or key.

Declaration

public ButtonState Convert

Field Value

Type	Description
ButtonState

D

The "D" key.

Declaration

public ButtonState D

Field Value

Type	Description
ButtonState

Decimal

The decimal (.) key as located on a numeric keypad.

Declaration

public ButtonState Decimal

Field Value

Type	Description
ButtonState

Delete

Represents the Delete key.

Declaration

public ButtonState Delete

Field Value

Type	Description
ButtonState

Divide

The divide (/) operation key as located on a numeric keypad.

Declaration

public ButtonState Divide

Field Value

Type	Description
ButtonState

Down

The Down Arrow key.

Declaration

public ButtonState Down

Field Value

Type	Description
ButtonState

E

The "E" key.

Declaration

public ButtonState E

Field Value

Type	Description
ButtonState

End

The End key.

Declaration

public ButtonState End

Field Value

Type	Description
ButtonState

Enter

The Enter key.

Declaration

public ButtonState Enter

Field Value

Type	Description
ButtonState

Escape

The Esc key.

Declaration

public ButtonState Escape

Field Value

Type	Description
ButtonState

Execute

The execute key or button.

Declaration

public ButtonState Execute

Field Value

Type	Description
ButtonState

F

The "F" key.

Declaration

public ButtonState F

Field Value

Type	Description
ButtonState

F1

The F1 function key.

Declaration

public ButtonState F1

Field Value

Type	Description
ButtonState

F10

The F10 function key.

Declaration

public ButtonState F10

Field Value

Type	Description
ButtonState

F11

The F11 function key.

Declaration

public ButtonState F11

Field Value

Type	Description
ButtonState

F12

The F12 function key.

Declaration

public ButtonState F12

Field Value

Type	Description
ButtonState

F13

The F13 function key.

Declaration

public ButtonState F13

Field Value

Type	Description
ButtonState

F14

The F14 function key.

Declaration

public ButtonState F14

Field Value

Type	Description
ButtonState

F15

The F15 function key.

Declaration

public ButtonState F15

Field Value

Type	Description
ButtonState

F16

The F16 function key.

Declaration

public ButtonState F16

Field Value

Type	Description
ButtonState

F17

Represents the F17 function key.

Declaration

public ButtonState F17

Field Value

Type	Description
ButtonState

F18

The F18 function key.

Declaration

public ButtonState F18

Field Value

Type	Description
ButtonState

F19

The F19 function key.

Declaration

public ButtonState F19

Field Value

Type	Description
ButtonState

F2

The F2 function key.

Declaration

public ButtonState F2

Field Value

Type	Description
ButtonState

F20

The F20 function key.

Declaration

public ButtonState F20

Field Value

Type	Description
ButtonState

F21

The F21 function key.

Declaration

public ButtonState F21

Field Value

Type	Description
ButtonState

F22

The F22 function key.

Declaration

public ButtonState F22

Field Value

Type	Description
ButtonState

F23

The F23 function key.

Declaration

public ButtonState F23

Field Value

Type	Description
ButtonState

F24

The F24 function key.

Declaration

public ButtonState F24

Field Value

Type	Description
ButtonState

F3

The F3 function key.

Declaration

public ButtonState F3

Field Value

Type	Description
ButtonState

F4

The F4 function key.

Declaration

public ButtonState F4

Field Value

Type	Description
ButtonState

F5

The F5 function key.

Declaration

public ButtonState F5

Field Value

Type	Description
ButtonState

F6

The F6 function key.

Declaration

public ButtonState F6

Field Value

Type	Description
ButtonState

F7

The F7 function key.

Declaration

public ButtonState F7

Field Value

Type	Description
ButtonState

F8

The F8 function key.

Declaration

public ButtonState F8

Field Value

Type	Description
ButtonState

F9

The F9 function key.

Declaration

public ButtonState F9

Field Value

Type	Description
ButtonState

Favorites

The favorite key.

Declaration

public ButtonState Favorites

Field Value

Type	Description
ButtonState

Final

The final symbol key-shift button.

Declaration

public ButtonState Final

Field Value

Type	Description
ButtonState

G

The 'G' key.

Declaration

public ButtonState G

Field Value

Type	Description
ButtonState

GoBack

The go-back key.

Declaration

public ButtonState GoBack

Field Value

Type	Description
ButtonState

GoForward

The go-forward key.

Declaration

public ButtonState GoForward

Field Value

Type	Description
ButtonState

GoHome

The "Go Home" key.

Declaration

public ButtonState GoHome

Field Value

Type	Description
ButtonState

Grave

The grave key.

Declaration

public ButtonState Grave

Field Value

Type	Description
ButtonState

H

The letter "H" key.

Declaration

public ButtonState H

Field Value

Type	Description
ButtonState

Help

The Help key or button.

Declaration

public ButtonState Help

Field Value

Type	Description
ButtonState

Home

The Home key.

Declaration

public ButtonState Home

Field Value

Type	Description
ButtonState

I

The "I" key.

Declaration

public ButtonState I

Field Value

Type	Description
ButtonState

Insert

The Insert key.

Declaration

public ButtonState Insert

Field Value

Type	Description
ButtonState

J

The "J" key.

Declaration

public ButtonState J

Field Value

Type	Description
ButtonState

Junja

The Junja symbol key shift button.

Declaration

public ButtonState Junja

Field Value

Type	Description
ButtonState

K

The "K" key.

Declaration

public ButtonState K

Field Value

Type	Description
ButtonState

Kana

The Kana symbol key shift button.

Declaration

public ButtonState Kana

Field Value

Type	Description
ButtonState

Kanji

The Kanji symbol key shift button.

Declaration

public ButtonState Kanji

Field Value

Type	Description
ButtonState

L

The "L" key.

Declaration

public ButtonState L

Field Value

Type	Description
ButtonState

Left

The Left Arrow key.

Declaration

public ButtonState Left

Field Value

Type	Description
ButtonState

LeftAlt

Represents the left Alt key.

Declaration

public ButtonState LeftAlt

Field Value

Type	Description
ButtonState

LeftControl

The left Ctrl key.

Declaration

public ButtonState LeftControl

Field Value

Type	Description
ButtonState

LeftMenu

The left menu key.

Declaration

public ButtonState LeftMenu

Field Value

Type	Description
ButtonState

LeftShift

The left shift key.

Declaration

public ButtonState LeftShift

Field Value

Type	Description
ButtonState

LeftWindows

The left Windows key.

Declaration

public ButtonState LeftWindows

Field Value

Type	Description
ButtonState

M

The "M" key.

Declaration

public ButtonState M

Field Value

Type	Description
ButtonState

Menu

Represents the menu key or button.

Declaration

public ButtonState Menu

Field Value

Type	Description
ButtonState

ModeChange

The mode-change key.

Declaration

public ButtonState ModeChange

Field Value

Type	Description
ButtonState

Multiply

The multiply (*) operation key located on a numeric keypad.

Declaration

public ButtonState Multiply

Field Value

Type	Description
ButtonState

N

The "N" key.

Declaration

public ButtonState N

Field Value

Type	Description
ButtonState

NavigationAccept

The navigation accept button.

Declaration

public ButtonState NavigationAccept

Field Value

Type	Description
ButtonState

NavigationCancel

The navigation cancel button.

Declaration

public ButtonState NavigationCancel

Field Value

Type	Description
ButtonState

NavigationDown

The navigation down button.

Declaration

public ButtonState NavigationDown

Field Value

Type	Description
ButtonState

NavigationLeft

The left navigation button.

Declaration

public ButtonState NavigationLeft

Field Value

Type	Description
ButtonState

NavigationMenu

The navigation menu button.

Declaration

public ButtonState NavigationMenu

Field Value

Type	Description
ButtonState

NavigationRight

The right navigation button.

Declaration

public ButtonState NavigationRight

Field Value

Type	Description
ButtonState

NavigationUp

The navigation upward button.

Declaration

public ButtonState NavigationUp

Field Value

Type	Description
ButtonState

NavigationView

The navigation upward button.

Declaration

public ButtonState NavigationView

Field Value

Type	Description
ButtonState

NonConvert

The non-convert button or key.

Declaration

public ButtonState NonConvert

Field Value

Type	Description
ButtonState

Number0

The "0" key.

Declaration

public ButtonState Number0

Field Value

Type	Description
ButtonState

Number1

The number "1" key.

Declaration

public ButtonState Number1

Field Value

Type	Description
ButtonState

Number2

The "2" key.

Declaration

public ButtonState Number2

Field Value

Type	Description
ButtonState

Number3

The number "3" key.

Declaration

public ButtonState Number3

Field Value

Type	Description
ButtonState

Number4

The "4" key.

Declaration

public ButtonState Number4

Field Value

Type	Description
ButtonState

Number5

The "5" key.

Declaration

public ButtonState Number5

Field Value

Type	Description
ButtonState

Number6

The "6" key.

Declaration

public ButtonState Number6

Field Value

Type	Description
ButtonState

Number7

The "7" key.

Declaration

public ButtonState Number7

Field Value

Type	Description
ButtonState

Number8

The number "8" key.

Declaration

public ButtonState Number8

Field Value

Type	Description
ButtonState

Number9

The "9" key.

Declaration

public ButtonState Number9

Field Value

Type	Description
ButtonState

NumberKeyLock

The Num Lock key.

Declaration

public ButtonState NumberKeyLock

Field Value

Type	Description
ButtonState

NumberPad0

The "0" key located on a numeric pad.

Declaration

public ButtonState NumberPad0

Field Value

Type	Description
ButtonState

NumberPad1

The number "1" key located on a numeric pad.

Declaration

public ButtonState NumberPad1

Field Value

Type	Description
ButtonState

NumberPad2

The number "2" key as located on a numeric keypad.

Declaration

public ButtonState NumberPad2

Field Value

Type	Description
ButtonState

NumberPad3

The number "3" key as located on a numeric keypad.

Declaration

public ButtonState NumberPad3

Field Value

Type	Description
ButtonState

NumberPad4

The number "4" key located on a numeric pad.

Declaration

public ButtonState NumberPad4

Field Value

Type	Description
ButtonState

NumberPad5

The number "5" key located on a numeric pad.

Declaration

public ButtonState NumberPad5

Field Value

Type	Description
ButtonState

NumberPad6

The number "6" key as located on a numeric keypad.

Declaration

public ButtonState NumberPad6

Field Value

Type	Description
ButtonState

NumberPad7

The number "7" key as located on a numeric keypad.

Declaration

public ButtonState NumberPad7

Field Value

Type	Description
ButtonState

NumberPad8

The number "8" key located on a numeric keypad.

Declaration

public ButtonState NumberPad8

Field Value

Type	Description
ButtonState

NumberPad9

The number "9" key as located on a numeric keypad.

Declaration

public ButtonState NumberPad9

Field Value

Type	Description
ButtonState

O

The letter "O" key.

Declaration

public ButtonState O

Field Value

Type	Description
ButtonState

P

The "P" key.

Declaration

public ButtonState P

Field Value

Type	Description
ButtonState

PageDown

The Page Down key.

Declaration

public ButtonState PageDown

Field Value

Type	Description
ButtonState

PageUp

The Page Up key.

Declaration

public ButtonState PageUp

Field Value

Type	Description
ButtonState

Pause

The Pause key or button.

Declaration

public ButtonState Pause

Field Value

Type	Description
ButtonState

Period

The period key.

Declaration

public ButtonState Period

Field Value

Type	Description
ButtonState

Print

The Print key or button.

Declaration

public ButtonState Print

Field Value

Type	Description
ButtonState

Q

The "Q" key.

Declaration

public ButtonState Q

Field Value

Type	Description
ButtonState

R

The "R" key.

Declaration

public ButtonState R

Field Value

Type	Description
ButtonState

Refresh

The refresh key.

Declaration

public ButtonState Refresh

Field Value

Type	Description
ButtonState

Right

The right arrow key.

Declaration

public ButtonState Right

Field Value

Type	Description
ButtonState

RightAlt

The Right Alt key.

Declaration

public ButtonState RightAlt

Field Value

Type	Description
ButtonState

RightControl

The right Ctrl key.

Declaration

public ButtonState RightControl

Field Value

Type	Description
ButtonState

RightMenu

The right menu key.

Declaration

public ButtonState RightMenu

Field Value

Type	Description
ButtonState

RightShift

The right Shift key.

Declaration

public ButtonState RightShift

Field Value

Type	Description
ButtonState

RightWindows

The right Windows key.

Declaration

public ButtonState RightWindows

Field Value

Type	Description
ButtonState

S

Represents the "S" key.

Declaration

public ButtonState S

Field Value

Type	Description
ButtonState

Scroll

The Scroll Lock (ScrLk) key.

Declaration

public ButtonState Scroll

Field Value

Type	Description
ButtonState

Search

The search key.

Declaration

public ButtonState Search

Field Value

Type	Description
ButtonState

Select

The Select key or button.

Declaration

public ButtonState Select

Field Value

Type	Description
ButtonState

Semicolon

The semicolon key.

Declaration

public ButtonState Semicolon

Field Value

Type	Description
ButtonState

Separator

The separator key located on a numeric pad.

Declaration

public ButtonState Separator

Field Value

Type	Description
ButtonState

Shift

The Shift key. This is the general Shift case, applicable to key layouts with only one Shift key or that do not need to differentiate between left Shift and right Shift keystrokes.

Declaration

public ButtonState Shift

Field Value

Type	Description
ButtonState

Slash

The slash key.

Declaration

public ButtonState Slash

Field Value

Type	Description
ButtonState

Sleep

The Sleep key or button.

Declaration

public ButtonState Sleep

Field Value

Type	Description
ButtonState

Space

The Spacebar key or button.

Declaration

public ButtonState Space

Field Value

Type	Description
ButtonState

Stop

The stop key.

Declaration

public ButtonState Stop

Field Value

Type	Description
ButtonState

Subtract

The subtract (-) operation key located on a numeric keypad.

Declaration

public ButtonState Subtract

Field Value

Type	Description
ButtonState

T

The "T" key.

Declaration

public ButtonState T

Field Value

Type	Description
ButtonState

Tab

The tab key.

Declaration

public ButtonState Tab

Field Value

Type	Description
ButtonState

U

The "U" key.

Declaration

public ButtonState U

Field Value

Type	Description
ButtonState

Underline

The underline key.

Declaration

public ButtonState Underline

Field Value

Type	Description
ButtonState

Up

The Up Arrow key.

Declaration

public ButtonState Up

Field Value

Type	Description
ButtonState

V

The "V" key.

Declaration

public ButtonState V

Field Value

Type	Description
ButtonState

W

The letter "W" key.

Declaration

public ButtonState W

Field Value

Type	Description
ButtonState

X

The "X" key.

Declaration

public ButtonState X

Field Value

Type	Description
ButtonState

Y

The "Y" key.

Declaration

public ButtonState Y

Field Value

Type	Description
ButtonState

Z

The "Z" key.

Declaration

public ButtonState Z

Field Value

Type	Description
ButtonState

Properties

IsConnected

Gets or sets a value indicating whether this instance is connected.

Declaration

public bool IsConnected { readonly get; set; }

Property Value

Type	Description
bool	true if this instance is connected; otherwise, false.

Methods

GetChar(Keys)

Gets the char of a pressed key.

Declaration

public char GetChar(Keys key)

Parameters

Type	Name	Description
Keys	key	The pressed key.

Returns

Type	Description
char	Returns the char.

IsKeyPressed(Keys)

Determines whether the specified key is pressed.

Declaration

public bool IsKeyPressed(Keys key)

Parameters

Type	Name	Description
Keys	key	The key.

Returns

Type	Description
bool	true if the specified key is pressed; false otherwise.

IsKeyReleased(Keys)

Determines whether the specified key is released.

Declaration

public bool IsKeyReleased(Keys key)

Parameters

Type	Name	Description
Keys	key	The key.

Returns

Type	Description
bool	true if the specified key is released; false otherwise.

Implements

IController

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)