Skip to content

Commit 682d645

Browse files
okreadyokready
committed
Updated documentation for MeshBasicMaterial, MeshLambertMaterial, and MeshPhongMaterial to include information about the alphaMap property.
1 parent 5d7807d commit 682d645

3 files changed

Lines changed: 13 additions & 0 deletions

File tree

‎docs/api/materials/MeshBasicMaterial.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ <h3>[name]( [page:Object parameters] )</h3>
3232
fog — Define whether the material color is affected by global fog settings. Default is true.<br />
3333
lightMap — Set light map. Default is null.<br />
3434
specularMap — Set specular map. Default is null.<br />
35+
alphaMap — Set alpha map. Default is null.<br />
3536
envMap — Set env map. Default is null.<br />
3637
skinning — Define whether the material uses skinning. Default is false.<br />
3738
morphTargets — Define whether the material uses morphTargets. Default is false.
@@ -74,6 +75,10 @@ <h3>.[page:Texture lightMap]</h3>
7475
<h3>.[page:Texture specularMap]</h3>
7576
<div>Set specular map. Default is null.</div>
7677

78+
<h3>.[page:Texture alphaMap]</h3>
79+
<div>The alpha map is a grayscale texture that controls the opacity across the surface (black: fully transparent; white: fully opaque). Default is null.</div>
80+
<div>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>
81+
7782
<h3>.[page:TextureCube envMap]</h3>
7883
<div>Set env map. Default is null.</div>
7984

‎docs/api/materials/MeshLambertMaterial.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ <h3>.[page:Texture lightMap]</h3>
8181
<h3>.[page:Texture specularMap]</h3>
8282
<div>Since this material does not have a specular component, the specular value affects only how much of the environment map affects the surface. Default is null.</div>
8383

84+
<h3>.[page:Texture alphaMap]</h3>
85+
<div>The alpha map is a grayscale texture that controls the opacity across the surface (black: fully transparent; white: fully opaque). Default is null.</div>
86+
<div>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>
87+
8488
<h3>.[page:TextureCube envMap]</h3>
8589
<div>Set env map. Default is null.</div>
8690

‎docs/api/materials/MeshPhongMaterial.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,10 @@ <h3>.[page:Texture lightMap]</h3>
9191
<h3>.[page:Texture specularMap]</h3>
9292
<div>The specular map value affects both how much the specular surface highlight contributes and how much of the environment map affects the surface. Default is null.</div>
9393

94+
<h3>.[page:Texture alphaMap]</h3>
95+
<div>The alpha map is a grayscale texture that controls the opacity across the surface (black: fully transparent; white: fully opaque). Default is null.</div>
96+
<div>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>
97+
9498
<h3>.[page:TextureCube envMap]</h3>
9599
<div>Set env map. Default is null.</div>
96100

0 commit comments

Comments
 (0)