| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>FullScreenQuad - 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> → <a href="Object3D.html">Object3D</a> → <a href="Mesh.html">Mesh</a> → </p>
- <h1 translate="no">FullScreenQuad</h1>
- <section>
- <header>
- <div class="class-description"><p>This module is a helper for passes which need to render a full
- screen effect which is quite common in context of post processing.</p>
- <p>The intended usage is to reuse a single full screen quad for rendering
- subsequent passes by just reassigning the <code>material</code> reference.</p>
- <p>This module can only be used with <a href="WebGLRenderer.html">WebGLRenderer</a>.</p></div>
- </header>
- <article>
- <h2 class="subsection-title">Import</h2>
- <p><span translate="no">FullScreenQuad</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
- <pre><code class="language-js">import { FullScreenQuad } from 'three/addons/postprocessing/Pass.js';</code></pre>
- <div class="container-overview">
- <h2>Constructor</h2>
- <h3 class="name name-method" id="FullScreenQuad" translate="no">new <a href="#FullScreenQuad">FullScreenQuad</a><span class="signature">( material : <span class="param-type">Material</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Constructs a new full screen quad.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>material</code></td>
- <td class="description last"><p>The material to render te full screen quad with.</p></td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <h2 class="subsection-title">Properties</h2>
- <div class="member">
- <h3 class="name" id="material" translate="no">.<a href="#material">material</a><span class="type-signature"> : <a href="Material.html">Material</a></span> </h3>
- <div class="description">
- <p>The quad's material.</p>
- </div>
- <dl class="details">
- <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Mesh.html#material">Mesh#material</a></dt>
- </dl>
- </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 the GPU-related resources allocated by this instance. Call this
- method whenever the instance is no longer used in your app.</p>
- </div>
- </div>
- <h3 class="name name-method" id="render" translate="no">.<a href="#render">render</a><span class="signature">( renderer : <span class="param-type">WebGLRenderer</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Renders the full screen quad.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>renderer</code></td>
- <td class="description last"><p>The renderer.</p></td>
- </tr>
- </tbody>
- </table>
- </div>
- <h2 class="subsection-title">Source</h2>
- <p>
- <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/postprocessing/Pass.js" target="_blank" rel="noopener" translate="no">examples/jsm/postprocessing/Pass.js</a>
- </p>
- </article>
- </section>
- <script src="../scripts/linenumber.js"></script>
- <script src="../scripts/page.js"></script>
- </body>
- </html>
|
