|
@@ -36,32 +36,70 @@
|
|
|
|
|
|
<h3>[name]( [page:Object parameters] )</h3>
|
|
|
<div>
|
|
|
- parameters is an object with one or more properties defining the material's appearance.
|
|
|
+ [page:Object parameters] - (optional) an object with one or more properties defining the material's appearance.
|
|
|
+ Any property of the material (including any property inherited from [page:Material]) can be passed in here.
|
|
|
</div>
|
|
|
+
|
|
|
+ <h2>Properties</h2>
|
|
|
+ <div>See the base [page:Material] class for common properties.</div>
|
|
|
+
|
|
|
+ <h3>[property:Texture alphaMap]</h3>
|
|
|
+ <div>The alpha map is a grayscale texture that controls the opacity across the surface
|
|
|
+ (black: fully transparent; white: fully opaque). Default is null.<br /><br />
|
|
|
+
|
|
|
+ Only the color of the texture is used, ignoring the alpha channel if one exists.
|
|
|
+ For RGB and RGBA textures, the [page:WebGLRenderer WebGL] renderer will use the
|
|
|
+ green channel when sampling this texture due to the extra bit of precision provided
|
|
|
+ for green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
|
|
|
+ luminance/alpha textures will also still work as expected.
|
|
|
+ </div>
|
|
|
+
|
|
|
+ <h3>[property:Constant depthPacking]</h3>
|
|
|
+ <div>Encoding for depth packing. Default is [page:Textures BasicDepthPacking].</div>
|
|
|
+
|
|
|
+ <h3>[property:Texture displacementMap]</h3>
|
|
|
+ <div>The displacement map. Default is null.</div>
|
|
|
+
|
|
|
+ <h3>[property:Number displacementMapBias]</h3>
|
|
|
+ <div>The displacement map's bias. Default is *0*.</div>
|
|
|
+
|
|
|
+ <h3>[property:Number displacementMapScale]</h3>
|
|
|
+ <div>The displacement map. Default is *1*.</div>
|
|
|
+
|
|
|
+ <h3>[property:Boolean fog]</h3>
|
|
|
+ <div>Whether the material is affected by fog. Default is *false*.</div>
|
|
|
+
|
|
|
+ <h3>[property:Boolean isMeshDepthMaterial]</h3>
|
|
|
<div>
|
|
|
- morphTargets -- Define whether the material uses morphTargets. Default is false.<br/>
|
|
|
- wireframe -- Render geometry as wireframe. Default is false (i.e. render as smooth shaded).<br/>
|
|
|
- wireframeLinewidth -- Controls wireframe thickness. Default is 1.<br/>
|
|
|
+ Used to check whether this or derived classes are mesh depth materials. Default is *true*.<br /><br />
|
|
|
+
|
|
|
+ You should not change this, as it used internally for optimisation.
|
|
|
</div>
|
|
|
|
|
|
+ <h3>[property:Boolean lights]</h3>
|
|
|
+ <div>Whether the material is affected by lights. Default is *false*.</div>
|
|
|
|
|
|
- <h2>Properties</h2>
|
|
|
- <div>See the base [page:Material] class for common properties.</div>
|
|
|
+ <h3>[property:Texture map]</h3>
|
|
|
+ <div>The color map. Default is null.</div>
|
|
|
|
|
|
<h3>[property:boolean morphTargets]</h3>
|
|
|
<div>Define whether the material uses morphTargets. Default is false.</div>
|
|
|
|
|
|
+ <h3>[property:Boolean skinning]</h3>
|
|
|
+ <div>Define whether the material uses skinning. Default is false.</div>
|
|
|
+
|
|
|
<h3>[property:boolean wireframe]</h3>
|
|
|
<div>Render geometry as wireframe. Default is false (i.e. render as smooth shaded).</div>
|
|
|
|
|
|
- <h3>[property:number wireframeLinewidth]</h3>
|
|
|
- <div>
|
|
|
- Controls wireframe thickness. Default is 1.<br/><br/>
|
|
|
- Due to limitations in the ANGLE layer, on Windows platforms linewidth will always be 1 regardless of the set value.
|
|
|
+ <h3>[property:Float wireframeLinewidth]</h3>
|
|
|
+ <div>Controls wireframe thickness. Default is 1.<br /><br />
|
|
|
+
|
|
|
+ Due to limitations in the [link:https://code.google.com/p/angleproject ANGLE layer],
|
|
|
+ on Windows platforms linewidth will always be 1 regardless of the set value.
|
|
|
</div>
|
|
|
|
|
|
<h2>Methods</h2>
|
|
|
-
|
|
|
+ <div>See the base [page:Material] class for common methods.</div>
|
|
|
|
|
|
|
|
|
<h2>Source</h2>
|