Input.xml 55 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264
  1. <Type Name="Input" FullName="Urho.Input">
  2. <TypeSignature Language="C#" Value="public class Input : Urho.UrhoObject" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Input extends Urho.UrhoObject" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.UrhoObject</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Input subsystem. Converts operating system window messages to input state and events.
  15. </summary>
  16. <remarks>
  17. <para>The Input subsystem provides keyboard, mouse, joystick and touch input both via a polled interface and events. This subsystem is also used for querying whether the application window has input focus or is minimized.</para>
  18. <para>The subsystem is always instantiated, even in headless mode, but is active only once the application window has been created. Once active, the subsystem takes over the operating system mouse cursor. It will be hidden by default, so the <see cref="T:Urho.UI" /> should be used to render a software cursor if necessary. For editor-like applications the operating system cursor can be made visible by calling <see cref="M:Urho.Input.SetMouseVisible" />.</para>
  19. <para>You can subscribe to these events by using one of the SubscribeToXxx methods in UrhoObject:</para>
  20. <list type="bullet">
  21. <item>
  22. <term>MouseButtonUp: a mouse button was released.</term>
  23. </item>
  24. <item>
  25. <term>MouseButtonDown: a mouse button was pressed.</term>
  26. </item>
  27. <item>
  28. <term>MouseMove: the mouse moved.</term>
  29. </item>
  30. <item>
  31. <term>MouseWheel: the mouse wheel moved.</term>
  32. </item>
  33. <item>
  34. <term>KeyUp: a key was released.</term>
  35. </item>
  36. <item>
  37. <term>KeyDown: a key was pressed.</term>
  38. </item>
  39. <item>
  40. <term>TextInput: a string of translated text input in UTF8 format. May contain a single character or several.</term>
  41. </item>
  42. <item>
  43. <term>JoystickConnected: a joystick was plugged in.</term>
  44. </item>
  45. <item>
  46. <term>JoystickDisconnected: a joystick was disconnected.</term>
  47. </item>
  48. <item>
  49. <term>JoystickButtonDown: a joystick button was pressed.</term>
  50. </item>
  51. <item>
  52. <term>JoystickButtonUp: a joystick button was released.</term>
  53. </item>
  54. <item>
  55. <term>JoystickAxisMove: a joystick axis was moved.</term>
  56. </item>
  57. <item>
  58. <term>JoystickHatMove: a joystick POV hat was moved.</term>
  59. </item>
  60. <item>
  61. <term>TouchBegin: a finger touched the screen.</term>
  62. </item>
  63. <item>
  64. <term>TouchEnd: a finger was lifted from the screen.</term>
  65. </item>
  66. <item>
  67. <term>TouchMove: a finger moved on the screen.</term>
  68. </item>
  69. <item>
  70. <term>GestureRecorded : recording a touch gesture is complete.</term>
  71. </item>
  72. <item>
  73. <term>GestureInput : a touch gesture was recognized.</term>
  74. </item>
  75. <item>
  76. <term>MultiGesture : a multi-finger pinch/rotation touch gesture is underway.</term>
  77. </item>
  78. <item>
  79. <term>DropFile : a file was drag-dropped on the application window.</term>
  80. </item>
  81. <item>
  82. <term>InputFocus : application input focus or window minimization state changed.</term>
  83. </item>
  84. <item>
  85. <term>MouseVisibleChanged : the visibility of the operating system mouse cursor was changed.</term>
  86. </item>
  87. <item>
  88. <term>ExitRequested : application exit was requested (eg. with the window close button.)</term>
  89. </item>
  90. </list>
  91. <para></para>
  92. <format type="text/html">
  93. <h2>Keyboard and Mouse Input</h2>
  94. </format>
  95. <para></para>
  96. <para>Key events include both the symbolic keycode ("Key") that depends on the keyboard layout, the layout- and operating system-independent SDL scancode ("Scancode"), and the true operating system-specific raw keycode ("Raw").</para>
  97. <para>The input polling API differentiates between the initiation of a key/mouse button press, and holding the key or button down.  <see cref="M:Urho.Input.GetKeyPress" /> and <see cref="M:Urho.Input.GetMouseButtonPress" /> return true only for one frame (the initiation) while <see cref="M:Urho.Input.GetKeyDown" /> and <see cref="M:Urho.Input.GetMouseButtonDown" /> return true as long as the key or button is held down. To check whether keys are down or pressed by scancode, use <see cref="M:Urho.Input.GetScancodeDown" /> and <see cref="M:Urho.Input.GetScancodePress" />. Functions also exist for converting keycodes to scancodes or vice versa, or getting key names. See for example <see cref="M:Urho.Input.GetKeyName" /> and <see cref="M:Urho.Input.GetKeyFromScancode" />.</para>
  98. <para>Mouse motion since the last frame can be accessed with <see cref="M:Urho.Input.GetMouseMove" />. The cursor position within the window can be queried with <see cref="M:Urho.Input.GetMousePosition" />.</para>
  99. <para></para>
  100. <format type="text/html">
  101. <h2>Mouse modes</h2>
  102. </format>
  103. <para>The operating system mouse cursor can be used in four modes which can be switched with <see cref="P:Urho.Input.MouseMode" />:</para>
  104. <list type="bullet">
  105. <item>
  106. <term>Absolute: is the default behaviour, allowing the toggling of operating system cursor visibility and allowing the cursor to escape the window when visible. When the operating system cursor is invisible in absolute mouse mode, the mouse is confined to the window. If the operating system and UI cursors are both invisible, interaction with the user interface will be limited (for example, drag move and drag end events will not trigger).    Setting this value to Absolute will call SetMouseGrabbed(false).</term>
  107. </item>
  108. </list>
  109. <list type="bullet">
  110. <item>
  111. <term>Relative: sets the operating system cursor to invisible and confines the cursor to the window. The operating system cursor cannot be set to be visible in this mode via SetMouseVisible(), however changes are tracked and will be restored when another mouse mode is set. When the virtual cursor is also invisible, UI interaction will still function as normal (eg: drag events will trigger). Setting this will call SetMouseGrabbed(true).</term>
  112. </item>
  113. </list>
  114. <para></para>
  115. <list type="bullet">
  116. <item>
  117. <term>Wrap: grabs the mouse from the operating system and confines the operating system cursor to the window, wrapping the cursor when it is near the edges. Setting this will call SetMouseGrabbed(true).</term>
  118. </item>
  119. </list>
  120. <list type="bullet">
  121. <item>
  122. <term>Free: does not grab/confine the mouse cursor even when it is hidden. This can be used for cases where the cursor should render using the operating system outside the window, and perform custom rendering (with SetMouseVisible(false)) inside.</term>
  123. </item>
  124. </list>
  125. <para></para>
  126. <format type="text/html">
  127. <h2>Joystick input</h2>
  128. </format>
  129. <para>Plugged in joysticks will begin sending input events automatically. Each joystick will be assigned a joystick ID which will be used in subsequent joystick events, as well as for retrieving the joystick state. Use <see cref="M:Urho.Input.GetJoystick" /> to retrieve the joystick state by ID. In case you do not have the ID, you can also use <see cref="M:Urho.Input.GetJoystickByIndex" /> which uses a zero-based index; see <see cref="P:Urho.Input.NumJoystick" /> for the number of currently connected joysticks. The ID, as well as the joystick name, can be looked up from the joystick state.</para>
  130. <para>If the joystick model is recognized by SDL as a game controller the buttons and axes mappings utilize known constants such as CONTROLLER_BUTTON_A or CONTROLLER_AXIS_LEFTX without having to guess them. Use <see cref="IsController()" /> to distinguish between a game controller and an unrecognized joystick.</para>
  131. <para></para>
  132. <para>On platforms that support the accelerometer, it will appear as a "virtual" joystick.</para>
  133. <para></para>
  134. <format type="text/html">
  135. <h2>Touch input</h2>
  136. </format>
  137. <para>On platforms where touch input is available, touch begin/end/move events will be sent, as well as multi-gesture events with pinch/rotation delta values when more than one finger is pressed down. The current finger touches can also be accessed via a polling API: <see cref="P:Urho.Input.NumTouches" /> and <see cref="M:Urho.Input.GetTouch." /></para>
  138. <para>Touch gestures can be recorded using SDL's inbuilt $1 gesture recognition system. Use <see cref="M:Urho.Input.RecordGesture" /> to start recording. The following finger movements will be recorded until the finger is lifted, at which point the recording ends and the GestureRecorded event is sent with the hash ID of the new gesture. The current in-memory gesture(s) can be saved or loaded as binary data.</para>
  139. <para></para>
  140. <para>Whenever a recognized gesture is entered by the user, the GestureInput event will be sent. In addition to the ID of the best matched gesture, it contains the center position and an error metric (lower = better) to help filter out false gestures.</para>
  141. <para>Note that all recorded (whether saved or not) and loaded gestures are held in-memory. Two additional functions are available to clear them: <see cref="M:Urho.Input.RemoveGesture" /> to selectively clear a gesture by its ID and <see cref="M:Urho.Input.RemoveAllGestures" /> to clear them all.</para>
  142. <para>Touch input can also emulate a virtual joystick by displaying on-screen buttons. See the function <see cref="M:Urho.Input.AddScreenJoystick" />.</para>
  143. <para>Touch emulation can be used to test mobile applications on a desktop machine without a touch screen. See <see cref="P:Urho.Input.TouchEmulation" />. When touch emulation is enabled, actual mouse events are no longer sent and the operating system mouse cursor is forced visible. The left mouse button acts as a moving finger, while the rest of the mouse buttons act as stationary fingers for multi-finger gestures. For example pressing down both left and right mouse buttons, then dragging the mouse with the buttons still pressed would emulate a two-finger pinch zoom-in gesture.</para>
  144. <para></para>
  145. <format type="text/html">
  146. <h2>Platform-specific details</h2>
  147. </format>
  148. <para>On platforms that support it (such as Android) an on-screen virtual keyboard can be shown or hidden. When shown, keypresses from the virtual keyboard will be sent as text input events just as if typed from an actual keyboard. Show or hide it by calling <see cref="S" />etScreenKeyboardVisible. The <see cref="T:Urho.UI" /> subsystem can also automatically show the virtual keyboard when a line editing element is focused, and hide it when defocused. This behavior can be controlled by calling SetUseScreenKeyboard.</para>
  149. <para>On Windows the user must first touch the screen once before touch input is activated. Trying to record or load touch gestures will fail before that.</para>
  150. </remarks>
  151. </Docs>
  152. <Members>
  153. <Member MemberName=".ctor">
  154. <MemberSignature Language="C#" Value="public Input (IntPtr handle);" />
  155. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  156. <MemberType>Constructor</MemberType>
  157. <AssemblyInfo>
  158. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  159. </AssemblyInfo>
  160. <Parameters>
  161. <Parameter Name="handle" Type="System.IntPtr" />
  162. </Parameters>
  163. <Docs>
  164. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  165. <summary>Constructs a new instance of Input, given a raw pointer to an unmanaged object</summary>
  166. <remarks>
  167. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  168. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  169. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  170. </remarks>
  171. </Docs>
  172. </Member>
  173. <Member MemberName=".ctor">
  174. <MemberSignature Language="C#" Value="public Input (Urho.Context context);" />
  175. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  176. <MemberType>Constructor</MemberType>
  177. <AssemblyInfo>
  178. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  179. </AssemblyInfo>
  180. <Parameters>
  181. <Parameter Name="context" Type="Urho.Context" />
  182. </Parameters>
  183. <Docs>
  184. <param name="context">The context that this object will be attached to.</param>
  185. <summary>Creates an instance of Input that is attached to an execution context.</summary>
  186. <remarks>
  187. <para>This creates an instance of Input attached to the specified execution context.</para>
  188. </remarks>
  189. </Docs>
  190. </Member>
  191. <Member MemberName=".ctor">
  192. <MemberSignature Language="C#" Value="public Input (Urho.UrhoObjectFlag emptyFlag);" />
  193. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  194. <MemberType>Constructor</MemberType>
  195. <AssemblyInfo>
  196. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  197. </AssemblyInfo>
  198. <Parameters>
  199. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  200. </Parameters>
  201. <Docs>
  202. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  203. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  204. <remarks>
  205. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  206. <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
  207. <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
  208. </remarks>
  209. </Docs>
  210. </Member>
  211. <Member MemberName="AddScreenJoystick">
  212. <MemberSignature Language="C#" Value="public int AddScreenJoystick (Urho.XMLFile layoutFile, Urho.XMLFile styleFile);" />
  213. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 AddScreenJoystick(class Urho.XMLFile layoutFile, class Urho.XMLFile styleFile) cil managed" />
  214. <MemberType>Method</MemberType>
  215. <AssemblyInfo>
  216. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  217. </AssemblyInfo>
  218. <ReturnValue>
  219. <ReturnType>System.Int32</ReturnType>
  220. </ReturnValue>
  221. <Parameters>
  222. <Parameter Name="layoutFile" Type="Urho.XMLFile" />
  223. <Parameter Name="styleFile" Type="Urho.XMLFile" />
  224. </Parameters>
  225. <Docs>
  226. <param name="layoutFile">To be added.</param>
  227. <param name="styleFile">To be added.</param>
  228. <summary>
  229. Add screen joystick. </summary>
  230. <returns>Return the joystick instance ID when successful or negative on error. </returns>
  231. <remarks>
  232. <para>If layout file is not given, use the default screen joystick layout. If style file is not given, use the default style file from root UI element. </para>
  233. <para />
  234. <para>This method should only be called in main thread.</para>
  235. </remarks>
  236. </Docs>
  237. </Member>
  238. <Member MemberName="BaseType">
  239. <MemberSignature Language="C#" Value="public override Urho.StringHash BaseType { get; }" />
  240. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash BaseType" />
  241. <MemberType>Property</MemberType>
  242. <AssemblyInfo>
  243. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  244. </AssemblyInfo>
  245. <ReturnValue>
  246. <ReturnType>Urho.StringHash</ReturnType>
  247. </ReturnValue>
  248. <Docs>
  249. <summary>Urho's type system base type.</summary>
  250. <value>StringHash representing the base type for this Urho type.</value>
  251. <remarks>This returns the Urho type system base type and is surfaced for low-level Urho code.</remarks>
  252. </Docs>
  253. </Member>
  254. <Member MemberName="GetJoystick">
  255. <MemberSignature Language="C#" Value="public Urho.JoystickState* GetJoystick (int id);" />
  256. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.JoystickState* GetJoystick(int32 id) cil managed" />
  257. <MemberType>Method</MemberType>
  258. <AssemblyInfo>
  259. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  260. </AssemblyInfo>
  261. <ReturnValue>
  262. <ReturnType>Urho.JoystickState*</ReturnType>
  263. </ReturnValue>
  264. <Parameters>
  265. <Parameter Name="id" Type="System.Int32" />
  266. </Parameters>
  267. <Docs>
  268. <param name="id">To be added.</param>
  269. <summary>
  270. Return joystick state by ID, or null if does not exist.
  271. </summary>
  272. <returns>To be added.</returns>
  273. <remarks>To be added.</remarks>
  274. </Docs>
  275. </Member>
  276. <Member MemberName="GetJoystickByIndex">
  277. <MemberSignature Language="C#" Value="public Urho.JoystickState* GetJoystickByIndex (uint index);" />
  278. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.JoystickState* GetJoystickByIndex(unsigned int32 index) cil managed" />
  279. <MemberType>Method</MemberType>
  280. <AssemblyInfo>
  281. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  282. </AssemblyInfo>
  283. <ReturnValue>
  284. <ReturnType>Urho.JoystickState*</ReturnType>
  285. </ReturnValue>
  286. <Parameters>
  287. <Parameter Name="index" Type="System.UInt32" />
  288. </Parameters>
  289. <Docs>
  290. <param name="index">To be added.</param>
  291. <summary>
  292. Return joystick state by index, or null if does not exist. 0 = first connected joystick.
  293. </summary>
  294. <returns>To be added.</returns>
  295. <remarks>To be added.</remarks>
  296. </Docs>
  297. </Member>
  298. <Member MemberName="GetKeyDown">
  299. <MemberSignature Language="C#" Value="public bool GetKeyDown (Urho.Key key);" />
  300. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetKeyDown(valuetype Urho.Key key) cil managed" />
  301. <MemberType>Method</MemberType>
  302. <AssemblyInfo>
  303. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  304. </AssemblyInfo>
  305. <ReturnValue>
  306. <ReturnType>System.Boolean</ReturnType>
  307. </ReturnValue>
  308. <Parameters>
  309. <Parameter Name="key" Type="Urho.Key" />
  310. </Parameters>
  311. <Docs>
  312. <param name="key">To be added.</param>
  313. <summary>
  314. Check if a key is held down.
  315. </summary>
  316. <returns>To be added.</returns>
  317. <remarks>To be added.</remarks>
  318. </Docs>
  319. </Member>
  320. <Member MemberName="GetKeyFromName">
  321. <MemberSignature Language="C#" Value="public int GetKeyFromName (string name);" />
  322. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 GetKeyFromName(string name) cil managed" />
  323. <MemberType>Method</MemberType>
  324. <AssemblyInfo>
  325. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  326. </AssemblyInfo>
  327. <ReturnValue>
  328. <ReturnType>System.Int32</ReturnType>
  329. </ReturnValue>
  330. <Parameters>
  331. <Parameter Name="name" Type="System.String" />
  332. </Parameters>
  333. <Docs>
  334. <param name="name">To be added.</param>
  335. <summary>
  336. Return keycode from key name.
  337. </summary>
  338. <returns>To be added.</returns>
  339. <remarks>To be added.</remarks>
  340. </Docs>
  341. </Member>
  342. <Member MemberName="GetKeyFromScancode">
  343. <MemberSignature Language="C#" Value="public int GetKeyFromScancode (int scancode);" />
  344. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 GetKeyFromScancode(int32 scancode) cil managed" />
  345. <MemberType>Method</MemberType>
  346. <AssemblyInfo>
  347. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  348. </AssemblyInfo>
  349. <ReturnValue>
  350. <ReturnType>System.Int32</ReturnType>
  351. </ReturnValue>
  352. <Parameters>
  353. <Parameter Name="scancode" Type="System.Int32" />
  354. </Parameters>
  355. <Docs>
  356. <param name="scancode">To be added.</param>
  357. <summary>
  358. Return keycode from scancode.
  359. </summary>
  360. <returns>To be added.</returns>
  361. <remarks>To be added.</remarks>
  362. </Docs>
  363. </Member>
  364. <Member MemberName="GetKeyName">
  365. <MemberSignature Language="C#" Value="public string GetKeyName (Urho.Key key);" />
  366. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetKeyName(valuetype Urho.Key key) cil managed" />
  367. <MemberType>Method</MemberType>
  368. <AssemblyInfo>
  369. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  370. </AssemblyInfo>
  371. <ReturnValue>
  372. <ReturnType>System.String</ReturnType>
  373. </ReturnValue>
  374. <Parameters>
  375. <Parameter Name="key" Type="Urho.Key" />
  376. </Parameters>
  377. <Docs>
  378. <param name="key">To be added.</param>
  379. <summary>
  380. Return name of key from keycode.
  381. </summary>
  382. <returns>To be added.</returns>
  383. <remarks>To be added.</remarks>
  384. </Docs>
  385. </Member>
  386. <Member MemberName="GetKeyPress">
  387. <MemberSignature Language="C#" Value="public bool GetKeyPress (Urho.Key key);" />
  388. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetKeyPress(valuetype Urho.Key key) cil managed" />
  389. <MemberType>Method</MemberType>
  390. <AssemblyInfo>
  391. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  392. </AssemblyInfo>
  393. <ReturnValue>
  394. <ReturnType>System.Boolean</ReturnType>
  395. </ReturnValue>
  396. <Parameters>
  397. <Parameter Name="key" Type="Urho.Key" />
  398. </Parameters>
  399. <Docs>
  400. <param name="key">To be added.</param>
  401. <summary>
  402. Check if a key has been pressed on this frame.
  403. </summary>
  404. <returns>To be added.</returns>
  405. <remarks>To be added.</remarks>
  406. </Docs>
  407. </Member>
  408. <Member MemberName="GetMouseButtonDown">
  409. <MemberSignature Language="C#" Value="public bool GetMouseButtonDown (Urho.MouseButton button);" />
  410. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetMouseButtonDown(valuetype Urho.MouseButton button) cil managed" />
  411. <MemberType>Method</MemberType>
  412. <AssemblyInfo>
  413. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  414. </AssemblyInfo>
  415. <ReturnValue>
  416. <ReturnType>System.Boolean</ReturnType>
  417. </ReturnValue>
  418. <Parameters>
  419. <Parameter Name="button" Type="Urho.MouseButton" />
  420. </Parameters>
  421. <Docs>
  422. <param name="button">To be added.</param>
  423. <summary>
  424. Check if a mouse button is held down.
  425. </summary>
  426. <returns>To be added.</returns>
  427. <remarks>To be added.</remarks>
  428. </Docs>
  429. </Member>
  430. <Member MemberName="GetMouseButtonPress">
  431. <MemberSignature Language="C#" Value="public bool GetMouseButtonPress (Urho.MouseButton button);" />
  432. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetMouseButtonPress(valuetype Urho.MouseButton button) cil managed" />
  433. <MemberType>Method</MemberType>
  434. <AssemblyInfo>
  435. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  436. </AssemblyInfo>
  437. <ReturnValue>
  438. <ReturnType>System.Boolean</ReturnType>
  439. </ReturnValue>
  440. <Parameters>
  441. <Parameter Name="button" Type="Urho.MouseButton" />
  442. </Parameters>
  443. <Docs>
  444. <param name="button">To be added.</param>
  445. <summary>
  446. Check if a mouse button has been pressed on this frame.
  447. </summary>
  448. <returns>To be added.</returns>
  449. <remarks>To be added.</remarks>
  450. </Docs>
  451. </Member>
  452. <Member MemberName="GetQualifierDown">
  453. <MemberSignature Language="C#" Value="public bool GetQualifierDown (int qualifier);" />
  454. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetQualifierDown(int32 qualifier) cil managed" />
  455. <MemberType>Method</MemberType>
  456. <AssemblyInfo>
  457. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  458. </AssemblyInfo>
  459. <ReturnValue>
  460. <ReturnType>System.Boolean</ReturnType>
  461. </ReturnValue>
  462. <Parameters>
  463. <Parameter Name="qualifier" Type="System.Int32" />
  464. </Parameters>
  465. <Docs>
  466. <param name="qualifier">To be added.</param>
  467. <summary>
  468. Check if a qualifier key is held down.
  469. </summary>
  470. <returns>To be added.</returns>
  471. <remarks>To be added.</remarks>
  472. </Docs>
  473. </Member>
  474. <Member MemberName="GetQualifierPress">
  475. <MemberSignature Language="C#" Value="public bool GetQualifierPress (int qualifier);" />
  476. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetQualifierPress(int32 qualifier) cil managed" />
  477. <MemberType>Method</MemberType>
  478. <AssemblyInfo>
  479. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  480. </AssemblyInfo>
  481. <ReturnValue>
  482. <ReturnType>System.Boolean</ReturnType>
  483. </ReturnValue>
  484. <Parameters>
  485. <Parameter Name="qualifier" Type="System.Int32" />
  486. </Parameters>
  487. <Docs>
  488. <param name="qualifier">To be added.</param>
  489. <summary>
  490. Check if a qualifier key has been pressed on this frame.
  491. </summary>
  492. <returns>To be added.</returns>
  493. <remarks>To be added.</remarks>
  494. </Docs>
  495. </Member>
  496. <Member MemberName="GetScancodeDown">
  497. <MemberSignature Language="C#" Value="public bool GetScancodeDown (int scancode);" />
  498. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetScancodeDown(int32 scancode) cil managed" />
  499. <MemberType>Method</MemberType>
  500. <AssemblyInfo>
  501. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  502. </AssemblyInfo>
  503. <ReturnValue>
  504. <ReturnType>System.Boolean</ReturnType>
  505. </ReturnValue>
  506. <Parameters>
  507. <Parameter Name="scancode" Type="System.Int32" />
  508. </Parameters>
  509. <Docs>
  510. <param name="scancode">To be added.</param>
  511. <summary>
  512. Check if a key is held down by scancode.
  513. </summary>
  514. <returns>To be added.</returns>
  515. <remarks>To be added.</remarks>
  516. </Docs>
  517. </Member>
  518. <Member MemberName="GetScancodeFromKey">
  519. <MemberSignature Language="C#" Value="public int GetScancodeFromKey (Urho.Key key);" />
  520. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 GetScancodeFromKey(valuetype Urho.Key key) cil managed" />
  521. <MemberType>Method</MemberType>
  522. <AssemblyInfo>
  523. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  524. </AssemblyInfo>
  525. <ReturnValue>
  526. <ReturnType>System.Int32</ReturnType>
  527. </ReturnValue>
  528. <Parameters>
  529. <Parameter Name="key" Type="Urho.Key" />
  530. </Parameters>
  531. <Docs>
  532. <param name="key">To be added.</param>
  533. <summary>
  534. Return scancode from keycode.
  535. </summary>
  536. <returns>To be added.</returns>
  537. <remarks>To be added.</remarks>
  538. </Docs>
  539. </Member>
  540. <Member MemberName="GetScancodeFromName">
  541. <MemberSignature Language="C#" Value="public int GetScancodeFromName (string name);" />
  542. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 GetScancodeFromName(string name) cil managed" />
  543. <MemberType>Method</MemberType>
  544. <AssemblyInfo>
  545. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  546. </AssemblyInfo>
  547. <ReturnValue>
  548. <ReturnType>System.Int32</ReturnType>
  549. </ReturnValue>
  550. <Parameters>
  551. <Parameter Name="name" Type="System.String" />
  552. </Parameters>
  553. <Docs>
  554. <param name="name">To be added.</param>
  555. <summary>
  556. Return scancode from key name.
  557. </summary>
  558. <returns>To be added.</returns>
  559. <remarks>To be added.</remarks>
  560. </Docs>
  561. </Member>
  562. <Member MemberName="GetScancodeName">
  563. <MemberSignature Language="C#" Value="public string GetScancodeName (int scancode);" />
  564. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetScancodeName(int32 scancode) cil managed" />
  565. <MemberType>Method</MemberType>
  566. <AssemblyInfo>
  567. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  568. </AssemblyInfo>
  569. <ReturnValue>
  570. <ReturnType>System.String</ReturnType>
  571. </ReturnValue>
  572. <Parameters>
  573. <Parameter Name="scancode" Type="System.Int32" />
  574. </Parameters>
  575. <Docs>
  576. <param name="scancode">To be added.</param>
  577. <summary>
  578. Return name of key from scancode.
  579. </summary>
  580. <returns>To be added.</returns>
  581. <remarks>To be added.</remarks>
  582. </Docs>
  583. </Member>
  584. <Member MemberName="GetScancodePress">
  585. <MemberSignature Language="C#" Value="public bool GetScancodePress (int scancode);" />
  586. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetScancodePress(int32 scancode) cil managed" />
  587. <MemberType>Method</MemberType>
  588. <AssemblyInfo>
  589. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  590. </AssemblyInfo>
  591. <ReturnValue>
  592. <ReturnType>System.Boolean</ReturnType>
  593. </ReturnValue>
  594. <Parameters>
  595. <Parameter Name="scancode" Type="System.Int32" />
  596. </Parameters>
  597. <Docs>
  598. <param name="scancode">To be added.</param>
  599. <summary>
  600. Check if a key has been pressed on this frame by scancode.
  601. </summary>
  602. <returns>To be added.</returns>
  603. <remarks>To be added.</remarks>
  604. </Docs>
  605. </Member>
  606. <Member MemberName="GetTouch">
  607. <MemberSignature Language="C#" Value="public Urho.TouchState GetTouch (uint index);" />
  608. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.TouchState GetTouch(unsigned int32 index) cil managed" />
  609. <MemberType>Method</MemberType>
  610. <AssemblyInfo>
  611. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  612. </AssemblyInfo>
  613. <ReturnValue>
  614. <ReturnType>Urho.TouchState</ReturnType>
  615. </ReturnValue>
  616. <Parameters>
  617. <Parameter Name="index" Type="System.UInt32" />
  618. </Parameters>
  619. <Docs>
  620. <param name="index">To be added.</param>
  621. <summary>
  622. Return active finger touch by index.
  623. </summary>
  624. <returns>To be added.</returns>
  625. <remarks>To be added.</remarks>
  626. </Docs>
  627. </Member>
  628. <Member MemberName="HasFocus">
  629. <MemberSignature Language="C#" Value="public bool HasFocus ();" />
  630. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasFocus() cil managed" />
  631. <MemberType>Method</MemberType>
  632. <AssemblyInfo>
  633. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  634. </AssemblyInfo>
  635. <ReturnValue>
  636. <ReturnType>System.Boolean</ReturnType>
  637. </ReturnValue>
  638. <Parameters />
  639. <Docs>
  640. <summary>
  641. Return whether application window has input focus.
  642. </summary>
  643. <returns>To be added.</returns>
  644. <remarks>To be added.</remarks>
  645. </Docs>
  646. </Member>
  647. <Member MemberName="IsMinimized">
  648. <MemberSignature Language="C#" Value="public bool IsMinimized ();" />
  649. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsMinimized() cil managed" />
  650. <MemberType>Method</MemberType>
  651. <AssemblyInfo>
  652. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  653. </AssemblyInfo>
  654. <ReturnValue>
  655. <ReturnType>System.Boolean</ReturnType>
  656. </ReturnValue>
  657. <Parameters />
  658. <Docs>
  659. <summary>
  660. Return whether application window is minimized.
  661. </summary>
  662. <returns>To be added.</returns>
  663. <remarks>To be added.</remarks>
  664. </Docs>
  665. </Member>
  666. <Member MemberName="IsMouseGrabbed">
  667. <MemberSignature Language="C#" Value="public bool IsMouseGrabbed ();" />
  668. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsMouseGrabbed() cil managed" />
  669. <MemberType>Method</MemberType>
  670. <AssemblyInfo>
  671. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  672. </AssemblyInfo>
  673. <ReturnValue>
  674. <ReturnType>System.Boolean</ReturnType>
  675. </ReturnValue>
  676. <Parameters />
  677. <Docs>
  678. <summary>
  679. Return whether the mouse is currently being grabbed by an operation.
  680. </summary>
  681. <returns>To be added.</returns>
  682. <remarks>To be added.</remarks>
  683. </Docs>
  684. </Member>
  685. <Member MemberName="IsMouseVisible">
  686. <MemberSignature Language="C#" Value="public bool IsMouseVisible ();" />
  687. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsMouseVisible() cil managed" />
  688. <MemberType>Method</MemberType>
  689. <AssemblyInfo>
  690. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  691. </AssemblyInfo>
  692. <ReturnValue>
  693. <ReturnType>System.Boolean</ReturnType>
  694. </ReturnValue>
  695. <Parameters />
  696. <Docs>
  697. <summary>
  698. Return whether the operating system mouse cursor is visible.
  699. </summary>
  700. <returns>To be added.</returns>
  701. <remarks>To be added.</remarks>
  702. </Docs>
  703. </Member>
  704. <Member MemberName="IsScreenJoystickVisible">
  705. <MemberSignature Language="C#" Value="public bool IsScreenJoystickVisible (int id);" />
  706. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsScreenJoystickVisible(int32 id) cil managed" />
  707. <MemberType>Method</MemberType>
  708. <AssemblyInfo>
  709. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  710. </AssemblyInfo>
  711. <ReturnValue>
  712. <ReturnType>System.Boolean</ReturnType>
  713. </ReturnValue>
  714. <Parameters>
  715. <Parameter Name="id" Type="System.Int32" />
  716. </Parameters>
  717. <Docs>
  718. <param name="id">To be added.</param>
  719. <summary>
  720. Return whether a virtual joystick is visible.
  721. </summary>
  722. <returns>To be added.</returns>
  723. <remarks>To be added.</remarks>
  724. </Docs>
  725. </Member>
  726. <Member MemberName="IsScreenKeyboardVisible">
  727. <MemberSignature Language="C#" Value="public bool IsScreenKeyboardVisible ();" />
  728. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsScreenKeyboardVisible() cil managed" />
  729. <MemberType>Method</MemberType>
  730. <AssemblyInfo>
  731. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  732. </AssemblyInfo>
  733. <ReturnValue>
  734. <ReturnType>System.Boolean</ReturnType>
  735. </ReturnValue>
  736. <Parameters />
  737. <Docs>
  738. <summary>
  739. Return whether on-screen keyboard is being shown.
  740. </summary>
  741. <returns>To be added.</returns>
  742. <remarks>To be added.</remarks>
  743. </Docs>
  744. </Member>
  745. <Member MemberName="MouseMode">
  746. <MemberSignature Language="C#" Value="public Urho.MouseMode MouseMode { get; set; }" />
  747. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.MouseMode MouseMode" />
  748. <MemberType>Property</MemberType>
  749. <AssemblyInfo>
  750. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  751. </AssemblyInfo>
  752. <ReturnValue>
  753. <ReturnType>Urho.MouseMode</ReturnType>
  754. </ReturnValue>
  755. <Docs>
  756. <summary>
  757. Return the mouse mode.
  758. Or
  759. Set the mouse mode. </summary>
  760. <value>
  761. <para />
  762. </value>
  763. <remarks>
  764. <para>See the <see cref="T:Urho.MouseMode" /> enumeration for detais on the meaning of the MouseMode.</para>
  765. </remarks>
  766. </Docs>
  767. </Member>
  768. <Member MemberName="MouseMove">
  769. <MemberSignature Language="C#" Value="public Urho.IntVector2 MouseMove { get; }" />
  770. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.IntVector2 MouseMove" />
  771. <MemberType>Property</MemberType>
  772. <AssemblyInfo>
  773. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  774. </AssemblyInfo>
  775. <ReturnValue>
  776. <ReturnType>Urho.IntVector2</ReturnType>
  777. </ReturnValue>
  778. <Docs>
  779. <summary>
  780. Return mouse movement since last frame.
  781. </summary>
  782. <value>To be added.</value>
  783. <remarks>To be added.</remarks>
  784. </Docs>
  785. </Member>
  786. <Member MemberName="MouseMoveWheel">
  787. <MemberSignature Language="C#" Value="public int MouseMoveWheel { get; }" />
  788. <MemberSignature Language="ILAsm" Value=".property instance int32 MouseMoveWheel" />
  789. <MemberType>Property</MemberType>
  790. <AssemblyInfo>
  791. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  792. </AssemblyInfo>
  793. <ReturnValue>
  794. <ReturnType>System.Int32</ReturnType>
  795. </ReturnValue>
  796. <Docs>
  797. <summary>
  798. Return mouse wheel movement since last frame.
  799. </summary>
  800. <value>To be added.</value>
  801. <remarks>To be added.</remarks>
  802. </Docs>
  803. </Member>
  804. <Member MemberName="MouseMoveX">
  805. <MemberSignature Language="C#" Value="public int MouseMoveX { get; }" />
  806. <MemberSignature Language="ILAsm" Value=".property instance int32 MouseMoveX" />
  807. <MemberType>Property</MemberType>
  808. <AssemblyInfo>
  809. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  810. </AssemblyInfo>
  811. <ReturnValue>
  812. <ReturnType>System.Int32</ReturnType>
  813. </ReturnValue>
  814. <Docs>
  815. <summary>
  816. Return horizontal mouse movement since last frame.
  817. </summary>
  818. <value>To be added.</value>
  819. <remarks>To be added.</remarks>
  820. </Docs>
  821. </Member>
  822. <Member MemberName="MouseMoveY">
  823. <MemberSignature Language="C#" Value="public int MouseMoveY { get; }" />
  824. <MemberSignature Language="ILAsm" Value=".property instance int32 MouseMoveY" />
  825. <MemberType>Property</MemberType>
  826. <AssemblyInfo>
  827. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  828. </AssemblyInfo>
  829. <ReturnValue>
  830. <ReturnType>System.Int32</ReturnType>
  831. </ReturnValue>
  832. <Docs>
  833. <summary>
  834. Return vertical mouse movement since last frame.
  835. </summary>
  836. <value>To be added.</value>
  837. <remarks>To be added.</remarks>
  838. </Docs>
  839. </Member>
  840. <Member MemberName="MousePosition">
  841. <MemberSignature Language="C#" Value="public Urho.IntVector2 MousePosition { get; }" />
  842. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.IntVector2 MousePosition" />
  843. <MemberType>Property</MemberType>
  844. <AssemblyInfo>
  845. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  846. </AssemblyInfo>
  847. <ReturnValue>
  848. <ReturnType>Urho.IntVector2</ReturnType>
  849. </ReturnValue>
  850. <Docs>
  851. <summary>
  852. Return mouse position within window. Should only be used with a visible mouse cursor.
  853. </summary>
  854. <value>To be added.</value>
  855. <remarks>To be added.</remarks>
  856. </Docs>
  857. </Member>
  858. <Member MemberName="NumJoysticks">
  859. <MemberSignature Language="C#" Value="public uint NumJoysticks { get; }" />
  860. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumJoysticks" />
  861. <MemberType>Property</MemberType>
  862. <AssemblyInfo>
  863. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  864. </AssemblyInfo>
  865. <ReturnValue>
  866. <ReturnType>System.UInt32</ReturnType>
  867. </ReturnValue>
  868. <Docs>
  869. <summary>
  870. Return number of connected joysticks.
  871. </summary>
  872. <value>To be added.</value>
  873. <remarks>To be added.</remarks>
  874. </Docs>
  875. </Member>
  876. <Member MemberName="NumTouches">
  877. <MemberSignature Language="C#" Value="public uint NumTouches { get; }" />
  878. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumTouches" />
  879. <MemberType>Property</MemberType>
  880. <AssemblyInfo>
  881. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  882. </AssemblyInfo>
  883. <ReturnValue>
  884. <ReturnType>System.UInt32</ReturnType>
  885. </ReturnValue>
  886. <Docs>
  887. <summary>
  888. Return number of active finger touches.
  889. </summary>
  890. <value>To be added.</value>
  891. <remarks>To be added.</remarks>
  892. </Docs>
  893. </Member>
  894. <Member MemberName="Qualifiers">
  895. <MemberSignature Language="C#" Value="public int Qualifiers { get; }" />
  896. <MemberSignature Language="ILAsm" Value=".property instance int32 Qualifiers" />
  897. <MemberType>Property</MemberType>
  898. <AssemblyInfo>
  899. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  900. </AssemblyInfo>
  901. <ReturnValue>
  902. <ReturnType>System.Int32</ReturnType>
  903. </ReturnValue>
  904. <Docs>
  905. <summary>
  906. Return the currently held down qualifiers.
  907. </summary>
  908. <value>To be added.</value>
  909. <remarks>To be added.</remarks>
  910. </Docs>
  911. </Member>
  912. <Member MemberName="RecordGesture">
  913. <MemberSignature Language="C#" Value="public bool RecordGesture ();" />
  914. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool RecordGesture() cil managed" />
  915. <MemberType>Method</MemberType>
  916. <AssemblyInfo>
  917. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  918. </AssemblyInfo>
  919. <ReturnValue>
  920. <ReturnType>System.Boolean</ReturnType>
  921. </ReturnValue>
  922. <Parameters />
  923. <Docs>
  924. <summary>
  925. Begin recording a touch gesture. Return true if successful. The E_GESTURERECORDED event (which contains the ID for the new gesture) will be sent when recording finishes.
  926. </summary>
  927. <returns>To be added.</returns>
  928. <remarks>To be added.</remarks>
  929. </Docs>
  930. </Member>
  931. <Member MemberName="RemoveAllGestures">
  932. <MemberSignature Language="C#" Value="public void RemoveAllGestures ();" />
  933. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveAllGestures() cil managed" />
  934. <MemberType>Method</MemberType>
  935. <AssemblyInfo>
  936. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  937. </AssemblyInfo>
  938. <ReturnValue>
  939. <ReturnType>System.Void</ReturnType>
  940. </ReturnValue>
  941. <Parameters />
  942. <Docs>
  943. <summary>
  944. Remove all in-memory gestures.
  945. </summary>
  946. <remarks>To be added.</remarks>
  947. </Docs>
  948. </Member>
  949. <Member MemberName="RemoveGesture">
  950. <MemberSignature Language="C#" Value="public bool RemoveGesture (uint gestureID);" />
  951. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool RemoveGesture(unsigned int32 gestureID) cil managed" />
  952. <MemberType>Method</MemberType>
  953. <AssemblyInfo>
  954. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  955. </AssemblyInfo>
  956. <ReturnValue>
  957. <ReturnType>System.Boolean</ReturnType>
  958. </ReturnValue>
  959. <Parameters>
  960. <Parameter Name="gestureID" Type="System.UInt32" />
  961. </Parameters>
  962. <Docs>
  963. <param name="gestureID">To be added.</param>
  964. <summary>
  965. Remove an in-memory gesture by ID. Return true if was found.
  966. </summary>
  967. <returns>To be added.</returns>
  968. <remarks>To be added.</remarks>
  969. </Docs>
  970. </Member>
  971. <Member MemberName="RemoveScreenJoystick">
  972. <MemberSignature Language="C#" Value="public bool RemoveScreenJoystick (int id);" />
  973. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool RemoveScreenJoystick(int32 id) cil managed" />
  974. <MemberType>Method</MemberType>
  975. <AssemblyInfo>
  976. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  977. </AssemblyInfo>
  978. <ReturnValue>
  979. <ReturnType>System.Boolean</ReturnType>
  980. </ReturnValue>
  981. <Parameters>
  982. <Parameter Name="id" Type="System.Int32" />
  983. </Parameters>
  984. <Docs>
  985. <param name="id">To be added.</param>
  986. <summary>
  987. Remove screen joystick by instance ID.
  988. Return true if successful.
  989. This method should only be called in main thread.
  990. </summary>
  991. <returns>To be added.</returns>
  992. <remarks>To be added.</remarks>
  993. </Docs>
  994. </Member>
  995. <Member MemberName="ResetMouseVisible">
  996. <MemberSignature Language="C#" Value="public void ResetMouseVisible ();" />
  997. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResetMouseVisible() cil managed" />
  998. <MemberType>Method</MemberType>
  999. <AssemblyInfo>
  1000. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1001. </AssemblyInfo>
  1002. <ReturnValue>
  1003. <ReturnType>System.Void</ReturnType>
  1004. </ReturnValue>
  1005. <Parameters />
  1006. <Docs>
  1007. <summary>
  1008. Reset last mouse visibility that was not suppressed in SetMouseVisible.
  1009. </summary>
  1010. <remarks>To be added.</remarks>
  1011. </Docs>
  1012. </Member>
  1013. <Member MemberName="ScreenKeyboardSupport">
  1014. <MemberSignature Language="C#" Value="public bool ScreenKeyboardSupport { get; }" />
  1015. <MemberSignature Language="ILAsm" Value=".property instance bool ScreenKeyboardSupport" />
  1016. <MemberType>Property</MemberType>
  1017. <AssemblyInfo>
  1018. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1019. </AssemblyInfo>
  1020. <ReturnValue>
  1021. <ReturnType>System.Boolean</ReturnType>
  1022. </ReturnValue>
  1023. <Docs>
  1024. <summary>
  1025. Return whether on-screen keyboard is supported.
  1026. </summary>
  1027. <value>To be added.</value>
  1028. <remarks>To be added.</remarks>
  1029. </Docs>
  1030. </Member>
  1031. <Member MemberName="SetMouseGrabbed">
  1032. <MemberSignature Language="C#" Value="public void SetMouseGrabbed (bool grab);" />
  1033. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetMouseGrabbed(bool grab) cil managed" />
  1034. <MemberType>Method</MemberType>
  1035. <AssemblyInfo>
  1036. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1037. </AssemblyInfo>
  1038. <ReturnValue>
  1039. <ReturnType>System.Void</ReturnType>
  1040. </ReturnValue>
  1041. <Parameters>
  1042. <Parameter Name="grab" Type="System.Boolean" />
  1043. </Parameters>
  1044. <Docs>
  1045. <param name="grab">To be added.</param>
  1046. <summary>
  1047. Set whether the mouse is currently being grabbed by an operation.
  1048. </summary>
  1049. <remarks>To be added.</remarks>
  1050. </Docs>
  1051. </Member>
  1052. <Member MemberName="SetMouseVisible">
  1053. <MemberSignature Language="C#" Value="public void SetMouseVisible (bool enable, bool suppressEvent);" />
  1054. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetMouseVisible(bool enable, bool suppressEvent) cil managed" />
  1055. <MemberType>Method</MemberType>
  1056. <AssemblyInfo>
  1057. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1058. </AssemblyInfo>
  1059. <ReturnValue>
  1060. <ReturnType>System.Void</ReturnType>
  1061. </ReturnValue>
  1062. <Parameters>
  1063. <Parameter Name="enable" Type="System.Boolean" />
  1064. <Parameter Name="suppressEvent" Type="System.Boolean" />
  1065. </Parameters>
  1066. <Docs>
  1067. <param name="enable">To be added.</param>
  1068. <param name="suppressEvent">To be added.</param>
  1069. <summary>
  1070. Set whether the operating system mouse cursor is visible. When not visible (default), is kept centered to prevent leaving the window. Mouse visibility event can be suppressed-- this also recalls any unsuppressed SetMouseVisible which can be returned by ResetMouseVisible().
  1071. </summary>
  1072. <remarks>To be added.</remarks>
  1073. </Docs>
  1074. </Member>
  1075. <Member MemberName="SetScreenJoystickVisible">
  1076. <MemberSignature Language="C#" Value="public void SetScreenJoystickVisible (int id, bool enable);" />
  1077. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetScreenJoystickVisible(int32 id, bool enable) cil managed" />
  1078. <MemberType>Method</MemberType>
  1079. <AssemblyInfo>
  1080. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1081. </AssemblyInfo>
  1082. <ReturnValue>
  1083. <ReturnType>System.Void</ReturnType>
  1084. </ReturnValue>
  1085. <Parameters>
  1086. <Parameter Name="id" Type="System.Int32" />
  1087. <Parameter Name="enable" Type="System.Boolean" />
  1088. </Parameters>
  1089. <Docs>
  1090. <param name="id">To be added.</param>
  1091. <param name="enable">To be added.</param>
  1092. <summary>
  1093. Set whether the virtual joystick is visible.
  1094. </summary>
  1095. <remarks>To be added.</remarks>
  1096. </Docs>
  1097. </Member>
  1098. <Member MemberName="SetScreenKeyboardVisible">
  1099. <MemberSignature Language="C#" Value="public void SetScreenKeyboardVisible (bool enable);" />
  1100. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetScreenKeyboardVisible(bool enable) cil managed" />
  1101. <MemberType>Method</MemberType>
  1102. <AssemblyInfo>
  1103. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1104. </AssemblyInfo>
  1105. <ReturnValue>
  1106. <ReturnType>System.Void</ReturnType>
  1107. </ReturnValue>
  1108. <Parameters>
  1109. <Parameter Name="enable" Type="System.Boolean" />
  1110. </Parameters>
  1111. <Docs>
  1112. <param name="enable">To be added.</param>
  1113. <summary>
  1114. Show or hide on-screen keyboard on platforms that support it. When shown, keypresses from it are delivered as key events.
  1115. </summary>
  1116. <remarks>To be added.</remarks>
  1117. </Docs>
  1118. </Member>
  1119. <Member MemberName="ToggleFullscreen">
  1120. <MemberSignature Language="C#" Value="public bool ToggleFullscreen { get; set; }" />
  1121. <MemberSignature Language="ILAsm" Value=".property instance bool ToggleFullscreen" />
  1122. <MemberType>Property</MemberType>
  1123. <AssemblyInfo>
  1124. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1125. </AssemblyInfo>
  1126. <ReturnValue>
  1127. <ReturnType>System.Boolean</ReturnType>
  1128. </ReturnValue>
  1129. <Docs>
  1130. <summary>
  1131. Return whether fullscreen toggle is enabled.
  1132. Or
  1133. Set whether ALT-ENTER fullscreen toggle is enabled.
  1134. </summary>
  1135. <value>To be added.</value>
  1136. <remarks>To be added.</remarks>
  1137. </Docs>
  1138. </Member>
  1139. <Member MemberName="TouchEmulation">
  1140. <MemberSignature Language="C#" Value="public bool TouchEmulation { get; set; }" />
  1141. <MemberSignature Language="ILAsm" Value=".property instance bool TouchEmulation" />
  1142. <MemberType>Property</MemberType>
  1143. <AssemblyInfo>
  1144. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1145. </AssemblyInfo>
  1146. <ReturnValue>
  1147. <ReturnType>System.Boolean</ReturnType>
  1148. </ReturnValue>
  1149. <Docs>
  1150. <summary>
  1151. Return whether touch emulation is enabled.
  1152. Or
  1153. Set touch emulation by mouse. Only available on desktop platforms. When enabled, actual mouse events are no longer sent and the mouse cursor is forced visible.
  1154. </summary>
  1155. <value>To be added.</value>
  1156. <remarks>To be added.</remarks>
  1157. </Docs>
  1158. </Member>
  1159. <Member MemberName="TryGetJoystickState">
  1160. <MemberSignature Language="C#" Value="public bool TryGetJoystickState (uint idx, out Urho.JoystickState state);" />
  1161. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetJoystickState(unsigned int32 idx, valuetype Urho.JoystickState state) cil managed" />
  1162. <MemberType>Method</MemberType>
  1163. <AssemblyInfo>
  1164. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1165. </AssemblyInfo>
  1166. <ReturnValue>
  1167. <ReturnType>System.Boolean</ReturnType>
  1168. </ReturnValue>
  1169. <Parameters>
  1170. <Parameter Name="idx" Type="System.UInt32" />
  1171. <Parameter Name="state" Type="Urho.JoystickState&amp;" RefType="out" />
  1172. </Parameters>
  1173. <Docs>
  1174. <param name="idx">To be added.</param>
  1175. <param name="state">To be added.</param>
  1176. <summary>To be added.</summary>
  1177. <returns>To be added.</returns>
  1178. <remarks>To be added.</remarks>
  1179. </Docs>
  1180. </Member>
  1181. <Member MemberName="Type">
  1182. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  1183. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  1184. <MemberType>Property</MemberType>
  1185. <AssemblyInfo>
  1186. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1187. </AssemblyInfo>
  1188. <ReturnValue>
  1189. <ReturnType>Urho.StringHash</ReturnType>
  1190. </ReturnValue>
  1191. <Docs>
  1192. <summary>Urho's type system type.</summary>
  1193. <value>StringHash representing the type for this C# type.</value>
  1194. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  1195. </Docs>
  1196. </Member>
  1197. <Member MemberName="TypeName">
  1198. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  1199. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  1200. <MemberType>Property</MemberType>
  1201. <AssemblyInfo>
  1202. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1203. </AssemblyInfo>
  1204. <ReturnValue>
  1205. <ReturnType>System.String</ReturnType>
  1206. </ReturnValue>
  1207. <Docs>
  1208. <summary>Urho's low-level type name.</summary>
  1209. <value>Stringified low-level type name.</value>
  1210. <remarks></remarks>
  1211. </Docs>
  1212. </Member>
  1213. <Member MemberName="TypeNameStatic">
  1214. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  1215. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  1216. <MemberType>Property</MemberType>
  1217. <AssemblyInfo>
  1218. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1219. </AssemblyInfo>
  1220. <ReturnValue>
  1221. <ReturnType>System.String</ReturnType>
  1222. </ReturnValue>
  1223. <Docs>
  1224. <summary>Urho's low-level type name, accessible as a static method.</summary>
  1225. <value>Stringified low-level type name.</value>
  1226. <remarks></remarks>
  1227. </Docs>
  1228. </Member>
  1229. <Member MemberName="TypeStatic">
  1230. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  1231. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  1232. <MemberType>Property</MemberType>
  1233. <AssemblyInfo>
  1234. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1235. </AssemblyInfo>
  1236. <ReturnValue>
  1237. <ReturnType>Urho.StringHash</ReturnType>
  1238. </ReturnValue>
  1239. <Docs>
  1240. <summary>To be added.</summary>
  1241. <value>To be added.</value>
  1242. <remarks>To be added.</remarks>
  1243. </Docs>
  1244. </Member>
  1245. <Member MemberName="Update">
  1246. <MemberSignature Language="C#" Value="public void Update ();" />
  1247. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Update() cil managed" />
  1248. <MemberType>Method</MemberType>
  1249. <AssemblyInfo>
  1250. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  1251. </AssemblyInfo>
  1252. <ReturnValue>
  1253. <ReturnType>System.Void</ReturnType>
  1254. </ReturnValue>
  1255. <Parameters />
  1256. <Docs>
  1257. <summary>
  1258. Poll for window messages. Called by HandleBeginFrame().
  1259. </summary>
  1260. <remarks>To be added.</remarks>
  1261. </Docs>
  1262. </Member>
  1263. </Members>
  1264. </Type>