Application.xml 32 KB

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