LUT3dlLoader.html 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>LUT3dlLoader - 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="Loader.html">Loader</a> → </p>
  13. <h1 translate="no">LUT3dlLoader</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A loader for the 3DL LUT format.</p>
  17. <p>References:</p>
  18. <ul>
  19. <li><a href="http://download.autodesk.com/us/systemdocs/help/2011/lustre/index.html?url=./files/WSc4e151a45a3b785a24c3d9a411df9298473-7ffd.htm,topicNumber=d0e9492" target="_blank" rel="noopener">3D LUTs</a></li>
  20. <li><a href="https://community.foundry.com/discuss/topic/103636/format-spec-for-3dl?mode=Post&amp;postID=895258" target="_blank" rel="noopener">Format Spec for .3dl</a></li>
  21. </ul></div>
  22. <h2>Code Example</h2>
  23. <div translate="no"><pre><code class="language-js">const loader = new LUT3dlLoader();
  24. const map = loader.loadAsync( 'luts/Presetpro-Cinematic.3dl' );
  25. </code></pre></div>
  26. </header>
  27. <article>
  28. <h2 class="subsection-title">Import</h2>
  29. <p><span translate="no">LUT3dlLoader</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank" rel="noopener">Installation#Addons</a>.</p>
  30. <pre><code class="language-js">import { LUT3dlLoader } from 'three/addons/loaders/LUT3dlLoader.js';</code></pre>
  31. <div class="container-overview">
  32. <h2>Constructor</h2>
  33. <h3 class="name name-method" id="LUT3dlLoader" translate="no">new <a href="#LUT3dlLoader">LUT3dlLoader</a><span class="signature">( manager : <span class="param-type"><a href="LoadingManager.html">LoadingManager</a></span> )</span> </h3>
  34. <div class="method">
  35. <div class="description">
  36. <p>Constructs a new 3DL LUT loader.</p>
  37. </div>
  38. <table class="params">
  39. <tbody>
  40. <tr>
  41. <td class="name">
  42. <strong>manager</strong>
  43. </td>
  44. <td class="description last">
  45. <p>The loading manager.</p>
  46. </td>
  47. </tr>
  48. </tbody>
  49. </table>
  50. </div>
  51. </div>
  52. <h2 class="subsection-title">Classes</h2>
  53. <dl>
  54. <dt><a href="LUT3dlLoader.html">LUT3dlLoader</a></dt>
  55. <dd></dd>
  56. </dl>
  57. <h2 class="subsection-title">Properties</h2>
  58. <div class="member">
  59. <h3 class="name" id="type" translate="no">.<a href="#type">type</a><span class="type-signature"> : <a href="global.html#UnsignedByteType">UnsignedByteType</a> | <a href="global.html#FloatType">FloatType</a></span> </h3>
  60. <div class="description">
  61. <p>The texture type.</p>
  62. <p>Default is <code>UnsignedByteType</code>.</p>
  63. </div>
  64. </div>
  65. <h2 class="subsection-title">Methods</h2>
  66. <h3 class="name name-method" id="load" translate="no">.<a href="#load">load</a><span class="signature">( url : <span class="param-type">string</span>, onLoad : <span class="param-type">function</span>, onProgress : <span class="param-type"><a href="global.html#onProgressCallback">onProgressCallback</a></span>, onError : <span class="param-type"><a href="global.html#onErrorCallback">onErrorCallback</a></span> )</span> </h3>
  67. <div class="method">
  68. <div class="description">
  69. <p>Starts loading from the given URL and passes the loaded 3DL LUT asset
  70. to the <code>onLoad()</code> callback.</p>
  71. </div>
  72. <table class="params">
  73. <tbody>
  74. <tr>
  75. <td class="name">
  76. <strong>url</strong>
  77. </td>
  78. <td class="description last">
  79. <p>The path/URL of the file to be loaded. This can also be a data URI.</p>
  80. </td>
  81. </tr>
  82. <tr>
  83. <td class="name">
  84. <strong>onLoad</strong>
  85. </td>
  86. <td class="description last">
  87. <p>Executed when the loading process has been finished.</p>
  88. </td>
  89. </tr>
  90. <tr>
  91. <td class="name">
  92. <strong>onProgress</strong>
  93. </td>
  94. <td class="description last">
  95. <p>Executed while the loading is in progress.</p>
  96. </td>
  97. </tr>
  98. <tr>
  99. <td class="name">
  100. <strong>onError</strong>
  101. </td>
  102. <td class="description last">
  103. <p>Executed when errors occur.</p>
  104. </td>
  105. </tr>
  106. </tbody>
  107. </table>
  108. <dl class="details">
  109. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
  110. </dl>
  111. </div>
  112. <h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( input : <span class="param-type">string</span> )</span><span class="type-signature"> : Object</span> </h3>
  113. <div class="method">
  114. <div class="description">
  115. <p>Parses the given 3DL LUT data and returns the resulting 3D data texture.</p>
  116. </div>
  117. <table class="params">
  118. <tbody>
  119. <tr>
  120. <td class="name">
  121. <strong>input</strong>
  122. </td>
  123. <td class="description last">
  124. <p>The raw 3DL LUT data as a string.</p>
  125. </td>
  126. </tr>
  127. </tbody>
  128. </table>
  129. <dl class="details">
  130. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
  131. </dl>
  132. <dl class="details">
  133. <dt class="tag-returns"><strong>Returns:</strong> The parsed 3DL LUT.</dt>
  134. </dl>
  135. </div>
  136. <h3 class="name name-method" id="setType" translate="no">.<a href="#setType">setType</a><span class="signature">( type : <span class="param-type"><a href="global.html#UnsignedByteType">UnsignedByteType</a> | <a href="global.html#FloatType">FloatType</a></span> )</span><span class="type-signature"> : <a href="LUT3dlLoader.html">LUT3dlLoader</a></span> </h3>
  137. <div class="method">
  138. <div class="description">
  139. <p>Sets the texture type.</p>
  140. </div>
  141. <table class="params">
  142. <tbody>
  143. <tr>
  144. <td class="name">
  145. <strong>type</strong>
  146. </td>
  147. <td class="description last">
  148. <p>The texture type to set.</p>
  149. </td>
  150. </tr>
  151. </tbody>
  152. </table>
  153. <dl class="details">
  154. <dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
  155. </dl>
  156. </div>
  157. <h2 class="subsection-title">Source</h2>
  158. <p>
  159. <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/LUT3dlLoader.js" translate="no" target="_blank" rel="noopener">examples/jsm/loaders/LUT3dlLoader.js</a>
  160. </p>
  161. </article>
  162. </section>
  163. <script src="../scripts/linenumber.js"></script>
  164. <script src="../scripts/page.js"></script>
  165. </body>
  166. </html>
粤ICP备19079148号