Application.xml 34 KB

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