Drawable.xml 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957
  1. <Type Name="Drawable" FullName="Urho.Drawable">
  2. <TypeSignature Language="C#" Value="public class Drawable : Urho.Component" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Drawable extends Urho.Component" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Component</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Base class for visible components.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public Drawable (IntPtr handle);" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) 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. <Parameter Name="handle" Type="System.IntPtr" />
  33. </Parameters>
  34. <Docs>
  35. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  36. <summary>Constructs a new instance of Urho.Drawable, given a raw pointer to an unmanaged object</summary>
  37. <remarks>
  38. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  39. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  40. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  41. </remarks>
  42. </Docs>
  43. </Member>
  44. <Member MemberName=".ctor">
  45. <MemberSignature Language="C#" Value="protected Drawable (Urho.UrhoObjectFlag emptyFlag);" />
  46. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  47. <MemberType>Constructor</MemberType>
  48. <AssemblyInfo>
  49. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  50. </AssemblyInfo>
  51. <Attributes>
  52. <Attribute>
  53. <AttributeName>Preserve</AttributeName>
  54. </Attribute>
  55. </Attributes>
  56. <Parameters>
  57. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  58. </Parameters>
  59. <Docs>
  60. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  61. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  62. <remarks>
  63. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  64. <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>
  65. <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>
  66. </remarks>
  67. </Docs>
  68. </Member>
  69. <Member MemberName="AddLight">
  70. <MemberSignature Language="C#" Value="public void AddLight (Urho.Light light);" />
  71. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddLight(class Urho.Light light) cil managed" />
  72. <MemberType>Method</MemberType>
  73. <AssemblyInfo>
  74. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  75. </AssemblyInfo>
  76. <ReturnValue>
  77. <ReturnType>System.Void</ReturnType>
  78. </ReturnValue>
  79. <Parameters>
  80. <Parameter Name="light" Type="Urho.Light" />
  81. </Parameters>
  82. <Docs>
  83. <param name="light">To be added.</param>
  84. <summary>Adds the specified light.</summary>
  85. <remarks>To be added.</remarks>
  86. </Docs>
  87. </Member>
  88. <Member MemberName="AddVertexLight">
  89. <MemberSignature Language="C#" Value="public void AddVertexLight (Urho.Light light);" />
  90. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddVertexLight(class Urho.Light light) cil managed" />
  91. <MemberType>Method</MemberType>
  92. <AssemblyInfo>
  93. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  94. </AssemblyInfo>
  95. <ReturnValue>
  96. <ReturnType>System.Void</ReturnType>
  97. </ReturnValue>
  98. <Parameters>
  99. <Parameter Name="light" Type="Urho.Light" />
  100. </Parameters>
  101. <Docs>
  102. <param name="light">To be added.</param>
  103. <summary>Adds the specified vertex light.</summary>
  104. <remarks>To be added.</remarks>
  105. </Docs>
  106. </Member>
  107. <Member MemberName="BoundingBox">
  108. <MemberSignature Language="C#" Value="public Urho.BoundingBox BoundingBox { get; }" />
  109. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.BoundingBox BoundingBox" />
  110. <MemberType>Property</MemberType>
  111. <AssemblyInfo>
  112. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  113. </AssemblyInfo>
  114. <ReturnValue>
  115. <ReturnType>Urho.BoundingBox</ReturnType>
  116. </ReturnValue>
  117. <Docs>
  118. <summary>
  119. Return local space bounding box. May not be applicable or properly updated on all drawables.
  120. </summary>
  121. <value>To be added.</value>
  122. <remarks>To be added.</remarks>
  123. </Docs>
  124. </Member>
  125. <Member MemberName="CastShadows">
  126. <MemberSignature Language="C#" Value="public bool CastShadows { get; set; }" />
  127. <MemberSignature Language="ILAsm" Value=".property instance bool CastShadows" />
  128. <MemberType>Property</MemberType>
  129. <AssemblyInfo>
  130. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  131. </AssemblyInfo>
  132. <ReturnValue>
  133. <ReturnType>System.Boolean</ReturnType>
  134. </ReturnValue>
  135. <Docs>
  136. <summary>
  137. Return shadowcaster flag.
  138. Or
  139. Set shadowcaster flag.
  140. </summary>
  141. <value>To be added.</value>
  142. <remarks>To be added.</remarks>
  143. </Docs>
  144. </Member>
  145. <Member MemberName="Distance">
  146. <MemberSignature Language="C#" Value="public float Distance { get; }" />
  147. <MemberSignature Language="ILAsm" Value=".property instance float32 Distance" />
  148. <MemberType>Property</MemberType>
  149. <AssemblyInfo>
  150. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  151. </AssemblyInfo>
  152. <ReturnValue>
  153. <ReturnType>System.Single</ReturnType>
  154. </ReturnValue>
  155. <Docs>
  156. <summary>
  157. Return distance from camera.
  158. </summary>
  159. <value>To be added.</value>
  160. <remarks>To be added.</remarks>
  161. </Docs>
  162. </Member>
  163. <Member MemberName="DrawableFlags">
  164. <MemberSignature Language="C#" Value="public byte DrawableFlags { get; }" />
  165. <MemberSignature Language="ILAsm" Value=".property instance unsigned int8 DrawableFlags" />
  166. <MemberType>Property</MemberType>
  167. <AssemblyInfo>
  168. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  169. </AssemblyInfo>
  170. <ReturnValue>
  171. <ReturnType>System.Byte</ReturnType>
  172. </ReturnValue>
  173. <Docs>
  174. <summary>
  175. Return drawable flags.
  176. </summary>
  177. <value>To be added.</value>
  178. <remarks>To be added.</remarks>
  179. </Docs>
  180. </Member>
  181. <Member MemberName="DrawDebugGeometry">
  182. <MemberSignature Language="C#" Value="public override void DrawDebugGeometry (Urho.DebugRenderer debug, bool depthTest);" />
  183. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void DrawDebugGeometry(class Urho.DebugRenderer debug, bool depthTest) cil managed" />
  184. <MemberType>Method</MemberType>
  185. <AssemblyInfo>
  186. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  187. </AssemblyInfo>
  188. <ReturnValue>
  189. <ReturnType>System.Void</ReturnType>
  190. </ReturnValue>
  191. <Parameters>
  192. <Parameter Name="debug" Type="Urho.DebugRenderer" />
  193. <Parameter Name="depthTest" Type="System.Boolean" />
  194. </Parameters>
  195. <Docs>
  196. <param name="debug">To be added.</param>
  197. <param name="depthTest">To be added.</param>
  198. <summary>
  199. Visualize the component as debug geometry.
  200. </summary>
  201. <remarks>To be added.</remarks>
  202. </Docs>
  203. </Member>
  204. <Member MemberName="DrawDistance">
  205. <MemberSignature Language="C#" Value="public float DrawDistance { get; set; }" />
  206. <MemberSignature Language="ILAsm" Value=".property instance float32 DrawDistance" />
  207. <MemberType>Property</MemberType>
  208. <AssemblyInfo>
  209. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  210. </AssemblyInfo>
  211. <ReturnValue>
  212. <ReturnType>System.Single</ReturnType>
  213. </ReturnValue>
  214. <Docs>
  215. <summary>
  216. Return draw distance.
  217. Or
  218. Set draw distance.
  219. </summary>
  220. <value>To be added.</value>
  221. <remarks>To be added.</remarks>
  222. </Docs>
  223. </Member>
  224. <Member MemberName="DrawOcclusion">
  225. <MemberSignature Language="C#" Value="public virtual bool DrawOcclusion (Urho.OcclusionBuffer buffer);" />
  226. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool DrawOcclusion(class Urho.OcclusionBuffer buffer) cil managed" />
  227. <MemberType>Method</MemberType>
  228. <AssemblyInfo>
  229. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  230. </AssemblyInfo>
  231. <ReturnValue>
  232. <ReturnType>System.Boolean</ReturnType>
  233. </ReturnValue>
  234. <Parameters>
  235. <Parameter Name="buffer" Type="Urho.OcclusionBuffer" />
  236. </Parameters>
  237. <Docs>
  238. <param name="buffer">To be added.</param>
  239. <summary>
  240. Draw to occlusion buffer. Return true if did not run out of triangles.
  241. </summary>
  242. <returns>To be added.</returns>
  243. <remarks>To be added.</remarks>
  244. </Docs>
  245. </Member>
  246. <Member MemberName="FirstLight">
  247. <MemberSignature Language="C#" Value="public Urho.Light FirstLight { get; }" />
  248. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Light FirstLight" />
  249. <MemberType>Property</MemberType>
  250. <AssemblyInfo>
  251. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  252. </AssemblyInfo>
  253. <ReturnValue>
  254. <ReturnType>Urho.Light</ReturnType>
  255. </ReturnValue>
  256. <Docs>
  257. <summary>
  258. Return the first added per-pixel light.
  259. </summary>
  260. <value>To be added.</value>
  261. <remarks>To be added.</remarks>
  262. </Docs>
  263. </Member>
  264. <Member MemberName="GetLodGeometry">
  265. <MemberSignature Language="C#" Value="public virtual Urho.Geometry GetLodGeometry (uint batchIndex, uint level);" />
  266. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Urho.Geometry GetLodGeometry(unsigned int32 batchIndex, unsigned int32 level) cil managed" />
  267. <MemberType>Method</MemberType>
  268. <AssemblyInfo>
  269. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  270. </AssemblyInfo>
  271. <ReturnValue>
  272. <ReturnType>Urho.Geometry</ReturnType>
  273. </ReturnValue>
  274. <Parameters>
  275. <Parameter Name="batchIndex" Type="System.UInt32" />
  276. <Parameter Name="level" Type="System.UInt32" />
  277. </Parameters>
  278. <Docs>
  279. <param name="batchIndex">To be added.</param>
  280. <param name="level">To be added.</param>
  281. <summary>
  282. Return the geometry for a specific LOD level.
  283. </summary>
  284. <returns>To be added.</returns>
  285. <remarks>To be added.</remarks>
  286. </Docs>
  287. </Member>
  288. <Member MemberName="HasBasePass">
  289. <MemberSignature Language="C#" Value="public bool HasBasePass (uint batchIndex);" />
  290. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasBasePass(unsigned int32 batchIndex) cil managed" />
  291. <MemberType>Method</MemberType>
  292. <AssemblyInfo>
  293. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  294. </AssemblyInfo>
  295. <ReturnValue>
  296. <ReturnType>System.Boolean</ReturnType>
  297. </ReturnValue>
  298. <Parameters>
  299. <Parameter Name="batchIndex" Type="System.UInt32" />
  300. </Parameters>
  301. <Docs>
  302. <param name="batchIndex">To be added.</param>
  303. <summary>
  304. Return whether has a base pass.
  305. </summary>
  306. <returns>To be added.</returns>
  307. <remarks>To be added.</remarks>
  308. </Docs>
  309. </Member>
  310. <Member MemberName="InView">
  311. <MemberSignature Language="C#" Value="public bool InView { get; }" />
  312. <MemberSignature Language="ILAsm" Value=".property instance bool InView" />
  313. <MemberType>Property</MemberType>
  314. <AssemblyInfo>
  315. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  316. </AssemblyInfo>
  317. <ReturnValue>
  318. <ReturnType>System.Boolean</ReturnType>
  319. </ReturnValue>
  320. <Docs>
  321. <summary>Return whether is in view this frame from any viewport camera. Excludes shadow map cameras.</summary>
  322. <value>To be added.</value>
  323. <remarks>To be added.</remarks>
  324. </Docs>
  325. </Member>
  326. <Member MemberName="IsInView">
  327. <MemberSignature Language="C#" Value="public bool IsInView (Urho.Camera camera);" />
  328. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsInView(class Urho.Camera camera) cil managed" />
  329. <MemberType>Method</MemberType>
  330. <AssemblyInfo>
  331. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  332. </AssemblyInfo>
  333. <ReturnValue>
  334. <ReturnType>System.Boolean</ReturnType>
  335. </ReturnValue>
  336. <Parameters>
  337. <Parameter Name="camera" Type="Urho.Camera" />
  338. </Parameters>
  339. <Docs>
  340. <param name="camera">To be added.</param>
  341. <summary>
  342. Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.
  343. </summary>
  344. <returns>To be added.</returns>
  345. <remarks>To be added.</remarks>
  346. </Docs>
  347. </Member>
  348. <Member MemberName="LightMask">
  349. <MemberSignature Language="C#" Value="public uint LightMask { get; set; }" />
  350. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 LightMask" />
  351. <MemberType>Property</MemberType>
  352. <AssemblyInfo>
  353. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  354. </AssemblyInfo>
  355. <ReturnValue>
  356. <ReturnType>System.UInt32</ReturnType>
  357. </ReturnValue>
  358. <Docs>
  359. <summary>
  360. Return light mask.
  361. Or
  362. Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit.
  363. </summary>
  364. <value>To be added.</value>
  365. <remarks>To be added.</remarks>
  366. </Docs>
  367. </Member>
  368. <Member MemberName="LimitLights">
  369. <MemberSignature Language="C#" Value="public void LimitLights ();" />
  370. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void LimitLights() cil managed" />
  371. <MemberType>Method</MemberType>
  372. <AssemblyInfo>
  373. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  374. </AssemblyInfo>
  375. <ReturnValue>
  376. <ReturnType>System.Void</ReturnType>
  377. </ReturnValue>
  378. <Parameters />
  379. <Docs>
  380. <summary>
  381. Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.
  382. </summary>
  383. <remarks>To be added.</remarks>
  384. </Docs>
  385. </Member>
  386. <Member MemberName="LimitVertexLights">
  387. <MemberSignature Language="C#" Value="public void LimitVertexLights (bool removeConvertedLights);" />
  388. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void LimitVertexLights(bool removeConvertedLights) cil managed" />
  389. <MemberType>Method</MemberType>
  390. <AssemblyInfo>
  391. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  392. </AssemblyInfo>
  393. <ReturnValue>
  394. <ReturnType>System.Void</ReturnType>
  395. </ReturnValue>
  396. <Parameters>
  397. <Parameter Name="removeConvertedLights" Type="System.Boolean" />
  398. </Parameters>
  399. <Docs>
  400. <param name="removeConvertedLights">To be added.</param>
  401. <summary>
  402. Sort and limit per-vertex lights to maximum allowed.
  403. </summary>
  404. <remarks>To be added.</remarks>
  405. </Docs>
  406. </Member>
  407. <Member MemberName="LodBias">
  408. <MemberSignature Language="C#" Value="public float LodBias { get; set; }" />
  409. <MemberSignature Language="ILAsm" Value=".property instance float32 LodBias" />
  410. <MemberType>Property</MemberType>
  411. <AssemblyInfo>
  412. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  413. </AssemblyInfo>
  414. <ReturnValue>
  415. <ReturnType>System.Single</ReturnType>
  416. </ReturnValue>
  417. <Docs>
  418. <summary>
  419. Return LOD bias.
  420. Or
  421. Set LOD bias.
  422. </summary>
  423. <value>To be added.</value>
  424. <remarks>To be added.</remarks>
  425. </Docs>
  426. </Member>
  427. <Member MemberName="LodDistance">
  428. <MemberSignature Language="C#" Value="public float LodDistance { get; }" />
  429. <MemberSignature Language="ILAsm" Value=".property instance float32 LodDistance" />
  430. <MemberType>Property</MemberType>
  431. <AssemblyInfo>
  432. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  433. </AssemblyInfo>
  434. <ReturnValue>
  435. <ReturnType>System.Single</ReturnType>
  436. </ReturnValue>
  437. <Docs>
  438. <summary>
  439. Return LOD scaled distance from camera.
  440. </summary>
  441. <value>To be added.</value>
  442. <remarks>To be added.</remarks>
  443. </Docs>
  444. </Member>
  445. <Member MemberName="MarkForUpdate">
  446. <MemberSignature Language="C#" Value="public void MarkForUpdate ();" />
  447. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void MarkForUpdate() cil managed" />
  448. <MemberType>Method</MemberType>
  449. <AssemblyInfo>
  450. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  451. </AssemblyInfo>
  452. <ReturnValue>
  453. <ReturnType>System.Void</ReturnType>
  454. </ReturnValue>
  455. <Parameters />
  456. <Docs>
  457. <summary>
  458. Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
  459. </summary>
  460. <remarks>To be added.</remarks>
  461. </Docs>
  462. </Member>
  463. <Member MemberName="MarkInView">
  464. <MemberSignature Language="C#" Value="public void MarkInView (uint frameNumber);" />
  465. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void MarkInView(unsigned int32 frameNumber) cil managed" />
  466. <MemberType>Method</MemberType>
  467. <AssemblyInfo>
  468. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  469. </AssemblyInfo>
  470. <ReturnValue>
  471. <ReturnType>System.Void</ReturnType>
  472. </ReturnValue>
  473. <Parameters>
  474. <Parameter Name="frameNumber" Type="System.UInt32" />
  475. </Parameters>
  476. <Docs>
  477. <param name="frameNumber">To be added.</param>
  478. <summary>
  479. Mark in view without specifying a camera. Used for shadow casters.
  480. </summary>
  481. <remarks>To be added.</remarks>
  482. </Docs>
  483. </Member>
  484. <Member MemberName="MaxLights">
  485. <MemberSignature Language="C#" Value="public uint MaxLights { get; set; }" />
  486. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 MaxLights" />
  487. <MemberType>Property</MemberType>
  488. <AssemblyInfo>
  489. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  490. </AssemblyInfo>
  491. <ReturnValue>
  492. <ReturnType>System.UInt32</ReturnType>
  493. </ReturnValue>
  494. <Docs>
  495. <summary>
  496. Return maximum number of per-pixel lights.
  497. Or
  498. Set maximum number of per-pixel lights. Default 0 is unlimited.
  499. </summary>
  500. <value>To be added.</value>
  501. <remarks>To be added.</remarks>
  502. </Docs>
  503. </Member>
  504. <Member MemberName="MaxZ">
  505. <MemberSignature Language="C#" Value="public float MaxZ { get; }" />
  506. <MemberSignature Language="ILAsm" Value=".property instance float32 MaxZ" />
  507. <MemberType>Property</MemberType>
  508. <AssemblyInfo>
  509. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  510. </AssemblyInfo>
  511. <ReturnValue>
  512. <ReturnType>System.Single</ReturnType>
  513. </ReturnValue>
  514. <Docs>
  515. <summary>
  516. Return the maximum view-space depth.
  517. </summary>
  518. <value>To be added.</value>
  519. <remarks>To be added.</remarks>
  520. </Docs>
  521. </Member>
  522. <Member MemberName="MinZ">
  523. <MemberSignature Language="C#" Value="public float MinZ { get; }" />
  524. <MemberSignature Language="ILAsm" Value=".property instance float32 MinZ" />
  525. <MemberType>Property</MemberType>
  526. <AssemblyInfo>
  527. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  528. </AssemblyInfo>
  529. <ReturnValue>
  530. <ReturnType>System.Single</ReturnType>
  531. </ReturnValue>
  532. <Docs>
  533. <summary>
  534. Return the minimum view-space depth.
  535. </summary>
  536. <value>To be added.</value>
  537. <remarks>To be added.</remarks>
  538. </Docs>
  539. </Member>
  540. <Member MemberName="NumOccluderTriangles">
  541. <MemberSignature Language="C#" Value="public virtual uint NumOccluderTriangles { get; }" />
  542. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumOccluderTriangles" />
  543. <MemberType>Property</MemberType>
  544. <AssemblyInfo>
  545. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  546. </AssemblyInfo>
  547. <ReturnValue>
  548. <ReturnType>System.UInt32</ReturnType>
  549. </ReturnValue>
  550. <Docs>
  551. <summary>
  552. Return number of occlusion geometry triangles.
  553. </summary>
  554. <value>To be added.</value>
  555. <remarks>To be added.</remarks>
  556. </Docs>
  557. </Member>
  558. <Member MemberName="Occludee">
  559. <MemberSignature Language="C#" Value="public bool Occludee { get; set; }" />
  560. <MemberSignature Language="ILAsm" Value=".property instance bool Occludee" />
  561. <MemberType>Property</MemberType>
  562. <AssemblyInfo>
  563. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  564. </AssemblyInfo>
  565. <ReturnValue>
  566. <ReturnType>System.Boolean</ReturnType>
  567. </ReturnValue>
  568. <Docs>
  569. <summary>Controls the occludee flag.</summary>
  570. <value>To be added.</value>
  571. <remarks>To be added.</remarks>
  572. </Docs>
  573. </Member>
  574. <Member MemberName="Occluder">
  575. <MemberSignature Language="C#" Value="public bool Occluder { get; set; }" />
  576. <MemberSignature Language="ILAsm" Value=".property instance bool Occluder" />
  577. <MemberType>Property</MemberType>
  578. <AssemblyInfo>
  579. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  580. </AssemblyInfo>
  581. <ReturnValue>
  582. <ReturnType>System.Boolean</ReturnType>
  583. </ReturnValue>
  584. <Docs>
  585. <summary>Controls the occluder flag.</summary>
  586. <value>To be added.</value>
  587. <remarks>To be added.</remarks>
  588. </Docs>
  589. </Member>
  590. <Member MemberName="Octant">
  591. <MemberSignature Language="C#" Value="public Urho.Octant* Octant { get; }" />
  592. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Octant* Octant" />
  593. <MemberType>Property</MemberType>
  594. <AssemblyInfo>
  595. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  596. </AssemblyInfo>
  597. <ReturnValue>
  598. <ReturnType>Urho.Octant*</ReturnType>
  599. </ReturnValue>
  600. <Docs>
  601. <summary>
  602. Return octree octant.
  603. </summary>
  604. <value>To be added.</value>
  605. <remarks>To be added.</remarks>
  606. </Docs>
  607. </Member>
  608. <Member MemberName="OnSetEnabled">
  609. <MemberSignature Language="C#" Value="public override void OnSetEnabled ();" />
  610. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void OnSetEnabled() cil managed" />
  611. <MemberType>Method</MemberType>
  612. <AssemblyInfo>
  613. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  614. </AssemblyInfo>
  615. <ReturnValue>
  616. <ReturnType>System.Void</ReturnType>
  617. </ReturnValue>
  618. <Parameters />
  619. <Docs>
  620. <summary>
  621. Handle enabled/disabled state change.
  622. </summary>
  623. <remarks>To be added.</remarks>
  624. </Docs>
  625. </Member>
  626. <Member MemberName="RegisterObject">
  627. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  628. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  629. <MemberType>Method</MemberType>
  630. <AssemblyInfo>
  631. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  632. </AssemblyInfo>
  633. <ReturnValue>
  634. <ReturnType>System.Void</ReturnType>
  635. </ReturnValue>
  636. <Parameters>
  637. <Parameter Name="context" Type="Urho.Context" />
  638. </Parameters>
  639. <Docs>
  640. <param name="context">To be added.</param>
  641. <summary>
  642. Register object attributes. Drawable must be registered first.
  643. </summary>
  644. <remarks>To be added.</remarks>
  645. </Docs>
  646. </Member>
  647. <Member MemberName="SetBasePass">
  648. <MemberSignature Language="C#" Value="public void SetBasePass (uint batchIndex);" />
  649. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetBasePass(unsigned int32 batchIndex) cil managed" />
  650. <MemberType>Method</MemberType>
  651. <AssemblyInfo>
  652. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  653. </AssemblyInfo>
  654. <ReturnValue>
  655. <ReturnType>System.Void</ReturnType>
  656. </ReturnValue>
  657. <Parameters>
  658. <Parameter Name="batchIndex" Type="System.UInt32" />
  659. </Parameters>
  660. <Docs>
  661. <param name="batchIndex">To be added.</param>
  662. <summary>
  663. Set base pass flag for a batch.
  664. </summary>
  665. <remarks>To be added.</remarks>
  666. </Docs>
  667. </Member>
  668. <Member MemberName="SetMinMaxZ">
  669. <MemberSignature Language="C#" Value="public void SetMinMaxZ (float minZ, float maxZ);" />
  670. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetMinMaxZ(float32 minZ, float32 maxZ) cil managed" />
  671. <MemberType>Method</MemberType>
  672. <AssemblyInfo>
  673. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  674. </AssemblyInfo>
  675. <ReturnValue>
  676. <ReturnType>System.Void</ReturnType>
  677. </ReturnValue>
  678. <Parameters>
  679. <Parameter Name="minZ" Type="System.Single" />
  680. <Parameter Name="maxZ" Type="System.Single" />
  681. </Parameters>
  682. <Docs>
  683. <param name="minZ">To be added.</param>
  684. <param name="maxZ">To be added.</param>
  685. <summary>
  686. Set view-space depth bounds.
  687. </summary>
  688. <remarks>To be added.</remarks>
  689. </Docs>
  690. </Member>
  691. <Member MemberName="SetZone">
  692. <MemberSignature Language="C#" Value="public void SetZone (Urho.Zone zone, bool temporary = false);" />
  693. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetZone(class Urho.Zone zone, bool temporary) cil managed" />
  694. <MemberType>Method</MemberType>
  695. <AssemblyInfo>
  696. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  697. </AssemblyInfo>
  698. <ReturnValue>
  699. <ReturnType>System.Void</ReturnType>
  700. </ReturnValue>
  701. <Parameters>
  702. <Parameter Name="zone" Type="Urho.Zone" />
  703. <Parameter Name="temporary" Type="System.Boolean" />
  704. </Parameters>
  705. <Docs>
  706. <param name="zone">To be added.</param>
  707. <param name="temporary">To be added.</param>
  708. <summary>
  709. Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.
  710. </summary>
  711. <remarks>To be added.</remarks>
  712. </Docs>
  713. </Member>
  714. <Member MemberName="ShadowDistance">
  715. <MemberSignature Language="C#" Value="public float ShadowDistance { get; set; }" />
  716. <MemberSignature Language="ILAsm" Value=".property instance float32 ShadowDistance" />
  717. <MemberType>Property</MemberType>
  718. <AssemblyInfo>
  719. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  720. </AssemblyInfo>
  721. <ReturnValue>
  722. <ReturnType>System.Single</ReturnType>
  723. </ReturnValue>
  724. <Docs>
  725. <summary>
  726. Return shadow draw distance.
  727. Or
  728. Set shadow draw distance.
  729. </summary>
  730. <value>To be added.</value>
  731. <remarks>To be added.</remarks>
  732. </Docs>
  733. </Member>
  734. <Member MemberName="ShadowMask">
  735. <MemberSignature Language="C#" Value="public uint ShadowMask { get; set; }" />
  736. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 ShadowMask" />
  737. <MemberType>Property</MemberType>
  738. <AssemblyInfo>
  739. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  740. </AssemblyInfo>
  741. <ReturnValue>
  742. <ReturnType>System.UInt32</ReturnType>
  743. </ReturnValue>
  744. <Docs>
  745. <summary>
  746. Return shadow mask.
  747. Or
  748. Set shadow mask. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map.
  749. </summary>
  750. <value>To be added.</value>
  751. <remarks>To be added.</remarks>
  752. </Docs>
  753. </Member>
  754. <Member MemberName="SortValue">
  755. <MemberSignature Language="C#" Value="public float SortValue { get; set; }" />
  756. <MemberSignature Language="ILAsm" Value=".property instance float32 SortValue" />
  757. <MemberType>Property</MemberType>
  758. <AssemblyInfo>
  759. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  760. </AssemblyInfo>
  761. <ReturnValue>
  762. <ReturnType>System.Single</ReturnType>
  763. </ReturnValue>
  764. <Docs>
  765. <summary>
  766. Return sorting value.
  767. Or
  768. Set sorting value.
  769. </summary>
  770. <value>To be added.</value>
  771. <remarks>To be added.</remarks>
  772. </Docs>
  773. </Member>
  774. <Member MemberName="Type">
  775. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  776. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  777. <MemberType>Property</MemberType>
  778. <AssemblyInfo>
  779. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  780. </AssemblyInfo>
  781. <ReturnValue>
  782. <ReturnType>Urho.StringHash</ReturnType>
  783. </ReturnValue>
  784. <Docs>
  785. <summary>Urho's type system type.</summary>
  786. <value>StringHash representing the type for this C# type.</value>
  787. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  788. </Docs>
  789. </Member>
  790. <Member MemberName="TypeName">
  791. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  792. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  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.</summary>
  802. <value>Stringified low-level type name.</value>
  803. <remarks>
  804. </remarks>
  805. </Docs>
  806. </Member>
  807. <Member MemberName="TypeNameStatic">
  808. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  809. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  810. <MemberType>Property</MemberType>
  811. <AssemblyInfo>
  812. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  813. </AssemblyInfo>
  814. <ReturnValue>
  815. <ReturnType>System.String</ReturnType>
  816. </ReturnValue>
  817. <Docs>
  818. <summary>Urho's low-level type name, accessible as a static method.</summary>
  819. <value>Stringified low-level type name.</value>
  820. <remarks>
  821. </remarks>
  822. </Docs>
  823. </Member>
  824. <Member MemberName="TypeStatic">
  825. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  826. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  827. <MemberType>Property</MemberType>
  828. <AssemblyInfo>
  829. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  830. </AssemblyInfo>
  831. <Attributes>
  832. <Attribute>
  833. <AttributeName>Preserve</AttributeName>
  834. </Attribute>
  835. </Attributes>
  836. <ReturnValue>
  837. <ReturnType>Urho.StringHash</ReturnType>
  838. </ReturnValue>
  839. <Docs>
  840. <summary>Urho's low-level type, accessible as a static method.</summary>
  841. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  842. <remarks>
  843. </remarks>
  844. </Docs>
  845. </Member>
  846. <Member MemberName="UpdateGeometryType">
  847. <MemberSignature Language="C#" Value="public virtual Urho.UpdateGeometryType UpdateGeometryType { get; }" />
  848. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.UpdateGeometryType UpdateGeometryType" />
  849. <MemberType>Property</MemberType>
  850. <AssemblyInfo>
  851. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  852. </AssemblyInfo>
  853. <ReturnValue>
  854. <ReturnType>Urho.UpdateGeometryType</ReturnType>
  855. </ReturnValue>
  856. <Docs>
  857. <summary>
  858. Return whether a geometry update is necessary, and if it can happen in a worker thread.
  859. </summary>
  860. <value>To be added.</value>
  861. <remarks>To be added.</remarks>
  862. </Docs>
  863. </Member>
  864. <Member MemberName="ViewMask">
  865. <MemberSignature Language="C#" Value="public uint ViewMask { get; set; }" />
  866. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 ViewMask" />
  867. <MemberType>Property</MemberType>
  868. <AssemblyInfo>
  869. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  870. </AssemblyInfo>
  871. <ReturnValue>
  872. <ReturnType>System.UInt32</ReturnType>
  873. </ReturnValue>
  874. <Docs>
  875. <summary>
  876. Return view mask.
  877. Or
  878. Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.
  879. </summary>
  880. <value>To be added.</value>
  881. <remarks>To be added.</remarks>
  882. </Docs>
  883. </Member>
  884. <Member MemberName="WorldBoundingBox">
  885. <MemberSignature Language="C#" Value="public Urho.BoundingBox WorldBoundingBox { get; }" />
  886. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.BoundingBox WorldBoundingBox" />
  887. <MemberType>Property</MemberType>
  888. <AssemblyInfo>
  889. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  890. </AssemblyInfo>
  891. <ReturnValue>
  892. <ReturnType>Urho.BoundingBox</ReturnType>
  893. </ReturnValue>
  894. <Docs>
  895. <summary>
  896. Return world-space bounding box.
  897. </summary>
  898. <value>To be added.</value>
  899. <remarks>To be added.</remarks>
  900. </Docs>
  901. </Member>
  902. <Member MemberName="Zone">
  903. <MemberSignature Language="C#" Value="public Urho.Zone Zone { get; }" />
  904. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Zone Zone" />
  905. <MemberType>Property</MemberType>
  906. <AssemblyInfo>
  907. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  908. </AssemblyInfo>
  909. <ReturnValue>
  910. <ReturnType>Urho.Zone</ReturnType>
  911. </ReturnValue>
  912. <Docs>
  913. <summary>
  914. Return current zone.
  915. </summary>
  916. <value>To be added.</value>
  917. <remarks>To be added.</remarks>
  918. </Docs>
  919. </Member>
  920. <Member MemberName="ZoneDirty">
  921. <MemberSignature Language="C#" Value="public bool ZoneDirty { get; }" />
  922. <MemberSignature Language="ILAsm" Value=".property instance bool ZoneDirty" />
  923. <MemberType>Property</MemberType>
  924. <AssemblyInfo>
  925. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  926. </AssemblyInfo>
  927. <ReturnValue>
  928. <ReturnType>System.Boolean</ReturnType>
  929. </ReturnValue>
  930. <Docs>
  931. <summary>Return whether current zone is inconclusive or dirty due to the drawable moving.</summary>
  932. <value>To be added.</value>
  933. <remarks>To be added.</remarks>
  934. </Docs>
  935. </Member>
  936. <Member MemberName="ZoneMask">
  937. <MemberSignature Language="C#" Value="public uint ZoneMask { get; set; }" />
  938. <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 ZoneMask" />
  939. <MemberType>Property</MemberType>
  940. <AssemblyInfo>
  941. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  942. </AssemblyInfo>
  943. <ReturnValue>
  944. <ReturnType>System.UInt32</ReturnType>
  945. </ReturnValue>
  946. <Docs>
  947. <summary>
  948. Return zone mask.
  949. Or
  950. Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.
  951. </summary>
  952. <value>To be added.</value>
  953. <remarks>To be added.</remarks>
  954. </Docs>
  955. </Member>
  956. </Members>
  957. </Type>