EXRExporter.html 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  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. <h1>[name]</h1>
  11. <p class="desc">
  12. An exporter for `EXR`.
  13. <br /><br />
  14. [link:https://www.openexr.com/ EXR] ( Extended Dynamic Range) is an
  15. [link:https://github.com/AcademySoftwareFoundation/openexr open format specification]
  16. for professional-grade image storage format of the motion picture industry. The purpose of
  17. format is to accurately and efficiently represent high-dynamic-range scene-linear image data
  18. and associated metadata. The library is widely used in host application software where accuracy
  19. is critical, such as photorealistic rendering, texture access, image compositing, deep compositing,
  20. and DI.
  21. </p>
  22. <h2>Import</h2>
  23. <p>
  24. [name] is an add-on, and must be imported explicitly.
  25. See [link:#manual/introduction/Installation Installation / Addons].
  26. </p>
  27. <code>
  28. import { EXRExporter } from 'three/addons/exporters/EXRExporter.js';
  29. </code>
  30. <h2>Code Example</h2>
  31. <code>
  32. // Instantiate a exporter
  33. const exporter = new EXRExporter();
  34. // Parse the input render target data and generate the EXR output
  35. const EXR = exporter.parse( renderer, renderTarget, options );
  36. downloadFile( EXR );
  37. </code>
  38. <h2>Constructor</h2>
  39. <h3>[name]()</h3>
  40. <p>
  41. </p>
  42. <p>
  43. Creates a new [name].
  44. </p>
  45. <h2>Methods</h2>
  46. <h3>[method:null parse]( [param:WebGLRenderer renderer], [param:WebGLRenderTarget renderTarget], [param:Object options] )</h3>
  47. <p>
  48. [page:Function renderTarget] — WebGLRenderTarget containing data used for exporting EXR image.<br />
  49. [page:Options options] — Export options.<br />
  50. <ul>
  51. <li>type - Output datatype for internal EXR data. Available options:<br />
  52. <code>
  53. THREE.HalfFloatType // default option
  54. THREE.FloatType
  55. </code>
  56. </li>
  57. <li>compression - Internal compression algorithm. Available options:<br />
  58. <code>
  59. NO_COMPRESSION
  60. ZIP_COMPRESSION // default option
  61. ZIPS_COMPRESSION
  62. </code>
  63. </li>
  64. </ul>
  65. </p>
  66. <p>
  67. Generates a .exr output from the input render target.
  68. </p>
  69. <h3>[method:null parse]( [param:DataTexture dataTexture], [param:Object options] )</h3>
  70. <p>
  71. [page:Function dataTexture] — DataTexture containing data used for exporting EXR image.<br />
  72. [page:Options options] — Export options (details above).<br />
  73. </p>
  74. <p>
  75. Generates a .exr output from the input data texture.
  76. </p>
  77. <h2>Source</h2>
  78. <p>
  79. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/exporters/EXRExporter.js examples/jsm/exporters/EXRExporter.js]
  80. </p>
  81. </body>
  82. </html>