Lensflare

Creates a simulated lens flare that tracks a light. Lensflare can only be used when setting the alpha context parameter of WebGLRenderer to true.

Import

Lensflare is an add-on, and must be imported explicitly. See Installation / Addons.

import { Lensflare, LensflareElement } from 'three/addons/objects/Lensflare.js';

Code Example

const light = new THREE.PointLight( 0xffffff, 1.5, 2000 );

const textureLoader = new THREE.TextureLoader();

const textureFlare0 = textureLoader.load( "textures/lensflare/lensflare0.png" );

const textureFlare1 = textureLoader.load( "textures/lensflare/lensflare2.png" );

const textureFlare2 = textureLoader.load( "textures/lensflare/lensflare3.png" );

const lensflare = new Lensflare();

lensflare.addElement( new LensflareElement( textureFlare0, 512, 0 ) );

lensflare.addElement( new LensflareElement( textureFlare1, 512, 0 ) );

lensflare.addElement( new LensflareElement( textureFlare2, 60, 0.6 ) );

light.add( lensflare );

Examples

WebGL / lensflares

Constructor

LensflareElement( texture : Texture, size : Float, distance : Float, color : Color )

texture – THREE.Texture to use for the flare.

size – (optional) size in pixels

distance – (optional) (0-1) from light source (0 = at light source)

color – (optional) the Color of the lens flare

Properties

See the base Mesh class for common properties.