Explorar el Código

More verbose description for opacity/transparent

Brent Van Minnen hace 11 años
padre
commit
a6580ef258
Se han modificado 1 ficheros con 14 adiciones y 5 borrados
  1. 14 5
      docs/api/materials/Material.html

+ 14 - 5
docs/api/materials/Material.html

@@ -17,7 +17,7 @@
 
 		<h3>[name]()</h3>
 		<div>
-		todo
+		This creates a generic material.
 		</div>
 
 
@@ -33,20 +33,29 @@
 		Material name. Default is an empty string.
 		</div>
 
-		<h3>.[page:Number opacity]</h3>
+		<h3>.[page:Float opacity]</h3>
 		<div>
-		Opacity. Default is *1*.
+		Float in the range of 0.0 - 1.0 indicating how see through the material is.
+		A value of 0.0 indicates fully transparent, 1.0 is fully opaque. If
+		*transparent* is not set to true for the material, the material will remain
+		fully opaque and this value will only affect its color.
 		</div>
+		<div>Default is *1.0*.</div>
 
 		<h3>.[page:Boolean transparent]</h3>
 		<div>
-		Defines whether this material is transparent. This has an effect on rendering, as transparent objects need special treatment, and are rendered after the opaque (i.e. non transparent) objects. For a working example of this behaviour, check the [page:WebGLRenderer WebGLRenderer] code.
+		Defines whether this material is transparent. This has an effect on rendering,
+		as transparent objects need an special treatment, and are rendered after the
+		non transparent objects. For a working example of this behaviour, check the
+		[page:WebGLRenderer WebGLRenderer] code.<br />
+		When set to true, the extent to which the material is transparent is
+		controlled by setting *opacity*.
 		</div>
 		<div>Default is *false*.</div>
 
 		<h3>.[page:Blending blending]</h3>
 		<div>
-		Which blending to use when displaying objects with this material. Default is [page:NormalBlending].
+		Which blending to use when displaying objects with this material. Default is [page:Materials NormalBlending].
 		</div>
 
 		<h3>.[page:Integer blendSrc]</h3>