Torque2D Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

Macros | Enumerations
Input system constants

## Macros
#define | SI_MAKE 0x01
| Device Event Action Types. More...
#define | SI_BREAK 0x02
#define | SI_MOVE 0x03
#define | SI_REPEAT 0x04
#define | SI_VALUE 0x05
#define | SI_UNKNOWN 0x01
| Device Event Types. More...
#define | SI_BUTTON 0x02
#define | SI_POV 0x03
#define | SI_KEY 0x0A
#define | SI_TEXT 0x0B
#define | SI_TOUCH 0x0C
#define | SI_GESTURE 0x0D
#define | SI_MOTION 0x0F
#define | SI_LEAP 0x11
#define | SI_ANY 0xff
| Event SubTypes. More...
#define | SI_LSHIFT (1<<0)
| shift and ctrl are the same between platforms. More...
#define | SI_RSHIFT (1<<1)
#define | SI_SHIFT (SI_LSHIFT|SI_RSHIFT)
#define | SI_LCTRL (1<<2)
#define | SI_RCTRL (1<<3)
#define | SI_CTRL (SI_LCTRL|SI_RCTRL)
#define | SI_LALT (1<<4)
| win altkey, mapped to mac cmdkey. More...
#define | SI_RALT (1<<5)
#define | SI_ALT (SI_LALT|SI_RALT)
#define | SI_MAC_LOPT (1<<6)
| mac optionkey More...
#define | SI_MAC_ROPT (1<<7)
#define | SI_MAC_OPT (SI_MAC_LOPT|SI_MAC_ROPT)

## Enumerations
enum | KeyCodes { KEY_NULL = 0x000, KEY_BACKSPACE = 0x001, KEY_TAB = 0x002, KEY_RETURN = 0x003, KEY_CONTROL = 0x004, KEY_ALT = 0x005, KEY_SHIFT = 0x006, KEY_PAUSE = 0x007, KEY_CAPSLOCK = 0x008, KEY_ESCAPE = 0x009, KEY_SPACE = 0x00a, KEY_PAGE_DOWN = 0x00b, KEY_PAGE_UP = 0x00c, KEY_END = 0x00d, KEY_HOME = 0x00e, KEY_LEFT = 0x00f, KEY_UP = 0x010, KEY_RIGHT = 0x011, KEY_DOWN = 0x012, KEY_PRINT = 0x013, KEY_INSERT = 0x014, KEY_DELETE = 0x015, KEY_HELP = 0x016, KEY_0 = 0x017, KEY_1 = 0x018, KEY_2 = 0x019, KEY_3 = 0x01a, KEY_4 = 0x01b, KEY_5 = 0x01c, KEY_6 = 0x01d, KEY_7 = 0x01e, KEY_8 = 0x01f, KEY_9 = 0x020, KEY_A = 0x021, KEY_B = 0x022, KEY_C = 0x023, KEY_D = 0x024, KEY_E = 0x025, KEY_F = 0x026, KEY_G = 0x027, KEY_H = 0x028, KEY_I = 0x029, KEY_J = 0x02a, KEY_K = 0x02b, KEY_L = 0x02c, KEY_M = 0x02d, KEY_N = 0x02e, KEY_O = 0x02f, KEY_P = 0x030, KEY_Q = 0x031, KEY_R = 0x032, KEY_S = 0x033, KEY_T = 0x034, KEY_U = 0x035, KEY_V = 0x036, KEY_W = 0x037, KEY_X = 0x038, KEY_Y = 0x039, KEY_Z = 0x03a, KEY_TILDE = 0x03b, KEY_MINUS = 0x03c, KEY_EQUALS = 0x03d, KEY_LBRACKET = 0x03e, KEY_RBRACKET = 0x03f, KEY_BACKSLASH = 0x040, KEY_SEMICOLON = 0x041, KEY_APOSTROPHE = 0x042, KEY_COMMA = 0x043, KEY_PERIOD = 0x044, KEY_SLASH = 0x045, KEY_NUMPAD0 = 0x046, KEY_NUMPAD1 = 0x047, KEY_NUMPAD2 = 0x048, KEY_NUMPAD3 = 0x049, KEY_NUMPAD4 = 0x04a, KEY_NUMPAD5 = 0x04b, KEY_NUMPAD6 = 0x04c, KEY_NUMPAD7 = 0x04d, KEY_NUMPAD8 = 0x04e, KEY_NUMPAD9 = 0x04f, KEY_MULTIPLY = 0x050, KEY_ADD = 0x051, KEY_SEPARATOR = 0x052, KEY_SUBTRACT = 0x053, KEY_DECIMAL = 0x054, KEY_DIVIDE = 0x055, KEY_NUMPADENTER = 0x056, KEY_F1 = 0x057, KEY_F2 = 0x058, KEY_F3 = 0x059, KEY_F4 = 0x05a, KEY_F5 = 0x05b, KEY_F6 = 0x05c, KEY_F7 = 0x05d, KEY_F8 = 0x05e, KEY_F9 = 0x05f, KEY_F10 = 0x060, KEY_F11 = 0x061, KEY_F12 = 0x062, KEY_F13 = 0x063, KEY_F14 = 0x064, KEY_F15 = 0x065, KEY_F16 = 0x066, KEY_F17 = 0x067, KEY_F18 = 0x068, KEY_F19 = 0x069, KEY_F20 = 0x06a, KEY_F21 = 0x06b, KEY_F22 = 0x06c, KEY_F23 = 0x06d, KEY_F24 = 0x06e, KEY_NUMLOCK = 0x06f, KEY_SCROLLLOCK = 0x070, KEY_LCONTROL = 0x071, KEY_RCONTROL = 0x072, KEY_LALT = 0x073, KEY_RALT = 0x074, KEY_LSHIFT = 0x075, KEY_RSHIFT = 0x076, KEY_WIN_LWINDOW = 0x077, KEY_WIN_RWINDOW = 0x078, KEY_WIN_APPS = 0x079, KEY_OEM_102 = 0x080, KEY_MAC_OPT = 0x090, KEY_MAC_LOPT = 0x091, KEY_MAC_ROPT = 0x092, KEY_BUTTON0 = 0x0100, KEY_BUTTON1 = 0x0101, KEY_BUTTON2 = 0x0102, KEY_BUTTON3 = 0x0103, KEY_BUTTON4 = 0x0104, KEY_BUTTON5 = 0x0105, KEY_BUTTON6 = 0x0106, KEY_BUTTON7 = 0x0107, KEY_BUTTON8 = 0x0108, KEY_BUTTON9 = 0x0109, KEY_BUTTON10 = 0x010A, KEY_BUTTON11 = 0x010B, KEY_BUTTON12 = 0x010C, KEY_BUTTON13 = 0x010D, KEY_BUTTON14 = 0x010E, KEY_BUTTON15 = 0x010F, KEY_BUTTON16 = 0x0110, KEY_BUTTON17 = 0x0111, KEY_BUTTON18 = 0x0112, KEY_BUTTON19 = 0x0113, KEY_BUTTON20 = 0x0114, KEY_BUTTON21 = 0x0115, KEY_BUTTON22 = 0x0116, KEY_BUTTON23 = 0x0117, KEY_BUTTON24 = 0x0118, KEY_BUTTON25 = 0x0119, KEY_BUTTON26 = 0x011A, KEY_BUTTON27 = 0x011B, KEY_BUTTON28 = 0x011C, KEY_BUTTON29 = 0x011D, KEY_BUTTON30 = 0x011E, KEY_BUTTON31 = 0x011F, KEY_ANYKEY = 0xfffe }
| Input event constants: More...
enum | JoystickCodes { SI_XPOV = 0x204, SI_YPOV = 0x205, SI_UPOV = 0x206, SI_DPOV = 0x207, SI_LPOV = 0x208, SI_RPOV = 0x209, SI_XAXIS = 0x20B, SI_YAXIS = 0x20C, SI_ZAXIS = 0x20D, SI_RXAXIS = 0x20E, SI_RYAXIS = 0x20F, SI_RZAXIS = 0x210, SI_SLIDER = 0x211, SI_XPOV2 = 0x212, SI_YPOV2 = 0x213, SI_UPOV2 = 0x214, SI_DPOV2 = 0x215, SI_LPOV2 = 0x216, SI_RPOV2 = 0x217, XI_CONNECT = 0x300, XI_THUMBLX = 0x301, XI_THUMBLY = 0x302, XI_THUMBRX = 0x303, XI_THUMBRY = 0x304, XI_LEFT_TRIGGER = 0x305, XI_RIGHT_TRIGGER = 0x306, XI_DPAD_UP = 0x206, XI_DPAD_DOWN = 0x207, XI_DPAD_LEFT = 0x208, XI_DPAD_RIGHT = 0x209, XI_START = 0x311, XI_BACK = 0x312, XI_LEFT_THUMB = 0x313, XI_RIGHT_THUMB = 0x314, XI_LEFT_SHOULDER = 0x315, XI_RIGHT_SHOULDER = 0x316, XI_A = 0x317, XI_B = 0x318, XI_X = 0x319, XI_Y = 0x320 }
| Joystick event codes. More...
enum | AccelerometerCodes { SI_ACCELX = 0x300, SI_ACCELY = 0x301, SI_ACCELZ = 0x302, SI_GRAVX = 0x303, SI_GRAVY = 0x304, SI_GRAVZ = 0x305 }
enum | GyroCodes { SI_GYROX = 0x306, SI_GYROY = 0x307, SI_GYROZ = 0x308, SI_YAW = 0x309, SI_PITCH = 0x30A, SI_ROLL = 0x30B }
enum | TouchCodes { SI_TOUCHDOWN = 0x30C, SI_TOUCHUP = 0x30D, SI_TOUCHMOVE = 0x30E }
enum | GestureCodes { SI_CIRCLE_GESTURE = 0x403, SI_SWIPE_GESTURE = 0x404, SI_KEYTAP_GESTURE = 0x405, SI_SCREENTAP_GESTURE = 0x406, SI_PINCH_GESTURE = 0x407, SI_SCALE_GESTURE = 0x408 }
enum | LeapMotionCodes { LM_HANDAXIS = 0x409, LM_HANDROT = 0x40A, LM_HANDPOS = 0x40B, LM_FINGERPOS = 0x40C }
enum | InputDeviceTypes { UnknownDeviceType, MouseDeviceType, KeyboardDeviceType, JoystickDeviceType, GamepadDeviceType, XInputDeviceType, ScreenTouchDeviceType, AccelerometerDeviceType, GyroscopeDeviceType, LeapMotionDeviceType }
| Input device types. More...

## Detailed Description

## Macro Definition Documentation

#define SI_ALT (SI_LALT|SI_RALT)

#define SI_ANY 0xff

Event SubTypes.

#define SI_BREAK 0x02

#define SI_BUTTON 0x02

#define SI_CTRL (SI_LCTRL|SI_RCTRL)

#define SI_GESTURE 0x0D

#define SI_KEY 0x0A

#define SI_LALT (1<<4)

win altkey, mapped to mac cmdkey.

#define SI_LCTRL (1<<2)

#define SI_LEAP 0x11

#define SI_LSHIFT (1<<0)

shift and ctrl are the same between platforms.

#define SI_MAC_LOPT (1<<6)

mac optionkey

#define SI_MAC_OPT (SI_MAC_LOPT|SI_MAC_ROPT)

#define SI_MAC_ROPT (1<<7)

#define SI_MAKE 0x01

Device Event Action Types.

#define SI_MOTION 0x0F

#define SI_MOVE 0x03

#define SI_POV 0x03

#define SI_RALT (1<<5)

#define SI_RCTRL (1<<3)

#define SI_REPEAT 0x04

#define SI_RSHIFT (1<<1)

#define SI_SHIFT (SI_LSHIFT|SI_RSHIFT)

#define SI_TEXT 0x0B

#define SI_TOUCH 0x0C

#define SI_UNKNOWN 0x01

Device Event Types.

#define SI_VALUE 0x05

## Enumeration Type Documentation

enum AccelerometerCodes

Enumerator
SI_ACCELX |
SI_ACCELY |
SI_ACCELZ |
SI_GRAVX |
SI_GRAVY |
SI_GRAVZ |

enum GestureCodes

Enumerator
SI_CIRCLE_GESTURE |
SI_SWIPE_GESTURE |
SI_KEYTAP_GESTURE |
SI_SCREENTAP_GESTURE |
SI_PINCH_GESTURE |
SI_SCALE_GESTURE |

enum GyroCodes

Enumerator
SI_GYROX |
SI_GYROY |
SI_GYROZ |
SI_YAW |
SI_PITCH |
SI_ROLL |

enum InputDeviceTypes

Input device types.

Enumerator
UnknownDeviceType |
MouseDeviceType |
KeyboardDeviceType |
JoystickDeviceType |
GamepadDeviceType |
XInputDeviceType |
ScreenTouchDeviceType |
AccelerometerDeviceType |
GyroscopeDeviceType |
LeapMotionDeviceType |

enum JoystickCodes

Joystick event codes.

Enumerator
SI_XPOV |
SI_YPOV |
SI_UPOV |
SI_DPOV |
SI_LPOV |
SI_RPOV |
SI_XAXIS |
SI_YAXIS |
SI_ZAXIS |
SI_RXAXIS |
SI_RYAXIS |
SI_RZAXIS |
SI_SLIDER |
SI_XPOV2 |
SI_YPOV2 |
SI_UPOV2 |
SI_DPOV2 |
SI_LPOV2 |
SI_RPOV2 |
XI_CONNECT |
XI_THUMBLX |
XI_THUMBLY |
XI_THUMBRX |
XI_THUMBRY |
XI_LEFT_TRIGGER |
XI_RIGHT_TRIGGER |
XI_DPAD_UP |
XI_DPAD_DOWN |
XI_DPAD_LEFT |
XI_DPAD_RIGHT |
XI_START |
XI_BACK |
XI_LEFT_THUMB |
XI_RIGHT_THUMB |
XI_LEFT_SHOULDER |
XI_RIGHT_SHOULDER |
XI_A |
XI_B |
XI_X |
XI_Y |

enum KeyCodes

Input event constants:

Enumerator
KEY_NULL | Invalid KeyCode.
KEY_BACKSPACE |
KEY_TAB |
KEY_RETURN |
KEY_CONTROL |
KEY_ALT |
KEY_SHIFT |
KEY_PAUSE |
KEY_CAPSLOCK |
KEY_ESCAPE |
KEY_SPACE |
KEY_PAGE_DOWN |
KEY_PAGE_UP |
KEY_END |
KEY_HOME |
KEY_LEFT |
KEY_UP |
KEY_RIGHT |
KEY_DOWN |
KEY_PRINT |
KEY_INSERT |
KEY_DELETE |
KEY_HELP |
KEY_0 |
KEY_1 |
KEY_2 |
KEY_3 |
KEY_4 |
KEY_5 |
KEY_6 |
KEY_7 |
KEY_8 |
KEY_9 |
KEY_A |
KEY_B |
KEY_C |
KEY_D |
KEY_E |
KEY_F |
KEY_G |
KEY_H |
KEY_I |
KEY_J |
KEY_K |
KEY_L |
KEY_M |
KEY_N |
KEY_O |
KEY_P |
KEY_Q |
KEY_R |
KEY_S |
KEY_T |
KEY_U |
KEY_V |
KEY_W |
KEY_X |
KEY_Y |
KEY_Z |
KEY_TILDE |
KEY_MINUS |
KEY_EQUALS |
KEY_LBRACKET |
KEY_RBRACKET |
KEY_BACKSLASH |
KEY_SEMICOLON |
KEY_APOSTROPHE |
KEY_COMMA |
KEY_PERIOD |
KEY_SLASH |
KEY_NUMPAD0 |
KEY_NUMPAD1 |
KEY_NUMPAD2 |
KEY_NUMPAD3 |
KEY_NUMPAD4 |
KEY_NUMPAD5 |
KEY_NUMPAD6 |
KEY_NUMPAD7 |
KEY_NUMPAD8 |
KEY_NUMPAD9 |
KEY_MULTIPLY |
KEY_ADD |
KEY_SEPARATOR |
KEY_SUBTRACT |
KEY_DECIMAL |
KEY_DIVIDE |
KEY_NUMPADENTER |
KEY_F1 |
KEY_F2 |
KEY_F3 |
KEY_F4 |
KEY_F5 |
KEY_F6 |
KEY_F7 |
KEY_F8 |
KEY_F9 |
KEY_F10 |
KEY_F11 |
KEY_F12 |
KEY_F13 |
KEY_F14 |
KEY_F15 |
KEY_F16 |
KEY_F17 |
KEY_F18 |
KEY_F19 |
KEY_F20 |
KEY_F21 |
KEY_F22 |
KEY_F23 |
KEY_F24 |
KEY_NUMLOCK |
KEY_SCROLLLOCK |
KEY_LCONTROL |
KEY_RCONTROL |
KEY_LALT |
KEY_RALT |
KEY_LSHIFT |
KEY_RSHIFT |
KEY_WIN_LWINDOW |
KEY_WIN_RWINDOW |
KEY_WIN_APPS |
KEY_OEM_102 |
KEY_MAC_OPT |
KEY_MAC_LOPT |
KEY_MAC_ROPT |
KEY_BUTTON0 |
KEY_BUTTON1 |
KEY_BUTTON2 |
KEY_BUTTON3 |
KEY_BUTTON4 |
KEY_BUTTON5 |
KEY_BUTTON6 |
KEY_BUTTON7 |
KEY_BUTTON8 |
KEY_BUTTON9 |
KEY_BUTTON10 |
KEY_BUTTON11 |
KEY_BUTTON12 |
KEY_BUTTON13 |
KEY_BUTTON14 |
KEY_BUTTON15 |
KEY_BUTTON16 |
KEY_BUTTON17 |
KEY_BUTTON18 |
KEY_BUTTON19 |
KEY_BUTTON20 |
KEY_BUTTON21 |
KEY_BUTTON22 |
KEY_BUTTON23 |
KEY_BUTTON24 |
KEY_BUTTON25 |
KEY_BUTTON26 |
KEY_BUTTON27 |
KEY_BUTTON28 |
KEY_BUTTON29 |
KEY_BUTTON30 |
KEY_BUTTON31 |
KEY_ANYKEY |

enum LeapMotionCodes

Enumerator
LM_HANDAXIS |
LM_HANDROT |
LM_HANDPOS |
LM_FINGERPOS |

enum TouchCodes

Enumerator
SI_TOUCHDOWN |
SI_TOUCHUP |
SI_TOUCHMOVE |