Lensflare.html 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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. [page:Mesh] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. Creates a simulated lens flare that tracks a light. [name] can only be used when setting the `alpha` context parameter of [page:WebGLRenderer] to `true`.
  14. </p>
  15. <h2>Import</h2>
  16. <p>
  17. [name] is an add-on, and must be imported explicitly.
  18. See [link:#manual/introduction/Installation Installation / Addons].
  19. </p>
  20. <code>
  21. import { Lensflare, LensflareElement } from 'three/addons/objects/Lensflare.js';
  22. </code>
  23. <h2>Code Example</h2>
  24. <code>
  25. const light = new THREE.PointLight( 0xffffff, 1.5, 2000 );
  26. const textureLoader = new THREE.TextureLoader();
  27. const textureFlare0 = textureLoader.load( "textures/lensflare/lensflare0.png" );
  28. const textureFlare1 = textureLoader.load( "textures/lensflare/lensflare2.png" );
  29. const textureFlare2 = textureLoader.load( "textures/lensflare/lensflare3.png" );
  30. const lensflare = new Lensflare();
  31. lensflare.addElement( new LensflareElement( textureFlare0, 512, 0 ) );
  32. lensflare.addElement( new LensflareElement( textureFlare1, 512, 0 ) );
  33. lensflare.addElement( new LensflareElement( textureFlare2, 60, 0.6 ) );
  34. light.add( lensflare );
  35. </code>
  36. <h2>Examples</h2>
  37. <p>
  38. [example:webgl_lensflares WebGL / lensflares]
  39. </p>
  40. <h2>Constructor</h2>
  41. <h3>LensflareElement( [param:Texture texture], [param:Float size], [param:Float distance], [param:Color color] )</h3>
  42. <p>
  43. [page:Texture texture] - THREE.Texture to use for the flare. <br />
  44. [page:Float size] - (optional) size in pixels <br />
  45. [page:Float distance] - (optional) (0-1) from light source (0 = at light source) <br />
  46. [page:Color color] - (optional) the [page:Color] of the lens flare
  47. </p>
  48. <h2>Properties</h2>
  49. <p>See the base [page:Mesh] class for common properties.</p>
  50. <h2>Source</h2>
  51. <p>
  52. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/objects/Lensflare.js examples/jsm/objects/Lensflare.js]
  53. </p>
  54. </body>
  55. </html>