forked from mrdoob/three.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathLensFlare.html
More file actions
80 lines (58 loc) · 2.12 KB
/
LensFlare.html
File metadata and controls
80 lines (58 loc) · 2.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<!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:Object3D] →
<h1>[name]</h1>
<div class="desc">Creates a simulated lens flare that tracks a light.<br /><br />
Note: [page:WebGLRenderer] must have *alpha* set to *true* for LensFlare to work.</div>
<h2>Example</h2>
<div>[example:webgl_lensflares lensflares]</div>
<h2>Constructor</h2>
<h3>[name]( [page:Texture texture], [page:Float size], [page:Float distance], [page:Materials blending], [page:Color color] )</h3>
<div>
texture -- THREE.Texture (optional) <br />
size -- size in pixels (-1 = use texture.width) <br />
distance -- (0-1) from light source (0 = at light source) <br />
blending -- [page:Materials Blending Mode] - Defaults to THREE.NormalBlending <br />
color -- The color of the lens flare
</div>
<div>
Automatically adds a lens flare to the lensFlares array if a texture is set.
</div>
<h2>Properties</h2>
<h3>[property:array lensFlares]</h3>
<div>
The array of flares as set by [page:LensFlare.add]
</div>
<h3>[property:Vector3 positionScreen]</h3>
<div>
The position of the lens flare on the screen.
</div>
<h3>[property:Function customUpdateCallback]</h3>
<div>
A custom update callback
</div>
<h2>Methods</h2>
<h3>[method:null add]( [page:Texture texture], [page:Float size], [page:Float distance], [page:Materials blending], [page:Color color] )</h3>
<div>
Adds a lens flare. See the constructor for details on the parameters.
</div>
<h3>[method:null updateLensFlares]()</h3>
<div>
Updates the lens flare based on the [page:LensFlare.positionScreen positionScreen] property.
</div>
<h3>[method:Lens Flare clone]()</h3>
<div>
Returns a clone of this LensFlare object and its descendants.
</div>
<h2>Source</h2>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</body>
</html>