PMREMNode.html 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>PMREMNode - 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">PMREMNode</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>This node represents a PMREM which is a special type of preprocessed
  17. environment map intended for PBR materials.</p></div>
  18. <h2>Code Example</h2>
  19. <div translate="no"><pre><code class="language-js">const material = new MeshStandardNodeMaterial();
  20. material.envNode = pmremTexture( envMap );
  21. </code></pre></div>
  22. </header>
  23. <article>
  24. <div class="container-overview">
  25. <h2>Constructor</h2>
  26. <h3 class="name name-method" id="PMREMNode" translate="no">new <a href="#PMREMNode">PMREMNode</a><span class="signature">( value : <span class="param-type"><a href="Texture.html">Texture</a></span>, uvNode : <span class="param-type"><a href="Node.html">Node</a>.&lt;vec2></span>, levelNode : <span class="param-type"><a href="Node.html">Node</a>.&lt;float></span> )</span> </h3>
  27. <div class="method">
  28. <div class="description">
  29. <p>Constructs a new function overloading node.</p>
  30. </div>
  31. <table class="params">
  32. <tbody>
  33. <tr>
  34. <td class="name">
  35. <strong>value</strong>
  36. </td>
  37. <td class="description last">
  38. <p>The input texture.</p>
  39. </td>
  40. </tr>
  41. <tr>
  42. <td class="name">
  43. <strong>uvNode</strong>
  44. </td>
  45. <td class="description last">
  46. <p>The uv node.</p>
  47. <p>Default is <code>null</code>.</p>
  48. </td>
  49. </tr>
  50. <tr>
  51. <td class="name">
  52. <strong>levelNode</strong>
  53. </td>
  54. <td class="description last">
  55. <p>The level node.</p>
  56. <p>Default is <code>null</code>.</p>
  57. </td>
  58. </tr>
  59. </tbody>
  60. </table>
  61. </div>
  62. </div>
  63. <h2 class="subsection-title">Properties</h2>
  64. <div class="member">
  65. <h3 class="name" id="levelNode" translate="no">.<a href="#levelNode">levelNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  66. <div class="description">
  67. <p>The level node.</p>
  68. </div>
  69. </div>
  70. <div class="member">
  71. <h3 class="name" id="updateBeforeType" translate="no">.<a href="#updateBeforeType">updateBeforeType</a><span class="type-signature"> : string</span> </h3>
  72. <div class="description">
  73. <p>The <code>updateBeforeType</code> is set to <code>NodeUpdateType.RENDER</code>.</p>
  74. <p>Default is <code>'render'</code>.</p>
  75. </div>
  76. <dl class="details">
  77. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#updateBeforeType">TempNode#updateBeforeType</a></dt>
  78. </dl>
  79. </div>
  80. <div class="member">
  81. <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>
  82. <div class="description">
  83. <p>The uv node.</p>
  84. </div>
  85. </div>
  86. <div class="member">
  87. <h3 class="name" id="value" translate="no">.<a href="#value">value</a><span class="type-signature"> : <a href="Texture.html">Texture</a></span> </h3>
  88. <div class="description">
  89. <p>The node's texture value.</p>
  90. </div>
  91. </div>
  92. <h2 class="subsection-title">Methods</h2>
  93. <h3 class="name name-method" id="updateFromTexture" translate="no">.<a href="#updateFromTexture">updateFromTexture</a><span class="signature">( texture : <span class="param-type"><a href="Texture.html">Texture</a></span> )</span> </h3>
  94. <div class="method">
  95. <div class="description">
  96. <p>Uses the given PMREM texture to update internal values.</p>
  97. </div>
  98. <table class="params">
  99. <tbody>
  100. <tr>
  101. <td class="name">
  102. <strong>texture</strong>
  103. </td>
  104. <td class="description last">
  105. <p>The PMREM texture.</p>
  106. </td>
  107. </tr>
  108. </tbody>
  109. </table>
  110. </div>
  111. <h2 class="subsection-title">Source</h2>
  112. <p>
  113. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/pmrem/PMREMNode.js" translate="no" target="_blank" rel="noopener">src/nodes/pmrem/PMREMNode.js</a>
  114. </p>
  115. </article>
  116. </section>
  117. <script src="../scripts/linenumber.js"></script>
  118. <script src="../scripts/page.js"></script>
  119. </body>
  120. </html>
粤ICP备19079148号