LUT3dlLoader.html 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. [page:Loader] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. A 3D LUT loader that supports the .3dl file format.<br />
  14. Based on the following references:
  15. </p>
  16. <ul>
  17. <li>[link:http://download.autodesk.com/us/systemdocs/help/2011/lustre/index.html?url=./files/WSc4e151a45a3b785a24c3d9a411df9298473-7ffd.htm,topicNumber=d0e9492]</li>
  18. <li>[link:https://community.foundry.com/discuss/topic/103636/format-spec-for-3dl?mode=Post&postID=895258]</li>
  19. </ul>
  20. <h2>Import</h2>
  21. <p>
  22. [name] is an add-on, and must be imported explicitly.
  23. See [link:#manual/introduction/Installation Installation / Addons].
  24. </p>
  25. <code>
  26. import { LUT3dlLoader } from 'three/addons/loaders/LUT3dlLoader.js';
  27. </code>
  28. <h2>Constructor</h2>
  29. <h3>[name]( [param:LoadingManager manager] )</h3>
  30. <p>
  31. [page:LoadingManager manager] — The LoadingManager to use. Defaults to [page:DefaultLoadingManager DefaultLoadingManager]<br />
  32. </p>
  33. <p>
  34. Creates a new [name].
  35. </p>
  36. <h2>Properties</h2>
  37. <p>See the base [page:Loader] class for common properties.</p>
  38. <h2>Methods</h2>
  39. <p>See the base [page:Loader] class for common methods.</p>
  40. <h3>[method:undefined load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
  41. <p>
  42. [page:String url] — A string containing the path/URL of the `.3dl` file.<br />
  43. [page:Function onLoad] — (optional) A function to be called after the loading is successfully completed. The function receives the result of the [page:Function parse] method.<br />
  44. [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, which contains [page:Integer total] and [page:Integer loaded] bytes. If the server does not set the Content-Length header; .[page:Integer total] will be 0.<br />
  45. [page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives the error as an argument.<br />
  46. </p>
  47. <p>
  48. Begin loading from url and return the loaded LUT.
  49. </p>
  50. <h3>[method:Object parse]( [param:String input] )</h3>
  51. <p>
  52. [page:String input] — The 3dl data string.<br />
  53. </p>
  54. <p>
  55. Parse a 3dl data string and fire [page:Function onLoad] callback when complete. The argument to [page:Function onLoad] will be an [page:Object object] containing the following LUT data: [page:Number .size], [page:DataTexture .texture] and [page:Data3DTexture .texture3D].
  56. </p>
  57. <h3>[method:this setType]( [param:Number type] )</h3>
  58. <p>
  59. [page:Number type] - The texture type. See the [page:Textures texture constants] page for details.<br />
  60. </p>
  61. <p>
  62. Sets the desired texture type. Only [page:Textures THREE.UnsignedByteType] and [page:Textures THREE.FloatType] are supported. The default is [page:Textures THREE.UnsignedByteType].
  63. </p>
  64. <h2>Source</h2>
  65. <p>
  66. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/[name].js examples/jsm/loaders/[name].js]
  67. </p>
  68. </body>
  69. </html>