From d073d158e51fd3edeaaab11bea999ef69f06c331 Mon Sep 17 00:00:00 2001 From: sole Date: Thu, 27 Sep 2012 20:56:13 +0200 Subject: [PATCH] Document Fog and FoxExp2 --- docs/api/scenes/Fog.html | 21 +++++++++++---------- docs/api/scenes/FogExp2.html | 17 +++++++---------- 2 files changed, 18 insertions(+), 20 deletions(-) diff --git a/docs/api/scenes/Fog.html b/docs/api/scenes/Fog.html index 8ad6d52df4..ed9e2d588e 100644 --- a/docs/api/scenes/Fog.html +++ b/docs/api/scenes/Fog.html @@ -9,25 +9,26 @@

[name]

-
todo
+
This class contains the parameters that define linear fog, i.e., that grows linearly denser with the distance.

Constructor

-

[name]()

+

[name]( [page:Integer hex], [page:Float near], [page:Float far] )

Properties

-

.[page:Vector3 todo]

+

.[page:Integer hex]

+
Fog color in hexadecimal. Example: 0x000000 will render far away objects black.
- -

Methods

- -

.todo( [page:Vector3 todo] )

-
- todo — todo
-
+

.[page:Float near]

+
The minimum distance to start applying fog. Objects that are less than 'near' units from the active camera won't be affected by fog.
+
Default is 1.
+ +

.[page:Float far]

+
The maximum distance at which fog stops being calculated and applied. Objects that are more than 'far' units away from the active camera won't be affected by fog.
+
Default is 1000.

Source

diff --git a/docs/api/scenes/FogExp2.html b/docs/api/scenes/FogExp2.html index 8ad6d52df4..7562baa036 100644 --- a/docs/api/scenes/FogExp2.html +++ b/docs/api/scenes/FogExp2.html @@ -9,25 +9,22 @@

[name]

-
todo
+
This class contains the parameters that define linear fog, i.e., that grows exponentially denser with the distance.

Constructor

-

[name]()

+

[name]( [page:Integer hex], [page:Float density])

Properties

-

.[page:Vector3 todo]

+

.[page:Integer hex]

+
Fog color in hexadecimal. Example: 0x000000 will render far away objects black.
- -

Methods

- -

.todo( [page:Vector3 todo] )

-
- todo — todo
-
+

.[page:Float density]

+
Defines how fast the fog will grow dense.
+
Default is 0.00025.

Source

-- GitLab