Application.xml 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910
  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="M:Urho.Application.Setup" /> and <see cref="M:Urho.Application.Start" /> methods.  You can use await asynchronous methods from the <see cref="M: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 Urho.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.ApplicationOptions options);" />
  133. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.ApplicationOptions options) cil managed" />
  134. <MemberType>Constructor</MemberType>
  135. <AssemblyInfo>
  136. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  137. </AssemblyInfo>
  138. <Parameters>
  139. <Parameter Name="options" Type="Urho.ApplicationOptions" />
  140. </Parameters>
  141. <Docs>
  142. <param name="options">To be added.</param>
  143. <summary>To be added.</summary>
  144. <remarks>To be added.</remarks>
  145. </Docs>
  146. </Member>
  147. <Member MemberName=".ctor">
  148. <MemberSignature Language="C#" Value="protected Application (Urho.UrhoObjectFlag emptyFlag);" />
  149. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  150. <MemberType>Constructor</MemberType>
  151. <AssemblyInfo>
  152. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  153. </AssemblyInfo>
  154. <Parameters>
  155. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  156. </Parameters>
  157. <Docs>
  158. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  159. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  160. <remarks>
  161. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  162. <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>
  163. <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>
  164. </remarks>
  165. </Docs>
  166. </Member>
  167. <Member MemberName="AllowNativeDelete">
  168. <MemberSignature Language="C#" Value="protected override bool AllowNativeDelete { get; }" />
  169. <MemberSignature Language="ILAsm" Value=".property instance bool AllowNativeDelete" />
  170. <MemberType>Property</MemberType>
  171. <AssemblyInfo>
  172. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  173. </AssemblyInfo>
  174. <ReturnValue>
  175. <ReturnType>System.Boolean</ReturnType>
  176. </ReturnValue>
  177. <Docs>
  178. <summary>To be added.</summary>
  179. <value>To be added.</value>
  180. <remarks>To be added.</remarks>
  181. </Docs>
  182. </Member>
  183. <Member MemberName="Audio">
  184. <MemberSignature Language="C#" Value="public Urho.Audio.Audio Audio { get; }" />
  185. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Audio.Audio Audio" />
  186. <MemberType>Property</MemberType>
  187. <AssemblyInfo>
  188. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  189. </AssemblyInfo>
  190. <ReturnValue>
  191. <ReturnType>Urho.Audio.Audio</ReturnType>
  192. </ReturnValue>
  193. <Docs>
  194. <summary>Returns the Audio subsystem.</summary>
  195. <value>
  196. <para />
  197. </value>
  198. <remarks>See the <see cref="T:Urho.Audio.Audio" /> class description for more information on how to use the Audio subsystem.</remarks>
  199. </Docs>
  200. </Member>
  201. <Member MemberName="Console">
  202. <MemberSignature Language="C#" Value="public Urho.UrhoConsole Console { get; }" />
  203. <MemberSignature Language="ILAsm" Value=".property instance class Urho.UrhoConsole Console" />
  204. <MemberType>Property</MemberType>
  205. <AssemblyInfo>
  206. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  207. </AssemblyInfo>
  208. <ReturnValue>
  209. <ReturnType>Urho.UrhoConsole</ReturnType>
  210. </ReturnValue>
  211. <Docs>
  212. <summary>Returns the Console subsystem</summary>
  213. <value>To be added.</value>
  214. <remarks>To be added.</remarks>
  215. </Docs>
  216. </Member>
  217. <Member MemberName="CreateInstance">
  218. <MemberSignature Language="C#" Value="public static Urho.Application CreateInstance (Type applicationType, Urho.ApplicationOptions options = null);" />
  219. <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Urho.Application CreateInstance(class System.Type applicationType, class Urho.ApplicationOptions options) cil managed" />
  220. <MemberType>Method</MemberType>
  221. <AssemblyInfo>
  222. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  223. </AssemblyInfo>
  224. <ReturnValue>
  225. <ReturnType>Urho.Application</ReturnType>
  226. </ReturnValue>
  227. <Parameters>
  228. <Parameter Name="applicationType" Type="System.Type" />
  229. <Parameter Name="options" Type="Urho.ApplicationOptions" />
  230. </Parameters>
  231. <Docs>
  232. <param name="applicationType">To be added.</param>
  233. <param name="options">To be added.</param>
  234. <summary>To be added.</summary>
  235. <returns>To be added.</returns>
  236. <remarks>To be added.</remarks>
  237. </Docs>
  238. </Member>
  239. <Member MemberName="CreateInstance&lt;T&gt;">
  240. <MemberSignature Language="C#" Value="public static T CreateInstance&lt;T&gt; (Urho.ApplicationOptions options = null) where T : Urho.Application;" />
  241. <MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T CreateInstance&lt;(class Urho.Application) T&gt;(class Urho.ApplicationOptions options) cil managed" />
  242. <MemberType>Method</MemberType>
  243. <AssemblyInfo>
  244. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  245. </AssemblyInfo>
  246. <ReturnValue>
  247. <ReturnType>T</ReturnType>
  248. </ReturnValue>
  249. <TypeParameters>
  250. <TypeParameter Name="T">
  251. <Constraints>
  252. <BaseTypeName>Urho.Application</BaseTypeName>
  253. </Constraints>
  254. </TypeParameter>
  255. </TypeParameters>
  256. <Parameters>
  257. <Parameter Name="options" Type="Urho.ApplicationOptions" />
  258. </Parameters>
  259. <Docs>
  260. <typeparam name="T">To be added.</typeparam>
  261. <param name="options">To be added.</param>
  262. <summary>To be added.</summary>
  263. <returns>To be added.</returns>
  264. <remarks>To be added.</remarks>
  265. </Docs>
  266. </Member>
  267. <Member MemberName="Current">
  268. <MemberSignature Language="C#" Value="public static Urho.Application Current { get; }" />
  269. <MemberSignature Language="ILAsm" Value=".property class Urho.Application Current" />
  270. <MemberType>Property</MemberType>
  271. <AssemblyInfo>
  272. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  273. </AssemblyInfo>
  274. <ReturnValue>
  275. <ReturnType>Urho.Application</ReturnType>
  276. </ReturnValue>
  277. <Docs>
  278. <summary>
  279. Last created application.</summary>
  280. <value>To be added.</value>
  281. <remarks>To be added.</remarks>
  282. </Docs>
  283. </Member>
  284. <Member MemberName="CurrentContext">
  285. <MemberSignature Language="C#" Value="public static Urho.Context CurrentContext { get; }" />
  286. <MemberSignature Language="ILAsm" Value=".property class Urho.Context CurrentContext" />
  287. <MemberType>Property</MemberType>
  288. <AssemblyInfo>
  289. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  290. </AssemblyInfo>
  291. <ReturnValue>
  292. <ReturnType>Urho.Context</ReturnType>
  293. </ReturnValue>
  294. <Docs>
  295. <summary>To be added.</summary>
  296. <value>To be added.</value>
  297. <remarks>To be added.</remarks>
  298. </Docs>
  299. </Member>
  300. <Member MemberName="Engine">
  301. <MemberSignature Language="C#" Value="public Urho.Engine Engine { get; }" />
  302. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Engine Engine" />
  303. <MemberType>Property</MemberType>
  304. <AssemblyInfo>
  305. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  306. </AssemblyInfo>
  307. <ReturnValue>
  308. <ReturnType>Urho.Engine</ReturnType>
  309. </ReturnValue>
  310. <Docs>
  311. <summary>Returns the application’s engine.</summary>
  312. <value>To be added.</value>
  313. <remarks>To be added.</remarks>
  314. </Docs>
  315. </Member>
  316. <Member MemberName="ErrorExit">
  317. <MemberSignature Language="C#" Value="public void ErrorExit (string message);" />
  318. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ErrorExit(string message) cil managed" />
  319. <MemberType>Method</MemberType>
  320. <AssemblyInfo>
  321. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  322. </AssemblyInfo>
  323. <ReturnValue>
  324. <ReturnType>System.Void</ReturnType>
  325. </ReturnValue>
  326. <Parameters>
  327. <Parameter Name="message" Type="System.String" />
  328. </Parameters>
  329. <Docs>
  330. <param name="message">To be added.</param>
  331. <summary>
  332. Show an error message (last log message if empty), terminate the main loop, and set failure exit code.
  333. </summary>
  334. <remarks>To be added.</remarks>
  335. </Docs>
  336. </Member>
  337. <Member MemberName="Exit">
  338. <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task Exit ();" />
  339. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task Exit() cil managed" />
  340. <MemberType>Method</MemberType>
  341. <AssemblyInfo>
  342. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  343. </AssemblyInfo>
  344. <ReturnValue>
  345. <ReturnType>System.Threading.Tasks.Task</ReturnType>
  346. </ReturnValue>
  347. <Parameters />
  348. <Docs>
  349. <summary>To be added.</summary>
  350. <returns>To be added.</returns>
  351. <remarks>To be added.</remarks>
  352. </Docs>
  353. </Member>
  354. <Member MemberName="FileSystem">
  355. <MemberSignature Language="C#" Value="public Urho.IO.FileSystem FileSystem { get; }" />
  356. <MemberSignature Language="ILAsm" Value=".property instance class Urho.IO.FileSystem FileSystem" />
  357. <MemberType>Property</MemberType>
  358. <AssemblyInfo>
  359. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  360. </AssemblyInfo>
  361. <ReturnValue>
  362. <ReturnType>Urho.IO.FileSystem</ReturnType>
  363. </ReturnValue>
  364. <Docs>
  365. <summary>Returns the FileSystem subsystem.</summary>
  366. <value>To be added.</value>
  367. <remarks>To be added.</remarks>
  368. </Docs>
  369. </Member>
  370. <Member MemberName="Graphics">
  371. <MemberSignature Language="C#" Value="public Urho.Graphics Graphics { get; }" />
  372. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Graphics Graphics" />
  373. <MemberType>Property</MemberType>
  374. <AssemblyInfo>
  375. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  376. </AssemblyInfo>
  377. <ReturnValue>
  378. <ReturnType>Urho.Graphics</ReturnType>
  379. </ReturnValue>
  380. <Docs>
  381. <summary>Returns the Graphics subsystem.</summary>
  382. <value>To be added.</value>
  383. <remarks>To be added.</remarks>
  384. </Docs>
  385. </Member>
  386. <Member MemberName="Handle">
  387. <MemberSignature Language="C#" Value="public IntPtr Handle { get; }" />
  388. <MemberSignature Language="ILAsm" Value=".property instance native int Handle" />
  389. <MemberType>Property</MemberType>
  390. <AssemblyInfo>
  391. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  392. </AssemblyInfo>
  393. <ReturnValue>
  394. <ReturnType>System.IntPtr</ReturnType>
  395. </ReturnValue>
  396. <Docs>
  397. <summary>To be added.</summary>
  398. <value>To be added.</value>
  399. <remarks>To be added.</remarks>
  400. </Docs>
  401. </Member>
  402. <Member MemberName="HasCurrent">
  403. <MemberSignature Language="C#" Value="public static bool HasCurrent { get; }" />
  404. <MemberSignature Language="ILAsm" Value=".property bool HasCurrent" />
  405. <MemberType>Property</MemberType>
  406. <AssemblyInfo>
  407. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  408. </AssemblyInfo>
  409. <ReturnValue>
  410. <ReturnType>System.Boolean</ReturnType>
  411. </ReturnValue>
  412. <Docs>
  413. <summary>Determines if the Current property has been set.</summary>
  414. <value>
  415. <see langword="true" /> if it has been set, <see langword="false" /> otherwise.</value>
  416. <remarks>
  417. <para />
  418. </remarks>
  419. </Docs>
  420. </Member>
  421. <Member MemberName="Input">
  422. <MemberSignature Language="C#" Value="public Urho.Input Input { get; }" />
  423. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Input Input" />
  424. <MemberType>Property</MemberType>
  425. <AssemblyInfo>
  426. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  427. </AssemblyInfo>
  428. <ReturnValue>
  429. <ReturnType>Urho.Input</ReturnType>
  430. </ReturnValue>
  431. <Docs>
  432. <summary>Returns the Input subsystem.</summary>
  433. <value>To be added.</value>
  434. <remarks>To be added.</remarks>
  435. </Docs>
  436. </Member>
  437. <Member MemberName="InvokeOnMain">
  438. <MemberSignature Language="C#" Value="public static void InvokeOnMain (Action action);" />
  439. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void InvokeOnMain(class System.Action action) cil managed" />
  440. <MemberType>Method</MemberType>
  441. <AssemblyInfo>
  442. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  443. </AssemblyInfo>
  444. <ReturnValue>
  445. <ReturnType>System.Void</ReturnType>
  446. </ReturnValue>
  447. <Parameters>
  448. <Parameter Name="action" Type="System.Action" />
  449. </Parameters>
  450. <Docs>
  451. <param name="action">Method to be invoked on the main thread.</param>
  452. <summary>
  453. Invoke actions in the Main Thread (the next Update call)
  454. </summary>
  455. <remarks>To be added.</remarks>
  456. </Docs>
  457. </Member>
  458. <Member MemberName="InvokeOnMainAsync">
  459. <MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task InvokeOnMainAsync (Action action);" />
  460. <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task InvokeOnMainAsync(class System.Action action) cil managed" />
  461. <MemberType>Method</MemberType>
  462. <AssemblyInfo>
  463. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  464. </AssemblyInfo>
  465. <ReturnValue>
  466. <ReturnType>System.Threading.Tasks.Task</ReturnType>
  467. </ReturnValue>
  468. <Parameters>
  469. <Parameter Name="action" Type="System.Action" />
  470. </Parameters>
  471. <Docs>
  472. <param name="action">Method to be invoked on the main thread.</param>
  473. <summary>Invoke actions in the Main Thread (the next Update call), async variation.</summary>
  474. <returns>To be added.</returns>
  475. <remarks>This method is equivalent to <see cref="M:Urho.Application.InvokeOnMain," /> with the difference that the result can be awaited on.</remarks>
  476. </Docs>
  477. </Member>
  478. <Member MemberName="IsClosed">
  479. <MemberSignature Language="C#" Value="public bool IsClosed { get; }" />
  480. <MemberSignature Language="ILAsm" Value=".property instance bool IsClosed" />
  481. <MemberType>Property</MemberType>
  482. <AssemblyInfo>
  483. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  484. </AssemblyInfo>
  485. <ReturnValue>
  486. <ReturnType>System.Boolean</ReturnType>
  487. </ReturnValue>
  488. <Docs>
  489. <summary>Determines if the application has been closed, and we are shutting down.</summary>
  490. <value>To be added.</value>
  491. <remarks>To be added.</remarks>
  492. </Docs>
  493. </Member>
  494. <Member MemberName="IsExiting">
  495. <MemberSignature Language="C#" Value="public bool IsExiting { get; }" />
  496. <MemberSignature Language="ILAsm" Value=".property instance bool IsExiting" />
  497. <MemberType>Property</MemberType>
  498. <AssemblyInfo>
  499. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  500. </AssemblyInfo>
  501. <ReturnValue>
  502. <ReturnType>System.Boolean</ReturnType>
  503. </ReturnValue>
  504. <Docs>
  505. <summary>To be added.</summary>
  506. <value>To be added.</value>
  507. <remarks>To be added.</remarks>
  508. </Docs>
  509. </Member>
  510. <Member MemberName="Log">
  511. <MemberSignature Language="C#" Value="public Urho.IO.Log Log { get; }" />
  512. <MemberSignature Language="ILAsm" Value=".property instance class Urho.IO.Log Log" />
  513. <MemberType>Property</MemberType>
  514. <AssemblyInfo>
  515. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  516. </AssemblyInfo>
  517. <ReturnValue>
  518. <ReturnType>Urho.IO.Log</ReturnType>
  519. </ReturnValue>
  520. <Docs>
  521. <summary>Returns the Log subsystem.</summary>
  522. <value>To be added.</value>
  523. <remarks>To be added.</remarks>
  524. </Docs>
  525. </Member>
  526. <Member MemberName="Network">
  527. <MemberSignature Language="C#" Value="public Urho.Network.Network Network { get; }" />
  528. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Network.Network Network" />
  529. <MemberType>Property</MemberType>
  530. <AssemblyInfo>
  531. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  532. </AssemblyInfo>
  533. <ReturnValue>
  534. <ReturnType>Urho.Network.Network</ReturnType>
  535. </ReturnValue>
  536. <Docs>
  537. <summary>Returns the Network subsystem.</summary>
  538. <value>To be added.</value>
  539. <remarks>To be added.</remarks>
  540. </Docs>
  541. </Member>
  542. <Member MemberName="OnUpdate">
  543. <MemberSignature Language="C#" Value="protected virtual void OnUpdate (float timeStep);" />
  544. <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnUpdate(float32 timeStep) cil managed" />
  545. <MemberType>Method</MemberType>
  546. <AssemblyInfo>
  547. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  548. </AssemblyInfo>
  549. <ReturnValue>
  550. <ReturnType>System.Void</ReturnType>
  551. </ReturnValue>
  552. <Parameters>
  553. <Parameter Name="timeStep" Type="System.Single" />
  554. </Parameters>
  555. <Docs>
  556. <param name="timeStep">To be added.</param>
  557. <summary>This method is invoked on every application update.</summary>
  558. <remarks>To be added.</remarks>
  559. </Docs>
  560. </Member>
  561. <Member MemberName="Options">
  562. <MemberSignature Language="C#" Value="public Urho.ApplicationOptions Options { get; }" />
  563. <MemberSignature Language="ILAsm" Value=".property instance class Urho.ApplicationOptions Options" />
  564. <MemberType>Property</MemberType>
  565. <AssemblyInfo>
  566. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  567. </AssemblyInfo>
  568. <ReturnValue>
  569. <ReturnType>Urho.ApplicationOptions</ReturnType>
  570. </ReturnValue>
  571. <Docs>
  572. <summary>The application options in use</summary>
  573. <value>The value is either the one that was passed to the constructor, or the default.</value>
  574. <remarks>
  575. <para />
  576. </remarks>
  577. </Docs>
  578. </Member>
  579. <Member MemberName="Platform">
  580. <MemberSignature Language="C#" Value="public static Urho.Platforms Platform { get; }" />
  581. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.Platforms Platform" />
  582. <MemberType>Property</MemberType>
  583. <AssemblyInfo>
  584. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  585. </AssemblyInfo>
  586. <ReturnValue>
  587. <ReturnType>Urho.Platforms</ReturnType>
  588. </ReturnValue>
  589. <Docs>
  590. <summary>Simple way of obtaining the platform on which the program is running from cross platform code.</summary>
  591. <value>
  592. <para />
  593. </value>
  594. <remarks>Use this to easily find out from your cross platform code on which platform you are executing.</remarks>
  595. </Docs>
  596. </Member>
  597. <Member MemberName="Profiler">
  598. <MemberSignature Language="C#" Value="public Urho.Profiler Profiler { get; }" />
  599. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Profiler Profiler" />
  600. <MemberType>Property</MemberType>
  601. <AssemblyInfo>
  602. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  603. </AssemblyInfo>
  604. <ReturnValue>
  605. <ReturnType>Urho.Profiler</ReturnType>
  606. </ReturnValue>
  607. <Docs>
  608. <summary>Returns the Profiler subsystem.</summary>
  609. <value>To be added.</value>
  610. <remarks>To be added.</remarks>
  611. </Docs>
  612. </Member>
  613. <Member MemberName="Renderer">
  614. <MemberSignature Language="C#" Value="public Urho.Renderer Renderer { get; }" />
  615. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Renderer Renderer" />
  616. <MemberType>Property</MemberType>
  617. <AssemblyInfo>
  618. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  619. </AssemblyInfo>
  620. <ReturnValue>
  621. <ReturnType>Urho.Renderer</ReturnType>
  622. </ReturnValue>
  623. <Docs>
  624. <summary>Returns the Renderer subsystem.</summary>
  625. <value>To be added.</value>
  626. <remarks>To be added.</remarks>
  627. </Docs>
  628. </Member>
  629. <Member MemberName="ResourceCache">
  630. <MemberSignature Language="C#" Value="public Urho.Resources.ResourceCache ResourceCache { get; }" />
  631. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Resources.ResourceCache ResourceCache" />
  632. <MemberType>Property</MemberType>
  633. <AssemblyInfo>
  634. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  635. </AssemblyInfo>
  636. <ReturnValue>
  637. <ReturnType>Urho.Resources.ResourceCache</ReturnType>
  638. </ReturnValue>
  639. <Docs>
  640. <summary>Returns the ResourceCache subsystem.</summary>
  641. <value>To be added.</value>
  642. <remarks>To be added.</remarks>
  643. </Docs>
  644. </Member>
  645. <Member MemberName="Run">
  646. <MemberSignature Language="C#" Value="public int Run ();" />
  647. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 Run() cil managed" />
  648. <MemberType>Method</MemberType>
  649. <AssemblyInfo>
  650. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  651. </AssemblyInfo>
  652. <ReturnValue>
  653. <ReturnType>System.Int32</ReturnType>
  654. </ReturnValue>
  655. <Parameters />
  656. <Docs>
  657. <summary>
  658. Initialize the engine and run the main loop, then return the application exit code. Catch out-of-memory exceptions while running.
  659. </summary>
  660. <returns>To be added.</returns>
  661. <remarks>To be added.</remarks>
  662. </Docs>
  663. </Member>
  664. <Member MemberName="Setup">
  665. <MemberSignature Language="C#" Value="protected virtual void Setup ();" />
  666. <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Setup() cil managed" />
  667. <MemberType>Method</MemberType>
  668. <AssemblyInfo>
  669. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  670. </AssemblyInfo>
  671. <ReturnValue>
  672. <ReturnType>System.Void</ReturnType>
  673. </ReturnValue>
  674. <Parameters />
  675. <Docs>
  676. <summary>Method invoked to setup your application. </summary>
  677. <remarks>
  678. <para>You can setup the engine parameters here, but you should postpone the resource loading until the <see cref="M:Urho.Application.Start" /> method is invoked.</para>
  679. <para />
  680. <para>On error, you can invoke the <see cref="M:Urho.Application.ErrorExit" /> method to terminate execution.</para>
  681. </remarks>
  682. </Docs>
  683. </Member>
  684. <Member MemberName="Start">
  685. <MemberSignature Language="C#" Value="protected virtual void Start ();" />
  686. <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Start() cil managed" />
  687. <MemberType>Method</MemberType>
  688. <AssemblyInfo>
  689. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  690. </AssemblyInfo>
  691. <ReturnValue>
  692. <ReturnType>System.Void</ReturnType>
  693. </ReturnValue>
  694. <Parameters />
  695. <Docs>
  696. <summary>Method invoked to start your application, this is where you would typically create your scene.</summary>
  697. <remarks>To be added.</remarks>
  698. </Docs>
  699. </Member>
  700. <Member MemberName="Started">
  701. <MemberSignature Language="C#" Value="public static event Action Started;" />
  702. <MemberSignature Language="ILAsm" Value=".event class System.Action Started" />
  703. <MemberType>Event</MemberType>
  704. <AssemblyInfo>
  705. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  706. </AssemblyInfo>
  707. <ReturnValue>
  708. <ReturnType>System.Action</ReturnType>
  709. </ReturnValue>
  710. <Docs>
  711. <summary>Event raised when your application has started.</summary>
  712. <remarks>This event is invoked after the <see cref="M:Urho.Application.Start" /> virtual method is invoked on your application.</remarks>
  713. </Docs>
  714. </Member>
  715. <Member MemberName="Stop">
  716. <MemberSignature Language="C#" Value="protected virtual void Stop ();" />
  717. <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Stop() cil managed" />
  718. <MemberType>Method</MemberType>
  719. <AssemblyInfo>
  720. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  721. </AssemblyInfo>
  722. <ReturnValue>
  723. <ReturnType>System.Void</ReturnType>
  724. </ReturnValue>
  725. <Parameters />
  726. <Docs>
  727. <summary>Method invoked to terminate your application.</summary>
  728. <remarks>To be added.</remarks>
  729. </Docs>
  730. </Member>
  731. <Member MemberName="Stoped">
  732. <MemberSignature Language="C#" Value="public static event Action Stoped;" />
  733. <MemberSignature Language="ILAsm" Value=".event class System.Action Stoped" />
  734. <MemberType>Event</MemberType>
  735. <AssemblyInfo>
  736. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  737. </AssemblyInfo>
  738. <ReturnValue>
  739. <ReturnType>System.Action</ReturnType>
  740. </ReturnValue>
  741. <Docs>
  742. <summary>Event raised when your application has stopped.</summary>
  743. <remarks>This event is invoked after the <see cref="M:Urho.Application.Stop" /> virtual method is invoked on your application.</remarks>
  744. </Docs>
  745. </Member>
  746. <Member MemberName="Time">
  747. <MemberSignature Language="C#" Value="public Urho.Time Time { get; }" />
  748. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Time Time" />
  749. <MemberType>Property</MemberType>
  750. <AssemblyInfo>
  751. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  752. </AssemblyInfo>
  753. <ReturnValue>
  754. <ReturnType>Urho.Time</ReturnType>
  755. </ReturnValue>
  756. <Docs>
  757. <summary>Returns the Time subsystem.</summary>
  758. <value>To be added.</value>
  759. <remarks>To be added.</remarks>
  760. </Docs>
  761. </Member>
  762. <Member MemberName="Type">
  763. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  764. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  765. <MemberType>Property</MemberType>
  766. <AssemblyInfo>
  767. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  768. </AssemblyInfo>
  769. <ReturnValue>
  770. <ReturnType>Urho.StringHash</ReturnType>
  771. </ReturnValue>
  772. <Docs>
  773. <summary>Urho's type system type.</summary>
  774. <value>StringHash representing the type for this C# type.</value>
  775. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  776. </Docs>
  777. </Member>
  778. <Member MemberName="TypeName">
  779. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  780. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  781. <MemberType>Property</MemberType>
  782. <AssemblyInfo>
  783. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  784. </AssemblyInfo>
  785. <ReturnValue>
  786. <ReturnType>System.String</ReturnType>
  787. </ReturnValue>
  788. <Docs>
  789. <summary>Urho's low-level type name.</summary>
  790. <value>Stringified low-level type name.</value>
  791. <remarks></remarks>
  792. </Docs>
  793. </Member>
  794. <Member MemberName="TypeNameStatic">
  795. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  796. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  797. <MemberType>Property</MemberType>
  798. <AssemblyInfo>
  799. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  800. </AssemblyInfo>
  801. <ReturnValue>
  802. <ReturnType>System.String</ReturnType>
  803. </ReturnValue>
  804. <Docs>
  805. <summary>Urho's low-level type name, accessible as a static method.</summary>
  806. <value>Stringified low-level type name.</value>
  807. <remarks></remarks>
  808. </Docs>
  809. </Member>
  810. <Member MemberName="TypeStatic">
  811. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  812. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  813. <MemberType>Property</MemberType>
  814. <AssemblyInfo>
  815. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  816. </AssemblyInfo>
  817. <ReturnValue>
  818. <ReturnType>Urho.StringHash</ReturnType>
  819. </ReturnValue>
  820. <Docs>
  821. <summary>Urho's low-level type, accessible as a static method.</summary>
  822. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  823. <remarks></remarks>
  824. </Docs>
  825. </Member>
  826. <Member MemberName="UI">
  827. <MemberSignature Language="C#" Value="public Urho.Gui.UI UI { get; }" />
  828. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Gui.UI UI" />
  829. <MemberType>Property</MemberType>
  830. <AssemblyInfo>
  831. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  832. </AssemblyInfo>
  833. <ReturnValue>
  834. <ReturnType>Urho.Gui.UI</ReturnType>
  835. </ReturnValue>
  836. <Docs>
  837. <summary>Returns the UI subsystem.</summary>
  838. <value>To be added.</value>
  839. <remarks>To be added.</remarks>
  840. </Docs>
  841. </Member>
  842. <Member MemberName="Update">
  843. <MemberSignature Language="C#" Value="public event Action&lt;Urho.UpdateEventArgs&gt; Update;" />
  844. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.UpdateEventArgs&gt; Update" />
  845. <MemberType>Event</MemberType>
  846. <AssemblyInfo>
  847. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  848. </AssemblyInfo>
  849. <ReturnValue>
  850. <ReturnType>System.Action&lt;Urho.UpdateEventArgs&gt;</ReturnType>
  851. </ReturnValue>
  852. <Docs>
  853. <summary>Frame update event</summary>
  854. <remarks>This event is raised when the frame has been updated.</remarks>
  855. </Docs>
  856. </Member>
  857. <Member MemberName="UrhoSurface">
  858. <MemberSignature Language="C#" Value="public Urho.IUrhoSurface UrhoSurface { get; }" />
  859. <MemberSignature Language="ILAsm" Value=".property instance class Urho.IUrhoSurface UrhoSurface" />
  860. <MemberType>Property</MemberType>
  861. <AssemblyInfo>
  862. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  863. </AssemblyInfo>
  864. <ReturnValue>
  865. <ReturnType>Urho.IUrhoSurface</ReturnType>
  866. </ReturnValue>
  867. <Docs>
  868. <summary>To be added.</summary>
  869. <value>To be added.</value>
  870. <remarks>To be added.</remarks>
  871. </Docs>
  872. </Member>
  873. <Member MemberName="WorkQueue">
  874. <MemberSignature Language="C#" Value="public Urho.WorkQueue WorkQueue { get; }" />
  875. <MemberSignature Language="ILAsm" Value=".property instance class Urho.WorkQueue WorkQueue" />
  876. <MemberType>Property</MemberType>
  877. <AssemblyInfo>
  878. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  879. </AssemblyInfo>
  880. <ReturnValue>
  881. <ReturnType>Urho.WorkQueue</ReturnType>
  882. </ReturnValue>
  883. <Docs>
  884. <summary>Returns the WorkQueue subsystem.</summary>
  885. <value>To be added.</value>
  886. <remarks>To be added.</remarks>
  887. </Docs>
  888. </Member>
  889. <Member MemberName="YieldFrame">
  890. <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task YieldFrame ();" />
  891. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task YieldFrame() cil managed" />
  892. <MemberType>Method</MemberType>
  893. <AssemblyInfo>
  894. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  895. </AssemblyInfo>
  896. <ReturnValue>
  897. <ReturnType>System.Threading.Tasks.Task</ReturnType>
  898. </ReturnValue>
  899. <Parameters />
  900. <Docs>
  901. <summary>Yield a frame</summary>
  902. <returns>To be added.</returns>
  903. <remarks>To be added.</remarks>
  904. </Docs>
  905. </Member>
  906. </Members>
  907. </Type>