ToneMappingNode.html 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>ToneMappingNode - 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">ToneMappingNode</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>This node represents a tone mapping operation.</p></div>
  17. </header>
  18. <article>
  19. <div class="container-overview">
  20. <h2>Constructor</h2>
  21. <h3 class="name name-method" id="ToneMappingNode" translate="no">new <a href="#ToneMappingNode">ToneMappingNode</a><span class="signature">( toneMapping : <span class="param-type">number</span>, exposureNode : <span class="param-type">Node</span>, colorNode : <span class="param-type">Node</span> )</span> </h3>
  22. <div class="method">
  23. <div class="description">
  24. <p>Constructs a new tone mapping node.</p>
  25. </div>
  26. <table class="params">
  27. <tbody>
  28. <tr>
  29. <td class="name"><code>toneMapping</code></td>
  30. <td class="description last"><p>The tone mapping type.</p></td>
  31. </tr>
  32. <tr>
  33. <td class="name"><code>exposureNode</code></td>
  34. <td class="description last"><p>The tone mapping exposure.</p></td>
  35. </tr>
  36. <tr>
  37. <td class="name"><code>colorNode</code></td>
  38. <td class="description last"><p>The color node to process.<br/>Default is <code>null</code>.</p></td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. </div>
  44. <h2 class="subsection-title">Properties</h2>
  45. <div class="member">
  46. <h3 class="name" id="colorNode" translate="no">.<a href="#colorNode">colorNode</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  47. <div class="description">
  48. <p>Represents the color to process.<br/>Default is <code>null</code>.</p>
  49. </div>
  50. </div>
  51. <div class="member">
  52. <h3 class="name" id="exposureNode" translate="no">.<a href="#exposureNode">exposureNode</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  53. <div class="description">
  54. <p>The tone mapping exposure.<br/>Default is <code>null</code>.</p>
  55. </div>
  56. </div>
  57. <h2 class="subsection-title">Methods</h2>
  58. <h3 class="name name-method" id="customCacheKey" translate="no">.<a href="#customCacheKey">customCacheKey</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
  59. <div class="method">
  60. <div class="description">
  61. <p>Overwrites the default <code>customCacheKey()</code> implementation by including the tone
  62. mapping type into the cache key.</p>
  63. </div>
  64. <dl class="details">
  65. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#customCacheKey">TempNode#customCacheKey</a></dt>
  66. </dl>
  67. <dl class="details">
  68. <dt class="tag-returns"><strong>Returns:</strong> The hash.</dt>
  69. </dl>
  70. </div>
  71. <h3 class="name name-method" id="getToneMapping" translate="no">.<a href="#getToneMapping">getToneMapping</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
  72. <div class="method">
  73. <div class="description">
  74. <p>Gets the tone mapping type.</p>
  75. </div>
  76. <dl class="details">
  77. <dt class="tag-returns"><strong>Returns:</strong> The tone mapping type.</dt>
  78. </dl>
  79. </div>
  80. <h3 class="name name-method" id="setToneMapping" translate="no">.<a href="#setToneMapping">setToneMapping</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="ToneMappingNode.html">ToneMappingNode</a></span> </h3>
  81. <div class="method">
  82. <div class="description">
  83. <p>Sets the tone mapping type.</p>
  84. </div>
  85. <table class="params">
  86. <tbody>
  87. <tr>
  88. <td class="name"><code>value</code></td>
  89. <td class="description last"><p>The tone mapping type.</p></td>
  90. </tr>
  91. </tbody>
  92. </table>
  93. <dl class="details">
  94. <dt class="tag-returns"><strong>Returns:</strong> A reference to this node.</dt>
  95. </dl>
  96. </div>
  97. <h2 class="subsection-title">Source</h2>
  98. <p>
  99. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/display/ToneMappingNode.js" target="_blank" rel="noopener" translate="no">src/nodes/display/ToneMappingNode.js</a>
  100. </p>
  101. </article>
  102. </section>
  103. <script src="../scripts/linenumber.js"></script>
  104. <script src="../scripts/page.js"></script>
  105. </body>
  106. </html>
粤ICP备19079148号