1
0

ComputeNode.html 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>ComputeNode - Three.js Docs</title>
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <script src="../scripts/highlight.min.js"></script>
  8. <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
  9. <link type="text/css" rel="stylesheet" href="../styles/page.css">
  10. </head>
  11. <body>
  12. <p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Node.html">Node</a> → </p>
  13. <h1 translate="no">ComputeNode</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>TODO</p></div>
  17. </header>
  18. <article>
  19. <div class="container-overview">
  20. <h2>Constructor</h2>
  21. <h3 class="name name-method" id="ComputeNode" translate="no">new <a href="#ComputeNode">ComputeNode</a><span class="signature">( computeNode : <span class="param-type"><a href="Node.html">Node</a></span>, workgroupSize : <span class="param-type">Array.&lt;number></span> )</span> </h3>
  22. <div class="method">
  23. <div class="description">
  24. <p>Constructs a new compute node.</p>
  25. </div>
  26. <table class="params">
  27. <tbody>
  28. <tr>
  29. <td class="name">
  30. <strong>computeNode</strong>
  31. </td>
  32. <td class="description last">
  33. <p>TODO</p>
  34. </td>
  35. </tr>
  36. <tr>
  37. <td class="name">
  38. <strong>workgroupSize</strong>
  39. </td>
  40. <td class="description last">
  41. <p>TODO.</p>
  42. </td>
  43. </tr>
  44. </tbody>
  45. </table>
  46. </div>
  47. </div>
  48. <h2 class="subsection-title">Properties</h2>
  49. <div class="member">
  50. <h3 class="name" id="computeNode" translate="no">.<a href="#computeNode">computeNode</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  51. <div class="description">
  52. <p>TODO</p>
  53. </div>
  54. </div>
  55. <div class="member">
  56. <h3 class="name" id="count" translate="no">.<a href="#count">count</a><span class="type-signature"> : number | Array.&lt;number></span> </h3>
  57. <div class="description">
  58. <p>TODO</p>
  59. </div>
  60. </div>
  61. <div class="member">
  62. <h3 class="name" id="isComputeNode" translate="no">.<a href="#isComputeNode">isComputeNode</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  63. <div class="description">
  64. <p>This flag can be used for type testing.</p>
  65. <p>Default is <code>true</code>.</p>
  66. </div>
  67. </div>
  68. <div class="member">
  69. <h3 class="name" id="name" translate="no">.<a href="#name">name</a><span class="type-signature"> : string</span> </h3>
  70. <div class="description">
  71. <p>The name or label of the uniform.</p>
  72. <p>Default is <code>''</code>.</p>
  73. </div>
  74. <dl class="details">
  75. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#name">Node#name</a></dt>
  76. </dl>
  77. </div>
  78. <div class="member">
  79. <h3 class="name" id="onInitFunction" translate="no">.<a href="#onInitFunction">onInitFunction</a><span class="type-signature"> : function</span> </h3>
  80. <div class="description">
  81. <p>TODO</p>
  82. </div>
  83. </div>
  84. <div class="member">
  85. <h3 class="name" id="updateBeforeType" translate="no">.<a href="#updateBeforeType">updateBeforeType</a><span class="type-signature"> : string</span> </h3>
  86. <div class="description">
  87. <p>The <code>updateBeforeType</code> is set to <code>NodeUpdateType.OBJECT</code> since <a href="ComputeNode.html#updateBefore">ComputeNode#updateBefore</a>
  88. is executed once per object by default.</p>
  89. <p>Default is <code>'object'</code>.</p>
  90. </div>
  91. <dl class="details">
  92. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#updateBeforeType">Node#updateBeforeType</a></dt>
  93. </dl>
  94. </div>
  95. <div class="member">
  96. <h3 class="name" id="version" translate="no">.<a href="#version">version</a><span class="type-signature"> : number</span> </h3>
  97. <div class="description">
  98. <p>TODO</p>
  99. </div>
  100. <dl class="details">
  101. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#version">Node#version</a></dt>
  102. </dl>
  103. </div>
  104. <div class="member">
  105. <h3 class="name" id="workgroupSize" translate="no">.<a href="#workgroupSize">workgroupSize</a><span class="type-signature"> : Array.&lt;number></span> </h3>
  106. <div class="description">
  107. <p>TODO</p>
  108. <p>Default is <code>[ 64 ]</code>.</p>
  109. </div>
  110. </div>
  111. <h2 class="subsection-title">Methods</h2>
  112. <h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
  113. <div class="method">
  114. <div class="description">
  115. <p>Executes the <code>dispose</code> event for this node.</p>
  116. </div>
  117. <dl class="details">
  118. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#dispose">Node#dispose</a></dt>
  119. </dl>
  120. </div>
  121. <h3 class="name name-method" id="getCount" translate="no">.<a href="#getCount">getCount</a><span class="signature">()</span><span class="type-signature"> : number | Array.&lt;number></span> </h3>
  122. <div class="method">
  123. <div class="description">
  124. <p>TODO</p>
  125. </div>
  126. </div>
  127. <h3 class="name name-method" id="label" translate="no">.<a href="#label">label</a><span class="signature">( name : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="ComputeNode.html">ComputeNode</a></span> </h3>
  128. <div class="method">
  129. <div class="description">
  130. <p>Sets the <a href="ComputeNode.html#name">ComputeNode#name</a> property.</p>
  131. </div>
  132. <table class="params">
  133. <tbody>
  134. <tr>
  135. <td class="name">
  136. <strong>name</strong>
  137. </td>
  138. <td class="description last">
  139. <p>The name of the uniform.</p>
  140. </td>
  141. </tr>
  142. </tbody>
  143. </table>
  144. <dl class="details">
  145. <dt class="important tag-deprecated"><strong>Deprecated:</strong> Yes</dt>
  146. </dl>
  147. <dl class="details">
  148. <dt class="tag-returns"><strong>Returns:</strong> A reference to this node.</dt>
  149. </dl>
  150. </div>
  151. <h3 class="name name-method" id="onInit" translate="no">.<a href="#onInit">onInit</a><span class="signature">( callback : <span class="param-type">function</span> )</span><span class="type-signature"> : <a href="ComputeNode.html">ComputeNode</a></span> </h3>
  152. <div class="method">
  153. <div class="description">
  154. <p>TODO</p>
  155. </div>
  156. <table class="params">
  157. <tbody>
  158. <tr>
  159. <td class="name">
  160. <strong>callback</strong>
  161. </td>
  162. <td class="description last">
  163. <p>TODO.</p>
  164. </td>
  165. </tr>
  166. </tbody>
  167. </table>
  168. <dl class="details">
  169. <dt class="tag-returns"><strong>Returns:</strong> A reference to this node.</dt>
  170. </dl>
  171. </div>
  172. <h3 class="name name-method" id="setCount" translate="no">.<a href="#setCount">setCount</a><span class="signature">( count : <span class="param-type">number | Array.&lt;number></span> )</span><span class="type-signature"> : <a href="ComputeNode.html">ComputeNode</a></span> </h3>
  173. <div class="method">
  174. <div class="description">
  175. <p>TODO</p>
  176. </div>
  177. <table class="params">
  178. <tbody>
  179. <tr>
  180. <td class="name">
  181. <strong>count</strong>
  182. </td>
  183. <td class="description last">
  184. <p>Array with [ x, y, z ] values for dispatch or a single number for the count</p>
  185. </td>
  186. </tr>
  187. </tbody>
  188. </table>
  189. </div>
  190. <h3 class="name name-method" id="setName" translate="no">.<a href="#setName">setName</a><span class="signature">( name : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="ComputeNode.html">ComputeNode</a></span> </h3>
  191. <div class="method">
  192. <div class="description">
  193. <p>Sets the <a href="ComputeNode.html#name">ComputeNode#name</a> property.</p>
  194. </div>
  195. <table class="params">
  196. <tbody>
  197. <tr>
  198. <td class="name">
  199. <strong>name</strong>
  200. </td>
  201. <td class="description last">
  202. <p>The name of the uniform.</p>
  203. </td>
  204. </tr>
  205. </tbody>
  206. </table>
  207. <dl class="details">
  208. <dt class="tag-returns"><strong>Returns:</strong> A reference to this node.</dt>
  209. </dl>
  210. </div>
  211. <h3 class="name name-method" id="updateBefore" translate="no">.<a href="#updateBefore">updateBefore</a><span class="signature">( frame : <span class="param-type"><a href="NodeFrame.html">NodeFrame</a></span> )</span> </h3>
  212. <div class="method">
  213. <div class="description">
  214. <p>The method execute the compute for this node.</p>
  215. </div>
  216. <table class="params">
  217. <tbody>
  218. <tr>
  219. <td class="name">
  220. <strong>frame</strong>
  221. </td>
  222. <td class="description last">
  223. <p>A reference to the current node frame.</p>
  224. </td>
  225. </tr>
  226. </tbody>
  227. </table>
  228. <dl class="details">
  229. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Node.html#updateBefore">Node#updateBefore</a></dt>
  230. </dl>
  231. </div>
  232. <h2 class="subsection-title">Source</h2>
  233. <p>
  234. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/gpgpu/ComputeNode.js" translate="no" target="_blank" rel="noopener">src/nodes/gpgpu/ComputeNode.js</a>
  235. </p>
  236. </article>
  237. </section>
  238. <script src="../scripts/linenumber.js"></script>
  239. <script src="../scripts/page.js"></script>
  240. </body>
  241. </html>
粤ICP备19079148号