Kaynağa Gözat

Document Fog and FoxExp2

sole 13 yıl önce
ebeveyn
işleme
d073d158e5
2 değiştirilmiş dosya ile 18 ekleme ve 20 silme
  1. 11 10
      docs/api/scenes/Fog.html
  2. 7 10
      docs/api/scenes/FogExp2.html

+ 11 - 10
docs/api/scenes/Fog.html

@@ -9,25 +9,26 @@
 	<body>
 		<h1>[name]</h1>
 
-		<div class="desc">todo</div>
+		<div class="desc">This class contains the parameters that define linear fog, i.e., that grows linearly denser with the distance.</div>
 
 
 		<h2>Constructor</h2>
 
-		<h3>[name]()</h3>
+		<h3>[name]( [page:Integer hex], [page:Float near], [page:Float far] )</h3>
 
 
 		<h2>Properties</h2>
 
-		<h3>.[page:Vector3 todo]</h3>
+		<h3>.[page:Integer hex]</h3>
+		<div>Fog color in hexadecimal. Example: 0x000000 will render far away objects black.</div>
 
-
-		<h2>Methods</h2>
-
-		<h3>.todo( [page:Vector3 todo] )</h3>
-		<div>
-		todo — todo<br />
-		</div>
+		<h3>.[page:Float near]</h3>
+		<div>The minimum distance to start applying fog. Objects that are less than 'near' units from the active camera won't be affected by fog.</div>
+		<div>Default is 1.</div>
+		
+		<h3>.[page:Float far]</h3>
+		<div>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.</div>
+		<div>Default is 1000.</div>
 
 
 		<h2>Source</h2>

+ 7 - 10
docs/api/scenes/FogExp2.html

@@ -9,25 +9,22 @@
 	<body>
 		<h1>[name]</h1>
 
-		<div class="desc">todo</div>
+		<div class="desc">This class contains the parameters that define linear fog, i.e., that grows exponentially denser with the distance.</div>
 
 
 		<h2>Constructor</h2>
 
-		<h3>[name]()</h3>
+		<h3>[name]( [page:Integer hex], [page:Float density])</h3>
 
 
 		<h2>Properties</h2>
 
-		<h3>.[page:Vector3 todo]</h3>
+		<h3>.[page:Integer hex]</h3>
+		<div>Fog color in hexadecimal. Example: 0x000000 will render far away objects black.</div>
 
-
-		<h2>Methods</h2>
-
-		<h3>.todo( [page:Vector3 todo] )</h3>
-		<div>
-		todo — todo<br />
-		</div>
+		<h3>.[page:Float density]</h3>
+		<div>Defines how fast the fog will grow dense.</div>
+		<div>Default is 0.00025.</div>
 
 
 		<h2>Source</h2>