KTX2Exporter.html 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  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 `KTX2`.
  13. <br /><br />
  14. [link:https://www.khronos.org/ktx/ KTX2] is an
  15. [link:https://github.khronos.org/KTX-Specification/ktxspec.v2.html open
  16. format specification] container format that provides efficient storage and
  17. transmission of texture data with support for GPU-optimized formats.
  18. </p>
  19. <h2>Import</h2>
  20. <p>
  21. [name] is an add-on, and must be imported explicitly. See
  22. [link:#manual/introduction/Installation Installation / Addons].
  23. </p>
  24. <code>
  25. import { KTX2Exporter } from 'three/addons/exporters/KTX2Exporter.js';
  26. </code>
  27. <h2>Code Example</h2>
  28. <code>
  29. // Instantiate an exporter
  30. const exporter = new KTX2Exporter();
  31. // Export a data texture
  32. const result = await exporter.parse( dataTexture );
  33. // Export a render target
  34. const result = await exporter.parse( renderer, renderTarget );
  35. </code>
  36. <h2>Examples</h2>
  37. <p>[example:misc_exporter_ktx2]</p>
  38. <h2>Constructor</h2>
  39. <h3>[name]()</h3>
  40. <p>Creates a new [name].</p>
  41. <h2>Methods</h2>
  42. <h3>[method:Promise parse]( [param:DataTexture texture] )</h3>
  43. <p>[page:Object texture] — DataTexture or Data3DTexture to export.<br /></p>
  44. <p>
  45. Generates a KTX2 file from the input texture. Returns a promise that
  46. resolves with the result.
  47. </p>
  48. <h3>
  49. [method:Promise parse]( [param:WebGLRenderer renderer],
  50. [param:WebGLRenderTarget renderTarget] )
  51. </h3>
  52. <p>
  53. [page:Object renderer] — Renderer to use to read pixel data from the render target. Should be a
  54. [page:WebGLRenderer] or [page:WebGPURenderer].<br />
  55. [page:Object renderTarget] — The render target to export. Should be a [page:RenderTarget].<br />
  56. </p>
  57. <p>
  58. Generates a KTX2 file from the render target. Returns a promise that
  59. resolves with the result.
  60. </p>
  61. <h2>Source</h2>
  62. <p>
  63. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/exporters/KTX2Exporter.js examples/jsm/exporters/KTX2Exporter.js]
  64. </p>
  65. </body>
  66. </html>
粤ICP备19079148号