Input

Input

Input handles user interaction and events such as keypresses.

Functions

Process Events  {</>}

ProcessEvents allows SplashKit to react to user interactions. This procedure checks the current keyboard and mouse states and should be called once within your game loop to check user interaction. Side Effects - Reads user interaction events - Updates keys down, text input, etc.

Signatures:

C++

void process_events()

C#

public static void SplashKit.ProcessEvents();

Python

def process_events():

Pascal

procedure ProcessEvents()

Usage:  {</>}

See Implementations in Guides

• Using Animations in SplashKit
• Reading Text
• Using Mouse Inputs
• Getting Started Creating User Interfaces
• Get Started with SplashKit GPIO
• Reading Button Presses
• Modify PWM through button presses

---

Quit Requested  {</>}

Checks to see if the user has asked for the application to quit. This value is updated by the Process Events routine. Also see window_close_requested.

Return Type: Boolean

Signatures:

C++

bool quit_requested()

C#

public static bool SplashKit.QuitRequested();

Python

def quit_requested():

Pascal

function QuitRequested(): Boolean

Usage:  {</>}

See Implementations in Guides

• Reading Text

---

Reset Quit

Cancels a quit request, ensuring the quit requested will return false.

Signatures:

C++

void reset_quit()

C#

public static void SplashKit.ResetQuit();

Python

def reset_quit():

Pascal

procedure ResetQuit()

---

Any Key Pressed  {</>}

Checks to see if any key has been pressed since the last time Process Events was called.

Return Type: Boolean

Signatures:

C++

bool any_key_pressed()

C#

public static bool SplashKit.AnyKeyPressed();

Python

def any_key_pressed():

Pascal

function AnyKeyPressed(): Boolean

Usage:  {</>}

See Implementations in Guides

• Get Started with SplashKit GPIO
• Reading Button Presses
• Modify PWM through button presses

---

Deregister Callback On Key Down

Remove the registered callback from receiving events related to key down actions.

Parameters:

Name	Type	Description
callback	Key Callback	The function to from from key down events

Signatures:

C++

void deregister_callback_on_key_down(key_callback *callback)

C#

public static void SplashKit.DeregisterCallbackOnKeyDown(KeyCallback callback);

Python

def deregister_callback_on_key_down(callback):

Pascal

procedure DeregisterCallbackOnKeyDown(callback: KeyCallback)

---

Deregister Callback On Key Typed

Remove the registered callback from receiving events related to key typed actions.

Parameters:

Name	Type	Description
callback	Key Callback	The function to from from key typed events

Signatures:

C++

void deregister_callback_on_key_typed(key_callback *callback)

C#

public static void SplashKit.DeregisterCallbackOnKeyTyped(KeyCallback callback);

Python

def deregister_callback_on_key_typed(callback):

Pascal

procedure DeregisterCallbackOnKeyTyped(callback: KeyCallback)

---

Deregister Callback On Key Up

Remove the registered callback from receiving events related to key up actions.

Parameters:

Name	Type	Description
callback	Key Callback	The function to from from key up events

Signatures:

C++

void deregister_callback_on_key_up(key_callback *callback)

C#

public static void SplashKit.DeregisterCallbackOnKeyUp(KeyCallback callback);

Python

def deregister_callback_on_key_up(callback):

Pascal

procedure DeregisterCallbackOnKeyUp(callback: KeyCallback)

---

Key Down  {</>}

Returns true when the key requested is being held down. This is updated as part of the Process Events call. Use the key codes from Key Code to specify the key to be checked.

Parameters:

Name	Type	Description
key	Key Code	The key to check if it is down

Return Type: Boolean

Signatures:

C++

bool key_down(key_code key)

C#

public static bool SplashKit.KeyDown(KeyCode key);

Python

def key_down(key):

Pascal

function KeyDown(key: KeyCode): Boolean

Usage:  {</>}

See Implementations in Guides

• Using Animations in SplashKit
• SplashKit Camera

---

Key Name

The Key Name function returns a string name for a given Key Code. For example, COMMA_KEY returns the string ‘Comma’. This function could be used to display more meaningful key names for configuring game controls, etc.

Parameters:

Name	Type	Description
key	Key Code	The key to get the name of

Return Type: String

Signatures:

C++

string key_name(key_code key)

C#

public static string SplashKit.KeyName(KeyCode key);

Python

def key_name(key):

Pascal

function KeyName(key: KeyCode): String

---

Key Released

Returns true if the specified key was released since the last time Process Events was called. This occurs only once for the key that is released and will not return true again until the key is pressed down and released again.

Parameters:

Name	Type	Description
key	Key Code	The key to check if it was released

Return Type: Boolean

Signatures:

C++

bool key_released(key_code key)

C#

public static bool SplashKit.KeyReleased(KeyCode key);

Python

def key_released(key):

Pascal

function KeyReleased(key: KeyCode): Boolean

---

Key Typed  {</>}

Returns true when the key requested is just pressed down. This is updated as part of the Process Events call. Use the key codes from Key Code to specify the key to be checked. this will only occur once for that key that is pressed and will not return true again until the key is released and presssed down again

Parameters:

Name	Type	Description
key	Key Code	The key to check if it was typed

Return Type: Boolean

Signatures:

C++

bool key_typed(key_code key)

C#

public static bool SplashKit.KeyTyped(KeyCode key);

Python

def key_typed(key):

Pascal

function KeyTyped(key: KeyCode): Boolean

Usage:  {</>}

See Implementations in Guides

• Using Animations in SplashKit
• Get Started with SplashKit Audio

---

Key Up

Returns false when the key requested is being held down. This is updated as part of the Process Events call. Use the key codes from Key Code to specify the key to be checked.

Parameters:

Name	Type	Description
key	Key Code	The key to check if it is up

Return Type: Boolean

Signatures:

C++

bool key_up(key_code key)

C#

public static bool SplashKit.KeyUp(KeyCode key);

Python

def key_up(key):

Pascal

function KeyUp(key: KeyCode): Boolean

---

Register Callback On Key Down

Register the passed in callback function to receive notification of key down calls. This will be called in response to Process Events, for each key that the user presses down.

Parameters:

Name	Type	Description
callback	Key Callback	The function to be called when a key is first pressed

Signatures:

C++

void register_callback_on_key_down(key_callback *callback)

C#

public static void SplashKit.RegisterCallbackOnKeyDown(KeyCallback callback);

Python

def register_callback_on_key_down(callback):

Pascal

procedure RegisterCallbackOnKeyDown(callback: KeyCallback)

---

Register Callback On Key Typed

Register the passed in callback function to receive notification of key typed calls. This will be called in response to Process Events, when the user initially presses a key down.

Parameters:

Name	Type	Description
callback	Key Callback	The function to be called when a key is typed

Signatures:

C++

void register_callback_on_key_typed(key_callback *callback)

C#

public static void SplashKit.RegisterCallbackOnKeyTyped(KeyCallback callback);

Python

def register_callback_on_key_typed(callback):

Pascal

procedure RegisterCallbackOnKeyTyped(callback: KeyCallback)

---

Register Callback On Key Up

Register the passed in callback function to receive notification of key up calls. This will be called in response to Process Events, for each key that the user releases.

Parameters:

Name	Type	Description
callback	Key Callback	The function to be called when a key is released

Signatures:

C++

void register_callback_on_key_up(key_callback *callback)

C#

public static void SplashKit.RegisterCallbackOnKeyUp(KeyCallback callback);

Python

def register_callback_on_key_up(callback):

Pascal

procedure RegisterCallbackOnKeyUp(callback: KeyCallback)

---

Hide Mouse

Tells the mouse cursor to hide (no longer visible) if it is currently showing. Use ShowMouse to make the mouse cursor visible again.

Signatures:

C++

void hide_mouse()

C#

public static void SplashKit.HideMouse();

Python

def hide_mouse():

Pascal

procedure HideMouse()

---

Mouse Clicked  {</>}

Returns true if the specified button was clicked since the last time Process Events was called.

Parameters:

Name	Type	Description
button	Mouse Button	The mouse button to check

Return Type: Boolean

Signatures:

C++

bool mouse_clicked(mouse_button button)

C#

public static bool SplashKit.MouseClicked(MouseButton button);

Python

def mouse_clicked(button):

Pascal

function MouseClicked(button: MouseButton): Boolean

Usage:  {</>}

See Implementations in Guides

• Reading Text
• Using Mouse Inputs

---

Mouse Down  {</>}

Returns true if the specified button is currently pressed down.

Parameters:

Name	Type	Description
button	Mouse Button	The mouse button to check

Return Type: Boolean

Signatures:

C++

bool mouse_down(mouse_button button)

C#

public static bool SplashKit.MouseDown(MouseButton button);

Python

def mouse_down(button):

Pascal

function MouseDown(button: MouseButton): Boolean

Usage:  {</>}

See Implementations in Guides

• Using Mouse Inputs

---

Mouse Movement  {</>}

Returns the amount of accumulated mouse movement, since the last time Process Events was called, as a Vector 2d.

Return Type: Vector 2d

Signatures:

C++

vector_2d mouse_movement()

C#

public static Vector2D SplashKit.MouseMovement();

Python

def mouse_movement():

Pascal

function MouseMovement(): Vector2D

Usage:  {</>}

See Implementations in Guides

• Using Mouse Inputs

---

Mouse Position

Returns the current window position of the mouse as a Point2D

Return Type: Point 2d

Signatures:

C++

point_2d mouse_position()

C#

public static Point2D SplashKit.MousePosition();

Python

def mouse_position():

Pascal

function MousePosition(): Point2D

---

Mouse Position Vector

Returns The current window position of the mouse as a Vector

Return Type: Vector 2d

Signatures:

C++

vector_2d mouse_position_vector()

C#

public static Vector2D SplashKit.MousePositionVector();

Python

def mouse_position_vector():

Pascal

function MousePositionVector(): Vector2D

---

Mouse Shown

Returns true if the mouse is currently visible, false if not.

Return Type: Boolean

Signatures:

C++

bool mouse_shown()

C#

public static bool SplashKit.MouseShown();

Python

def mouse_shown():

Pascal

function MouseShown(): Boolean

---

Mouse Up  {</>}

Returns true if the specified button is currently up.

Parameters:

Name	Type	Description
button	Mouse Button	The mouse button to check

Return Type: Boolean

Signatures:

C++

bool mouse_up(mouse_button button)

C#

public static bool SplashKit.MouseUp(MouseButton button);

Python

def mouse_up(button):

Pascal

function MouseUp(button: MouseButton): Boolean

Usage:  {</>}

See Implementations in Guides

• Using Mouse Inputs

---

Mouse Wheel Scroll

Returns the amount the mouse wheel was scrolled since the last call to Process Events. The result is a vector containing the x and y amounts scrolled. Scroll left generates a negative x, scroll right a positive x. Scroll backward is negative y, scroll forward positive y. Note that on MacOS the directions may be inverted by OS settings.

Return Type: Vector 2d

Signatures:

C++

vector_2d mouse_wheel_scroll()

C#

public static Vector2D SplashKit.MouseWheelScroll();

Python

def mouse_wheel_scroll():

Pascal

function MouseWheelScroll(): Vector2D

---

Mouse X

Returns the current x value of the mouse’s position.

Return Type: Float

Signatures:

C++

float mouse_x()

C#

public static float SplashKit.MouseX();

Python

def mouse_x():

Pascal

function MouseX(): Single

---

Mouse Y

Returns the current y value of the mouse’s position.

Return Type: Float

Signatures:

C++

float mouse_y()

C#

public static float SplashKit.MouseY();

Python

def mouse_y():

Pascal

function MouseY(): Single

---

Move Mouse

Note

This function is overloaded. The following versions exist:

• Move Mouse (x: double, y: double)
• Move Mouse (point: point_2d)

Move Mouse

Moves the mouse cursor to the specified screen location.

Parameters:

Name	Type	Description
x	Double	The new x location of the mouse
y	Double	The new y location of the mouse

Signatures:

C++

void move_mouse(double x, double y)

C#

public static void SplashKit.MoveMouse(double x, double y);

Python

def move_mouse(x, y):

Pascal

procedure MoveMouse(x: Double; y: Double)

---

Move Mouse

Moves the mouse cursor to the specified screen location.

Parameters:

Name	Type	Description
point	Point 2d	The new location of the mouse

Signatures:

C++

void move_mouse(point_2d point)

C#

public static void SplashKit.MoveMouse(Point2D point);

Python

def move_mouse_to_point(point):

Pascal

procedure MoveMouse(point: Point2D)

---

Show Mouse

Note

This function is overloaded. The following versions exist:

• Show Mouse ()
• Show Mouse (show: bool)

Show Mouse

Tells the mouse cursor to be visible if it was previously hidden with by a HideMouse or SetMouseVisible(False) call.

Signatures:

C++

void show_mouse()

C#

public static void SplashKit.ShowMouse();

Python

def show_mouse():

Pascal

procedure ShowMouse()

---

Show Mouse

Used to explicitly set the mouse cursors visible state (if it is showing in the window or not) based on the show parameter.

Parameters:

Name	Type	Description
show	Boolean	When true the mouse is shown, when false it is hidden

Signatures:

C++

void show_mouse(bool show)

C#

public static void SplashKit.ShowMouse(bool show);

Python

def show_mouse_with_boolean(show):

Pascal

procedure ShowMouse(show: Boolean)

---

Draw Collected Text  {</>}

Draw the text that the user is currently enterring on the current window.

Parameters:

Name	Type	Description
clr	Color	The color for the text
fnt	Font	The font to use
font_size	Integer	The size of the font
opts	Drawing Options	Any drawing options

Signatures:

C++

void draw_collected_text(color clr, font fnt, int font_size, const drawing_options &opts)

C#

public static void SplashKit.DrawCollectedText(Color clr, Font fnt, int fontSize, DrawingOptions opts);

Python

def draw_collected_text(clr, fnt, font_size, opts):

Pascal

procedure DrawCollectedText(clr: Color; fnt: Font; fontSize: Integer; const opts: DrawingOptions)

Usage:  {</>}

See Implementations in Guides

• Reading Text

---

End Reading Text

Note

This function is overloaded. The following versions exist:

• End Reading Text ()
• End Reading Text (wind: window)

End Reading Text

Ends reading text in for the current window.

Signatures:

C++

void end_reading_text()

C#

public static void SplashKit.EndReadingText();

Python

def end_reading_text():

Pascal

procedure EndReadingText()

---

End Reading Text

Ends reading text for the passed in window.

Parameters:

Name	Type	Description
wind	Window	The window to end reading text

Signatures:

C++

void end_reading_text(window wind)

C#

public static void SplashKit.EndReadingText(Window wind);

Python

def end_reading_text_in_window(wind):

Pascal

procedure EndReadingText(wind: Window)

---

Reading Text  {</>}

Note

This function is overloaded. The following versions exist:

• Reading Text ()  {</>}
• Reading Text (wind: window)

Reading Text  {</>}

Returns true when the current window is reading text.

Return Type: Boolean

Signatures:

C++

bool reading_text()

C#

public static bool SplashKit.ReadingText();

Python

def reading_text():

Pascal

function ReadingText(): Boolean

Usage:  {</>}

See Implementations in Guides

• Reading Text

---

Reading Text

Returns true when the window is reading text.

Parameters:

Name	Type	Description
wind	Window	The window to check

Return Type: Boolean

Signatures:

C++

bool reading_text(window wind)

C#

public static bool SplashKit.ReadingText(Window wind);

Python

def reading_text_in_window(wind):

Pascal

function ReadingText(wind: Window): Boolean

---

Start Reading Text  {</>}

Note

This function is overloaded. The following versions exist:

• Start Reading Text (rect: rectangle)  {</>}
• Start Reading Text (rect: rectangle, initial_text: string)
• Start Reading Text (wind: window, rect: rectangle)
• Start Reading Text (wind: window, rect: rectangle, initial_text: string)

Start Reading Text  {</>}

Start reading text in the current window within the bounds of the supplied rectangle.

Parameters:

Name	Type	Description
rect	Rectangle	The area where the text will be entered.

Signatures:

C++

void start_reading_text(rectangle rect)

C#

public static void SplashKit.StartReadingText(Rectangle rect);

Python

def start_reading_text(rect):

Pascal

procedure StartReadingText(rect: Rectangle)

Usage:  {</>}

See Implementations in Guides

• Reading Text
• Reading Text

---

Start Reading Text

Start reading text in the current window within the bounds of the supplied rectangle. The text will start with an initial value.

Parameters:

Name	Type	Description
rect	Rectangle	The area where the text will be entered.
initial_text	String	The initial text, which may be edited by the user.

Signatures:

C++

void start_reading_text(rectangle rect, string initial_text)

C#

public static void SplashKit.StartReadingText(Rectangle rect, string initialText);

Python

def start_reading_text_with_initial_text(rect, initial_text):

Pascal

procedure StartReadingText(rect: Rectangle; initialText: String)

---

Start Reading Text

Start reading text in the window within the bounds of the supplied rectangle.

Parameters:

Name	Type	Description
wind	Window	The window where the text will be entered
rect	Rectangle	The area where the text will be entered.

Signatures:

C++

void start_reading_text(window wind, rectangle rect)

C#

public static void SplashKit.StartReadingText(Window wind, Rectangle rect);

Python

def start_reading_text_in_window(wind, rect):

Pascal

procedure StartReadingText(wind: Window; rect: Rectangle)

---

Start Reading Text

Start reading text in the window within the bounds of the supplied rectangle. The text will start with an initial value.

Parameters:

Name	Type	Description
wind	Window	The window where the text will be entered
rect	Rectangle	The area where the text will be entered.
initial_text	String	The initial text, which may be edited by the user.

Signatures:

C++

void start_reading_text(window wind, rectangle rect, string initial_text)

C#

public static void SplashKit.StartReadingText(Window wind, Rectangle rect, string initialText);

Python

def start_reading_text_in_window_with_initial_text(wind, rect, initial_text):

Pascal

procedure StartReadingText(wind: Window; rect: Rectangle; initialText: String)

---

Text Entry Cancelled  {</>}

Note

This function is overloaded. The following versions exist:

• Text Entry Cancelled ()  {</>}
• Text Entry Cancelled (wind: window)

Text Entry Cancelled  {</>}

Did the user press escape and cancel the enterring of text?

Return Type: Boolean

Signatures:

C++

bool text_entry_cancelled()

C#

public static bool SplashKit.TextEntryCancelled();

Python

def text_entry_cancelled():

Pascal

function TextEntryCancelled(): Boolean

Usage:  {</>}

See Implementations in Guides

• Reading Text

---

Text Entry Cancelled

Did the user press escape and cancel the enterring of text?

Parameters:

Name	Type	Description
wind	Window	The window to check

Return Type: Boolean

Signatures:

C++

bool text_entry_cancelled(window wind)

C#

public static bool SplashKit.TextEntryCancelled(Window wind);

Python

def text_entry_cancelled_in_window(wind):

Pascal

function TextEntryCancelled(wind: Window): Boolean

---

Text Input  {</>}

Note

This function is overloaded. The following versions exist:

• Text Input ()  {</>}
• Text Input (wind: window)

Text Input  {</>}

The text the user has currently enterred on the current window.

Return Type: String

Signatures:

C++

string text_input()

C#

public static string SplashKit.TextInput();

Python

def text_input():

Pascal

function TextInput(): String

Usage:  {</>}

See Implementations in Guides

• Reading Text

---

Text Input

The text the user has currently enterred on the current window.

Parameters:

Name	Type	Description
wind	Window	The window to check

Return Type: String

Signatures:

C++

string text_input(window wind)

C#

public static string SplashKit.TextInput(Window wind);

Python

def text_input_in_window(wind):

Pascal

function TextInput(wind: Window): String

---

Types

Key Callback

The Key Callback is a function pointer used to register your code with SplashKit or keyboard related events. See Register Callback On Key Down, Register Callback On Key Up, and Register Callback On Key Typed

---

Key Code

These are the key codes you can use to check details of keyboard actions. See Key Down, Key Up, Key Typed, and Key Released functions. You can get a string representation of these keys using Key Name.

C++

Constant	Description
UNKNOWN_KEY	The unknown key
BACKSPACE_KEY	The backspace key
TAB_KEY	The tab key
CLEAR_KEY	The clear key
RETURN_KEY	The return key
PAUSE_KEY	The pause key
ESCAPE_KEY	The escape key
SPACE_KEY	The space key
EXCLAIM_KEY	The exclaim key
DOUBLE_QUOTE_KEY	The double quote key
HASH_KEY	The hash key
DOLLAR_KEY	The dollar key
AMPERSAND_KEY	The ampersand key
QUOTE_KEY	The quote key
LEFT_PAREN_KEY	The left paren key
RIGHT_PAREN_KEY	The right paren key
ASTERISK_KEY	The asterisk key
PLUS_KEY	The plus key
COMMA_KEY	The comma key
MINUS_KEY	The minus key
PERIOD_KEY	The period key
SLASH_KEY	The slash key
NUM_0_KEY	The num 0 key
NUM_1_KEY	The num 1 key
NUM_2_KEY	The num 2 key
NUM_3_KEY	The num 3 key
NUM_4_KEY	The num 4 key
NUM_5_KEY	The num 5 key
NUM_6_KEY	The num 6 key
NUM_7_KEY	The num 7 key
NUM_8_KEY	The num 8 key
NUM_9_KEY	The num 9 key
COLON_KEY	The colon key
SEMI_COLON_KEY	The semi colon key
LESS_KEY	The less key
EQUALS_KEY	The equals key
GREATER_KEY	The greater key
QUESTION_KEY	The question key
AT_KEY	The at key
LEFT_BRACKET_KEY	The left bracket key
BACKSLASH_KEY	The backslash () key
RIGHT_BRACKET_KEY	The right bracket key
CARET_KEY	The caret (^) key
UNDERSCORE_KEY	The underscore (_) key
BACKQUOTE_KEY	The backquote (`) key
A_KEY	The a key
B_KEY	The b key
C_KEY	The c key
D_KEY	The d key
E_KEY	The e key
F_KEY	The f key
G_KEY	The g key
H_KEY	The h key
I_KEY	The i key
J_KEY	The j key
K_KEY	The k key
L_KEY	The l key
M_KEY	The m key
N_KEY	The n key
O_KEY	The o key
P_KEY	The p key
Q_KEY	The q key
R_KEY	The r key
S_KEY	The s key
T_KEY	The t key
U_KEY	The u key
V_KEY	The v key
W_KEY	The w key
X_KEY	The x key
Y_KEY	The y key
Z_KEY	The z key
DELETE_KEY	The delete key
KEYPAD_0	The keypad 0 key
KEYPAD_1	The keypad 1 key
KEYPAD_2	The keypad 2 key
KEYPAD_3	The keypad 3 key
KEYPAD_4	The keypad 4 key
KEYPAD_5	The keypad 5 key
KEYPAD_6	The keypad 6 key
KEYPAD_7	The keypad 7 key
KEYPAD_8	The keypad 8 key
KEYPAD_9	The keypad 9 key
KEYPAD_PERIOD	The keypad period key
KEYPAD_DIVIDE	The keypad divide key
KEYPAD_MULTIPLY	The keypad multiply key
KEYPAD_MINUS	The keypad minus key
KEYPAD_PLUS	The keypad plus key
KEYPAD_ENTER	The keypad enter key
KEYPAD_EQUALS	The keypad equals key
UP_KEY	The up key
DOWN_KEY	The down key
RIGHT_KEY	The right key
LEFT_KEY	The left key
INSERT_KEY	The insert key
HOME_KEY	The home key
END_KEY	The end key
PAGE_UP_KEY	The page up key
PAGE_DOWN_KEY	The page down key
F1_KEY	The f1 key
F2_KEY	The f2 key
F3_KEY	The f3 key
F4_KEY	The f4 key
F5_KEY	The f5 key
F6_KEY	The f6 key
F7_KEY	The f7 key
F8_KEY	The f8 key
F9_KEY	The f9 key
F10_KEY	The f10 key
F11_KEY	The f11 key
F12_KEY	The f12 key
F13_KEY	The f13 key
F14_KEY	The f14 key
F15_KEY	The f15 key
NUM_LOCK_KEY	The num lock key
CAPS_LOCK_KEY	The caps lock key
SCROLL_LOCK_KEY	The scroll lock key
RIGHT_SHIFT_KEY	The right shift key
LEFT_SHIFT_KEY	The left shift key
RIGHT_CTRL_KEY	The right ctrl key
LEFT_CTRL_KEY	The left ctrl key
RIGHT_ALT_KEY	The right alt or option key
LEFT_ALT_KEY	The left alt or option key
LEFT_SUPER_KEY	The left super (windows or command) key
RIGHT_SUPER_KEY	The right super (windows or command) key
MODE_KEY	The mode key
HELP_KEY	The help key
SYS_REQ_KEY	The sys req key
MENU_KEY	The menu key
POWER_KEY	The power key

C#

Constant	Description
KeyCode.UnknownKey	The unknown key
KeyCode.BackspaceKey	The backspace key
KeyCode.TabKey	The tab key
KeyCode.ClearKey	The clear key
KeyCode.ReturnKey	The return key
KeyCode.PauseKey	The pause key
KeyCode.EscapeKey	The escape key
KeyCode.SpaceKey	The space key
KeyCode.ExclaimKey	The exclaim key
KeyCode.DoubleQuoteKey	The double quote key
KeyCode.HashKey	The hash key
KeyCode.DollarKey	The dollar key
KeyCode.AmpersandKey	The ampersand key
KeyCode.QuoteKey	The quote key
KeyCode.LeftParenKey	The left paren key
KeyCode.RightParenKey	The right paren key
KeyCode.AsteriskKey	The asterisk key
KeyCode.PlusKey	The plus key
KeyCode.CommaKey	The comma key
KeyCode.MinusKey	The minus key
KeyCode.PeriodKey	The period key
KeyCode.SlashKey	The slash key
KeyCode.Num0Key	The num 0 key
KeyCode.Num1Key	The num 1 key
KeyCode.Num2Key	The num 2 key
KeyCode.Num3Key	The num 3 key
KeyCode.Num4Key	The num 4 key
KeyCode.Num5Key	The num 5 key
KeyCode.Num6Key	The num 6 key
KeyCode.Num7Key	The num 7 key
KeyCode.Num8Key	The num 8 key
KeyCode.Num9Key	The num 9 key
KeyCode.ColonKey	The colon key
KeyCode.SemiColonKey	The semi colon key
KeyCode.LessKey	The less key
KeyCode.EqualsKey	The equals key
KeyCode.GreaterKey	The greater key
KeyCode.QuestionKey	The question key
KeyCode.AtKey	The at key
KeyCode.LeftBracketKey	The left bracket key
KeyCode.BackslashKey	The backslash () key
KeyCode.RightBracketKey	The right bracket key
KeyCode.CaretKey	The caret (^) key
KeyCode.UnderscoreKey	The underscore (_) key
KeyCode.BackquoteKey	The backquote (`) key
KeyCode.AKey	The a key
KeyCode.BKey	The b key
KeyCode.CKey	The c key
KeyCode.DKey	The d key
KeyCode.EKey	The e key
KeyCode.FKey	The f key
KeyCode.GKey	The g key
KeyCode.HKey	The h key
KeyCode.IKey	The i key
KeyCode.JKey	The j key
KeyCode.KKey	The k key
KeyCode.LKey	The l key
KeyCode.MKey	The m key
KeyCode.NKey	The n key
KeyCode.OKey	The o key
KeyCode.PKey	The p key
KeyCode.QKey	The q key
KeyCode.RKey	The r key
KeyCode.SKey	The s key
KeyCode.TKey	The t key
KeyCode.UKey	The u key
KeyCode.VKey	The v key
KeyCode.WKey	The w key
KeyCode.XKey	The x key
KeyCode.YKey	The y key
KeyCode.ZKey	The z key
KeyCode.DeleteKey	The delete key
KeyCode.Keypad0	The keypad 0 key
KeyCode.Keypad1	The keypad 1 key
KeyCode.Keypad2	The keypad 2 key
KeyCode.Keypad3	The keypad 3 key
KeyCode.Keypad4	The keypad 4 key
KeyCode.Keypad5	The keypad 5 key
KeyCode.Keypad6	The keypad 6 key
KeyCode.Keypad7	The keypad 7 key
KeyCode.Keypad8	The keypad 8 key
KeyCode.Keypad9	The keypad 9 key
KeyCode.KeypadPeriod	The keypad period key
KeyCode.KeypadDivide	The keypad divide key
KeyCode.KeypadMultiply	The keypad multiply key
KeyCode.KeypadMinus	The keypad minus key
KeyCode.KeypadPlus	The keypad plus key
KeyCode.KeypadEnter	The keypad enter key
KeyCode.KeypadEquals	The keypad equals key
KeyCode.UpKey	The up key
KeyCode.DownKey	The down key
KeyCode.RightKey	The right key
KeyCode.LeftKey	The left key
KeyCode.InsertKey	The insert key
KeyCode.HomeKey	The home key
KeyCode.EndKey	The end key
KeyCode.PageUpKey	The page up key
KeyCode.PageDownKey	The page down key
KeyCode.F1Key	The f1 key
KeyCode.F2Key	The f2 key
KeyCode.F3Key	The f3 key
KeyCode.F4Key	The f4 key
KeyCode.F5Key	The f5 key
KeyCode.F6Key	The f6 key
KeyCode.F7Key	The f7 key
KeyCode.F8Key	The f8 key
KeyCode.F9Key	The f9 key
KeyCode.F10Key	The f10 key
KeyCode.F11Key	The f11 key
KeyCode.F12Key	The f12 key
KeyCode.F13Key	The f13 key
KeyCode.F14Key	The f14 key
KeyCode.F15Key	The f15 key
KeyCode.NumLockKey	The num lock key
KeyCode.CapsLockKey	The caps lock key
KeyCode.ScrollLockKey	The scroll lock key
KeyCode.RightShiftKey	The right shift key
KeyCode.LeftShiftKey	The left shift key
KeyCode.RightCtrlKey	The right ctrl key
KeyCode.LeftCtrlKey	The left ctrl key
KeyCode.RightAltKey	The right alt or option key
KeyCode.LeftAltKey	The left alt or option key
KeyCode.LeftSuperKey	The left super (windows or command) key
KeyCode.RightSuperKey	The right super (windows or command) key
KeyCode.ModeKey	The mode key
KeyCode.HelpKey	The help key
KeyCode.SysReqKey	The sys req key
KeyCode.MenuKey	The menu key
KeyCode.PowerKey	The power key

Python

Constant	Description
KeyCode.unknown_key	The unknown key
KeyCode.backspace_key	The backspace key
KeyCode.tab_key	The tab key
KeyCode.clear_key	The clear key
KeyCode.return_key	The return key
KeyCode.pause_key	The pause key
KeyCode.escape_key	The escape key
KeyCode.space_key	The space key
KeyCode.exclaim_key	The exclaim key
KeyCode.double_quote_key	The double quote key
KeyCode.hash_key	The hash key
KeyCode.dollar_key	The dollar key
KeyCode.ampersand_key	The ampersand key
KeyCode.quote_key	The quote key
KeyCode.left_paren_key	The left paren key
KeyCode.right_paren_key	The right paren key
KeyCode.asterisk_key	The asterisk key
KeyCode.plus_key	The plus key
KeyCode.comma_key	The comma key
KeyCode.minus_key	The minus key
KeyCode.period_key	The period key
KeyCode.slash_key	The slash key
KeyCode.num_0_key	The num 0 key
KeyCode.num_1_key	The num 1 key
KeyCode.num_2_key	The num 2 key
KeyCode.num_3_key	The num 3 key
KeyCode.num_4_key	The num 4 key
KeyCode.num_5_key	The num 5 key
KeyCode.num_6_key	The num 6 key
KeyCode.num_7_key	The num 7 key
KeyCode.num_8_key	The num 8 key
KeyCode.num_9_key	The num 9 key
KeyCode.colon_key	The colon key
KeyCode.semi_colon_key	The semi colon key
KeyCode.less_key	The less key
KeyCode.equals_key	The equals key
KeyCode.greater_key	The greater key
KeyCode.question_key	The question key
KeyCode.at_key	The at key
KeyCode.left_bracket_key	The left bracket key
KeyCode.backslash_key	The backslash () key
KeyCode.right_bracket_key	The right bracket key
KeyCode.caret_key	The caret (^) key
KeyCode.underscore_key	The underscore (_) key
KeyCode.backquote_key	The backquote (`) key
KeyCode.a_key	The a key
KeyCode.b_key	The b key
KeyCode.c_key	The c key
KeyCode.d_key	The d key
KeyCode.e_key	The e key
KeyCode.f_key	The f key
KeyCode.g_key	The g key
KeyCode.h_key	The h key
KeyCode.i_key	The i key
KeyCode.j_key	The j key
KeyCode.k_key	The k key
KeyCode.l_key	The l key
KeyCode.m_key	The m key
KeyCode.n_key	The n key
KeyCode.o_key	The o key
KeyCode.p_key	The p key
KeyCode.q_key	The q key
KeyCode.r_key	The r key
KeyCode.s_key	The s key
KeyCode.t_key	The t key
KeyCode.u_key	The u key
KeyCode.v_key	The v key
KeyCode.w_key	The w key
KeyCode.x_key	The x key
KeyCode.y_key	The y key
KeyCode.z_key	The z key
KeyCode.delete_key	The delete key
KeyCode.keypad_0	The keypad 0 key
KeyCode.keypad_1	The keypad 1 key
KeyCode.keypad_2	The keypad 2 key
KeyCode.keypad_3	The keypad 3 key
KeyCode.keypad_4	The keypad 4 key
KeyCode.keypad_5	The keypad 5 key
KeyCode.keypad_6	The keypad 6 key
KeyCode.keypad_7	The keypad 7 key
KeyCode.keypad_8	The keypad 8 key
KeyCode.keypad_9	The keypad 9 key
KeyCode.keypad_period	The keypad period key
KeyCode.keypad_divide	The keypad divide key
KeyCode.keypad_multiply	The keypad multiply key
KeyCode.keypad_minus	The keypad minus key
KeyCode.keypad_plus	The keypad plus key
KeyCode.keypad_enter	The keypad enter key
KeyCode.keypad_equals	The keypad equals key
KeyCode.up_key	The up key
KeyCode.down_key	The down key
KeyCode.right_key	The right key
KeyCode.left_key	The left key
KeyCode.insert_key	The insert key
KeyCode.home_key	The home key
KeyCode.end_key	The end key
KeyCode.page_up_key	The page up key
KeyCode.page_down_key	The page down key
KeyCode.f1_key	The f1 key
KeyCode.f2_key	The f2 key
KeyCode.f3_key	The f3 key
KeyCode.f4_key	The f4 key
KeyCode.f5_key	The f5 key
KeyCode.f6_key	The f6 key
KeyCode.f7_key	The f7 key
KeyCode.f8_key	The f8 key
KeyCode.f9_key	The f9 key
KeyCode.f10_key	The f10 key
KeyCode.f11_key	The f11 key
KeyCode.f12_key	The f12 key
KeyCode.f13_key	The f13 key
KeyCode.f14_key	The f14 key
KeyCode.f15_key	The f15 key
KeyCode.num_lock_key	The num lock key
KeyCode.caps_lock_key	The caps lock key
KeyCode.scroll_lock_key	The scroll lock key
KeyCode.right_shift_key	The right shift key
KeyCode.left_shift_key	The left shift key
KeyCode.right_ctrl_key	The right ctrl key
KeyCode.left_ctrl_key	The left ctrl key
KeyCode.right_alt_key	The right alt or option key
KeyCode.left_alt_key	The left alt or option key
KeyCode.left_super_key	The left super (windows or command) key
KeyCode.right_super_key	The right super (windows or command) key
KeyCode.mode_key	The mode key
KeyCode.help_key	The help key
KeyCode.sys_req_key	The sys req key
KeyCode.menu_key	The menu key
KeyCode.power_key	The power key

Pascal

Constant	Description
KeyCode.UnknownKey	The unknown key
KeyCode.BackspaceKey	The backspace key
KeyCode.TabKey	The tab key
KeyCode.ClearKey	The clear key
KeyCode.ReturnKey	The return key
KeyCode.PauseKey	The pause key
KeyCode.EscapeKey	The escape key
KeyCode.SpaceKey	The space key
KeyCode.ExclaimKey	The exclaim key
KeyCode.DoubleQuoteKey	The double quote key
KeyCode.HashKey	The hash key
KeyCode.DollarKey	The dollar key
KeyCode.AmpersandKey	The ampersand key
KeyCode.QuoteKey	The quote key
KeyCode.LeftParenKey	The left paren key
KeyCode.RightParenKey	The right paren key
KeyCode.AsteriskKey	The asterisk key
KeyCode.PlusKey	The plus key
KeyCode.CommaKey	The comma key
KeyCode.MinusKey	The minus key
KeyCode.PeriodKey	The period key
KeyCode.SlashKey	The slash key
KeyCode.Num0Key	The num 0 key
KeyCode.Num1Key	The num 1 key
KeyCode.Num2Key	The num 2 key
KeyCode.Num3Key	The num 3 key
KeyCode.Num4Key	The num 4 key
KeyCode.Num5Key	The num 5 key
KeyCode.Num6Key	The num 6 key
KeyCode.Num7Key	The num 7 key
KeyCode.Num8Key	The num 8 key
KeyCode.Num9Key	The num 9 key
KeyCode.ColonKey	The colon key
KeyCode.SemiColonKey	The semi colon key
KeyCode.LessKey	The less key
KeyCode.EqualsKey	The equals key
KeyCode.GreaterKey	The greater key
KeyCode.QuestionKey	The question key
KeyCode.AtKey	The at key
KeyCode.LeftBracketKey	The left bracket key
KeyCode.BackslashKey	The backslash () key
KeyCode.RightBracketKey	The right bracket key
KeyCode.CaretKey	The caret (^) key
KeyCode.UnderscoreKey	The underscore (_) key
KeyCode.BackquoteKey	The backquote (`) key
KeyCode.AKey	The a key
KeyCode.BKey	The b key
KeyCode.CKey	The c key
KeyCode.DKey	The d key
KeyCode.EKey	The e key
KeyCode.FKey	The f key
KeyCode.GKey	The g key
KeyCode.HKey	The h key
KeyCode.IKey	The i key
KeyCode.JKey	The j key
KeyCode.KKey	The k key
KeyCode.LKey	The l key
KeyCode.MKey	The m key
KeyCode.NKey	The n key
KeyCode.OKey	The o key
KeyCode.PKey	The p key
KeyCode.QKey	The q key
KeyCode.RKey	The r key
KeyCode.SKey	The s key
KeyCode.TKey	The t key
KeyCode.UKey	The u key
KeyCode.VKey	The v key
KeyCode.WKey	The w key
KeyCode.XKey	The x key
KeyCode.YKey	The y key
KeyCode.ZKey	The z key
KeyCode.DeleteKey	The delete key
KeyCode.Keypad0	The keypad 0 key
KeyCode.Keypad1	The keypad 1 key
KeyCode.Keypad2	The keypad 2 key
KeyCode.Keypad3	The keypad 3 key
KeyCode.Keypad4	The keypad 4 key
KeyCode.Keypad5	The keypad 5 key
KeyCode.Keypad6	The keypad 6 key
KeyCode.Keypad7	The keypad 7 key
KeyCode.Keypad8	The keypad 8 key
KeyCode.Keypad9	The keypad 9 key
KeyCode.KeypadPeriod	The keypad period key
KeyCode.KeypadDivide	The keypad divide key
KeyCode.KeypadMultiply	The keypad multiply key
KeyCode.KeypadMinus	The keypad minus key
KeyCode.KeypadPlus	The keypad plus key
KeyCode.KeypadEnter	The keypad enter key
KeyCode.KeypadEquals	The keypad equals key
KeyCode.UpKey	The up key
KeyCode.DownKey	The down key
KeyCode.RightKey	The right key
KeyCode.LeftKey	The left key
KeyCode.InsertKey	The insert key
KeyCode.HomeKey	The home key
KeyCode.EndKey	The end key
KeyCode.PageUpKey	The page up key
KeyCode.PageDownKey	The page down key
KeyCode.F1Key	The f1 key
KeyCode.F2Key	The f2 key
KeyCode.F3Key	The f3 key
KeyCode.F4Key	The f4 key
KeyCode.F5Key	The f5 key
KeyCode.F6Key	The f6 key
KeyCode.F7Key	The f7 key
KeyCode.F8Key	The f8 key
KeyCode.F9Key	The f9 key
KeyCode.F10Key	The f10 key
KeyCode.F11Key	The f11 key
KeyCode.F12Key	The f12 key
KeyCode.F13Key	The f13 key
KeyCode.F14Key	The f14 key
KeyCode.F15Key	The f15 key
KeyCode.NumLockKey	The num lock key
KeyCode.CapsLockKey	The caps lock key
KeyCode.ScrollLockKey	The scroll lock key
KeyCode.RightShiftKey	The right shift key
KeyCode.LeftShiftKey	The left shift key
KeyCode.RightCtrlKey	The right ctrl key
KeyCode.LeftCtrlKey	The left ctrl key
KeyCode.RightAltKey	The right alt or option key
KeyCode.LeftAltKey	The left alt or option key
KeyCode.LeftSuperKey	The left super (windows or command) key
KeyCode.RightSuperKey	The right super (windows or command) key
KeyCode.ModeKey	The mode key
KeyCode.HelpKey	The help key
KeyCode.SysReqKey	The sys req key
KeyCode.MenuKey	The menu key
KeyCode.PowerKey	The power key

---

Mouse Button

A mouse can have many different types of buttons. Most people know about the simple Left and Right buttons, but there is also a Middle button (sometimes part of a scoll wheel), and possible side buttons.

C++

Constant	Description
NO_BUTTON	No mouse button
LEFT_BUTTON	The left mouse button
MIDDLE_BUTTON	The middle mouse button
RIGHT_BUTTON	The right mouse button
MOUSE_X1_BUTTON	The x1 mouse button
MOUSE_X2_BUTTON	The x2 mouse button

C#

Constant	Description
MouseButton.NoButton	No mouse button
MouseButton.LeftButton	The left mouse button
MouseButton.MiddleButton	The middle mouse button
MouseButton.RightButton	The right mouse button
MouseButton.MouseX1Button	The x1 mouse button
MouseButton.MouseX2Button	The x2 mouse button

Python

Constant	Description
MouseButton.no_button	No mouse button
MouseButton.left_button	The left mouse button
MouseButton.middle_button	The middle mouse button
MouseButton.right_button	The right mouse button
MouseButton.mouse_x1_button	The x1 mouse button
MouseButton.mouse_x2_button	The x2 mouse button

Pascal

Constant	Description
MouseButton.NoButton	No mouse button
MouseButton.LeftButton	The left mouse button
MouseButton.MiddleButton	The middle mouse button
MouseButton.RightButton	The right mouse button
MouseButton.MouseX1Button	The x1 mouse button
MouseButton.MouseX2Button	The x2 mouse button

---