| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>LensflareElement - 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>
- <h1 translate="no">LensflareElement</h1>
- <section>
- <header>
- <div class="class-description"><p>Represents a single flare that can be added to a <a href="Lensflare.html">Lensflare</a> container.</p></div>
- </header>
- <article>
- <h2 class="subsection-title">Import</h2>
- <p><span translate="no">LensflareElement</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 { LensflareElement } from 'three/addons/objects/Lensflare.js';</code></pre>
- <div class="container-overview">
- <h2>Constructor</h2>
- <h3 class="name name-method" id="LensflareElement" translate="no">new <a href="#LensflareElement">LensflareElement</a><span class="signature">( texture : <span class="param-type">Texture</span>, size : <span class="param-type">number</span>, distance : <span class="param-type">number</span>, color : <span class="param-type">Color</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Constructs a new lensflare element.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>texture</code></td>
- <td class="description last"><p>The flare's texture.</p></td>
- </tr>
- <tr>
- <td class="name"><code>size</code></td>
- <td class="description last"><p>The size in pixels.<br/>Default is <code>1</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>distance</code></td>
- <td class="description last"><p>The normalized distance (<code>[0,1]</code>) from the light source.
- A value of <code>0</code> means the flare is located at light source.<br/>Default is <code>0</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>color</code></td>
- <td class="description last"><p>The flare's color</p></td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <h2 class="subsection-title">Properties</h2>
- <div class="member">
- <h3 class="name" id="color" translate="no">.<a href="#color">color</a><span class="type-signature"> : <a href="Color.html">Color</a></span> </h3>
- <div class="description">
- <p>The flare's color<br/>Default is <code>(1,1,1)</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="distance" translate="no">.<a href="#distance">distance</a><span class="type-signature"> : number</span> </h3>
- <div class="description">
- <p>The normalized distance (<code>[0,1]</code>) from the light source.
- A value of <code>0</code> means the flare is located at light source.<br/>Default is <code>0</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="size" translate="no">.<a href="#size">size</a><span class="type-signature"> : number</span> </h3>
- <div class="description">
- <p>The size in pixels.<br/>Default is <code>1</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="texture" translate="no">.<a href="#texture">texture</a><span class="type-signature"> : <a href="Texture.html">Texture</a></span> </h3>
- <div class="description">
- <p>The flare's texture.</p>
- </div>
- </div>
- <h2 class="subsection-title">Source</h2>
- <p>
- <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/objects/Lensflare.js" target="_blank" rel="noopener" translate="no">examples/jsm/objects/Lensflare.js</a>
- </p>
- </article>
- </section>
- <script src="../scripts/linenumber.js"></script>
- <script src="../scripts/page.js"></script>
- </body>
- </html>
|
