Package SiliconStudio.Paradox.Input

Classes
struct	GamePadState
	Describes the state of a gamepad. More...
class	GestureConfig
	This represents the base class for all gesture configuration. More...
class	GestureConfigCollection
	A collection of GestureConfig. More...
class	GestureConfigComposite
	Configuration class for the Composite gesture. More...
class	GestureConfigDrag
	Configuration class for the Drag gesture. More...
class	GestureConfigFlick
	Configuration class for the Flick gesture. More...
class	GestureConfigLongPress
	Configuration class the Long Press gestures. More...
class	GestureConfigTap
	Configuration class for the Tap gesture. More...
class	GestureEvent
	Base class for the gesture events. More...
class	GestureEventComposite
	Event class for the Composite gesture. More...
class	GestureEventDrag
	Event class for the Drag gesture. More...
class	GestureEventFlick
	Event class for the Flick gesture. More...
class	GestureEventLongPress
	Event class for the LongPress gesture. More...
class	GestureEventTap
	Event class for the Tap gesture. More...
class	GestureEventTranslation
	Event class for the Drag gesture. More...
class	GestureRecognizer
class	GestureRecognizerComposite
class	GestureRecognizerContMotion
	A gesture recognizer for continuous motions.
class	GestureRecognizerDrag
class	GestureRecognizerFlick
class	GestureRecognizerLongPress
class	GestureRecognizerTap
class	InputManager
class	InputManagerBase
	Interface for input management system, including keyboard, mouse, gamepads and touch. More...
interface	IVirtualButton
	Interface IVirtualButton More...
struct	KeyEvent
	A keyboard event. More...
class	NamespaceDoc
	The SiliconStudio.Paradox.Input namespace contains types to manage the input. More...
class	PointerEvent
	A pointer event. More...
class	VirtualButton
	Describes a virtual button (a key from a keyboard, a mouse button, an axis of a joystick...etc.). More...
class	VirtualButtonBinding
	Describes a binding between a name and a IVirtualButton. More...
class	VirtualButtonConfig
	Describes the configuration composed by a collection of VirtualButtonBinding. More...
class	VirtualButtonConfigSet
	A collection of VirtualButtonConfig. More...
class	VirtualButtonGroup
	A combination of IVirtualButton, by default evaluated as the operator '&&' to produce a value if all buttons are pressed. More...
class	VirtualButtonTwoWay
	Describes a IVirtualButton using the sum of a negative and positive button. More...

Enumerations
enum	GamePadButton : ushort {   GamePadButton.PadUp = 1 << 0, GamePadButton.PadDown = 1 << 1, GamePadButton.PadLeft = 1 << 2, GamePadButton.PadRight = 1 << 3,   GamePadButton.Start = 1 << 4, GamePadButton.Back = 1 << 5, GamePadButton.LeftThumb = 1 << 6, GamePadButton.RightThumb = 1 << 7,   GamePadButton.LeftShoulder = 1 << 8, GamePadButton.RightShoulder = 1 << 9, GamePadButton.A = 1 << 12, GamePadButton.B = 1 << 13,   GamePadButton.X = 1 << 14, GamePadButton.Y = 1 << 15, GamePadButton.None = 0 }
	Buttons for gamepad returned by GamePadState. More...
enum	GestureShape { GestureShape.Horizontal, GestureShape.Vertical, GestureShape.Free }
	Gesture possible shapes. More...
enum	GestureState { GestureState.Occurred, GestureState.Began, GestureState.Changed, GestureState.Ended }
	The different possible states of a gestures. More...
enum	GestureType {   GestureType.Drag, GestureType.Flick, GestureType.LongPress, GestureType.Composite,   GestureType.Tap }
	List all the available type of Gestures. More...
enum	KeyEventType { KeyEventType.Pressed, KeyEventType.Released }
	Used by KeyEvent More...
enum	Keys {   Keys.None = 0, Keys.Cancel = 1, Keys.Back = 2, Keys.Tab = 3,   Keys.LineFeed = 4, Keys.Clear = 5, Keys.Enter = 6, Keys.Return = 6,   Keys.Pause = 7, Keys.Capital = 8, Keys.CapsLock = 8, Keys.HangulMode = 9,   Keys.KanaMode = 9, Keys.JunjaMode = 10, Keys.FinalMode = 11, Keys.HanjaMode = 12,   Keys.KanjiMode = 12, Keys.Escape = 13, Keys.ImeConvert = 14, Keys.ImeNonConvert = 15,   Keys.ImeAccept = 16, Keys.ImeModeChange = 17, Keys.Space = 18, Keys.PageUp = 19,   Keys.Prior = 19, Keys.Next = 20, Keys.PageDown = 20, Keys.End = 21,   Keys.Home = 22, Keys.Left = 23, Keys.Up = 24, Keys.Right = 25,   Keys.Down = 26, Keys.Select = 27, Keys.Print = 28, Keys.Execute = 29,   Keys.PrintScreen = 30, Keys.Snapshot = 30, Keys.Insert = 31, Keys.Delete = 32,   Keys.Help = 33, Keys.D0 = 34, Keys.D1 = 35, Keys.D2 = 36,   Keys.D3 = 37, Keys.D4 = 38, Keys.D5 = 39, Keys.D6 = 40,   Keys.D7 = 41, Keys.D8 = 42, Keys.D9 = 43, Keys.A = 44,   Keys.B = 45, Keys.C = 46, Keys.D = 47, Keys.E = 48,   Keys.F = 49, Keys.G = 50, Keys.H = 51, Keys.I = 52,   Keys.J = 53, Keys.K = 54, Keys.L = 55, Keys.M = 56,   Keys.N = 57, Keys.O = 58, Keys.P = 59, Keys.Q = 60,   Keys.R = 61, Keys.S = 62, Keys.T = 63, Keys.U = 64,   Keys.V = 65, Keys.W = 66, Keys.X = 67, Keys.Y = 68,   Keys.Z = 69, Keys.LeftWin = 70, Keys.RightWin = 71, Keys.Apps = 72,   Keys.Sleep = 73, Keys.NumPad0 = 74, Keys.NumPad1 = 75, Keys.NumPad2 = 76,   Keys.NumPad3 = 77, Keys.NumPad4 = 78, Keys.NumPad5 = 79, Keys.NumPad6 = 80,   Keys.NumPad7 = 81, Keys.NumPad8 = 82, Keys.NumPad9 = 83, Keys.Multiply = 84,   Keys.Add = 85, Keys.Separator = 86, Keys.Subtract = 87, Keys.Decimal = 88,   Keys.Divide = 89, Keys.F1 = 90, Keys.F2 = 91, Keys.F3 = 92,   Keys.F4 = 93, Keys.F5 = 94, Keys.F6 = 95, Keys.F7 = 96,   Keys.F8 = 97, Keys.F9 = 98, Keys.F10 = 99, Keys.F11 = 100,   Keys.F12 = 101, Keys.F13 = 102, Keys.F14 = 103, Keys.F15 = 104,   Keys.F16 = 105, Keys.F17 = 106, Keys.F18 = 107, Keys.F19 = 108,   Keys.F20 = 109, Keys.F21 = 110, Keys.F22 = 111, Keys.F23 = 112,   Keys.F24 = 113, Keys.NumLock = 114, Keys.Scroll = 115, Keys.LeftShift = 116,   Keys.RightShift = 117, Keys.LeftCtrl = 118, Keys.RightCtrl = 119, Keys.LeftAlt = 120,   Keys.RightAlt = 121, Keys.BrowserBack = 122, Keys.BrowserForward = 123, Keys.BrowserRefresh = 124,   Keys.BrowserStop = 125, Keys.BrowserSearch = 126, Keys.BrowserFavorites = 127, Keys.BrowserHome = 128,   Keys.VolumeMute = 129, Keys.VolumeDown = 130, Keys.VolumeUp = 131, Keys.MediaNextTrack = 132,   Keys.MediaPreviousTrack = 133, Keys.MediaStop = 134, Keys.MediaPlayPause = 135, Keys.LaunchMail = 136,   Keys.SelectMedia = 137, Keys.LaunchApplication1 = 138, Keys.LaunchApplication2 = 139, Keys.Oem1 = 140,   Keys.OemSemicolon = 140, Keys.OemPlus = 141, Keys.OemComma = 142, Keys.OemMinus = 143,   Keys.OemPeriod = 144, Keys.Oem2 = 145, Keys.OemQuestion = 145, Keys.Oem3 = 146,   Keys.OemTilde = 146, Keys.Oem4 = 149, Keys.OemOpenBrackets = 149, Keys.Oem5 = 150,   Keys.OemPipe = 150, Keys.Oem6 = 151, Keys.OemCloseBrackets = 151, Keys.Oem7 = 152,   Keys.OemQuotes = 152, Keys.Oem8 = 153, Keys.Oem102 = 154, Keys.OemBackslash = 154,   Keys.Attn = 163, Keys.CrSel = 164, Keys.ExSel = 165, Keys.EraseEof = 166,   Keys.Play = 167, Keys.Zoom = 168, Keys.NoName = 169, Keys.Pa1 = 170,   Keys.OemClear = 171, Keys.NumPadEnter = 180, Keys.NumPadDecimal = 181 }
	Enumeration for keys. More...
enum	MouseButton {   MouseButton.Left = 0, MouseButton.Middle = 1, MouseButton.Right = 2, MouseButton.Extended1 = 3,   MouseButton.Extended2 = 4 }
	Mouse buttons. More...
enum	PointerState {   PointerState.Down, PointerState.Move, PointerState.Up, PointerState.Out,   PointerState.Cancel }
	State of a pointer event. More...
enum	PointerType { PointerType.Unknown, PointerType.Mouse, PointerType.Touch }
	Type of a pointer device. More...
enum	VirtualButtonType { VirtualButtonType.Keyboard = 1 << 28, VirtualButtonType.Mouse = 2 << 28, VirtualButtonType.Pointer = 3 << 28, VirtualButtonType.GamePad = 4 << 28 }
	Type of a VirtualButton. More...

Enumeration Type Documentation

enum SiliconStudio.Paradox.Input.GamePadButton : ushort

Buttons for gamepad returned by GamePadState.

Enumerator
PadUp	PadUp button.
PadDown	PadDown button.
PadLeft	PadLeft button.
PadRight	PadRight button.
Start	Start button.
Back	Back button.
LeftThumb	Left thumb button.
RightThumb	Right thumb button.
LeftShoulder	Left shoulder button.
RightShoulder	Right shoulder button.
A	A button.
B	B button.
X	X button.
Y	Y button.
None	No buttons.

Definition at line 11 of file GamePadButton.cs.

enum SiliconStudio.Paradox.Input.GestureShape

Gesture possible shapes.

Enumerator
Horizontal	Represent a gesture that has its shape along the horizontal axis.
Vertical	Represent a gesture that has its shape along the vertical axis.
Free	Represent a gesture that has a random shape.

Definition at line 8 of file GestureShape.cs.

enum SiliconStudio.Paradox.Input.GestureState

The different possible states of a gestures.

Enumerator
Occurred	A discrete gesture has occurred.
Began	A continuous gesture has started.
Changed	A continuous gesture parameters changed.
Ended	A continuous gesture has stopped.

Definition at line 8 of file GestureState.cs.

enum SiliconStudio.Paradox.Input.GestureType

List all the available type of Gestures.

Enumerator
Drag	The user touched the screen and then performed a free translation. Drag is a continuous gesture.
Flick	The user touched the screen and then performed a quick swipe. Flick is a discrete gesture.
LongPress	The user touched and maintained a point on the screen. LongPress is a discrete gesture.
Composite	The user touched two points of the screen and performed a composite transformation (translation, rotation, scale). Rotation is a continuous gesture.
Tap	The user touched the screen. Tap is a discrete gesture.

Definition at line 9 of file GestureType.cs.

enum SiliconStudio.Paradox.Input.KeyEventType

Used by KeyEvent

Enumerator
Pressed	A key has been pressed.
Released	A key has been released.

Definition at line 8 of file KeyEventType.cs.

enum SiliconStudio.Paradox.Input.Keys

Enumeration for keys.

Enumerator
None	The 'none' key.
Cancel	The 'cancel' key.
Back	The 'back' key.
Tab	The 'tab' key.
LineFeed	The 'linefeed' key.
Clear	The 'clear' key.
Enter	The 'enter' key.
Return	The 'return' key.
Pause	The 'pause' key.
Capital	The 'capital' key.
CapsLock	The 'capslock' key.
HangulMode	The 'hangulmode' key.
KanaMode	The 'kanamode' key.
JunjaMode	The 'junjamode' key.
FinalMode	The 'finalmode' key.
HanjaMode	The 'hanjamode' key.
KanjiMode	The 'kanjimode' key.
Escape	The 'escape' key.
ImeConvert	The 'imeconvert' key.
ImeNonConvert	The 'imenonconvert' key.
ImeAccept	The 'imeaccept' key.
ImeModeChange	The 'imemodechange' key.
Space	The 'space' key.
PageUp	The 'pageup' key.
Prior	The 'prior' key.
Next	The 'next' key.
PageDown	The 'pagedown' key.
End	The 'end' key.
Home	The 'home' key.
Left	The 'left' key.
Up	The 'up' key.
Right	The 'right' key.
Down	The 'down' key.
Select	The 'select' key.
Print	The 'print' key.
Execute	The 'execute' key.
PrintScreen	The 'printscreen' key.
Snapshot	The 'snapshot' key.
Insert	The 'insert' key.
Delete	The 'delete' key.
Help	The 'help' key.
D0	The 'd0' key.
D1	The 'd1' key.
D2	The 'd2' key.
D3	The 'd3' key.
D4	The 'd4' key.
D5	The 'd5' key.
D6	The 'd6' key.
D7	The 'd7' key.
D8	The 'd8' key.
D9	The 'd9' key.
A	The 'a' key.
B	The 'b' key.
C	The 'c' key.
D	The 'd' key.
E	The 'e' key.
F	The 'f' key.
G	The 'g' key.
H	The 'h' key.
I	The 'i' key.
J	The 'j' key.
K	The 'k' key.
L	The 'l' key.
M	The 'm' key.
N	The 'n' key.
O	The 'o' key.
P	The 'p' key.
Q	The 'q' key.
R	The 'r' key.
S	The 's' key.
T	The 't' key.
U	The 'u' key.
V	The 'v' key.
W	The 'w' key.
X	The 'x' key.
Y	The 'y' key.
Z	The 'z' key.
LeftWin	The 'leftwin' key.
RightWin	The 'rightwin' key.
Apps	The 'apps' key.
Sleep	The 'sleep' key.
NumPad0	The 'numpad0' key.
NumPad1	The 'numpad1' key.
NumPad2	The 'numpad2' key.
NumPad3	The 'numpad3' key.
NumPad4	The 'numpad4' key.
NumPad5	The 'numpad5' key.
NumPad6	The 'numpad6' key.
NumPad7	The 'numpad7' key.
NumPad8	The 'numpad8' key.
NumPad9	The 'numpad9' key.
Multiply	The 'multiply' key.
Add	The 'add' key.
Separator	The 'separator' key.
Subtract	The 'subtract' key.
Decimal	The 'decimal' key.
Divide	The 'divide' key.
F1	The 'f1' key.
F2	The 'f2' key.
F3	The 'f3' key.
F4	The 'f4' key.
F5	The 'f5' key.
F6	The 'f6' key.
F7	The 'f7' key.
F8	The 'f8' key.
F9	The 'f9' key.
F10	The 'f10' key.
F11	The 'f11' key.
F12	The 'f12' key.
F13	The 'f13' key.
F14	The 'f14' key.
F15	The 'f15' key.
F16	The 'f16' key.
F17	The 'f17' key.
F18	The 'f18' key.
F19	The 'f19' key.
F20	The 'f20' key.
F21	The 'f21' key.
F22	The 'f22' key.
F23	The 'f23' key.
F24	The 'f24' key.
NumLock	The 'numlock' key.
Scroll	The 'scroll' key.
LeftShift	The 'leftshift' key.
RightShift	The 'rightshift' key.
LeftCtrl	The 'leftctrl' key.
RightCtrl	The 'rightctrl' key.
LeftAlt	The 'leftalt' key.
RightAlt	The 'rightalt' key.
BrowserBack	The 'browserback' key.
BrowserForward	The 'browserforward' key.
BrowserRefresh	The 'browserrefresh' key.
BrowserStop	The 'browserstop' key.
BrowserSearch	The 'browsersearch' key.
BrowserFavorites	The 'browserfavorites' key.
BrowserHome	The 'browserhome' key.
VolumeMute	The 'volumemute' key.
VolumeDown	The 'volumedown' key.
VolumeUp	The 'volumeup' key.
MediaNextTrack	The 'medianexttrack' key.
MediaPreviousTrack	The 'mediaprevioustrack' key.
MediaStop	The 'mediastop' key.
MediaPlayPause	The 'mediaplaypause' key.
LaunchMail	The 'launchmail' key.
SelectMedia	The 'selectmedia' key.
LaunchApplication1	The 'launchapplication1' key.
LaunchApplication2	The 'launchapplication2' key.
Oem1	The 'oem1' key.
OemSemicolon	The 'oemsemicolon' key.
OemPlus	The 'oemplus' key.
OemComma	The 'oemcomma' key.
OemMinus	The 'oemminus' key.
OemPeriod	The 'oemperiod' key.
Oem2	The 'oem2' key.
OemQuestion	The 'oemquestion' key.
Oem3	The 'oem3' key.
OemTilde	The 'oemtilde' key.
Oem4	The 'oem4' key.
OemOpenBrackets	The 'oemopenbrackets' key.
Oem5	The 'oem5' key.
OemPipe	The 'oempipe' key.
Oem6	The 'oem6' key.
OemCloseBrackets	The 'oemclosebrackets' key.
Oem7	The 'oem7' key.
OemQuotes	The 'oemquotes' key.
Oem8	The 'oem8' key.
Oem102	The 'oem102' key.
OemBackslash	The 'oembackslash' key.
Attn	The 'attn' key.
CrSel	The 'crsel' key.
ExSel	The 'exsel' key.
EraseEof	The 'eraseeof' key.
Play	The 'play' key.
Zoom	The 'zoom' key.
NoName	The 'noname' key.
Pa1	The 'pa1' key.
OemClear	The 'oemclear' key.
NumPadEnter	The 'numpad enter' key.
NumPadDecimal	The 'numpad decimal' key.

Definition at line 8 of file Keys.cs.

enum SiliconStudio.Paradox.Input.MouseButton

Mouse buttons.

Enumerator
Left	Left button.
Middle	Middle button.
Right	Right button.
Extended1	Extended button 1.
Extended2	Extended button 2.

Definition at line 10 of file MouseButton.cs.

enum SiliconStudio.Paradox.Input.PointerState

State of a pointer event.

Enumerator
Down	The pointer just started to hit the digitizer.
Move	The pointer is moving onto the digitizer.
Up	The pointer just released pressure to the digitizer.
Out	The pointer is out of the digitizer.
Cancel	The pointer has been canceled.

Definition at line 8 of file PointerState.cs.

enum SiliconStudio.Paradox.Input.PointerType

Type of a pointer device.

Enumerator
Unknown	An unknown pointer.
Mouse	A mouse pointer.
Touch	A touch pointer.

Definition at line 8 of file PointerType.cs.

enum SiliconStudio.Paradox.Input.VirtualButtonType

Type of a VirtualButton.

Enumerator
Keyboard	A keyboard virtual button.
Mouse	A mouse virtual button.
Pointer	A pointer virtual button.
GamePad	A gamepad virtual button.

Definition at line 8 of file VirtualButtonType.cs.