Resource.xml 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613
  1. <Type Name="Resource" FullName="Urho.Resources.Resource">
  2. <TypeSignature Language="C#" Value="public class Resource : Urho.UrhoObject" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Resource 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 resources.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public Resource ();" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Attributes>
  27. <Attribute>
  28. <AttributeName>Preserve</AttributeName>
  29. </Attribute>
  30. </Attributes>
  31. <Parameters />
  32. <Docs>
  33. <summary>
  34. <para>Constructs a new instance of Urho.Resources.Resource which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  35. </summary>
  36. <remarks></remarks>
  37. </Docs>
  38. </Member>
  39. <Member MemberName=".ctor">
  40. <MemberSignature Language="C#" Value="public Resource (IntPtr handle);" />
  41. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  42. <MemberType>Constructor</MemberType>
  43. <AssemblyInfo>
  44. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  45. </AssemblyInfo>
  46. <Attributes>
  47. <Attribute>
  48. <AttributeName>Preserve</AttributeName>
  49. </Attribute>
  50. </Attributes>
  51. <Parameters>
  52. <Parameter Name="handle" Type="System.IntPtr" />
  53. </Parameters>
  54. <Docs>
  55. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  56. <summary>Constructs a new instance of Urho.Resources.Resource, given a raw pointer to an unmanaged object</summary>
  57. <remarks>
  58. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  59. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  60. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  61. </remarks>
  62. </Docs>
  63. </Member>
  64. <Member MemberName=".ctor">
  65. <MemberSignature Language="C#" Value="public Resource (Urho.Context context);" />
  66. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  67. <MemberType>Constructor</MemberType>
  68. <AssemblyInfo>
  69. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  70. </AssemblyInfo>
  71. <Attributes>
  72. <Attribute>
  73. <AttributeName>Preserve</AttributeName>
  74. </Attribute>
  75. </Attributes>
  76. <Parameters>
  77. <Parameter Name="context" Type="Urho.Context" />
  78. </Parameters>
  79. <Docs>
  80. <param name="context">The context that this object will be attached to.</param>
  81. <summary>
  82. <para>Constructs a new instance of Urho.Resources.Resource linked to a specific <see cref="T:Urho.Context" />.</para>
  83. </summary>
  84. <remarks></remarks>
  85. </Docs>
  86. </Member>
  87. <Member MemberName=".ctor">
  88. <MemberSignature Language="C#" Value="protected Resource (Urho.UrhoObjectFlag emptyFlag);" />
  89. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  90. <MemberType>Constructor</MemberType>
  91. <AssemblyInfo>
  92. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  93. </AssemblyInfo>
  94. <Attributes>
  95. <Attribute>
  96. <AttributeName>Preserve</AttributeName>
  97. </Attribute>
  98. </Attributes>
  99. <Parameters>
  100. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  101. </Parameters>
  102. <Docs>
  103. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  104. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  105. <remarks>
  106. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  107. <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>
  108. <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>
  109. </remarks>
  110. </Docs>
  111. </Member>
  112. <Member MemberName="AsyncLoadState">
  113. <MemberSignature Language="C#" Value="public Urho.Resources.AsyncLoadState AsyncLoadState { get; set; }" />
  114. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Resources.AsyncLoadState AsyncLoadState" />
  115. <MemberType>Property</MemberType>
  116. <AssemblyInfo>
  117. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  118. </AssemblyInfo>
  119. <ReturnValue>
  120. <ReturnType>Urho.Resources.AsyncLoadState</ReturnType>
  121. </ReturnValue>
  122. <Docs>
  123. <summary>
  124. Return the asynchronous loading state.
  125. Or
  126. Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.
  127. </summary>
  128. <value>To be added.</value>
  129. <remarks>To be added.</remarks>
  130. </Docs>
  131. </Member>
  132. <Member MemberName="BeginLoad">
  133. <MemberSignature Language="C#" Value="public virtual bool BeginLoad (Urho.IO.File source);" />
  134. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool BeginLoad(class Urho.IO.File source) cil managed" />
  135. <MemberType>Method</MemberType>
  136. <AssemblyInfo>
  137. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  138. </AssemblyInfo>
  139. <ReturnValue>
  140. <ReturnType>System.Boolean</ReturnType>
  141. </ReturnValue>
  142. <Parameters>
  143. <Parameter Name="source" Type="Urho.IO.File" />
  144. </Parameters>
  145. <Docs>
  146. <param name="source">To be added.</param>
  147. <summary>Load resource from stream. May be called from a worker thread. Return true if successful.</summary>
  148. <returns>To be added.</returns>
  149. <remarks>To be added.</remarks>
  150. </Docs>
  151. </Member>
  152. <Member MemberName="BeginLoad">
  153. <MemberSignature Language="C#" Value="public virtual bool BeginLoad (Urho.MemoryBuffer source);" />
  154. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool BeginLoad(class Urho.MemoryBuffer source) cil managed" />
  155. <MemberType>Method</MemberType>
  156. <AssemblyInfo>
  157. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  158. </AssemblyInfo>
  159. <ReturnValue>
  160. <ReturnType>System.Boolean</ReturnType>
  161. </ReturnValue>
  162. <Parameters>
  163. <Parameter Name="source" Type="Urho.MemoryBuffer" />
  164. </Parameters>
  165. <Docs>
  166. <param name="source">To be added.</param>
  167. <summary>To be added.</summary>
  168. <returns>To be added.</returns>
  169. <remarks>To be added.</remarks>
  170. </Docs>
  171. </Member>
  172. <Member MemberName="EndLoad">
  173. <MemberSignature Language="C#" Value="public virtual bool EndLoad ();" />
  174. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool EndLoad() cil managed" />
  175. <MemberType>Method</MemberType>
  176. <AssemblyInfo>
  177. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  178. </AssemblyInfo>
  179. <ReturnValue>
  180. <ReturnType>System.Boolean</ReturnType>
  181. </ReturnValue>
  182. <Parameters />
  183. <Docs>
  184. <summary>
  185. Finish resource loading. Always called from the main thread. Return true if successful.
  186. </summary>
  187. <returns>To be added.</returns>
  188. <remarks>To be added.</remarks>
  189. </Docs>
  190. </Member>
  191. <Member MemberName="Load">
  192. <MemberSignature Language="C#" Value="public bool Load (string fileName);" />
  193. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Load(string fileName) cil managed" />
  194. <MemberType>Method</MemberType>
  195. <AssemblyInfo>
  196. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  197. </AssemblyInfo>
  198. <ReturnValue>
  199. <ReturnType>System.Boolean</ReturnType>
  200. </ReturnValue>
  201. <Parameters>
  202. <Parameter Name="fileName" Type="System.String" />
  203. </Parameters>
  204. <Docs>
  205. <param name="fileName">To be added.</param>
  206. <summary>Load resource from file.</summary>
  207. <returns>To be added.</returns>
  208. <remarks>To be added.</remarks>
  209. </Docs>
  210. </Member>
  211. <Member MemberName="Load">
  212. <MemberSignature Language="C#" Value="public bool Load (Urho.IO.File source);" />
  213. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Load(class Urho.IO.File source) cil managed" />
  214. <MemberType>Method</MemberType>
  215. <AssemblyInfo>
  216. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  217. </AssemblyInfo>
  218. <ReturnValue>
  219. <ReturnType>System.Boolean</ReturnType>
  220. </ReturnValue>
  221. <Parameters>
  222. <Parameter Name="source" Type="Urho.IO.File" />
  223. </Parameters>
  224. <Docs>
  225. <param name="source">To be added.</param>
  226. <summary>Load resource synchronously. Call both BeginLoad() &amp; EndLoad() and return true if both succeeded.</summary>
  227. <returns>To be added.</returns>
  228. <remarks>To be added.</remarks>
  229. </Docs>
  230. </Member>
  231. <Member MemberName="Load">
  232. <MemberSignature Language="C#" Value="public bool Load (Urho.MemoryBuffer source);" />
  233. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Load(class Urho.MemoryBuffer source) cil managed" />
  234. <MemberType>Method</MemberType>
  235. <AssemblyInfo>
  236. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  237. </AssemblyInfo>
  238. <ReturnValue>
  239. <ReturnType>System.Boolean</ReturnType>
  240. </ReturnValue>
  241. <Parameters>
  242. <Parameter Name="source" Type="Urho.MemoryBuffer" />
  243. </Parameters>
  244. <Docs>
  245. <param name="source">To be added.</param>
  246. <summary>To be added.</summary>
  247. <returns>To be added.</returns>
  248. <remarks>To be added.</remarks>
  249. </Docs>
  250. </Member>
  251. <Member MemberName="MemoryUse">
  252. <MemberSignature Language="C#" Value="public uint MemoryUse { get; set; }" />
  253. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 MemoryUse" />
  254. <MemberType>Property</MemberType>
  255. <AssemblyInfo>
  256. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  257. </AssemblyInfo>
  258. <ReturnValue>
  259. <ReturnType>System.UInt32</ReturnType>
  260. </ReturnValue>
  261. <Docs>
  262. <summary>
  263. Return memory use in bytes, possibly approximate.
  264. Or
  265. Set memory use in bytes, possibly approximate.
  266. </summary>
  267. <value>To be added.</value>
  268. <remarks>To be added.</remarks>
  269. </Docs>
  270. </Member>
  271. <Member MemberName="Name">
  272. <MemberSignature Language="C#" Value="public string Name { get; set; }" />
  273. <MemberSignature Language="ILAsm" Value=".property instance string Name" />
  274. <MemberType>Property</MemberType>
  275. <AssemblyInfo>
  276. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  277. </AssemblyInfo>
  278. <ReturnValue>
  279. <ReturnType>System.String</ReturnType>
  280. </ReturnValue>
  281. <Docs>
  282. <summary>
  283. Return name.
  284. Or
  285. Set name.
  286. </summary>
  287. <value>To be added.</value>
  288. <remarks>To be added.</remarks>
  289. </Docs>
  290. </Member>
  291. <Member MemberName="NameHash">
  292. <MemberSignature Language="C#" Value="public Urho.StringHash NameHash { get; }" />
  293. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash NameHash" />
  294. <MemberType>Property</MemberType>
  295. <AssemblyInfo>
  296. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  297. </AssemblyInfo>
  298. <ReturnValue>
  299. <ReturnType>Urho.StringHash</ReturnType>
  300. </ReturnValue>
  301. <Docs>
  302. <summary>
  303. Return name hash.
  304. </summary>
  305. <value>To be added.</value>
  306. <remarks>To be added.</remarks>
  307. </Docs>
  308. </Member>
  309. <Member MemberName="ReloadFailed">
  310. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Resources.ReloadFailedEventArgs&gt; ReloadFailed;" />
  311. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Resources.ReloadFailedEventArgs&gt; ReloadFailed" />
  312. <MemberType>Event</MemberType>
  313. <AssemblyInfo>
  314. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  315. </AssemblyInfo>
  316. <ReturnValue>
  317. <ReturnType>System.Action&lt;Urho.Resources.ReloadFailedEventArgs&gt;</ReturnType>
  318. </ReturnValue>
  319. <Docs>
  320. <summary>Resource reloading failed.</summary>
  321. <remarks>
  322. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToReloadFailed" /> method. That one will force that callback and will ignore any previously set events here.</para>
  323. </remarks>
  324. </Docs>
  325. </Member>
  326. <Member MemberName="ReloadFinished">
  327. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Resources.ReloadFinishedEventArgs&gt; ReloadFinished;" />
  328. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Resources.ReloadFinishedEventArgs&gt; ReloadFinished" />
  329. <MemberType>Event</MemberType>
  330. <AssemblyInfo>
  331. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  332. </AssemblyInfo>
  333. <ReturnValue>
  334. <ReturnType>System.Action&lt;Urho.Resources.ReloadFinishedEventArgs&gt;</ReturnType>
  335. </ReturnValue>
  336. <Docs>
  337. <summary>Resource reloading finished.</summary>
  338. <remarks>
  339. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToReloadFinished" /> method. That one will force that callback and will ignore any previously set events here.</para>
  340. </remarks>
  341. </Docs>
  342. </Member>
  343. <Member MemberName="ReloadStarted">
  344. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Resources.ReloadStartedEventArgs&gt; ReloadStarted;" />
  345. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Resources.ReloadStartedEventArgs&gt; ReloadStarted" />
  346. <MemberType>Event</MemberType>
  347. <AssemblyInfo>
  348. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  349. </AssemblyInfo>
  350. <ReturnValue>
  351. <ReturnType>System.Action&lt;Urho.Resources.ReloadStartedEventArgs&gt;</ReturnType>
  352. </ReturnValue>
  353. <Docs>
  354. <summary>Resource reloading started.</summary>
  355. <remarks>
  356. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToReloadStarted" /> method. That one will force that callback and will ignore any previously set events here.</para>
  357. </remarks>
  358. </Docs>
  359. </Member>
  360. <Member MemberName="ResetUseTimer">
  361. <MemberSignature Language="C#" Value="public void ResetUseTimer ();" />
  362. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResetUseTimer() cil managed" />
  363. <MemberType>Method</MemberType>
  364. <AssemblyInfo>
  365. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  366. </AssemblyInfo>
  367. <ReturnValue>
  368. <ReturnType>System.Void</ReturnType>
  369. </ReturnValue>
  370. <Parameters />
  371. <Docs>
  372. <summary>
  373. Reset last used timer.
  374. </summary>
  375. <remarks>To be added.</remarks>
  376. </Docs>
  377. </Member>
  378. <Member MemberName="Save">
  379. <MemberSignature Language="C#" Value="public virtual bool Save (string fileName);" />
  380. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Save(string fileName) cil managed" />
  381. <MemberType>Method</MemberType>
  382. <AssemblyInfo>
  383. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  384. </AssemblyInfo>
  385. <ReturnValue>
  386. <ReturnType>System.Boolean</ReturnType>
  387. </ReturnValue>
  388. <Parameters>
  389. <Parameter Name="fileName" Type="System.String" />
  390. </Parameters>
  391. <Docs>
  392. <param name="fileName">To be added.</param>
  393. <summary>Save resource to file.</summary>
  394. <returns>To be added.</returns>
  395. <remarks>To be added.</remarks>
  396. </Docs>
  397. </Member>
  398. <Member MemberName="Save">
  399. <MemberSignature Language="C#" Value="public virtual bool Save (Urho.IO.File dest);" />
  400. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Save(class Urho.IO.File dest) cil managed" />
  401. <MemberType>Method</MemberType>
  402. <AssemblyInfo>
  403. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  404. </AssemblyInfo>
  405. <ReturnValue>
  406. <ReturnType>System.Boolean</ReturnType>
  407. </ReturnValue>
  408. <Parameters>
  409. <Parameter Name="dest" Type="Urho.IO.File" />
  410. </Parameters>
  411. <Docs>
  412. <param name="dest">To be added.</param>
  413. <summary>Save resource to file.</summary>
  414. <returns>To be added.</returns>
  415. <remarks>To be added.</remarks>
  416. </Docs>
  417. </Member>
  418. <Member MemberName="Save">
  419. <MemberSignature Language="C#" Value="public virtual bool Save (Urho.MemoryBuffer dest);" />
  420. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Save(class Urho.MemoryBuffer dest) cil managed" />
  421. <MemberType>Method</MemberType>
  422. <AssemblyInfo>
  423. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  424. </AssemblyInfo>
  425. <ReturnValue>
  426. <ReturnType>System.Boolean</ReturnType>
  427. </ReturnValue>
  428. <Parameters>
  429. <Parameter Name="dest" Type="Urho.MemoryBuffer" />
  430. </Parameters>
  431. <Docs>
  432. <param name="dest">To be added.</param>
  433. <summary>To be added.</summary>
  434. <returns>To be added.</returns>
  435. <remarks>To be added.</remarks>
  436. </Docs>
  437. </Member>
  438. <Member MemberName="SubscribeToReloadFailed">
  439. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToReloadFailed (Action&lt;Urho.Resources.ReloadFailedEventArgs&gt; handler);" />
  440. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToReloadFailed(class System.Action`1&lt;valuetype Urho.Resources.ReloadFailedEventArgs&gt; handler) cil managed" />
  441. <MemberType>Method</MemberType>
  442. <AssemblyInfo>
  443. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  444. </AssemblyInfo>
  445. <Attributes>
  446. <Attribute>
  447. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ReloadFailed += ...' instead.")</AttributeName>
  448. </Attribute>
  449. </Attributes>
  450. <ReturnValue>
  451. <ReturnType>Urho.Subscription</ReturnType>
  452. </ReturnValue>
  453. <Parameters>
  454. <Parameter Name="handler" Type="System.Action&lt;Urho.Resources.ReloadFailedEventArgs&gt;" />
  455. </Parameters>
  456. <Docs>
  457. <param name="handler">The handler to invoke when this event is raised.</param>
  458. <summary>Subscribes to the ReloadFailed event raised by the Resource.</summary>
  459. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  460. <remarks>
  461. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  462. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  463. <para>For a more event-like approach, use the <see cref="E:Urho.Resources.Resource.ReloadFailed" /> event.</para>
  464. </remarks>
  465. </Docs>
  466. </Member>
  467. <Member MemberName="SubscribeToReloadFinished">
  468. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToReloadFinished (Action&lt;Urho.Resources.ReloadFinishedEventArgs&gt; handler);" />
  469. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToReloadFinished(class System.Action`1&lt;valuetype Urho.Resources.ReloadFinishedEventArgs&gt; handler) cil managed" />
  470. <MemberType>Method</MemberType>
  471. <AssemblyInfo>
  472. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  473. </AssemblyInfo>
  474. <Attributes>
  475. <Attribute>
  476. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ReloadFinished += ...' instead.")</AttributeName>
  477. </Attribute>
  478. </Attributes>
  479. <ReturnValue>
  480. <ReturnType>Urho.Subscription</ReturnType>
  481. </ReturnValue>
  482. <Parameters>
  483. <Parameter Name="handler" Type="System.Action&lt;Urho.Resources.ReloadFinishedEventArgs&gt;" />
  484. </Parameters>
  485. <Docs>
  486. <param name="handler">The handler to invoke when this event is raised.</param>
  487. <summary>Subscribes to the ReloadFinished event raised by the Resource.</summary>
  488. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  489. <remarks>
  490. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  491. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  492. <para>For a more event-like approach, use the <see cref="E:Urho.Resources.Resource.ReloadFinished" /> event.</para>
  493. </remarks>
  494. </Docs>
  495. </Member>
  496. <Member MemberName="SubscribeToReloadStarted">
  497. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToReloadStarted (Action&lt;Urho.Resources.ReloadStartedEventArgs&gt; handler);" />
  498. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToReloadStarted(class System.Action`1&lt;valuetype Urho.Resources.ReloadStartedEventArgs&gt; handler) cil managed" />
  499. <MemberType>Method</MemberType>
  500. <AssemblyInfo>
  501. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  502. </AssemblyInfo>
  503. <Attributes>
  504. <Attribute>
  505. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ReloadStarted += ...' instead.")</AttributeName>
  506. </Attribute>
  507. </Attributes>
  508. <ReturnValue>
  509. <ReturnType>Urho.Subscription</ReturnType>
  510. </ReturnValue>
  511. <Parameters>
  512. <Parameter Name="handler" Type="System.Action&lt;Urho.Resources.ReloadStartedEventArgs&gt;" />
  513. </Parameters>
  514. <Docs>
  515. <param name="handler">The handler to invoke when this event is raised.</param>
  516. <summary>Subscribes to the ReloadStarted event raised by the Resource.</summary>
  517. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  518. <remarks>
  519. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  520. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  521. <para>For a more event-like approach, use the <see cref="E:Urho.Resources.Resource.ReloadStarted" /> event.</para>
  522. </remarks>
  523. </Docs>
  524. </Member>
  525. <Member MemberName="Type">
  526. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  527. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  528. <MemberType>Property</MemberType>
  529. <AssemblyInfo>
  530. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  531. </AssemblyInfo>
  532. <ReturnValue>
  533. <ReturnType>Urho.StringHash</ReturnType>
  534. </ReturnValue>
  535. <Docs>
  536. <summary>Urho's type system type.</summary>
  537. <value>StringHash representing the type for this C# type.</value>
  538. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  539. </Docs>
  540. </Member>
  541. <Member MemberName="TypeName">
  542. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  543. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  544. <MemberType>Property</MemberType>
  545. <AssemblyInfo>
  546. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  547. </AssemblyInfo>
  548. <ReturnValue>
  549. <ReturnType>System.String</ReturnType>
  550. </ReturnValue>
  551. <Docs>
  552. <summary>Urho's low-level type name.</summary>
  553. <value>Stringified low-level type name.</value>
  554. <remarks></remarks>
  555. </Docs>
  556. </Member>
  557. <Member MemberName="TypeNameStatic">
  558. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  559. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  560. <MemberType>Property</MemberType>
  561. <AssemblyInfo>
  562. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  563. </AssemblyInfo>
  564. <ReturnValue>
  565. <ReturnType>System.String</ReturnType>
  566. </ReturnValue>
  567. <Docs>
  568. <summary>Urho's low-level type name, accessible as a static method.</summary>
  569. <value>Stringified low-level type name.</value>
  570. <remarks></remarks>
  571. </Docs>
  572. </Member>
  573. <Member MemberName="TypeStatic">
  574. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  575. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  576. <MemberType>Property</MemberType>
  577. <AssemblyInfo>
  578. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  579. </AssemblyInfo>
  580. <Attributes>
  581. <Attribute>
  582. <AttributeName>Preserve</AttributeName>
  583. </Attribute>
  584. </Attributes>
  585. <ReturnValue>
  586. <ReturnType>Urho.StringHash</ReturnType>
  587. </ReturnValue>
  588. <Docs>
  589. <summary>Urho's low-level type, accessible as a static method.</summary>
  590. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  591. <remarks></remarks>
  592. </Docs>
  593. </Member>
  594. <Member MemberName="UseTimer">
  595. <MemberSignature Language="C#" Value="public uint UseTimer { get; }" />
  596. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 UseTimer" />
  597. <MemberType>Property</MemberType>
  598. <AssemblyInfo>
  599. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  600. </AssemblyInfo>
  601. <ReturnValue>
  602. <ReturnType>System.UInt32</ReturnType>
  603. </ReturnValue>
  604. <Docs>
  605. <summary>
  606. Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero.
  607. </summary>
  608. <value>To be added.</value>
  609. <remarks>To be added.</remarks>
  610. </Docs>
  611. </Member>
  612. </Members>
  613. </Type>