Light.xml 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963
  1. <Type Name="Light" FullName="Urho.Light">
  2. <TypeSignature Language="C#" Value="public class Light : Urho.Drawable" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Light extends Urho.Drawable" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Drawable</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Light component.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public Light ();" />
  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.Light which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  35. </summary>
  36. <remarks>
  37. </remarks>
  38. </Docs>
  39. </Member>
  40. <Member MemberName=".ctor">
  41. <MemberSignature Language="C#" Value="public Light (IntPtr handle);" />
  42. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  43. <MemberType>Constructor</MemberType>
  44. <AssemblyInfo>
  45. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  46. </AssemblyInfo>
  47. <Attributes>
  48. <Attribute>
  49. <AttributeName>Preserve</AttributeName>
  50. </Attribute>
  51. </Attributes>
  52. <Parameters>
  53. <Parameter Name="handle" Type="System.IntPtr" />
  54. </Parameters>
  55. <Docs>
  56. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  57. <summary>Constructs a new instance of Urho.Light, given a raw pointer to an unmanaged object</summary>
  58. <remarks>
  59. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  60. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  61. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  62. </remarks>
  63. </Docs>
  64. </Member>
  65. <Member MemberName=".ctor">
  66. <MemberSignature Language="C#" Value="public Light (Urho.Context context);" />
  67. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  68. <MemberType>Constructor</MemberType>
  69. <AssemblyInfo>
  70. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  71. </AssemblyInfo>
  72. <Attributes>
  73. <Attribute>
  74. <AttributeName>Preserve</AttributeName>
  75. </Attribute>
  76. </Attributes>
  77. <Parameters>
  78. <Parameter Name="context" Type="Urho.Context" />
  79. </Parameters>
  80. <Docs>
  81. <param name="context">The context that this object will be attached to.</param>
  82. <summary>
  83. <para>Constructs a new instance of Urho.Light linked to a specific <see cref="T:Urho.Context" />.</para>
  84. </summary>
  85. <remarks>
  86. </remarks>
  87. </Docs>
  88. </Member>
  89. <Member MemberName=".ctor">
  90. <MemberSignature Language="C#" Value="protected Light (Urho.UrhoObjectFlag emptyFlag);" />
  91. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  92. <MemberType>Constructor</MemberType>
  93. <AssemblyInfo>
  94. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  95. </AssemblyInfo>
  96. <Attributes>
  97. <Attribute>
  98. <AttributeName>Preserve</AttributeName>
  99. </Attribute>
  100. </Attributes>
  101. <Parameters>
  102. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  103. </Parameters>
  104. <Docs>
  105. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  106. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  107. <remarks>
  108. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  109. <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>
  110. <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>
  111. </remarks>
  112. </Docs>
  113. </Member>
  114. <Member MemberName="AspectRatio">
  115. <MemberSignature Language="C#" Value="public float AspectRatio { get; set; }" />
  116. <MemberSignature Language="ILAsm" Value=".property instance float32 AspectRatio" />
  117. <MemberType>Property</MemberType>
  118. <AssemblyInfo>
  119. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  120. </AssemblyInfo>
  121. <ReturnValue>
  122. <ReturnType>System.Single</ReturnType>
  123. </ReturnValue>
  124. <Docs>
  125. <summary>
  126. Return spotlight aspect ratio.
  127. Or
  128. Set spotlight aspect ratio.
  129. </summary>
  130. <value>To be added.</value>
  131. <remarks>To be added.</remarks>
  132. </Docs>
  133. </Member>
  134. <Member MemberName="Brightness">
  135. <MemberSignature Language="C#" Value="public float Brightness { get; set; }" />
  136. <MemberSignature Language="ILAsm" Value=".property instance float32 Brightness" />
  137. <MemberType>Property</MemberType>
  138. <AssemblyInfo>
  139. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  140. </AssemblyInfo>
  141. <ReturnValue>
  142. <ReturnType>System.Single</ReturnType>
  143. </ReturnValue>
  144. <Docs>
  145. <summary>
  146. Return brightness multiplier.
  147. Or
  148. Set light brightness multiplier. Both the color and specular intensity are multiplied with this to get final values for rendering.
  149. </summary>
  150. <value>To be added.</value>
  151. <remarks>To be added.</remarks>
  152. </Docs>
  153. </Member>
  154. <Member MemberName="Color">
  155. <MemberSignature Language="C#" Value="public Urho.Color Color { get; set; }" />
  156. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Color Color" />
  157. <MemberType>Property</MemberType>
  158. <AssemblyInfo>
  159. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  160. </AssemblyInfo>
  161. <ReturnValue>
  162. <ReturnType>Urho.Color</ReturnType>
  163. </ReturnValue>
  164. <Docs>
  165. <summary>
  166. Return color.
  167. Or
  168. Set color.
  169. </summary>
  170. <value>To be added.</value>
  171. <remarks>To be added.</remarks>
  172. </Docs>
  173. </Member>
  174. <Member MemberName="ColorFromTemperature">
  175. <MemberSignature Language="C#" Value="public Urho.Color ColorFromTemperature { get; }" />
  176. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Color ColorFromTemperature" />
  177. <MemberType>Property</MemberType>
  178. <AssemblyInfo>
  179. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  180. </AssemblyInfo>
  181. <ReturnValue>
  182. <ReturnType>Urho.Color</ReturnType>
  183. </ReturnValue>
  184. <Docs>
  185. <summary>Return the color value of the temperature in Kelvin.</summary>
  186. <value>To be added.</value>
  187. <remarks>To be added.</remarks>
  188. </Docs>
  189. </Member>
  190. <Member MemberName="DrawDebugGeometry">
  191. <MemberSignature Language="C#" Value="public override void DrawDebugGeometry (Urho.DebugRenderer debug, bool depthTest);" />
  192. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void DrawDebugGeometry(class Urho.DebugRenderer debug, bool depthTest) cil managed" />
  193. <MemberType>Method</MemberType>
  194. <AssemblyInfo>
  195. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  196. </AssemblyInfo>
  197. <ReturnValue>
  198. <ReturnType>System.Void</ReturnType>
  199. </ReturnValue>
  200. <Parameters>
  201. <Parameter Name="debug" Type="Urho.DebugRenderer" />
  202. <Parameter Name="depthTest" Type="System.Boolean" />
  203. </Parameters>
  204. <Docs>
  205. <param name="debug">To be added.</param>
  206. <param name="depthTest">To be added.</param>
  207. <summary>
  208. Visualize the component as debug geometry.
  209. </summary>
  210. <remarks>To be added.</remarks>
  211. </Docs>
  212. </Member>
  213. <Member MemberName="EffectiveColor">
  214. <MemberSignature Language="C#" Value="public Urho.Color EffectiveColor { get; }" />
  215. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Color EffectiveColor" />
  216. <MemberType>Property</MemberType>
  217. <AssemblyInfo>
  218. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  219. </AssemblyInfo>
  220. <ReturnValue>
  221. <ReturnType>Urho.Color</ReturnType>
  222. </ReturnValue>
  223. <Docs>
  224. <summary>
  225. Return effective color, multiplied by brightness. Do not multiply the alpha so that can compare against the default black color to detect a light with no effect.
  226. </summary>
  227. <value>To be added.</value>
  228. <remarks>To be added.</remarks>
  229. </Docs>
  230. </Member>
  231. <Member MemberName="EffectiveSpecularIntensity">
  232. <MemberSignature Language="C#" Value="public float EffectiveSpecularIntensity { get; }" />
  233. <MemberSignature Language="ILAsm" Value=".property instance float32 EffectiveSpecularIntensity" />
  234. <MemberType>Property</MemberType>
  235. <AssemblyInfo>
  236. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  237. </AssemblyInfo>
  238. <ReturnValue>
  239. <ReturnType>System.Single</ReturnType>
  240. </ReturnValue>
  241. <Docs>
  242. <summary>
  243. Return effective specular intensity, multiplied by absolute value of brightness.
  244. </summary>
  245. <value>To be added.</value>
  246. <remarks>To be added.</remarks>
  247. </Docs>
  248. </Member>
  249. <Member MemberName="FadeDistance">
  250. <MemberSignature Language="C#" Value="public float FadeDistance { get; set; }" />
  251. <MemberSignature Language="ILAsm" Value=".property instance float32 FadeDistance" />
  252. <MemberType>Property</MemberType>
  253. <AssemblyInfo>
  254. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  255. </AssemblyInfo>
  256. <ReturnValue>
  257. <ReturnType>System.Single</ReturnType>
  258. </ReturnValue>
  259. <Docs>
  260. <summary>
  261. Return fade start distance.
  262. Or
  263. Set fade out start distance.
  264. </summary>
  265. <value>To be added.</value>
  266. <remarks>To be added.</remarks>
  267. </Docs>
  268. </Member>
  269. <Member MemberName="Fov">
  270. <MemberSignature Language="C#" Value="public float Fov { get; set; }" />
  271. <MemberSignature Language="ILAsm" Value=".property instance float32 Fov" />
  272. <MemberType>Property</MemberType>
  273. <AssemblyInfo>
  274. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  275. </AssemblyInfo>
  276. <ReturnValue>
  277. <ReturnType>System.Single</ReturnType>
  278. </ReturnValue>
  279. <Docs>
  280. <summary>
  281. Return spotlight field of view.
  282. Or
  283. Set spotlight field of view.
  284. </summary>
  285. <value>To be added.</value>
  286. <remarks>To be added.</remarks>
  287. </Docs>
  288. </Member>
  289. <Member MemberName="Frustum">
  290. <MemberSignature Language="C#" Value="public Urho.Frustum Frustum { get; }" />
  291. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Frustum Frustum" />
  292. <MemberType>Property</MemberType>
  293. <AssemblyInfo>
  294. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  295. </AssemblyInfo>
  296. <ReturnValue>
  297. <ReturnType>Urho.Frustum</ReturnType>
  298. </ReturnValue>
  299. <Docs>
  300. <summary>
  301. Return spotlight frustum.
  302. </summary>
  303. <value>To be added.</value>
  304. <remarks>To be added.</remarks>
  305. </Docs>
  306. </Member>
  307. <Member MemberName="GetFullscreenQuadTransform">
  308. <MemberSignature Language="C#" Value="public static Urho.Matrix3x4 GetFullscreenQuadTransform (Urho.Camera camera);" />
  309. <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Urho.Matrix3x4 GetFullscreenQuadTransform(class Urho.Camera camera) cil managed" />
  310. <MemberType>Method</MemberType>
  311. <AssemblyInfo>
  312. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  313. </AssemblyInfo>
  314. <ReturnValue>
  315. <ReturnType>Urho.Matrix3x4</ReturnType>
  316. </ReturnValue>
  317. <Parameters>
  318. <Parameter Name="camera" Type="Urho.Camera" />
  319. </Parameters>
  320. <Docs>
  321. <param name="camera">To be added.</param>
  322. <summary>To be added.</summary>
  323. <returns>To be added.</returns>
  324. <remarks>To be added.</remarks>
  325. </Docs>
  326. </Member>
  327. <Member MemberName="GetIntensityDivisor">
  328. <MemberSignature Language="C#" Value="public float GetIntensityDivisor (float attenuation = 1);" />
  329. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 GetIntensityDivisor(float32 attenuation) cil managed" />
  330. <MemberType>Method</MemberType>
  331. <AssemblyInfo>
  332. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  333. </AssemblyInfo>
  334. <ReturnValue>
  335. <ReturnType>System.Single</ReturnType>
  336. </ReturnValue>
  337. <Parameters>
  338. <Parameter Name="attenuation" Type="System.Single" />
  339. </Parameters>
  340. <Docs>
  341. <param name="attenuation">To be added.</param>
  342. <summary>
  343. Return a divisor value based on intensity for calculating the sort value.
  344. </summary>
  345. <returns>To be added.</returns>
  346. <remarks>To be added.</remarks>
  347. </Docs>
  348. </Member>
  349. <Member MemberName="GetViewSpaceFrustum">
  350. <MemberSignature Language="C#" Value="public Urho.Frustum GetViewSpaceFrustum (Urho.Matrix3x4 view);" />
  351. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Frustum GetViewSpaceFrustum(valuetype Urho.Matrix3x4 view) cil managed" />
  352. <MemberType>Method</MemberType>
  353. <AssemblyInfo>
  354. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  355. </AssemblyInfo>
  356. <ReturnValue>
  357. <ReturnType>Urho.Frustum</ReturnType>
  358. </ReturnValue>
  359. <Parameters>
  360. <Parameter Name="view" Type="Urho.Matrix3x4" />
  361. </Parameters>
  362. <Docs>
  363. <param name="view">View space.</param>
  364. <summary>Return spotlight frustum in the specified view space.</summary>
  365. <returns>Return spotlight frustum in the specified view space.</returns>
  366. <remarks>
  367. <para />
  368. </remarks>
  369. </Docs>
  370. </Member>
  371. <Member MemberName="GetVolumeTransform">
  372. <MemberSignature Language="C#" Value="public Urho.Matrix3x4 GetVolumeTransform (Urho.Camera camera);" />
  373. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Urho.Matrix3x4 GetVolumeTransform(class Urho.Camera camera) cil managed" />
  374. <MemberType>Method</MemberType>
  375. <AssemblyInfo>
  376. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  377. </AssemblyInfo>
  378. <ReturnValue>
  379. <ReturnType>Urho.Matrix3x4</ReturnType>
  380. </ReturnValue>
  381. <Parameters>
  382. <Parameter Name="camera" Type="Urho.Camera" />
  383. </Parameters>
  384. <Docs>
  385. <param name="camera">To be added.</param>
  386. <summary>To be added.</summary>
  387. <returns>To be added.</returns>
  388. <remarks>To be added.</remarks>
  389. </Docs>
  390. </Member>
  391. <Member MemberName="Length">
  392. <MemberSignature Language="C#" Value="public float Length { get; set; }" />
  393. <MemberSignature Language="ILAsm" Value=".property instance float32 Length" />
  394. <MemberType>Property</MemberType>
  395. <AssemblyInfo>
  396. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  397. </AssemblyInfo>
  398. <ReturnValue>
  399. <ReturnType>System.Single</ReturnType>
  400. </ReturnValue>
  401. <Docs>
  402. <summary>Return area tube light length. Works only with PBR shaders.
  403. Or
  404. Set tube area light length. Works only with PBR shaders.</summary>
  405. <value>To be added.</value>
  406. <remarks>To be added.</remarks>
  407. </Docs>
  408. </Member>
  409. <Member MemberName="LightQueue">
  410. <MemberSignature Language="C#" Value="public Urho.LightBatchQueue* LightQueue { get; set; }" />
  411. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.LightBatchQueue* LightQueue" />
  412. <MemberType>Property</MemberType>
  413. <AssemblyInfo>
  414. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  415. </AssemblyInfo>
  416. <ReturnValue>
  417. <ReturnType>Urho.LightBatchQueue*</ReturnType>
  418. </ReturnValue>
  419. <Docs>
  420. <summary>
  421. Return light queue. Called by View.
  422. Or
  423. Set light queue used for this light. Called by View.
  424. </summary>
  425. <value>To be added.</value>
  426. <remarks>To be added.</remarks>
  427. </Docs>
  428. </Member>
  429. <Member MemberName="LightType">
  430. <MemberSignature Language="C#" Value="public Urho.LightType LightType { get; set; }" />
  431. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.LightType LightType" />
  432. <MemberType>Property</MemberType>
  433. <AssemblyInfo>
  434. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  435. </AssemblyInfo>
  436. <ReturnValue>
  437. <ReturnType>Urho.LightType</ReturnType>
  438. </ReturnValue>
  439. <Docs>
  440. <summary>
  441. Return light type.
  442. Or
  443. Set light type.
  444. </summary>
  445. <value>To be added.</value>
  446. <remarks>To be added.</remarks>
  447. </Docs>
  448. </Member>
  449. <Member MemberName="Negative">
  450. <MemberSignature Language="C#" Value="public bool Negative { get; }" />
  451. <MemberSignature Language="ILAsm" Value=".property instance bool Negative" />
  452. <MemberType>Property</MemberType>
  453. <AssemblyInfo>
  454. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  455. </AssemblyInfo>
  456. <ReturnValue>
  457. <ReturnType>System.Boolean</ReturnType>
  458. </ReturnValue>
  459. <Docs>
  460. <summary>Return whether light has negative (darkening) color.</summary>
  461. <value>To be added.</value>
  462. <remarks>To be added.</remarks>
  463. </Docs>
  464. </Member>
  465. <Member MemberName="NumShadowSplits">
  466. <MemberSignature Language="C#" Value="public int NumShadowSplits { get; }" />
  467. <MemberSignature Language="ILAsm" Value=".property instance int32 NumShadowSplits" />
  468. <MemberType>Property</MemberType>
  469. <AssemblyInfo>
  470. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  471. </AssemblyInfo>
  472. <ReturnValue>
  473. <ReturnType>System.Int32</ReturnType>
  474. </ReturnValue>
  475. <Docs>
  476. <summary>
  477. Return number of shadow map cascade splits for a directional light, considering also graphics API limitations.
  478. </summary>
  479. <value>To be added.</value>
  480. <remarks>To be added.</remarks>
  481. </Docs>
  482. </Member>
  483. <Member MemberName="PerVertex">
  484. <MemberSignature Language="C#" Value="public bool PerVertex { get; set; }" />
  485. <MemberSignature Language="ILAsm" Value=".property instance bool PerVertex" />
  486. <MemberType>Property</MemberType>
  487. <AssemblyInfo>
  488. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  489. </AssemblyInfo>
  490. <ReturnValue>
  491. <ReturnType>System.Boolean</ReturnType>
  492. </ReturnValue>
  493. <Docs>
  494. <summary>
  495. Return vertex lighting mode.
  496. Or
  497. Set vertex lighting mode.
  498. </summary>
  499. <value>To be added.</value>
  500. <remarks>To be added.</remarks>
  501. </Docs>
  502. </Member>
  503. <Member MemberName="Radius">
  504. <MemberSignature Language="C#" Value="public float Radius { get; set; }" />
  505. <MemberSignature Language="ILAsm" Value=".property instance float32 Radius" />
  506. <MemberType>Property</MemberType>
  507. <AssemblyInfo>
  508. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  509. </AssemblyInfo>
  510. <ReturnValue>
  511. <ReturnType>System.Single</ReturnType>
  512. </ReturnValue>
  513. <Docs>
  514. <summary>Return area light mode radius. Works only with PBR shaders.
  515. Or
  516. Set area light radius. Greater than zero activates area light mode. Works only with PBR shaders.</summary>
  517. <value>To be added.</value>
  518. <remarks>To be added.</remarks>
  519. </Docs>
  520. </Member>
  521. <Member MemberName="RampTexture">
  522. <MemberSignature Language="C#" Value="public Urho.Texture RampTexture { get; set; }" />
  523. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Texture RampTexture" />
  524. <MemberType>Property</MemberType>
  525. <AssemblyInfo>
  526. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  527. </AssemblyInfo>
  528. <ReturnValue>
  529. <ReturnType>Urho.Texture</ReturnType>
  530. </ReturnValue>
  531. <Docs>
  532. <summary>
  533. Return range attenuation texture.
  534. Or
  535. Set range attenuation texture.
  536. </summary>
  537. <value>To be added.</value>
  538. <remarks>To be added.</remarks>
  539. </Docs>
  540. </Member>
  541. <Member MemberName="RampTextureAttr">
  542. <MemberSignature Language="C#" Value="public Urho.ResourceRef RampTextureAttr { get; }" />
  543. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.ResourceRef RampTextureAttr" />
  544. <MemberType>Property</MemberType>
  545. <AssemblyInfo>
  546. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  547. </AssemblyInfo>
  548. <ReturnValue>
  549. <ReturnType>Urho.ResourceRef</ReturnType>
  550. </ReturnValue>
  551. <Docs>
  552. <summary>
  553. Return ramp texture attribute.
  554. </summary>
  555. <value>To be added.</value>
  556. <remarks>To be added.</remarks>
  557. </Docs>
  558. </Member>
  559. <Member MemberName="Range">
  560. <MemberSignature Language="C#" Value="public float Range { get; set; }" />
  561. <MemberSignature Language="ILAsm" Value=".property instance float32 Range" />
  562. <MemberType>Property</MemberType>
  563. <AssemblyInfo>
  564. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  565. </AssemblyInfo>
  566. <ReturnValue>
  567. <ReturnType>System.Single</ReturnType>
  568. </ReturnValue>
  569. <Docs>
  570. <summary>
  571. Return range.
  572. Or
  573. Set range.
  574. </summary>
  575. <value>To be added.</value>
  576. <remarks>To be added.</remarks>
  577. </Docs>
  578. </Member>
  579. <Member MemberName="RegisterObject">
  580. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  581. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  582. <MemberType>Method</MemberType>
  583. <AssemblyInfo>
  584. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  585. </AssemblyInfo>
  586. <ReturnValue>
  587. <ReturnType>System.Void</ReturnType>
  588. </ReturnValue>
  589. <Parameters>
  590. <Parameter Name="context" Type="Urho.Context" />
  591. </Parameters>
  592. <Docs>
  593. <param name="context">To be added.</param>
  594. <summary>
  595. Register object factory. Drawable must be registered first.
  596. </summary>
  597. <remarks>To be added.</remarks>
  598. </Docs>
  599. </Member>
  600. <Member MemberName="SetIntensitySortValue">
  601. <MemberSignature Language="C#" Value="public void SetIntensitySortValue (float distance);" />
  602. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetIntensitySortValue(float32 distance) cil managed" />
  603. <MemberType>Method</MemberType>
  604. <AssemblyInfo>
  605. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  606. </AssemblyInfo>
  607. <ReturnValue>
  608. <ReturnType>System.Void</ReturnType>
  609. </ReturnValue>
  610. <Parameters>
  611. <Parameter Name="distance" Type="System.Single" />
  612. </Parameters>
  613. <Docs>
  614. <param name="distance">To be added.</param>
  615. <summary>
  616. Set sort value based on intensity and view distance.
  617. </summary>
  618. <remarks>To be added.</remarks>
  619. </Docs>
  620. </Member>
  621. <Member MemberName="SetIntensitySortValue">
  622. <MemberSignature Language="C#" Value="public void SetIntensitySortValue (Urho.BoundingBox box);" />
  623. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetIntensitySortValue(valuetype Urho.BoundingBox box) cil managed" />
  624. <MemberType>Method</MemberType>
  625. <AssemblyInfo>
  626. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  627. </AssemblyInfo>
  628. <ReturnValue>
  629. <ReturnType>System.Void</ReturnType>
  630. </ReturnValue>
  631. <Parameters>
  632. <Parameter Name="box" Type="Urho.BoundingBox" />
  633. </Parameters>
  634. <Docs>
  635. <param name="box">To be added.</param>
  636. <summary>
  637. Set sort value based on overall intensity over a bounding box.
  638. </summary>
  639. <remarks>To be added.</remarks>
  640. </Docs>
  641. </Member>
  642. <Member MemberName="ShadowBias">
  643. <MemberSignature Language="C#" Value="public Urho.BiasParameters ShadowBias { get; set; }" />
  644. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.BiasParameters ShadowBias" />
  645. <MemberType>Property</MemberType>
  646. <AssemblyInfo>
  647. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  648. </AssemblyInfo>
  649. <ReturnValue>
  650. <ReturnType>Urho.BiasParameters</ReturnType>
  651. </ReturnValue>
  652. <Docs>
  653. <summary>
  654. Return shadow depth bias parameters.
  655. Or
  656. Set shadow depth bias parameters.
  657. </summary>
  658. <value>To be added.</value>
  659. <remarks>To be added.</remarks>
  660. </Docs>
  661. </Member>
  662. <Member MemberName="ShadowCascade">
  663. <MemberSignature Language="C#" Value="public Urho.CascadeParameters ShadowCascade { get; set; }" />
  664. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.CascadeParameters ShadowCascade" />
  665. <MemberType>Property</MemberType>
  666. <AssemblyInfo>
  667. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  668. </AssemblyInfo>
  669. <ReturnValue>
  670. <ReturnType>Urho.CascadeParameters</ReturnType>
  671. </ReturnValue>
  672. <Docs>
  673. <summary>
  674. Return directional light cascaded shadow parameters.
  675. Or
  676. Set directional light cascaded shadow parameters.
  677. </summary>
  678. <value>To be added.</value>
  679. <remarks>To be added.</remarks>
  680. </Docs>
  681. </Member>
  682. <Member MemberName="ShadowFadeDistance">
  683. <MemberSignature Language="C#" Value="public float ShadowFadeDistance { get; set; }" />
  684. <MemberSignature Language="ILAsm" Value=".property instance float32 ShadowFadeDistance" />
  685. <MemberType>Property</MemberType>
  686. <AssemblyInfo>
  687. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  688. </AssemblyInfo>
  689. <ReturnValue>
  690. <ReturnType>System.Single</ReturnType>
  691. </ReturnValue>
  692. <Docs>
  693. <summary>
  694. Return shadow fade start distance.
  695. Or
  696. Set shadow fade out start distance. Only has effect if shadow distance is also non-zero.
  697. </summary>
  698. <value>To be added.</value>
  699. <remarks>To be added.</remarks>
  700. </Docs>
  701. </Member>
  702. <Member MemberName="ShadowFocus">
  703. <MemberSignature Language="C#" Value="public Urho.FocusParameters ShadowFocus { get; set; }" />
  704. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.FocusParameters ShadowFocus" />
  705. <MemberType>Property</MemberType>
  706. <AssemblyInfo>
  707. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  708. </AssemblyInfo>
  709. <ReturnValue>
  710. <ReturnType>Urho.FocusParameters</ReturnType>
  711. </ReturnValue>
  712. <Docs>
  713. <summary>Controsl the shadow map focusing parameters</summary>
  714. <value>To be added.</value>
  715. <remarks>To be added.</remarks>
  716. </Docs>
  717. </Member>
  718. <Member MemberName="ShadowIntensity">
  719. <MemberSignature Language="C#" Value="public float ShadowIntensity { get; set; }" />
  720. <MemberSignature Language="ILAsm" Value=".property instance float32 ShadowIntensity" />
  721. <MemberType>Property</MemberType>
  722. <AssemblyInfo>
  723. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  724. </AssemblyInfo>
  725. <ReturnValue>
  726. <ReturnType>System.Single</ReturnType>
  727. </ReturnValue>
  728. <Docs>
  729. <summary>
  730. Return shadow intensity.
  731. Or
  732. Set shadow intensity between 0.0 - 1.0. 0.0 (the default) gives fully dark shadows.
  733. </summary>
  734. <value>To be added.</value>
  735. <remarks>To be added.</remarks>
  736. </Docs>
  737. </Member>
  738. <Member MemberName="ShadowMaxExtrusion">
  739. <MemberSignature Language="C#" Value="public float ShadowMaxExtrusion { get; set; }" />
  740. <MemberSignature Language="ILAsm" Value=".property instance float32 ShadowMaxExtrusion" />
  741. <MemberType>Property</MemberType>
  742. <AssemblyInfo>
  743. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  744. </AssemblyInfo>
  745. <ReturnValue>
  746. <ReturnType>System.Single</ReturnType>
  747. </ReturnValue>
  748. <Docs>
  749. <summary>Return maximum shadow extrusion distance for directional lights.
  750. Or
  751. Set maximum shadow extrusion for directional lights. The actual extrusion will be the smaller of this and camera far clip. Default 1000.</summary>
  752. <value>To be added.</value>
  753. <remarks>To be added.</remarks>
  754. </Docs>
  755. </Member>
  756. <Member MemberName="ShadowNearFarRatio">
  757. <MemberSignature Language="C#" Value="public float ShadowNearFarRatio { get; set; }" />
  758. <MemberSignature Language="ILAsm" Value=".property instance float32 ShadowNearFarRatio" />
  759. <MemberType>Property</MemberType>
  760. <AssemblyInfo>
  761. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  762. </AssemblyInfo>
  763. <ReturnValue>
  764. <ReturnType>System.Single</ReturnType>
  765. </ReturnValue>
  766. <Docs>
  767. <summary>
  768. Return shadow camera near/far clip distance ratio.
  769. Or
  770. Set shadow camera near/far clip distance ratio.
  771. </summary>
  772. <value>To be added.</value>
  773. <remarks>To be added.</remarks>
  774. </Docs>
  775. </Member>
  776. <Member MemberName="ShadowResolution">
  777. <MemberSignature Language="C#" Value="public float ShadowResolution { get; set; }" />
  778. <MemberSignature Language="ILAsm" Value=".property instance float32 ShadowResolution" />
  779. <MemberType>Property</MemberType>
  780. <AssemblyInfo>
  781. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  782. </AssemblyInfo>
  783. <ReturnValue>
  784. <ReturnType>System.Single</ReturnType>
  785. </ReturnValue>
  786. <Docs>
  787. <summary>
  788. Return shadow resolution.
  789. Or
  790. Set shadow resolution between 0.25 - 1.0. Determines the shadow map to use.
  791. </summary>
  792. <value>To be added.</value>
  793. <remarks>To be added.</remarks>
  794. </Docs>
  795. </Member>
  796. <Member MemberName="ShapeTexture">
  797. <MemberSignature Language="C#" Value="public Urho.Texture ShapeTexture { get; set; }" />
  798. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Texture ShapeTexture" />
  799. <MemberType>Property</MemberType>
  800. <AssemblyInfo>
  801. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  802. </AssemblyInfo>
  803. <ReturnValue>
  804. <ReturnType>Urho.Texture</ReturnType>
  805. </ReturnValue>
  806. <Docs>
  807. <summary>
  808. Return spotlight attenuation texture.
  809. Or
  810. Set spotlight attenuation texture.
  811. </summary>
  812. <value>To be added.</value>
  813. <remarks>To be added.</remarks>
  814. </Docs>
  815. </Member>
  816. <Member MemberName="ShapeTextureAttr">
  817. <MemberSignature Language="C#" Value="public Urho.ResourceRef ShapeTextureAttr { get; }" />
  818. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.ResourceRef ShapeTextureAttr" />
  819. <MemberType>Property</MemberType>
  820. <AssemblyInfo>
  821. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  822. </AssemblyInfo>
  823. <ReturnValue>
  824. <ReturnType>Urho.ResourceRef</ReturnType>
  825. </ReturnValue>
  826. <Docs>
  827. <summary>
  828. Return shape texture attribute.
  829. </summary>
  830. <value>To be added.</value>
  831. <remarks>To be added.</remarks>
  832. </Docs>
  833. </Member>
  834. <Member MemberName="SpecularIntensity">
  835. <MemberSignature Language="C#" Value="public float SpecularIntensity { get; set; }" />
  836. <MemberSignature Language="ILAsm" Value=".property instance float32 SpecularIntensity" />
  837. <MemberType>Property</MemberType>
  838. <AssemblyInfo>
  839. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  840. </AssemblyInfo>
  841. <ReturnValue>
  842. <ReturnType>System.Single</ReturnType>
  843. </ReturnValue>
  844. <Docs>
  845. <summary>
  846. Return specular intensity.
  847. Or
  848. Set specular intensity. Zero disables specular calculations.
  849. </summary>
  850. <value>To be added.</value>
  851. <remarks>To be added.</remarks>
  852. </Docs>
  853. </Member>
  854. <Member MemberName="Temperature">
  855. <MemberSignature Language="C#" Value="public float Temperature { get; set; }" />
  856. <MemberSignature Language="ILAsm" Value=".property instance float32 Temperature" />
  857. <MemberType>Property</MemberType>
  858. <AssemblyInfo>
  859. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  860. </AssemblyInfo>
  861. <ReturnValue>
  862. <ReturnType>System.Single</ReturnType>
  863. </ReturnValue>
  864. <Docs>
  865. <summary>Return the temperature of the light in Kelvin.
  866. Or
  867. Set temperature of the light in Kelvin. Modulates the light color when "use physical values" is enabled.</summary>
  868. <value>To be added.</value>
  869. <remarks>To be added.</remarks>
  870. </Docs>
  871. </Member>
  872. <Member MemberName="Type">
  873. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  874. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  875. <MemberType>Property</MemberType>
  876. <AssemblyInfo>
  877. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  878. </AssemblyInfo>
  879. <ReturnValue>
  880. <ReturnType>Urho.StringHash</ReturnType>
  881. </ReturnValue>
  882. <Docs>
  883. <summary>Urho's type system type.</summary>
  884. <value>StringHash representing the type for this C# type.</value>
  885. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  886. </Docs>
  887. </Member>
  888. <Member MemberName="TypeName">
  889. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  890. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  891. <MemberType>Property</MemberType>
  892. <AssemblyInfo>
  893. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  894. </AssemblyInfo>
  895. <ReturnValue>
  896. <ReturnType>System.String</ReturnType>
  897. </ReturnValue>
  898. <Docs>
  899. <summary>Urho's low-level type name.</summary>
  900. <value>Stringified low-level type name.</value>
  901. <remarks>
  902. </remarks>
  903. </Docs>
  904. </Member>
  905. <Member MemberName="TypeNameStatic">
  906. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  907. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  908. <MemberType>Property</MemberType>
  909. <AssemblyInfo>
  910. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  911. </AssemblyInfo>
  912. <ReturnValue>
  913. <ReturnType>System.String</ReturnType>
  914. </ReturnValue>
  915. <Docs>
  916. <summary>Urho's low-level type name, accessible as a static method.</summary>
  917. <value>Stringified low-level type name.</value>
  918. <remarks>
  919. </remarks>
  920. </Docs>
  921. </Member>
  922. <Member MemberName="TypeStatic">
  923. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  924. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  925. <MemberType>Property</MemberType>
  926. <AssemblyInfo>
  927. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  928. </AssemblyInfo>
  929. <Attributes>
  930. <Attribute>
  931. <AttributeName>Preserve</AttributeName>
  932. </Attribute>
  933. </Attributes>
  934. <ReturnValue>
  935. <ReturnType>Urho.StringHash</ReturnType>
  936. </ReturnValue>
  937. <Docs>
  938. <summary>Urho's low-level type, accessible as a static method.</summary>
  939. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  940. <remarks>
  941. </remarks>
  942. </Docs>
  943. </Member>
  944. <Member MemberName="UsePhysicalValues">
  945. <MemberSignature Language="C#" Value="public bool UsePhysicalValues { get; set; }" />
  946. <MemberSignature Language="ILAsm" Value=".property instance bool UsePhysicalValues" />
  947. <MemberType>Property</MemberType>
  948. <AssemblyInfo>
  949. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  950. </AssemblyInfo>
  951. <ReturnValue>
  952. <ReturnType>System.Boolean</ReturnType>
  953. </ReturnValue>
  954. <Docs>
  955. <summary>Return if light uses temperature and brightness in lumens.
  956. Or
  957. Set use physical light values.</summary>
  958. <value>To be added.</value>
  959. <remarks>To be added.</remarks>
  960. </Docs>
  961. </Member>
  962. </Members>
  963. </Type>