RenderPathCommand.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  1. <Type Name="RenderPathCommand" FullName="Urho.RenderPathCommand">
  2. <TypeSignature Language="C#" Value="public struct RenderPathCommand" />
  3. <TypeSignature Language="ILAsm" Value=".class public ansi sealed beforefieldinit RenderPathCommand extends System.ValueType" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>System.ValueType</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>Rendering path command.</summary>
  14. <remarks>Viewports defines a command sequence for rendering a scene, called the Render Path.  </remarks>
  15. </Docs>
  16. <Members>
  17. <Member MemberName="BlendMode">
  18. <MemberSignature Language="C#" Value="public Urho.BlendMode BlendMode;" />
  19. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.BlendMode BlendMode" />
  20. <MemberType>Field</MemberType>
  21. <AssemblyInfo>
  22. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  23. </AssemblyInfo>
  24. <ReturnValue>
  25. <ReturnType>Urho.BlendMode</ReturnType>
  26. </ReturnValue>
  27. <Docs>
  28. <summary>Blend mode, affects quad command only.</summary>
  29. <remarks>To be added.</remarks>
  30. </Docs>
  31. </Member>
  32. <Member MemberName="ClearColor">
  33. <MemberSignature Language="C#" Value="public Urho.Color ClearColor;" />
  34. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.Color ClearColor" />
  35. <MemberType>Field</MemberType>
  36. <AssemblyInfo>
  37. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  38. </AssemblyInfo>
  39. <ReturnValue>
  40. <ReturnType>Urho.Color</ReturnType>
  41. </ReturnValue>
  42. <Docs>
  43. <summary>Clear color, affects the clear command only.</summary>
  44. <remarks>To be added.</remarks>
  45. </Docs>
  46. </Member>
  47. <Member MemberName="ClearDepth">
  48. <MemberSignature Language="C#" Value="public float ClearDepth;" />
  49. <MemberSignature Language="ILAsm" Value=".field public float32 ClearDepth" />
  50. <MemberType>Field</MemberType>
  51. <AssemblyInfo>
  52. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  53. </AssemblyInfo>
  54. <ReturnValue>
  55. <ReturnType>System.Single</ReturnType>
  56. </ReturnValue>
  57. <Docs>
  58. <summary>Clear depth, affectrs the clear command only.</summary>
  59. <remarks>To be added.</remarks>
  60. </Docs>
  61. </Member>
  62. <Member MemberName="ClearFlags">
  63. <MemberSignature Language="C#" Value="public uint ClearFlags;" />
  64. <MemberSignature Language="ILAsm" Value=".field public unsigned int32 ClearFlags" />
  65. <MemberType>Field</MemberType>
  66. <AssemblyInfo>
  67. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  68. </AssemblyInfo>
  69. <ReturnValue>
  70. <ReturnType>System.UInt32</ReturnType>
  71. </ReturnValue>
  72. <Docs>
  73. <summary>Clear flags, affects the clear command only.</summary>
  74. <remarks>To be added.</remarks>
  75. </Docs>
  76. </Member>
  77. <Member MemberName="ClearStencil">
  78. <MemberSignature Language="C#" Value="public uint ClearStencil;" />
  79. <MemberSignature Language="ILAsm" Value=".field public unsigned int32 ClearStencil" />
  80. <MemberType>Field</MemberType>
  81. <AssemblyInfo>
  82. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  83. </AssemblyInfo>
  84. <ReturnValue>
  85. <ReturnType>System.UInt32</ReturnType>
  86. </ReturnValue>
  87. <Docs>
  88. <summary>Clear stencil, affects the clear command only.</summary>
  89. <remarks>To be added.</remarks>
  90. </Docs>
  91. </Member>
  92. <Member MemberName="DepthStencilName">
  93. <MemberSignature Language="C#" Value="public Urho.UrhoString DepthStencilName;" />
  94. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.UrhoString DepthStencilName" />
  95. <MemberType>Field</MemberType>
  96. <AssemblyInfo>
  97. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  98. </AssemblyInfo>
  99. <ReturnValue>
  100. <ReturnType>Urho.UrhoString</ReturnType>
  101. </ReturnValue>
  102. <Docs>
  103. <summary>Depth-stencil output name.</summary>
  104. <remarks>To be added.</remarks>
  105. </Docs>
  106. </Member>
  107. <Member MemberName="Enabled">
  108. <MemberSignature Language="C#" Value="public byte Enabled;" />
  109. <MemberSignature Language="ILAsm" Value=".field public unsigned int8 Enabled" />
  110. <MemberType>Field</MemberType>
  111. <AssemblyInfo>
  112. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  113. </AssemblyInfo>
  114. <ReturnValue>
  115. <ReturnType>System.Byte</ReturnType>
  116. </ReturnValue>
  117. <Docs>
  118. <summary>Enabled flag.</summary>
  119. <remarks>To be added.</remarks>
  120. </Docs>
  121. </Member>
  122. <Member MemberName="MarkToStencil">
  123. <MemberSignature Language="C#" Value="public byte MarkToStencil;" />
  124. <MemberSignature Language="ILAsm" Value=".field public unsigned int8 MarkToStencil" />
  125. <MemberType>Field</MemberType>
  126. <AssemblyInfo>
  127. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  128. </AssemblyInfo>
  129. <ReturnValue>
  130. <ReturnType>System.Byte</ReturnType>
  131. </ReturnValue>
  132. <Docs>
  133. <summary>Mark to stencil flag</summary>
  134. <remarks>To be added.</remarks>
  135. </Docs>
  136. </Member>
  137. <Member MemberName="Metadata">
  138. <MemberSignature Language="C#" Value="public Urho.UrhoString Metadata;" />
  139. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.UrhoString Metadata" />
  140. <MemberType>Field</MemberType>
  141. <AssemblyInfo>
  142. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  143. </AssemblyInfo>
  144. <ReturnValue>
  145. <ReturnType>Urho.UrhoString</ReturnType>
  146. </ReturnValue>
  147. <Docs>
  148. <summary>Command/pass metadata.</summary>
  149. <remarks>To be added.</remarks>
  150. </Docs>
  151. </Member>
  152. <Member MemberName="Outputs">
  153. <MemberSignature Language="C#" Value="public IntPtr Outputs;" />
  154. <MemberSignature Language="ILAsm" Value=".field public native int Outputs" />
  155. <MemberType>Field</MemberType>
  156. <AssemblyInfo>
  157. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  158. </AssemblyInfo>
  159. <ReturnValue>
  160. <ReturnType>System.IntPtr</ReturnType>
  161. </ReturnValue>
  162. <Docs>
  163. <summary>Output render targets and faces.</summary>
  164. <remarks>To be added.</remarks>
  165. </Docs>
  166. </Member>
  167. <Member MemberName="Pass">
  168. <MemberSignature Language="C#" Value="public Urho.UrhoString Pass;" />
  169. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.UrhoString Pass" />
  170. <MemberType>Field</MemberType>
  171. <AssemblyInfo>
  172. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  173. </AssemblyInfo>
  174. <ReturnValue>
  175. <ReturnType>Urho.UrhoString</ReturnType>
  176. </ReturnValue>
  177. <Docs>
  178. <summary>Scene pass name.</summary>
  179. <remarks>To be added.</remarks>
  180. </Docs>
  181. </Member>
  182. <Member MemberName="PassIndex">
  183. <MemberSignature Language="C#" Value="public uint PassIndex;" />
  184. <MemberSignature Language="ILAsm" Value=".field public unsigned int32 PassIndex" />
  185. <MemberType>Field</MemberType>
  186. <AssemblyInfo>
  187. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  188. </AssemblyInfo>
  189. <ReturnValue>
  190. <ReturnType>System.UInt32</ReturnType>
  191. </ReturnValue>
  192. <Docs>
  193. <summary>Scene pass index, filled by view.</summary>
  194. <remarks>To be added.</remarks>
  195. </Docs>
  196. </Member>
  197. <Member MemberName="PixelShaderDefines">
  198. <MemberSignature Language="C#" Value="public Urho.UrhoString PixelShaderDefines;" />
  199. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.UrhoString PixelShaderDefines" />
  200. <MemberType>Field</MemberType>
  201. <AssemblyInfo>
  202. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  203. </AssemblyInfo>
  204. <ReturnValue>
  205. <ReturnType>Urho.UrhoString</ReturnType>
  206. </ReturnValue>
  207. <Docs>
  208. <summary>Pixel shader defines</summary>
  209. <remarks>To be added.</remarks>
  210. </Docs>
  211. </Member>
  212. <Member MemberName="PixelShaderName">
  213. <MemberSignature Language="C#" Value="public Urho.UrhoString PixelShaderName;" />
  214. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.UrhoString PixelShaderName" />
  215. <MemberType>Field</MemberType>
  216. <AssemblyInfo>
  217. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  218. </AssemblyInfo>
  219. <ReturnValue>
  220. <ReturnType>Urho.UrhoString</ReturnType>
  221. </ReturnValue>
  222. <Docs>
  223. <summary>Pixel shader name.</summary>
  224. <remarks>To be added.</remarks>
  225. </Docs>
  226. </Member>
  227. <Member MemberName="ShaderParameters">
  228. <MemberSignature Language="C#" Value="public IntPtr ShaderParameters;" />
  229. <MemberSignature Language="ILAsm" Value=".field public native int ShaderParameters" />
  230. <MemberType>Field</MemberType>
  231. <AssemblyInfo>
  232. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  233. </AssemblyInfo>
  234. <ReturnValue>
  235. <ReturnType>System.IntPtr</ReturnType>
  236. </ReturnValue>
  237. <Docs>
  238. <summary>Pointers to a vector of paris of stringhashes and variants.</summary>
  239. <remarks>To be added.</remarks>
  240. </Docs>
  241. </Member>
  242. <Member MemberName="SortMode">
  243. <MemberSignature Language="C#" Value="public Urho.RenderCommandSortMode SortMode;" />
  244. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.RenderCommandSortMode SortMode" />
  245. <MemberType>Field</MemberType>
  246. <AssemblyInfo>
  247. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  248. </AssemblyInfo>
  249. <ReturnValue>
  250. <ReturnType>Urho.RenderCommandSortMode</ReturnType>
  251. </ReturnValue>
  252. <Docs>
  253. <summary>Sorting mode.</summary>
  254. <remarks>To be added.</remarks>
  255. </Docs>
  256. </Member>
  257. <Member MemberName="Tag">
  258. <MemberSignature Language="C#" Value="public Urho.UrhoString Tag;" />
  259. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.UrhoString Tag" />
  260. <MemberType>Field</MemberType>
  261. <AssemblyInfo>
  262. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  263. </AssemblyInfo>
  264. <ReturnValue>
  265. <ReturnType>Urho.UrhoString</ReturnType>
  266. </ReturnValue>
  267. <Docs>
  268. <summary>Tag name</summary>
  269. <remarks>To be added.</remarks>
  270. </Docs>
  271. </Member>
  272. <Member MemberName="TextureNames">
  273. <MemberSignature Language="C#" Value="public IntPtr TextureNames;" />
  274. <MemberSignature Language="ILAsm" Value=".field public native int TextureNames" />
  275. <MemberType>Field</MemberType>
  276. <AssemblyInfo>
  277. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  278. </AssemblyInfo>
  279. <ReturnValue>
  280. <ReturnType>System.IntPtr</ReturnType>
  281. </ReturnValue>
  282. <Docs>
  283. <summary>Textures (points to strings ontaining the texture names) </summary>
  284. <remarks>To be added.</remarks>
  285. </Docs>
  286. </Member>
  287. <Member MemberName="Type">
  288. <MemberSignature Language="C#" Value="public Urho.RenderCommandType Type;" />
  289. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.RenderCommandType Type" />
  290. <MemberType>Field</MemberType>
  291. <AssemblyInfo>
  292. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  293. </AssemblyInfo>
  294. <ReturnValue>
  295. <ReturnType>Urho.RenderCommandType</ReturnType>
  296. </ReturnValue>
  297. <Docs>
  298. <summary>Command type.</summary>
  299. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  300. </Docs>
  301. </Member>
  302. <Member MemberName="UseFogColor">
  303. <MemberSignature Language="C#" Value="public byte UseFogColor;" />
  304. <MemberSignature Language="ILAsm" Value=".field public unsigned int8 UseFogColor" />
  305. <MemberType>Field</MemberType>
  306. <AssemblyInfo>
  307. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  308. </AssemblyInfo>
  309. <ReturnValue>
  310. <ReturnType>System.Byte</ReturnType>
  311. </ReturnValue>
  312. <Docs>
  313. <summary>Use fog color for clearing</summary>
  314. <remarks>To be added.</remarks>
  315. </Docs>
  316. </Member>
  317. <Member MemberName="UseLitBase">
  318. <MemberSignature Language="C#" Value="public byte UseLitBase;" />
  319. <MemberSignature Language="ILAsm" Value=".field public unsigned int8 UseLitBase" />
  320. <MemberType>Field</MemberType>
  321. <AssemblyInfo>
  322. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  323. </AssemblyInfo>
  324. <ReturnValue>
  325. <ReturnType>System.Byte</ReturnType>
  326. </ReturnValue>
  327. <Docs>
  328. <summary>Use lit base pass optimization for forward per-pixel lights.</summary>
  329. <remarks>To be added.</remarks>
  330. </Docs>
  331. </Member>
  332. <Member MemberName="VertexLights">
  333. <MemberSignature Language="C#" Value="public byte VertexLights;" />
  334. <MemberSignature Language="ILAsm" Value=".field public unsigned int8 VertexLights" />
  335. <MemberType>Field</MemberType>
  336. <AssemblyInfo>
  337. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  338. </AssemblyInfo>
  339. <ReturnValue>
  340. <ReturnType>System.Byte</ReturnType>
  341. </ReturnValue>
  342. <Docs>
  343. <summary>Vertex lights flag.</summary>
  344. <remarks>To be added.</remarks>
  345. </Docs>
  346. </Member>
  347. <Member MemberName="VertexShaderDefines">
  348. <MemberSignature Language="C#" Value="public Urho.UrhoString VertexShaderDefines;" />
  349. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.UrhoString VertexShaderDefines" />
  350. <MemberType>Field</MemberType>
  351. <AssemblyInfo>
  352. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  353. </AssemblyInfo>
  354. <ReturnValue>
  355. <ReturnType>Urho.UrhoString</ReturnType>
  356. </ReturnValue>
  357. <Docs>
  358. <summary>Vertex shader defines</summary>
  359. <remarks>To be added.</remarks>
  360. </Docs>
  361. </Member>
  362. <Member MemberName="VertexShaderName">
  363. <MemberSignature Language="C#" Value="public Urho.UrhoString VertexShaderName;" />
  364. <MemberSignature Language="ILAsm" Value=".field public valuetype Urho.UrhoString VertexShaderName" />
  365. <MemberType>Field</MemberType>
  366. <AssemblyInfo>
  367. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  368. </AssemblyInfo>
  369. <ReturnValue>
  370. <ReturnType>Urho.UrhoString</ReturnType>
  371. </ReturnValue>
  372. <Docs>
  373. <summary>Vertex shader name</summary>
  374. <remarks>To be added.</remarks>
  375. </Docs>
  376. </Member>
  377. </Members>
  378. </Type>