浏览代码

Docs: Add note regarding .map alpha channel transparency (#24134)

* Add note regarding .map alpha channel transparency

* update documentation with suggestions

* zh docs: replace phrase
Peter Ferenczy 3 年之前
父节点
当前提交
1387439dfd

+ 4 - 1
docs/api/en/materials/MeshBasicMaterial.html

@@ -93,7 +93,10 @@
 		<p>Intensity of the baked light. Default is 1.</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>The color map. Default is null.</p>
+		<p>
+			The color map. May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. Default is null.
+		</p>
 
 		<h3>[property:Float reflectivity]</h3>
 		<p>

+ 4 - 1
docs/api/en/materials/MeshDepthMaterial.html

@@ -82,7 +82,10 @@
 		<p>Whether the material is affected by fog. Default is `false`.</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>The color map. Default is null.</p>
+		<p>
+			The color map. May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. Default is null.
+		</p>
 
 		<h3>[property:Boolean wireframe]</h3>
 		<p>Render geometry as wireframe. Default is false (i.e. render as smooth shaded).</p>

+ 4 - 1
docs/api/en/materials/MeshDistanceMaterial.html

@@ -93,7 +93,10 @@
 		<p>Whether the material is affected by fog. Default is `false`.</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>The color map. Default is null.</p>
+		<p>
+			The color map. May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. Default is null.
+		</p>
 
 		<h3>[property:Float nearDistance]</h3>
 		<p>

+ 4 - 1
docs/api/en/materials/MeshLambertMaterial.html

@@ -120,7 +120,10 @@
 		<p>Intensity of the baked light. Default is 1.</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>The color map. Default is null.</p>
+		<p>
+			The color map. May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. Default is null.
+		</p>
 
 		<h3>[property:Float reflectivity]</h3>
 		<p>How much the environment map affects the surface; also see [page:.combine].</p>

+ 5 - 1
docs/api/en/materials/MeshMatcapMaterial.html

@@ -104,7 +104,11 @@
 		<p>Whether the material is affected by fog. Default is `true`.</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>The color map. Default is null. The texture map color is modulated by the diffuse [page:.color].</p>
+		<p>
+			The color map. May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. Default is null.
+			The texture map color is modulated by the diffuse [page:.color].
+		</p>
 
 		<h3>[property:Texture matcap]</h3>
 		<p>The matcap map. Default is null.</p>

+ 5 - 1
docs/api/en/materials/MeshPhongMaterial.html

@@ -157,7 +157,11 @@
 		<p>Intensity of the baked light. Default is 1.</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>The color map. Default is null. The texture map color is modulated by the diffuse [page:.color].</p>
+		<p>
+			The color map. May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. Default is null.
+			The texture map color is modulated by the diffuse [page:.color].
+		</p>
 
 		<h3>[property:Texture normalMap]</h3>
 		<p>

+ 5 - 1
docs/api/en/materials/MeshStandardMaterial.html

@@ -192,7 +192,11 @@
 		<p>Intensity of the baked light. Default is 1.</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>The color map. Default is null. The texture map color is modulated by the diffuse [page:.color].</p>
+		<p>
+			The color map. May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. Default is null.
+			The texture map color is modulated by the diffuse [page:.color].
+		</p>
 
 		<h3>[property:Float metalness]</h3>
 		<p>

+ 5 - 1
docs/api/en/materials/MeshToonMaterial.html

@@ -134,7 +134,11 @@
 		<p>Intensity of the baked light. Default is 1.</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>The color map. Default is null. The texture map color is modulated by the diffuse [page:.color].</p>
+		<p>
+			The color map. May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. Default is null.
+			The texture map color is modulated by the diffuse [page:.color].
+		</p>
 
 		<h3>[property:Texture normalMap]</h3>
 		<p>

+ 5 - 1
docs/api/en/materials/PointsMaterial.html

@@ -85,7 +85,11 @@
 		<p>Whether the material is affected by fog. Default is `true`.</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>Sets the color of the points using data from a [page:Texture].</p>
+		<p>
+			Sets the color of the points using data from a [page:Texture].
+			May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest].
+		</p>
 
 		<h3>[property:Number size]</h3>
 		<p>Defines the size of the points in pixels. Default is 1.0.<br/>

+ 4 - 1
docs/api/en/materials/SpriteMaterial.html

@@ -71,7 +71,10 @@
 		</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>The texture map. Default is null.</p>
+		<p>
+			The color map. May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. Default is null.
+		</p>
 
 		<h3>[property:Radians rotation]</h3>
 		<p>The rotation of the sprite in radians. Default is 0.</p>

+ 4 - 1
docs/api/zh/materials/MeshBasicMaterial.html

@@ -83,7 +83,10 @@
 		<p>烘焙光的强度。默认值为1。</p>
 
 		<h3>[property:Texture map]</h3>
-		<p> 颜色贴图。默认为null。</p>
+		<p>
+			颜色贴图。可以选择包括一个alpha通道,通常与[page:Material.transparent .transparent]
+			或[page:Material.alphaTest .alphaTest]。默认为null。
+		</p>
 
 		<h3>[property:Float reflectivity]</h3>
 		<p> 环境贴图对表面的影响程度; 见[page:.combine]。默认值为1,有效范围介于0(无反射)和1(完全反射)之间。

+ 4 - 1
docs/api/zh/materials/MeshDepthMaterial.html

@@ -68,7 +68,10 @@
 		</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>颜色贴图。默认为null。</p>
+		<p>
+			颜色贴图。可以选择包括一个alpha通道,通常与[page:Material.transparent .transparent]
+			或[page:Material.alphaTest .alphaTest]。默认为null。
+		</p>
 
 		<h3>[property:Boolean wireframe]</h3>
 		<p> 将几何体渲染为线框。默认值为*false*(即渲染为平滑着色)。</p>

+ 4 - 1
docs/api/zh/materials/MeshDistanceMaterial.html

@@ -79,7 +79,10 @@
 		</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>颜色贴图。默认为null。</p>
+		<p>
+			颜色贴图。可以选择包括一个alpha通道,通常与[page:Material.transparent .transparent]
+			或[page:Material.alphaTest .alphaTest]。默认为null。
+		</p>
 
 		<h3>[property:Float nearDistance]</h3>
 		<p>

+ 4 - 1
docs/api/zh/materials/MeshLambertMaterial.html

@@ -102,7 +102,10 @@
 		<p>烘焙光的强度。默认值为1。</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>颜色贴图。默认为null。</p>
+		<p>
+			颜色贴图。可以选择包括一个alpha通道,通常与[page:Material.transparent .transparent]
+			或[page:Material.alphaTest .alphaTest]。默认为null。
+		</p>
 
 		<h3>[property:Float reflectivity]</h3>
 		<p> 环境贴图对表面的影响程度; 见[page:.combine]。默认值为1,有效范围介于0(无反射)和1(完全反射)之间。</p>

+ 5 - 1
docs/api/zh/materials/MeshMatcapMaterial.html

@@ -88,7 +88,11 @@
 		<p>材质是否受雾影响。默认为*true*。</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>颜色贴图。默认为null。纹理贴图颜色由漫反射颜色[page:.color]调节。</p>
+		<p>
+			颜色贴图。可以选择包括一个alpha通道,通常与[page:Material.transparent .transparent]
+			或[page:Material.alphaTest .alphaTest]。默认为null。
+			纹理贴图颜色由漫反射颜色[page:.color]调节。
+		</p>
 
 		<h3>[property:Texture matcap]</h3>
 		<p>matcap贴图,默认为null。</p>

+ 5 - 1
docs/api/zh/materials/MeshPhongMaterial.html

@@ -126,7 +126,11 @@
 		<p>烘焙光的强度。默认值为1。</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>颜色贴图。默认为null。纹理贴图颜色由漫反射颜色[page:.color]调节。</p>
+		<p>
+			颜色贴图。可以选择包括一个alpha通道,通常与[page:Material.transparent .transparent]
+			或[page:Material.alphaTest .alphaTest]。默认为null。
+			纹理贴图颜色由漫反射颜色[page:.color]调节。
+		</p>
 
 		<h3>[property:Texture normalMap]</h3>
 		<p> 用于创建法线贴图的纹理。RGB值会影响每个像素片段的曲面法线,并更改颜色照亮的方式。法线贴图不会改变曲面的实际形状,只会改变光照。

+ 5 - 1
docs/api/zh/materials/MeshStandardMaterial.html

@@ -159,7 +159,11 @@
 		<p>烘焙光的强度。默认值为1。</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>颜色贴图。默认为null。纹理贴图颜色由漫反射颜色[page:.color]调节。</p>
+		<p>
+			颜色贴图。可以选择包括一个alpha通道,通常与[page:Material.transparent .transparent]
+			或[page:Material.alphaTest .alphaTest]。默认为null。
+			纹理贴图颜色由漫反射颜色[page:.color]调节。
+		</p>
 
 		<h3>[property:Float metalness]</h3>
 		<p> 材质与金属的相似度。非金属材质,如木材或石材,使用0.0,金属使用1.0,通常没有中间值。

+ 5 - 1
docs/api/zh/materials/MeshToonMaterial.html

@@ -134,7 +134,11 @@
 		<p>Intensity of the baked light. Default is 1.</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>The color map. Default is null. The texture map color is modulated by the diffuse [page:.color].</p>
+		<p>
+			The color map. May optionally include an alpha channel, typically combined with
+			[page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. Default is null.
+			The texture map color is modulated by the diffuse [page:.color].
+		</p>
 
 		<h3>[property:Texture normalMap]</h3>
 		<p>

+ 4 - 1
docs/api/zh/materials/PointsMaterial.html

@@ -82,7 +82,10 @@
 		<p>材质是否受雾影响。默认为*true*。</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>使用[page:Texture]中的数据设置点的颜色。</p>
+		<p>
+			使用来自[page:Texture]的数据设置点的颜色。可以选择包括一个alpha通道,通常与
+			[page:Material.transparent .transparent]或[page:Material.alphaTest .alphaTest]。
+		</p>
 
 		<h3>[property:Number size]</h3>
 		<p>设置点的大小。默认值为1.0。<br/>

+ 4 - 1
docs/api/zh/materials/SpriteMaterial.html

@@ -69,7 +69,10 @@
 		</p>
 
 		<h3>[property:Texture map]</h3>
-		<p>颜色贴图。默认为null。</p>
+		<p>
+			颜色贴图。可以选择包括一个alpha通道,通常与[page:Material.transparent .transparent]
+			或[page:Material.alphaTest .alphaTest]。默认为null。
+		</p>
 
 		<h3>[property:Radians rotation]</h3>
 		<p> sprite的转动,以弧度为单位。默认值为0。</p>