Просмотр исходного кода

Doc: Improve material displacementBias description (#30564)

Co-authored-by: Samuel Rigaud <srigaud@duodisplay.com>
Samuel Rigaud 10 месяцев назад
Родитель
Сommit
09e9894747

+ 3 - 2
docs/api/en/materials/MeshDepthMaterial.html

@@ -87,13 +87,14 @@
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			The offset of the displacement map's values on the mesh's vertices.
+			The bias is added to the scaled sample of the displacement map.
 			Without a displacement map set, this value is not applied. Default is `0`.
 		</p>
 
 		<h3>[property:Texture map]</h3>
 		<p>
 			The color map. May optionally include an alpha channel, typically combined
-			with [page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. 
+			with [page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest].
 			Default is null.
 		</p>
 
@@ -108,7 +109,7 @@
 			Controls wireframe thickness. Default is `1`.<br /><br />
 
 			Due to limitations of the
-			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile] 
+			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]
 			with the [page:WebGLRenderer WebGL] renderer on most platforms linewidth will always be `1` regardless of the set value.
 		</p>
 

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

@@ -88,13 +88,14 @@
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			The offset of the displacement map's values on the mesh's vertices.
+			The bias is added to the scaled sample of the displacement map.
 			Without a displacement map set, this value is not applied. Default is `0`.
 		</p>
 
 		<h3>[property:Texture map]</h3>
 		<p>
 			The color map. May optionally include an alpha channel, typically combined
-			with [page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. 
+			with [page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest].
 			Default is null.
 		</p>
 

+ 6 - 5
docs/api/en/materials/MeshLambertMaterial.html

@@ -141,6 +141,7 @@
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			The offset of the displacement map's values on the mesh's vertices.
+			The bias is added to the scaled sample of the displacement map.
 			Without a displacement map set, this value is not applied. Default is `0`.
 		</p>
 
@@ -192,7 +193,7 @@
 		<h3>[property:Texture map]</h3>
 		<p>
 			The color map. May optionally include an alpha channel, typically combined
-			with [page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. 
+			with [page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest].
 			Default is null.
 		</p>
 
@@ -230,7 +231,7 @@
 		<p>
 			The index of refraction (IOR) of air (approximately 1) divided by the
 			index of refraction of the material. It is used with environment mapping
-			modes [page:Textures THREE.CubeRefractionMapping] and [page:Textures THREE.EquirectangularRefractionMapping]. 
+			modes [page:Textures THREE.CubeRefractionMapping] and [page:Textures THREE.EquirectangularRefractionMapping].
 			The refraction ratio should not
 			exceed `1`. Default is `0.98`.
 		</p>
@@ -250,7 +251,7 @@
 			"square". Default is 'round'.<br /><br />
 
 			This corresponds to the
-			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap] 
+			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap]
 			property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
 		</p>
 
@@ -260,7 +261,7 @@
 			"miter". Default is 'round'.<br /><br />
 
 			This corresponds to the
-			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin] 
+			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin]
 			property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
 		</p>
 
@@ -269,7 +270,7 @@
 			Controls wireframe thickness. Default is `1`.<br /><br />
 
 			Due to limitations of the
-			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile] 
+			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]
 			with the [page:WebGLRenderer WebGL] renderer on most
 			platforms linewidth will always be `1` regardless of the set value.
 		</p>

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

@@ -109,6 +109,7 @@
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			The offset of the displacement map's values on the mesh's vertices.
+			The bias is added to the scaled sample of the displacement map.
 			Without a displacement map set, this value is not applied. Default is `0`.
 		</p>
 
@@ -124,7 +125,7 @@
 		<h3>[property:Texture map]</h3>
 		<p>
 			The color map. May optionally include an alpha channel, typically combined
-			with [page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. 
+			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>

+ 2 - 1
docs/api/en/materials/MeshNormalMaterial.html

@@ -81,6 +81,7 @@
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			The offset of the displacement map's values on the mesh's vertices.
+			The bias is added to the scaled sample of the displacement map.
 			Without a displacement map set, this value is not applied. Default is `0`.
 		</p>
 
@@ -125,7 +126,7 @@
 			Controls wireframe thickness. Default is `1`.<br /><br />
 
 			Due to limitations of the
-			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile] 
+			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]
 			with the [page:WebGLRenderer WebGL] renderer on most
 			platforms linewidth will always be `1` regardless of the set value.
 		</p>

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

@@ -139,6 +139,7 @@
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			The offset of the displacement map's values on the mesh's vertices.
+			The bias is added to the scaled sample of the displacement map.
 			Without a displacement map set, this value is not applied. Default is `0`.
 		</p>
 
@@ -190,7 +191,7 @@
 		<h3>[property:Texture map]</h3>
 		<p>
 			The color map. May optionally include an alpha channel, typically combined
-			with [page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. 
+			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>
@@ -230,7 +231,7 @@
 		<p>
 			The index of refraction (IOR) of air (approximately 1) divided by the
 			index of refraction of the material. It is used with environment mapping
-			modes [page:Textures THREE.CubeRefractionMapping] and [page:Textures THREE.EquirectangularRefractionMapping]. 
+			modes [page:Textures THREE.CubeRefractionMapping] and [page:Textures THREE.EquirectangularRefractionMapping].
 			The refraction ratio should not exceed `1`. Default is `0.98`.
 		</p>
 
@@ -267,7 +268,7 @@
 			"square". Default is 'round'.<br /><br />
 
 			This corresponds to the
-			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap] 
+			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap]
 			property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
 		</p>
 
@@ -277,7 +278,7 @@
 			"miter". Default is 'round'.<br /><br />
 
 			This corresponds to the
-			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin] 
+			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin]
 			property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
 		</p>
 
@@ -286,7 +287,7 @@
 			Controls wireframe thickness. Default is `1`.<br /><br />
 
 			Due to limitations of the
-			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile] 
+			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]
 			with the [page:WebGLRenderer WebGL] renderer on most
 			platforms linewidth will always be `1` regardless of the set value.
 		</p>

+ 7 - 7
docs/api/en/materials/MeshStandardMaterial.html

@@ -32,7 +32,7 @@
 			being somewhat more computationally expensive. [name] uses per-fragment
 			shading.<br /><br />
 
-			Note that for best results you should always specify an [page:.envMap environment map] 
+			Note that for best results you should always specify an [page:.envMap environment map]
 			when using this material.<br /><br />
 
 			For a non-technical introduction to the concept of PBR and how to set up a
@@ -50,7 +50,7 @@
 		<p>
 			Technical details of the approach used in three.js (and most other PBR
 			systems) can be found is this
-			[link:https://media.disneyanimation.com/uploads/production/publication_asset/48/asset/s2012_pbs_disney_brdf_notes_v3.pdf paper from Disney] 
+			[link:https://media.disneyanimation.com/uploads/production/publication_asset/48/asset/s2012_pbs_disney_brdf_notes_v3.pdf paper from Disney]
 			(pdf), by Brent Burley.
 		</p>
 
@@ -165,9 +165,9 @@
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			The offset of the displacement map's values on the mesh's vertices.
+			The bias is added to the scaled sample of the displacement map.
 			Without a displacement map set, this value is not applied. Default is `0`.
 		</p>
-
 		<h3>[property:Color emissive]</h3>
 		<p>
 			Emissive (light) color of the material, essentially a solid color
@@ -226,7 +226,7 @@
 		<h3>[property:Texture map]</h3>
 		<p>
 			The color map. May optionally include an alpha channel, typically combined
-			with [page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. 
+			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>
 
@@ -293,7 +293,7 @@
 			"square". Default is 'round'.<br /><br />
 
 			This corresponds to the
-			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap] 
+			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap]
 			property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
 		</p>
 
@@ -303,7 +303,7 @@
 			"miter". Default is 'round'.<br /><br />
 
 			This corresponds to the
-			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin] 
+			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin]
 			property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
 		</p>
 
@@ -312,7 +312,7 @@
 			Controls wireframe thickness. Default is `1`.<br /><br />
 
 			Due to limitations of the
-			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile] 
+			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]
 			with the [page:WebGLRenderer WebGL] renderer on most
 			platforms linewidth will always be `1` regardless of the set value.
 		</p>

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

@@ -121,6 +121,7 @@
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			The offset of the displacement map's values on the mesh's vertices.
+			The bias is added to the scaled sample of the displacement map.
 			Without a displacement map set, this value is not applied. Default is `0`.
 		</p>
 
@@ -150,7 +151,7 @@
 		<h3>[property:Texture gradientMap]</h3>
 		<p>
 			Gradient map for toon shading. It's required to set
-			[page:Texture.minFilter] and [page:Texture.magFilter] to [page:Textures THREE.NearestFilter] 
+			[page:Texture.minFilter] and [page:Texture.magFilter] to [page:Textures THREE.NearestFilter]
 			when using this type of texture. Default is `null`.
 		</p>
 
@@ -165,7 +166,7 @@
 		<h3>[property:Texture map]</h3>
 		<p>
 			The color map. May optionally include an alpha channel, typically combined
-			with [page:Material.transparent .transparent] or [page:Material.alphaTest .alphaTest]. 
+			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>
 
@@ -205,7 +206,7 @@
 			"square". Default is 'round'.<br /><br />
 
 			This corresponds to the
-			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap] 
+			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap]
 			property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
 		</p>
 
@@ -215,7 +216,7 @@
 			"miter". Default is 'round'.<br /><br />
 
 			This corresponds to the
-			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin] 
+			[link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin]
 			property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
 		</p>
 
@@ -224,7 +225,7 @@
 			Controls wireframe thickness. Default is `1`.<br /><br />
 
 			Due to limitations of the
-			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile] 
+			[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]
 			with the [page:WebGLRenderer WebGL] renderer on most
 			platforms linewidth will always be `1` regardless of the set value.
 		</p>

+ 5 - 3
docs/api/fr/materials/MeshDepthMaterial.html

@@ -68,14 +68,16 @@
 		<h3>[property:Float displacementScale]</h3>
 		<p>
 			Dans quelle mesure la carte de déplacement affecte le maillage (où le noir n'est pas un déplacement,
-			et le blanc est le déplacement maximal). Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée.
-			La valeur par défaut est 1.
+			et le blanc est le déplacement maximal). Sans carte de déplacement, cette valeur n'est pas appliquée.
+			La valeur par défaut est `1`.
 		</p>
 
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			Le décalage des valeurs de la carte de déplacement sur les sommets du maillage.
-			Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée. La valeur par défaut est 0.
+			Le décalage est ajouté après la mise à l'échelle de la carte de déplacement.
+			Sans carte de déplacement, cette valeur n'est pas appliquée. La valeur par défaut
+			est `0`.
 		</p>
 
 		<h3>[property:Texture map]</h3>

+ 5 - 3
docs/api/fr/materials/MeshDistanceMaterial.html

@@ -74,14 +74,16 @@
 		<h3>[property:Float displacementScale]</h3>
 		<p>
 			Dans quelle mesure la carte de déplacement affecte le maillage (où le noir n'est pas un déplacement,
-			et le blanc est le déplacement maximal). Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée.
-			La valeur par défaut est 1.
+			et le blanc est le déplacement maximal). Sans carte de déplacement, cette valeur n'est pas appliquée.
+			La valeur par défaut est `1`.
 		</p>
 
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			Le décalage des valeurs de la carte de déplacement sur les sommets du maillage.
-			Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée. La valeur par défaut est 0.
+			Le décalage est ajouté après la mise à l'échelle de la carte de déplacement.
+			Sans carte de déplacement, cette valeur n'est pas appliquée. La valeur par défaut
+			est `0`.
 		</p>
 
 		<h3>[property:Texture map]</h3>

+ 5 - 3
docs/api/fr/materials/MeshLambertMaterial.html

@@ -106,14 +106,16 @@
 		<h3>[property:Float displacementScale]</h3>
 		<p>
 			Dans quelle mesure la carte de déplacement affecte le maillage (où le noir n'est pas un déplacement,
-			et le blanc est le déplacement maximal). Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée.
-			La valeur par défaut est 1.
+			et le blanc est le déplacement maximal). Sans carte de déplacement, cette valeur n'est pas appliquée.
+			La valeur par défaut est `1`.
 		</p>
 
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			Le décalage des valeurs de la carte de déplacement sur les sommets du maillage.
-			Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée. La valeur par défaut est 0.
+			Le décalage est ajouté après la mise à l'échelle de la carte de déplacement.
+			Sans carte de déplacement, cette valeur n'est pas appliquée. La valeur par défaut
+			est `0`.
 		</p>
 
 		<h3>[property:Color emissive]</h3>

+ 5 - 3
docs/api/fr/materials/MeshMatcapMaterial.html

@@ -84,14 +84,16 @@
 		<h3>[property:Float displacementScale]</h3>
 		<p>
 			Dans quelle mesure la carte de déplacement affecte le maillage (où le noir n'est pas un déplacement,
-			et le blanc est le déplacement maximal). Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée.
-			La valeur par défaut est 1.
+			et le blanc est le déplacement maximal). Sans carte de déplacement, cette valeur n'est pas appliquée.
+			La valeur par défaut est `1`.
 		</p>
 
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			Le décalage des valeurs de la carte de déplacement sur les sommets du maillage.
-			Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée. La valeur par défaut est 0.
+			Le décalage est ajouté après la mise à l'échelle de la carte de déplacement.
+			Sans carte de déplacement, cette valeur n'est pas appliquée. La valeur par défaut
+			est `0`.
 		</p>
 
 		<h3>[property:Boolean flatShading]</h3>

+ 5 - 3
docs/api/fr/materials/MeshNormalMaterial.html

@@ -64,14 +64,16 @@
 		<h3>[property:Float displacementScale]</h3>
 		<p>
 			Dans quelle mesure la carte de déplacement affecte le maillage (où le noir n'est pas un déplacement,
-			et le blanc est le déplacement maximal). Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée.
-			La valeur par défaut est 1.
+			et le blanc est le déplacement maximal). Sans carte de déplacement, cette valeur n'est pas appliquée.
+			La valeur par défaut est `1`.
 		</p>
 
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			Le décalage des valeurs de la carte de déplacement sur les sommets du maillage.
-			Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée. La valeur par défaut est 0.
+			Le décalage est ajouté après la mise à l'échelle de la carte de déplacement.
+			Sans carte de déplacement, cette valeur n'est pas appliquée. La valeur par défaut
+			est `0`.
 		</p>
 
 		<h3>[property:Boolean flatShading]</h3>

+ 5 - 3
docs/api/fr/materials/MeshPhongMaterial.html

@@ -106,14 +106,16 @@
 		<h3>[property:Float displacementScale]</h3>
 		<p>
 			Dans quelle mesure la carte de déplacement affecte le maillage (où le noir n'est pas un déplacement,
-			et le blanc est le déplacement maximal). Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée.
-			La valeur par défaut est 1.
+			et le blanc est le déplacement maximal). Sans carte de déplacement, cette valeur n'est pas appliquée.
+			La valeur par défaut est `1`.
 		</p>
 
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			Le décalage des valeurs de la carte de déplacement sur les sommets du maillage.
-			Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée. La valeur par défaut est 0.
+			Le décalage est ajouté après la mise à l'échelle de la carte de déplacement.
+			Sans carte de déplacement, cette valeur n'est pas appliquée. La valeur par défaut
+			est `0`.
 		</p>
 
 		<h3>[property:Color emissive]</h3>

+ 5 - 3
docs/api/fr/materials/MeshStandardMaterial.html

@@ -131,14 +131,16 @@
 		<h3>[property:Float displacementScale]</h3>
 		<p>
 			Dans quelle mesure la carte de déplacement affecte le maillage (où le noir n'est pas un déplacement,
-			et le blanc est le déplacement maximal). Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée.
-			La valeur par défaut est 1.
+			et le blanc est le déplacement maximal). Sans carte de déplacement, cette valeur n'est pas appliquée.
+			La valeur par défaut est `1`.
 		</p>
 
 		<h3>[property:Float displacementBias]</h3>
 		<p>
 			Le décalage des valeurs de la carte de déplacement sur les sommets du maillage.
-			Sans ensemble de cartes de déplacement, cette valeur n'est pas appliquée. La valeur par défaut est 0.
+			Le décalage est ajouté après la mise à l'échelle de la carte de déplacement.
+			Sans carte de déplacement, cette valeur n'est pas appliquée. La valeur par défaut
+			est `0`.
 		</p>
 
 		<h3>[property:Color emissive]</h3>

粤ICP备19079148号