javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git


			
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
							<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../" />
		<script src="list.js"></script>
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		[page:Mesh] &rarr;

		<h1>[name]</h1>

		<div class="desc">
			Creates a simulated lens flare that tracks a light.<br /><br />

			Note: [page:WebGLRenderer.alpha] must be set to *true* for LensFlare to work.
		</div>

		<h2>Example</h2>

		<div>
			[example:webgl_lensflares lensflares]

			<code>
var light = new THREE.PointLight( 0xffffff, 1.5, 2000 );

var textureLoader = new THREE.TextureLoader();

var textureFlare0 = textureLoader.load( "textures/lensflare/lensflare0.png" );
var textureFlare1 = textureLoader.load( "textures/lensflare/lensflare2.png" );
var textureFlare2 = textureLoader.load( "textures/lensflare/lensflare3.png" );

var lensFlare = new THREE.LensFlare();

lensFlare.add( new THREE.LensFlareElement( textureFlare0, 512, 0 ) );
lensFlare.add( new THREE.LensFlareElement( textureFlare1, 512, 0 ) );
lensFlare.add( new THREE.LensFlareElement( textureFlare2, 60, 0.6 ) );

light.add( lensFlare );
			</code>

		</div>

		<h2>Constructor</h2>


		<h3>LensFlareElement( [page:Texture texture], [page:Float size], [page:Float distance], [page:Color color], [page:Materials blending] )</h3>
		<div>
		[page:Texture texture] - THREE.Texture to use for the flare. <br />
		[page:Float size] - (optional) size in pixels <br />
		[page:Float distance] - (optional) (0-1) from light source (0 = at light source) <br />
		[page:Color color] - (optional) the [page:Color] of the lens flare<br />
		[page:Materials blending] - (optional) [page:Materials Blending Mode] - Defaults to THREE.NormalBlending
		</div>

		<h2>Properties</h2>
		<div>See the base [page:Mesh] class for common properties.</div>

		<h3>[property:Boolean isLensFlare]</h3>
		<div>
			Used to check whether this or derived classes are lens flares. Default is *true*.<br /><br />

			You should not change this, as it used internally for optimisation.
		</div>


		<h2>Source</h2>

		[link:https://github.com/mrdoob/three.js/blob/master/examples/js/objects/LensFlare.js examples/js/objects/LensFlare.js]
	</body>
</html>