| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>ReadbackBuffer - Three.js Docs</title>
- <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
- <script src="../scripts/highlight.min.js"></script>
- <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
- <link type="text/css" rel="stylesheet" href="../styles/page.css">
- </head>
- <body>
- <p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → </p>
- <h1 translate="no">ReadbackBuffer</h1>
- <section>
- <header>
- <div class="class-description"><p>A readback buffer is used to transfer data from the GPU to the CPU.
- It is primarily used to read back compute shader results.</p></div>
- </header>
- <article>
- <div class="container-overview">
- <h2>Constructor</h2>
- <h3 class="name name-method" id="ReadbackBuffer" translate="no">new <a href="#ReadbackBuffer">ReadbackBuffer</a><span class="signature">( maxByteLength : <span class="param-type">number</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Constructs a new readback buffer.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong translate="no">maxByteLength</strong>
- </td>
- <td class="description last">
- <p>The maximum size of the buffer to be read back.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <h2 class="subsection-title">Properties</h2>
- <div class="member">
- <h3 class="name" id="buffer" translate="no">.<a href="#buffer">buffer</a><span class="type-signature"> : ArrayBuffer | null</span> </h3>
- <div class="description">
- <p>The mapped, read back array buffer.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="isReadbackBuffer" translate="no">.<a href="#isReadbackBuffer">isReadbackBuffer</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
- <div class="description">
- <p>This flag can be used for type testing.</p>
- <p>Default is <code>true</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="maxByteLength" translate="no">.<a href="#maxByteLength">maxByteLength</a><span class="type-signature"> : number</span> </h3>
- <div class="description">
- <p>The maximum size of the buffer to be read back.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="name" translate="no">.<a href="#name">name</a><span class="type-signature"> : string</span> </h3>
- <div class="description">
- <p>Name used for debugging purposes.</p>
- </div>
- </div>
- <h2 class="subsection-title">Methods</h2>
- <h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
- <div class="method">
- <div class="description">
- <p>Frees internal resources.</p>
- </div>
- </div>
- <h3 class="name name-method" id="release" translate="no">.<a href="#release">release</a><span class="signature">()</span> </h3>
- <div class="method">
- <div class="description">
- <p>Releases the mapped buffer data so the GPU buffer can be
- used by the GPU again.</p>
- <p>Note: Any <code>ArrayBuffer</code> data associated with this readback buffer
- are removed and no longer accessible after calling this method.</p>
- </div>
- </div>
- <h2 class="subsection-title">Source</h2>
- <p>
- <a href="https://github.com/mrdoob/three.js/blob/master/src/renderers/common/ReadbackBuffer.js" translate="no" target="_blank" rel="noopener">src/renderers/common/ReadbackBuffer.js</a>
- </p>
- </article>
- </section>
- <script src="../scripts/linenumber.js"></script>
- <script src="../scripts/page.js"></script>
- </body>
- </html>
|
