Application.xml 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787
  1. <Type Name="Application" FullName="Urho.Application">
  2. <TypeSignature Language="C#" Value="public class Application : Urho.UrhoObject" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Application 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. Base class for creating applications which initialize the Urho3D engine and run a main loop until exited.
  15. </summary>
  16. <remarks>
  17. <para>This is the base class that your application should subclass and provide at implementations for the <see cref="T:Urho.Application.Setup" /> and <see cref="T:Urho.Application.Start" /> methods.  You can use await asynchronous methods from the <see cref="T:Urho.Application.Start" /> methods.</para>
  18. <para></para>
  19. <para>Access to various subsystems in Urho is available through the various properties in this class:</para>
  20. <list type="bullet">
  21. <item>
  22. <term>
  23. <see cref="P:Urho.Application.Audio" />
  24. </term>
  25. </item>
  26. <item>
  27. <term>
  28. <see cref="P:Urho.Application.Console" />
  29. </term>
  30. </item>
  31. <item>
  32. <term>
  33. <see cref="P:Urho.Application.FileSystem" />
  34. <para></para>
  35. </term>
  36. </item>
  37. <item>
  38. <term>
  39. <see cref="P:Urho.Application.Graphics" />
  40. </term>
  41. </item>
  42. <item>
  43. <term>
  44. <see cref="P:Urho.Application.Input" />
  45. </term>
  46. </item>
  47. <item>
  48. <term>
  49. <see cref="P:Urho.Application.Log" />
  50. </term>
  51. </item>
  52. <item>
  53. <term>
  54. <see cref="P:Urho.Application.Network" />
  55. </term>
  56. </item>
  57. <item>
  58. <term>
  59. <see cref="P:Urho.Application.Profiler" />
  60. </term>
  61. </item>
  62. <item>
  63. <term>
  64. <see cref="P:Urho.Application.Renderer" />
  65. </term>
  66. </item>
  67. <item>
  68. <term>
  69. <see cref="P:Urho.Application.ResourceCache" />
  70. </term>
  71. </item>
  72. <item>
  73. <term>
  74. <see cref="P:Urho.Application.Time" />
  75. </term>
  76. </item>
  77. <item>
  78. <term>
  79. <see cref="P:Urho.Application.UI" />
  80. </term>
  81. </item>
  82. </list>
  83. <para>An application is tied to a <see cref="T:Urho.Context" /> which should be passed on the initial constructor.</para>
  84. <para>This shows a minimal application:</para>
  85. <para></para>
  86. <example>
  87. <code lang="C#"><![CDATA[public class HelloWorld : Application
  88. {
  89. public HelloWorld(Context c) : base(c) { }
  90. public override void Start()
  91. {
  92. var cache = ResourceCache;
  93. var helloText = new Text(Context) {
  94. Value = "Hello World from UrhoSharp",
  95. HorizontalAlignment = HorizontalAlignment.Center,
  96. VerticalAlignment = VerticalAlignment.Center
  97. };
  98. helloText.SetColor (new Color(0f, 1f, 0f));
  99. helloText.SetFont (font: cache.GetFont("Fonts/Anonymous Pro.ttf"), size: 30);
  100. UI.Root.AddChild (helloText);
  101. Graphics.SetWindowIcon(cache.GetImage("Textures/UrhoIcon.png"));
  102. Graphics.WindowTitle = "UrhoSharp Sample";
  103. // Subscribe to Esc key:
  104. SubscribeToKeyDown(args => { if (args.Key == Key.Esc) Engine.Exit(); });
  105. }
  106. }]]></code>
  107. </example>
  108. </remarks>
  109. </Docs>
  110. <Members>
  111. <Member MemberName=".ctor">
  112. <MemberSignature Language="C#" Value="public Application (IntPtr handle);" />
  113. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  114. <MemberType>Constructor</MemberType>
  115. <AssemblyInfo>
  116. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  117. </AssemblyInfo>
  118. <Parameters>
  119. <Parameter Name="handle" Type="System.IntPtr" />
  120. </Parameters>
  121. <Docs>
  122. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  123. <summary>Constructs a new instance of Application, given a raw pointer to an unmanaged object</summary>
  124. <remarks>
  125. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  126. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  127. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  128. </remarks>
  129. </Docs>
  130. </Member>
  131. <Member MemberName=".ctor">
  132. <MemberSignature Language="C#" Value="public Application (Urho.UrhoObjectFlag emptyFlag);" />
  133. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  134. <MemberType>Constructor</MemberType>
  135. <AssemblyInfo>
  136. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  137. </AssemblyInfo>
  138. <Parameters>
  139. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  140. </Parameters>
  141. <Docs>
  142. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  143. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  144. <remarks>
  145. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  146. <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>
  147. <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>
  148. </remarks>
  149. </Docs>
  150. </Member>
  151. <Member MemberName=".ctor">
  152. <MemberSignature Language="C#" Value="public Application (Urho.Context context, Urho.ApplicationOptions options = null);" />
  153. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context, class Urho.ApplicationOptions options) cil managed" />
  154. <MemberType>Constructor</MemberType>
  155. <AssemblyInfo>
  156. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  157. </AssemblyInfo>
  158. <Parameters>
  159. <Parameter Name="context" Type="Urho.Context" />
  160. <Parameter Name="options" Type="Urho.ApplicationOptions" />
  161. </Parameters>
  162. <Docs>
  163. <param name="context">The context that this object will be attached to.</param>
  164. <param name="options">To be added.</param>
  165. <summary>Creates an instance of Application that is attached to an execution context.</summary>
  166. <remarks>
  167. <para>This creates an instance of Application attached to the specified execution context.</para>
  168. </remarks>
  169. </Docs>
  170. </Member>
  171. <Member MemberName="Audio">
  172. <MemberSignature Language="C#" Value="public Urho.Audio Audio { get; }" />
  173. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Audio Audio" />
  174. <MemberType>Property</MemberType>
  175. <AssemblyInfo>
  176. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  177. </AssemblyInfo>
  178. <ReturnValue>
  179. <ReturnType>Urho.Audio</ReturnType>
  180. </ReturnValue>
  181. <Docs>
  182. <summary>Returns the Audio subsystem.</summary>
  183. <value>
  184. <para />
  185. </value>
  186. <remarks>See the <see cref="T:Urho.Audio" /> class description for more information on how to use the Audio subsystem.</remarks>
  187. </Docs>
  188. </Member>
  189. <Member MemberName="BaseType">
  190. <MemberSignature Language="C#" Value="public override Urho.StringHash BaseType { get; }" />
  191. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash BaseType" />
  192. <MemberType>Property</MemberType>
  193. <AssemblyInfo>
  194. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  195. </AssemblyInfo>
  196. <ReturnValue>
  197. <ReturnType>Urho.StringHash</ReturnType>
  198. </ReturnValue>
  199. <Docs>
  200. <summary>Urho's type system base type.</summary>
  201. <value>StringHash representing the base type for this Urho type.</value>
  202. <remarks>This returns the Urho type system base type and is surfaced for low-level Urho code.</remarks>
  203. </Docs>
  204. </Member>
  205. <Member MemberName="Console">
  206. <MemberSignature Language="C#" Value="public Urho.UrhoConsole Console { get; }" />
  207. <MemberSignature Language="ILAsm" Value=".property instance class Urho.UrhoConsole Console" />
  208. <MemberType>Property</MemberType>
  209. <AssemblyInfo>
  210. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  211. </AssemblyInfo>
  212. <ReturnValue>
  213. <ReturnType>Urho.UrhoConsole</ReturnType>
  214. </ReturnValue>
  215. <Docs>
  216. <summary>Returns the Console subsystem</summary>
  217. <value>To be added.</value>
  218. <remarks>To be added.</remarks>
  219. </Docs>
  220. </Member>
  221. <Member MemberName="CreateInstance">
  222. <MemberSignature Language="C#" Value="public static Urho.Application CreateInstance (Type applicationType, Urho.Context context = null);" />
  223. <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Urho.Application CreateInstance(class System.Type applicationType, class Urho.Context context) cil managed" />
  224. <MemberType>Method</MemberType>
  225. <AssemblyInfo>
  226. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  227. </AssemblyInfo>
  228. <ReturnValue>
  229. <ReturnType>Urho.Application</ReturnType>
  230. </ReturnValue>
  231. <Parameters>
  232. <Parameter Name="applicationType" Type="System.Type" />
  233. <Parameter Name="context" Type="Urho.Context" />
  234. </Parameters>
  235. <Docs>
  236. <param name="applicationType">To be added.</param>
  237. <param name="context">To be added.</param>
  238. <summary>To be added.</summary>
  239. <returns>To be added.</returns>
  240. <remarks>To be added.</remarks>
  241. </Docs>
  242. </Member>
  243. <Member MemberName="CreateInstance&lt;T&gt;">
  244. <MemberSignature Language="C#" Value="public static T CreateInstance&lt;T&gt; (Urho.Context context = null) where T : Urho.Application;" />
  245. <MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T CreateInstance&lt;(class Urho.Application) T&gt;(class Urho.Context context) cil managed" />
  246. <MemberType>Method</MemberType>
  247. <AssemblyInfo>
  248. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  249. </AssemblyInfo>
  250. <ReturnValue>
  251. <ReturnType>T</ReturnType>
  252. </ReturnValue>
  253. <TypeParameters>
  254. <TypeParameter Name="T">
  255. <Constraints>
  256. <BaseTypeName>Urho.Application</BaseTypeName>
  257. </Constraints>
  258. </TypeParameter>
  259. </TypeParameters>
  260. <Parameters>
  261. <Parameter Name="context" Type="Urho.Context" />
  262. </Parameters>
  263. <Docs>
  264. <typeparam name="T">To be added.</typeparam>
  265. <param name="context">To be added.</param>
  266. <summary>To be added.</summary>
  267. <returns>To be added.</returns>
  268. <remarks>To be added.</remarks>
  269. </Docs>
  270. </Member>
  271. <Member MemberName="Current">
  272. <MemberSignature Language="C#" Value="public static Urho.Application Current { get; }" />
  273. <MemberSignature Language="ILAsm" Value=".property class Urho.Application Current" />
  274. <MemberType>Property</MemberType>
  275. <AssemblyInfo>
  276. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  277. </AssemblyInfo>
  278. <ReturnValue>
  279. <ReturnType>Urho.Application</ReturnType>
  280. </ReturnValue>
  281. <Docs>
  282. <summary>
  283. Last created application.</summary>
  284. <value>To be added.</value>
  285. <remarks>To be added.</remarks>
  286. </Docs>
  287. </Member>
  288. <Member MemberName="Delay">
  289. <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task Delay (float durationMs);" />
  290. <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task Delay(float32 durationMs) cil managed" />
  291. <MemberType>Method</MemberType>
  292. <AssemblyInfo>
  293. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  294. </AssemblyInfo>
  295. <ReturnValue>
  296. <ReturnType>System.Threading.Tasks.Task</ReturnType>
  297. </ReturnValue>
  298. <Parameters>
  299. <Parameter Name="durationMs" Type="System.Single" />
  300. </Parameters>
  301. <Docs>
  302. <param name="durationMs">Duration in millyseconds</param>
  303. <summary>
  304. Waits given game time.
  305. </summary>
  306. <returns>To be added.</returns>
  307. <remarks>To be added.</remarks>
  308. </Docs>
  309. </Member>
  310. <Member MemberName="Engine">
  311. <MemberSignature Language="C#" Value="public Urho.Engine Engine { get; }" />
  312. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Engine Engine" />
  313. <MemberType>Property</MemberType>
  314. <AssemblyInfo>
  315. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  316. </AssemblyInfo>
  317. <ReturnValue>
  318. <ReturnType>Urho.Engine</ReturnType>
  319. </ReturnValue>
  320. <Docs>
  321. <summary>Returns the application’s engine.</summary>
  322. <value>To be added.</value>
  323. <remarks>To be added.</remarks>
  324. </Docs>
  325. </Member>
  326. <Member MemberName="EngineInited">
  327. <MemberSignature Language="C#" Value="public static bool EngineInited { get; set; }" />
  328. <MemberSignature Language="ILAsm" Value=".property bool EngineInited" />
  329. <MemberType>Property</MemberType>
  330. <AssemblyInfo>
  331. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  332. </AssemblyInfo>
  333. <ReturnValue>
  334. <ReturnType>System.Boolean</ReturnType>
  335. </ReturnValue>
  336. <Docs>
  337. <summary>
  338. Call UrhoEngine.Init() to initialize the engine
  339. </summary>
  340. <value>To be added.</value>
  341. <remarks>To be added.</remarks>
  342. </Docs>
  343. </Member>
  344. <Member MemberName="ErrorExit">
  345. <MemberSignature Language="C#" Value="public void ErrorExit (string message);" />
  346. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ErrorExit(string message) cil managed" />
  347. <MemberType>Method</MemberType>
  348. <AssemblyInfo>
  349. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  350. </AssemblyInfo>
  351. <ReturnValue>
  352. <ReturnType>System.Void</ReturnType>
  353. </ReturnValue>
  354. <Parameters>
  355. <Parameter Name="message" Type="System.String" />
  356. </Parameters>
  357. <Docs>
  358. <param name="message">To be added.</param>
  359. <summary>
  360. Show an error message (last log message if empty), terminate the main loop, and set failure exit code.
  361. </summary>
  362. <remarks>To be added.</remarks>
  363. </Docs>
  364. </Member>
  365. <Member MemberName="FileSystem">
  366. <MemberSignature Language="C#" Value="public Urho.FileSystem FileSystem { get; }" />
  367. <MemberSignature Language="ILAsm" Value=".property instance class Urho.FileSystem FileSystem" />
  368. <MemberType>Property</MemberType>
  369. <AssemblyInfo>
  370. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  371. </AssemblyInfo>
  372. <ReturnValue>
  373. <ReturnType>Urho.FileSystem</ReturnType>
  374. </ReturnValue>
  375. <Docs>
  376. <summary>Returns the FileSystem subsystem.</summary>
  377. <value>To be added.</value>
  378. <remarks>To be added.</remarks>
  379. </Docs>
  380. </Member>
  381. <Member MemberName="GetApp">
  382. <MemberSignature Language="C#" Value="public static Urho.Application GetApp (IntPtr h);" />
  383. <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Urho.Application GetApp(native int h) cil managed" />
  384. <MemberType>Method</MemberType>
  385. <AssemblyInfo>
  386. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  387. </AssemblyInfo>
  388. <ReturnValue>
  389. <ReturnType>Urho.Application</ReturnType>
  390. </ReturnValue>
  391. <Parameters>
  392. <Parameter Name="h" Type="System.IntPtr" />
  393. </Parameters>
  394. <Docs>
  395. <param name="h">To be added.</param>
  396. <summary>To be added.</summary>
  397. <returns>To be added.</returns>
  398. <remarks>To be added.</remarks>
  399. </Docs>
  400. </Member>
  401. <Member MemberName="Graphics">
  402. <MemberSignature Language="C#" Value="public Urho.Graphics Graphics { get; }" />
  403. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Graphics Graphics" />
  404. <MemberType>Property</MemberType>
  405. <AssemblyInfo>
  406. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  407. </AssemblyInfo>
  408. <ReturnValue>
  409. <ReturnType>Urho.Graphics</ReturnType>
  410. </ReturnValue>
  411. <Docs>
  412. <summary>Returns the Graphics subsystem.</summary>
  413. <value>To be added.</value>
  414. <remarks>To be added.</remarks>
  415. </Docs>
  416. </Member>
  417. <Member MemberName="Input">
  418. <MemberSignature Language="C#" Value="public Urho.Input Input { get; }" />
  419. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Input Input" />
  420. <MemberType>Property</MemberType>
  421. <AssemblyInfo>
  422. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  423. </AssemblyInfo>
  424. <ReturnValue>
  425. <ReturnType>Urho.Input</ReturnType>
  426. </ReturnValue>
  427. <Docs>
  428. <summary>Returns the Input subsystem.</summary>
  429. <value>To be added.</value>
  430. <remarks>To be added.</remarks>
  431. </Docs>
  432. </Member>
  433. <Member MemberName="InvokeOnMain">
  434. <MemberSignature Language="C#" Value="public static void InvokeOnMain (Action action);" />
  435. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void InvokeOnMain(class System.Action action) cil managed" />
  436. <MemberType>Method</MemberType>
  437. <AssemblyInfo>
  438. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  439. </AssemblyInfo>
  440. <ReturnValue>
  441. <ReturnType>System.Void</ReturnType>
  442. </ReturnValue>
  443. <Parameters>
  444. <Parameter Name="action" Type="System.Action" />
  445. </Parameters>
  446. <Docs>
  447. <param name="action">To be added.</param>
  448. <summary>
  449. Invoke actions in the Main Thread (the next Update call)
  450. </summary>
  451. <remarks>To be added.</remarks>
  452. </Docs>
  453. </Member>
  454. <Member MemberName="Log">
  455. <MemberSignature Language="C#" Value="public Urho.Log Log { get; }" />
  456. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Log Log" />
  457. <MemberType>Property</MemberType>
  458. <AssemblyInfo>
  459. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  460. </AssemblyInfo>
  461. <ReturnValue>
  462. <ReturnType>Urho.Log</ReturnType>
  463. </ReturnValue>
  464. <Docs>
  465. <summary>Returns the Log subsystem.</summary>
  466. <value>To be added.</value>
  467. <remarks>To be added.</remarks>
  468. </Docs>
  469. </Member>
  470. <Member MemberName="Network">
  471. <MemberSignature Language="C#" Value="public Urho.Network Network { get; }" />
  472. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Network Network" />
  473. <MemberType>Property</MemberType>
  474. <AssemblyInfo>
  475. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  476. </AssemblyInfo>
  477. <ReturnValue>
  478. <ReturnType>Urho.Network</ReturnType>
  479. </ReturnValue>
  480. <Docs>
  481. <summary>Returns the Network subsystem.</summary>
  482. <value>To be added.</value>
  483. <remarks>To be added.</remarks>
  484. </Docs>
  485. </Member>
  486. <Member MemberName="OnSceneUpdate">
  487. <MemberSignature Language="C#" Value="protected virtual void OnSceneUpdate (float timeStep, Urho.Scene scene);" />
  488. <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnSceneUpdate(float32 timeStep, class Urho.Scene scene) cil managed" />
  489. <MemberType>Method</MemberType>
  490. <AssemblyInfo>
  491. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  492. </AssemblyInfo>
  493. <ReturnValue>
  494. <ReturnType>System.Void</ReturnType>
  495. </ReturnValue>
  496. <Parameters>
  497. <Parameter Name="timeStep" Type="System.Single" />
  498. <Parameter Name="scene" Type="Urho.Scene" />
  499. </Parameters>
  500. <Docs>
  501. <param name="timeStep">To be added.</param>
  502. <param name="scene">To be added.</param>
  503. <summary>This method is invoked on each scene update.</summary>
  504. <remarks>To be added.</remarks>
  505. </Docs>
  506. </Member>
  507. <Member MemberName="OnUpdate">
  508. <MemberSignature Language="C#" Value="protected virtual void OnUpdate (float timeStep);" />
  509. <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnUpdate(float32 timeStep) cil managed" />
  510. <MemberType>Method</MemberType>
  511. <AssemblyInfo>
  512. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  513. </AssemblyInfo>
  514. <ReturnValue>
  515. <ReturnType>System.Void</ReturnType>
  516. </ReturnValue>
  517. <Parameters>
  518. <Parameter Name="timeStep" Type="System.Single" />
  519. </Parameters>
  520. <Docs>
  521. <param name="timeStep">To be added.</param>
  522. <summary>This method is invoked on every application update.</summary>
  523. <remarks>To be added.</remarks>
  524. </Docs>
  525. </Member>
  526. <Member MemberName="Profiler">
  527. <MemberSignature Language="C#" Value="public Urho.Profiler Profiler { get; }" />
  528. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Profiler Profiler" />
  529. <MemberType>Property</MemberType>
  530. <AssemblyInfo>
  531. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  532. </AssemblyInfo>
  533. <ReturnValue>
  534. <ReturnType>Urho.Profiler</ReturnType>
  535. </ReturnValue>
  536. <Docs>
  537. <summary>Returns the Profiler subsystem.</summary>
  538. <value>To be added.</value>
  539. <remarks>To be added.</remarks>
  540. </Docs>
  541. </Member>
  542. <Member MemberName="Renderer">
  543. <MemberSignature Language="C#" Value="public Urho.Renderer Renderer { get; }" />
  544. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Renderer Renderer" />
  545. <MemberType>Property</MemberType>
  546. <AssemblyInfo>
  547. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  548. </AssemblyInfo>
  549. <ReturnValue>
  550. <ReturnType>Urho.Renderer</ReturnType>
  551. </ReturnValue>
  552. <Docs>
  553. <summary>Returns the Renderer subsystem.</summary>
  554. <value>To be added.</value>
  555. <remarks>To be added.</remarks>
  556. </Docs>
  557. </Member>
  558. <Member MemberName="ResourceCache">
  559. <MemberSignature Language="C#" Value="public Urho.ResourceCache ResourceCache { get; }" />
  560. <MemberSignature Language="ILAsm" Value=".property instance class Urho.ResourceCache ResourceCache" />
  561. <MemberType>Property</MemberType>
  562. <AssemblyInfo>
  563. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  564. </AssemblyInfo>
  565. <ReturnValue>
  566. <ReturnType>Urho.ResourceCache</ReturnType>
  567. </ReturnValue>
  568. <Docs>
  569. <summary>Returns the ResourceCache subsystem.</summary>
  570. <value>To be added.</value>
  571. <remarks>To be added.</remarks>
  572. </Docs>
  573. </Member>
  574. <Member MemberName="Run">
  575. <MemberSignature Language="C#" Value="public int Run ();" />
  576. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 Run() cil managed" />
  577. <MemberType>Method</MemberType>
  578. <AssemblyInfo>
  579. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  580. </AssemblyInfo>
  581. <ReturnValue>
  582. <ReturnType>System.Int32</ReturnType>
  583. </ReturnValue>
  584. <Parameters />
  585. <Docs>
  586. <summary>
  587. Initialize the engine and run the main loop, then return the application exit code. Catch out-of-memory exceptions while running.
  588. </summary>
  589. <returns>To be added.</returns>
  590. <remarks>To be added.</remarks>
  591. </Docs>
  592. </Member>
  593. <Member MemberName="SceneUpdate">
  594. <MemberSignature Language="C#" Value="public event Action&lt;Urho.SceneUpdateEventArgs&gt; SceneUpdate;" />
  595. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.SceneUpdateEventArgs&gt; SceneUpdate" />
  596. <MemberType>Event</MemberType>
  597. <AssemblyInfo>
  598. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  599. </AssemblyInfo>
  600. <ReturnValue>
  601. <ReturnType>System.Action&lt;Urho.SceneUpdateEventArgs&gt;</ReturnType>
  602. </ReturnValue>
  603. <Docs>
  604. <summary>To be added.</summary>
  605. <remarks>To be added.</remarks>
  606. </Docs>
  607. </Member>
  608. <Member MemberName="Setup">
  609. <MemberSignature Language="C#" Value="public virtual void Setup ();" />
  610. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Setup() cil managed" />
  611. <MemberType>Method</MemberType>
  612. <AssemblyInfo>
  613. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  614. </AssemblyInfo>
  615. <ReturnValue>
  616. <ReturnType>System.Void</ReturnType>
  617. </ReturnValue>
  618. <Parameters />
  619. <Docs>
  620. <summary>Method invoked to setup your application.</summary>
  621. <remarks>To be added.</remarks>
  622. </Docs>
  623. </Member>
  624. <Member MemberName="Start">
  625. <MemberSignature Language="C#" Value="public virtual void Start ();" />
  626. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Start() cil managed" />
  627. <MemberType>Method</MemberType>
  628. <AssemblyInfo>
  629. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  630. </AssemblyInfo>
  631. <ReturnValue>
  632. <ReturnType>System.Void</ReturnType>
  633. </ReturnValue>
  634. <Parameters />
  635. <Docs>
  636. <summary>Method invoked to start your application, this is where you would typically create your scene.</summary>
  637. <remarks>To be added.</remarks>
  638. </Docs>
  639. </Member>
  640. <Member MemberName="Stop">
  641. <MemberSignature Language="C#" Value="public virtual void Stop ();" />
  642. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Stop() cil managed" />
  643. <MemberType>Method</MemberType>
  644. <AssemblyInfo>
  645. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  646. </AssemblyInfo>
  647. <ReturnValue>
  648. <ReturnType>System.Void</ReturnType>
  649. </ReturnValue>
  650. <Parameters />
  651. <Docs>
  652. <summary>Method invoked to terminate your application.</summary>
  653. <remarks>To be added.</remarks>
  654. </Docs>
  655. </Member>
  656. <Member MemberName="Time">
  657. <MemberSignature Language="C#" Value="public Urho.Time Time { get; }" />
  658. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Time Time" />
  659. <MemberType>Property</MemberType>
  660. <AssemblyInfo>
  661. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  662. </AssemblyInfo>
  663. <ReturnValue>
  664. <ReturnType>Urho.Time</ReturnType>
  665. </ReturnValue>
  666. <Docs>
  667. <summary>Returns the Time subsystem.</summary>
  668. <value>To be added.</value>
  669. <remarks>To be added.</remarks>
  670. </Docs>
  671. </Member>
  672. <Member MemberName="Type">
  673. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  674. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  675. <MemberType>Property</MemberType>
  676. <AssemblyInfo>
  677. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  678. </AssemblyInfo>
  679. <ReturnValue>
  680. <ReturnType>Urho.StringHash</ReturnType>
  681. </ReturnValue>
  682. <Docs>
  683. <summary>Urho's type system type.</summary>
  684. <value>StringHash representing the type for this C# type.</value>
  685. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  686. </Docs>
  687. </Member>
  688. <Member MemberName="TypeName">
  689. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  690. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  691. <MemberType>Property</MemberType>
  692. <AssemblyInfo>
  693. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  694. </AssemblyInfo>
  695. <ReturnValue>
  696. <ReturnType>System.String</ReturnType>
  697. </ReturnValue>
  698. <Docs>
  699. <summary>Urho's low-level type name.</summary>
  700. <value>Stringified low-level type name.</value>
  701. <remarks></remarks>
  702. </Docs>
  703. </Member>
  704. <Member MemberName="TypeNameStatic">
  705. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  706. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  707. <MemberType>Property</MemberType>
  708. <AssemblyInfo>
  709. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  710. </AssemblyInfo>
  711. <ReturnValue>
  712. <ReturnType>System.String</ReturnType>
  713. </ReturnValue>
  714. <Docs>
  715. <summary>Urho's low-level type name, accessible as a static method.</summary>
  716. <value>Stringified low-level type name.</value>
  717. <remarks></remarks>
  718. </Docs>
  719. </Member>
  720. <Member MemberName="TypeStatic">
  721. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  722. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  723. <MemberType>Property</MemberType>
  724. <AssemblyInfo>
  725. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  726. </AssemblyInfo>
  727. <ReturnValue>
  728. <ReturnType>Urho.StringHash</ReturnType>
  729. </ReturnValue>
  730. <Docs>
  731. <summary>To be added.</summary>
  732. <value>To be added.</value>
  733. <remarks>To be added.</remarks>
  734. </Docs>
  735. </Member>
  736. <Member MemberName="UI">
  737. <MemberSignature Language="C#" Value="public Urho.UI UI { get; }" />
  738. <MemberSignature Language="ILAsm" Value=".property instance class Urho.UI UI" />
  739. <MemberType>Property</MemberType>
  740. <AssemblyInfo>
  741. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  742. </AssemblyInfo>
  743. <ReturnValue>
  744. <ReturnType>Urho.UI</ReturnType>
  745. </ReturnValue>
  746. <Docs>
  747. <summary>Returns the UI subsystem.</summary>
  748. <value>To be added.</value>
  749. <remarks>To be added.</remarks>
  750. </Docs>
  751. </Member>
  752. <Member MemberName="Update">
  753. <MemberSignature Language="C#" Value="public event Action&lt;Urho.UpdateEventArgs&gt; Update;" />
  754. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.UpdateEventArgs&gt; Update" />
  755. <MemberType>Event</MemberType>
  756. <AssemblyInfo>
  757. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  758. </AssemblyInfo>
  759. <ReturnValue>
  760. <ReturnType>System.Action&lt;Urho.UpdateEventArgs&gt;</ReturnType>
  761. </ReturnValue>
  762. <Docs>
  763. <summary>To be added.</summary>
  764. <remarks>To be added.</remarks>
  765. </Docs>
  766. </Member>
  767. <Member MemberName="WorkQueue">
  768. <MemberSignature Language="C#" Value="public Urho.WorkQueue WorkQueue { get; }" />
  769. <MemberSignature Language="ILAsm" Value=".property instance class Urho.WorkQueue WorkQueue" />
  770. <MemberType>Property</MemberType>
  771. <AssemblyInfo>
  772. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  773. </AssemblyInfo>
  774. <ReturnValue>
  775. <ReturnType>Urho.WorkQueue</ReturnType>
  776. </ReturnValue>
  777. <Docs>
  778. <summary>Returns the WorkQueue subsystem.</summary>
  779. <value>To be added.</value>
  780. <remarks>To be added.</remarks>
  781. </Docs>
  782. </Member>
  783. </Members>
  784. </Type>