FilmNode.html 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>FilmNode - 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> → <a href="TempNode.html">TempNode</a> → </p>
  13. <h1 translate="no">FilmNode</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>Post processing node for creating a film grain effect.</p></div>
  17. </header>
  18. <article>
  19. <h2 class="subsection-title">Import</h2>
  20. <p><span translate="no">FilmNode</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
  21. <pre><code class="language-js">import { film } from 'three/addons/tsl/display/FilmNode.js';</code></pre>
  22. <div class="container-overview">
  23. <h2>Constructor</h2>
  24. <h3 class="name name-method" id="FilmNode" translate="no">new <a href="#FilmNode">FilmNode</a><span class="signature">( inputNode : <span class="param-type">Node</span>, intensityNode : <span class="param-type">Node.&lt;float></span>, uvNode : <span class="param-type">Node.&lt;vec2></span> )</span> </h3>
  25. <div class="method">
  26. <div class="description">
  27. <p>Constructs a new film node.</p>
  28. </div>
  29. <table class="params">
  30. <tbody>
  31. <tr>
  32. <td class="name"><code>inputNode</code></td>
  33. <td class="description last"><p>The node that represents the input of the effect.</p></td>
  34. </tr>
  35. <tr>
  36. <td class="name"><code>intensityNode</code></td>
  37. <td class="description last"><p>A node that represents the effect's intensity.<br/>Default is <code>null</code>.</p></td>
  38. </tr>
  39. <tr>
  40. <td class="name"><code>uvNode</code></td>
  41. <td class="description last"><p>A node that allows to pass custom (e.g. animated) uv data.<br/>Default is <code>null</code>.</p></td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. </div>
  47. <h2 class="subsection-title">Properties</h2>
  48. <div class="member">
  49. <h3 class="name" id="inputNode" translate="no">.<a href="#inputNode">inputNode</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  50. <div class="description">
  51. <p>The node that represents the input of the effect.</p>
  52. </div>
  53. </div>
  54. <div class="member">
  55. <h3 class="name" id="intensityNode" translate="no">.<a href="#intensityNode">intensityNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  56. <div class="description">
  57. <p>A node that represents the effect's intensity.<br/>Default is <code>null</code>.</p>
  58. </div>
  59. </div>
  60. <div class="member">
  61. <h3 class="name" id="uvNode" translate="no">.<a href="#uvNode">uvNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;vec2></span> </h3>
  62. <div class="description">
  63. <p>A node that allows to pass custom (e.g. animated) uv data.<br/>Default is <code>null</code>.</p>
  64. </div>
  65. </div>
  66. <h2 class="subsection-title">Methods</h2>
  67. <h3 class="name name-method" id="setup" translate="no">.<a href="#setup">setup</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span><span class="type-signature"> : ShaderCallNodeInternal</span> </h3>
  68. <div class="method">
  69. <div class="description">
  70. <p>This method is used to setup the effect's TSL code.</p>
  71. </div>
  72. <table class="params">
  73. <tbody>
  74. <tr>
  75. <td class="name"><code>builder</code></td>
  76. <td class="description last"><p>The current node builder.</p></td>
  77. </tr>
  78. </tbody>
  79. </table>
  80. <dl class="details">
  81. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#setup">TempNode#setup</a></dt>
  82. </dl>
  83. <dl class="details">
  84. <dt class="tag-returns"><strong>Returns:</strong> </dt>
  85. </dl>
  86. </div>
  87. <h2 class="subsection-title">Source</h2>
  88. <p>
  89. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/tsl/display/FilmNode.js" target="_blank" rel="noopener" translate="no">examples/jsm/tsl/display/FilmNode.js</a>
  90. </p>
  91. </article>
  92. </section>
  93. <script src="../scripts/linenumber.js"></script>
  94. <script src="../scripts/page.js"></script>
  95. </body>
  96. </html>
粤ICP备19079148号