|
1 | | -<!DOCTYPE html> |
2 | | -<html lang="en"> |
3 | | - <head> |
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en"> |
| 3 | + <head> |
4 | 4 | <meta charset="utf-8" /> |
5 | | - <base href="../../" /> |
6 | | - <script src="list.js"></script> |
7 | | - <script src="page.js"></script> |
8 | | - <link type="text/css" rel="stylesheet" href="page.css" /> |
9 | | - </head> |
10 | | - <body> |
11 | | - [page:Object3D] → |
12 | | - |
13 | | - <h1>[name]</h1> |
14 | | - |
15 | | - <div class="desc">Creates a simulated lens flare that tracks a light</div> |
16 | | - |
17 | | - <h2>Example</h2> |
18 | | - |
19 | | - <div>[example:webgl_lensflares lensflares]</div> |
20 | | - |
21 | | - <h2>Constructor</h2> |
22 | | - |
23 | | - |
24 | | - <h3>[name]([page:Texture texture], [page:Float size], [page:Float distance], [page:Materials blending], [page:Color color])</h3> |
25 | | - <div> |
26 | | - texture -- THREE.Texture (optional) <br /> |
27 | | - size -- size in pixels (-1 = use texture.width) <br /> |
28 | | - distance -- (0-1) from light source (0 = at light source) <br /> |
29 | | - blending -- [page:Materials Blending Mode] - Defaults to THREE.NormalBlending <br /> |
30 | | - color -- The color of the lens flare |
31 | | - </div> |
32 | | - <div> |
33 | | - Automatically adds a lens flare to the lensFlares array if a texture is set. |
34 | | - </div> |
35 | | - |
36 | | - <h2>Properties</h2> |
37 | | - |
38 | | - |
39 | | - |
40 | | - <h3>[property:array lensFlares]</h3> |
41 | | - <div> |
42 | | - The array of flares as set by [page:LensFlare.add] |
43 | | - </div> |
44 | | - |
45 | | - <h3>[property:Vector3 positionScreen]</h3> |
46 | | - <div> |
47 | | - The position of the lens flare on the screen. |
48 | | - </div> |
49 | | - |
50 | | - <h3>[property:Function customUpdateCallback]</h3> |
51 | | - <div> |
52 | | - A custom update callback |
53 | | - </div> |
54 | | - |
55 | | - <h2>Methods</h2> |
56 | | - |
57 | | - |
58 | | - <h3>[method:null add]([page:Texture texture], [page:Float size], [page:Float distance], [page:Materials blending], [page:Color color])</h3> |
59 | | - <div> |
60 | | - Adds a lens flare. See the constructor for details on the parameters. |
61 | | - </div> |
62 | | - |
63 | | - |
64 | | - <h3>[method:null updateLensFlares]()</h3> |
65 | | - <div> |
66 | | - Updates the lens flare based on the [page:LensFlare.positionScreen positionScreen] property. |
67 | | - </div> |
68 | | - |
69 | | - <h3>[method:Object3D clone]([page:Object3D object])</h3> |
70 | | - <div> |
71 | | - object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned LensFlare Object. |
72 | | - </div> |
73 | | - <div> |
74 | | - Clone a LensFlare Object. |
75 | | - </div> |
76 | | - |
77 | | - <h2>Source</h2> |
78 | | - |
79 | | - [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] |
80 | | - </body> |
81 | | -</html> |
| 5 | + <base href="../../" /> |
| 6 | + <script src="list.js"></script> |
| 7 | + <script src="page.js"></script> |
| 8 | + <link type="text/css" rel="stylesheet" href="page.css" /> |
| 9 | + </head> |
| 10 | + <body> |
| 11 | + [page:Object3D] → |
| 12 | + |
| 13 | + <h1>[name]</h1> |
| 14 | + |
| 15 | + <div class="desc">Creates a simulated lens flare that tracks a light</div> |
| 16 | + |
| 17 | + <h2>Example</h2> |
| 18 | + |
| 19 | + <div>[example:webgl_lensflares lensflares]</div> |
| 20 | + |
| 21 | + <h2>Constructor</h2> |
| 22 | + |
| 23 | + |
| 24 | + <h3>[name]([page:Texture texture], [page:Float size], [page:Float distance], [page:Materials blending], [page:Color color])</h3> |
| 25 | + <div> |
| 26 | + texture -- THREE.Texture (optional) <br /> |
| 27 | + size -- size in pixels (-1 = use texture.width) <br /> |
| 28 | + distance -- (0-1) from light source (0 = at light source) <br /> |
| 29 | + blending -- [page:Materials Blending Mode] - Defaults to THREE.NormalBlending <br /> |
| 30 | + color -- The color of the lens flare |
| 31 | + </div> |
| 32 | + <div> |
| 33 | + Automatically adds a lens flare to the lensFlares array if a texture is set. |
| 34 | + </div> |
| 35 | + |
| 36 | + <h2>Properties</h2> |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | + <h3>[property:array lensFlares]</h3> |
| 41 | + <div> |
| 42 | + The array of flares as set by [page:LensFlare.add] |
| 43 | + </div> |
| 44 | + |
| 45 | + <h3>[property:Vector3 positionScreen]</h3> |
| 46 | + <div> |
| 47 | + The position of the lens flare on the screen. |
| 48 | + </div> |
| 49 | + |
| 50 | + <h3>[property:Function customUpdateCallback]</h3> |
| 51 | + <div> |
| 52 | + A custom update callback |
| 53 | + </div> |
| 54 | + |
| 55 | + <h2>Methods</h2> |
| 56 | + |
| 57 | + |
| 58 | + <h3>[method:null add]([page:Texture texture], [page:Float size], [page:Float distance], [page:Materials blending], [page:Color color])</h3> |
| 59 | + <div> |
| 60 | + Adds a lens flare. See the constructor for details on the parameters. |
| 61 | + </div> |
| 62 | + |
| 63 | + |
| 64 | + <h3>[method:null updateLensFlares]()</h3> |
| 65 | + <div> |
| 66 | + Updates the lens flare based on the [page:LensFlare.positionScreen positionScreen] property. |
| 67 | + </div> |
| 68 | + |
| 69 | + <h3>[method:Object3D clone]([page:Object3D object])</h3> |
| 70 | + <div> |
| 71 | + object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned LensFlare Object. |
| 72 | + </div> |
| 73 | + <div> |
| 74 | + Clone a LensFlare Object. |
| 75 | + </div> |
| 76 | + |
| 77 | + <h2>Source</h2> |
| 78 | + |
| 79 | + [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js] |
| 80 | + |
| 81 | + <h2>Common pitfalls</h2> |
| 82 | + <div> |
| 83 | + When integrating LensFlare to your existing project, make sure that your WebGLRenderer object has the "alpha" property set to TRUE. If not, then no LensFlare will ever display at all (they will always remain transparent). |
| 84 | + </div> |
| 85 | + </body> |
| 86 | +</html> |
0 commit comments