Skip to content

Commit d0c0d25

Browse files
mrdoobmrdoob
committed
Docs: Fixed vertexColors description. Fixes mrdoob#4265.
1 parent c8eedca commit d0c0d25

5 files changed

Lines changed: 11 additions & 13 deletions

File tree

‎docs/api/materials/LineBasicMaterial.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ <h3>[name]( [page:Object parameters] )</h3>
2525
linewidth — Line thickness. Default is 1.<br />
2626
linecap — Define appearance of line ends. Default is 'round'.<br />
2727
linejoin — Define appearance of line joints. Default is 'round'.<br />
28-
vertexColors — Define whether the material uses vertex colors, or not. Default is false.<br />
28+
vertexColors — Define how the vertices gets colored. Default is THREE.NoColors.<br />
2929
fog — Define whether the material color is affected by global fog settings. Default is false.
3030
</div>
3131

@@ -46,9 +46,9 @@ <h3>.[page:String linejoin]</h3>
4646
<div>Define appearance of line joints. Possible values are "round", "bevel" and "miter". Default is 'round'.</div>
4747
<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:WebGLRenderer WebGL] renderer, but does work with the [page:CanvasRenderer Canvas] renderer.</div>
4848

49-
<h3>.[page:Boolean vertexColors]</h3>
50-
<div>Define whether the material uses vertex colors, or not. Default is false.</div>
51-
<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:CanvasRenderer Canvas] renderer, but does work with the [page:WebGLRenderer WebGL] renderer.</div>
49+
<h3>.[page:Integer vertexColors]</h3>
50+
<div>Define how the vertices gets colored. Possible values are THREE.NoColors, THREE.FaceColors and THREE.VertexColors. Default is THREE.NoColors.</div>
51+
<div>This setting might not have any effect when used with certain renderers.</div>
5252

5353
<h3>.[page:Boolean fog]</h3>
5454
<div>Define whether the material color is affected by global fog settings.</div>

‎docs/api/materials/MeshBasicMaterial.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h3>[name]( [page:Object parameters] )</h3>
2828
wireframeLinecap — Define appearance of line ends. Default is 'round'.<br />
2929
wireframeLinejoin — Define appearance of line joints. Default is 'round'.<br />
3030
shading — Define shading type. Default is THREE.SmoothShading.<br />
31-
vertexColors — Define whether the material uses vertex colors, or not. Default is false.<br />
31+
vertexColors — Define how the vertices gets colored. Default is THREE.NoColors.<br />
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 />
@@ -60,8 +60,8 @@ <h3>.[page:String wireframeLinejoin]</h3>
6060
<h3>.[page:String shading]</h3>
6161
<div>Define shading type. Default is THREE.SmoothShading.</div>
6262

63-
<h3>.[page:Boolean vertexColors]</h3>
64-
<div>Define whether the material uses vertex colors, or not. Default is false.</div>
63+
<h3>.[page:Integer vertexColors]</h3>
64+
<div>Define how the vertices gets colored. Possible values are THREE.NoColors, THREE.FaceColors and THREE.VertexColors. Default is THREE.NoColors.</div>
6565
<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:CanvasRenderer Canvas] renderer, but does work with the [page:WebGLRenderer WebGL] renderer.</div>
6666

6767
<h3>.[page:Boolean fog]</h3>

‎docs/api/materials/MeshLambertMaterial.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ <h3>.[page:String wireframeLinejoin]</h3>
6464
<div>Define appearance of line joints. Possible values are "round", "bevel" and "miter". Default is 'round'.</div>
6565
<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:WebGLRenderer WebGL] renderer, but does work with the [page:CanvasRenderer Canvas] renderer.</div>
6666

67-
<h3>.[page:Boolean vertexColors]</h3>
68-
<div>Define whether the material uses vertex colors, or not. Default is *false*.</div>
67+
<h3>.[page:Integer vertexColors]</h3>
68+
<div>Define how the vertices gets colored. Possible values are THREE.NoColors, THREE.FaceColors and THREE.VertexColors. Default is THREE.NoColors.</div>
6969
<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:CanvasRenderer Canvas] renderer, but does work with the [page:WebGLRenderer WebGL] renderer.</div>
7070

7171
<h3>.[page:Boolean fog]</h3>

‎docs/api/materials/MeshPhongMaterial.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ <h3>.[page:String wireframeLinejoin]</h3>
7474
<div>Define appearance of line joints. Possible values are "round", "bevel" and "miter". Default is 'round'.</div>
7575
<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:WebGLRenderer WebGL] renderer, but does work with the [page:CanvasRenderer Canvas] renderer.</div>
7676

77-
<h3>.[page:Boolean vertexColors]</h3>
78-
<div>Define whether the material uses vertex colors, or not. Default is *false*.</div>
77+
<h3>.[page:Integer vertexColors]</h3>
78+
<div>Define how the vertices gets colored. Possible values are THREE.NoColors, THREE.FaceColors and THREE.VertexColors. Default is THREE.NoColors.</div>
7979
<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:CanvasRenderer Canvas] renderer, but does work with the [page:WebGLRenderer WebGL] renderer.</div>
8080

8181
<h3>.[page:Boolean fog]</h3>

‎docs/api/materials/ParticleSystemMaterial.html‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,6 @@ <h3>.[page:Boolean sizeAttenuation]</h3>
4848
<div>Specify whether particles' size will get smaller with the distance. Default is true.</div>
4949

5050
<h3>.[page:Boolean vertexColors]</h3>
51-
<div>Define whether the material uses vertex colors, or not. Default is false.</div>
52-
<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:CanvasRenderer Canvas] renderer, but does work with the [page:WebGLRenderer WebGL] renderer.</div>
5351

5452
<h3>.[page:Boolean fog]</h3>
5553
<div>Define whether the material color is affected by global fog settings.</div>

0 commit comments

Comments
 (0)