Skip to content

Commit 0d8d37b

Browse files
Mugen87donmccurdy
authored andcommitted
Docs: Clean up. (mrdoob#23553)
1 parent f6a1e9f commit 0d8d37b

File tree

10 files changed

+73
-3
lines changed

10 files changed

+73
-3
lines changed

docs/api/en/materials/ShadowMaterial.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ <h3>[name]( [param:Object parameters] )</h3>
4848
<h2>Properties</h2>
4949
<p>See the base [page:Material] classes for common properties.</p>
5050

51+
<h3>[property:Color color]</h3>
52+
<p>[page:Color] of the material, by default set to black (0x000000).</p>
53+
5154
<h3>[property:Boolean transparent]</h3>
5255
<p>Defines whether this material is transparent. Default is *true*.</p>
5356

docs/api/en/materials/SpriteMaterial.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ <h3>[property:Radians rotation]</h3>
7171
<h3>[property:Boolean sizeAttenuation]</h3>
7272
<p>Whether the size of the sprite is attenuated by the camera depth. (Perspective camera only.) Default is *true*.</p>
7373

74+
<h3>[property:Boolean transparent]</h3>
75+
<p>Defines whether this material is transparent. Default is *true*.</p>
76+
7477
<h2>Methods</h2>
7578
<p>See the base [page:Material] class for common methods.</p>
7679

docs/api/en/textures/CubeTexture.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,11 @@ <h2>Properties</h2>
4646
See the base [page:Texture Texture] class for common properties.
4747
</p>
4848

49+
<h3>[property:Boolean flipY]</h3>
50+
<p>
51+
If set to *true*, the texture is flipped along the vertical axis when uploaded to the GPU. Default is *false*.
52+
</p>
53+
4954
<h2>Methods</h2>
5055

5156
<p>

docs/api/en/textures/DataTexture.html

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ <h2>Constructor</h2>
1919
<h3>[name]( data, width, height, format, type, mapping, wrapS, wrapT, magFilter, minFilter, anisotropy, encoding )</h3>
2020
<p>
2121
The data argument must be an [link:https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView ArrayBufferView].
22-
Further parameters correspond to the properties inherited from [page:Texture], where both magFilter and minFilter default to THREE.NearestFilter. The properties flipY and generateMipmaps are initially set to false.
22+
Further parameters correspond to the properties inherited from [page:Texture], where both magFilter and minFilter default to THREE.NearestFilter.
2323
</p>
2424
<p>
2525
The interpretation of the data depends on type and format:
@@ -70,11 +70,30 @@ <h2>Properties</h2>
7070
See the base [page:Texture Texture] class for common properties.
7171
</p>
7272

73+
<h3>[property:Boolean flipY]</h3>
74+
<p>
75+
If set to *true*, the texture is flipped along the vertical axis when uploaded to the GPU. Default is *false*.
76+
</p>
77+
78+
<h3>[property:Boolean generateMipmaps]</h3>
79+
<p>
80+
Whether to generate mipmaps (if possible) for a texture. False by default.
81+
</p>
82+
7383
<h3>[property:Image image]</h3>
7484
<p>
7585
Overridden with a record type holding data, width and height.
7686
</p>
7787

88+
<h3>[property:number unpackAlignment]</h3>
89+
<p>
90+
1 by default. Specifies the alignment requirements for the start of each pixel row in memory.
91+
The allowable values are 1 (byte-alignment), 2 (rows aligned to even-numbered bytes),
92+
4 (word-alignment), and 8 (rows start on double-word boundaries).
93+
See [link:http://www.khronos.org/opengles/sdk/docs/man/xhtml/glPixelStorei.xml glPixelStorei]
94+
for more information.
95+
</p>
96+
7897
<h2>Methods</h2>
7998

8099
<p>

docs/api/en/textures/VideoTexture.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ <h3>[name]( [param:Video video], [param:Constant mapping], [param:Constant wrapS
5151

5252
[page:Constant format] -- The default is [page:Textures THREE.RGBAFormat].
5353
See [page:Textures format constants] for other choices.<br />
54-
54+
5555
[page:Constant type] -- Default is [page:Textures THREE.UnsignedByteType].
5656
See [page:Textures type constants] for other choices.<br />
5757

@@ -67,6 +67,11 @@ <h2>Properties</h2>
6767
See the base [page:Texture Texture] class for common properties.
6868
</p>
6969

70+
<h3>[property:Boolean generateMipmaps]</h3>
71+
<p>
72+
Whether to generate mipmaps. False by default.
73+
</p>
74+
7075
<h3>[property:Boolean needsUpdate]</h3>
7176
<p>
7277
You will not need to set this manually here as it is handled by the [page:VideoTexture.update update] method.

docs/api/zh/materials/ShadowMaterial.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ <h3>[name]( [param:Object parameters] )</h3>
4747
<h2>属性(Properties)</h2>
4848
<p>共有属性请参见其基类[page:Material]。</p>
4949

50+
<h3>[property:Color color]</h3>
51+
<p>[page:Color] of the material, by default set to black (0x000000).</p>
52+
5053
<h3>[property:Boolean transparent]</h3>
5154
<p>定义此材质是否透明。默认值为 *true*。</p>
5255

docs/api/zh/materials/SpriteMaterial.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ <h3>[property:Radians rotation]</h3>
6969
<h3>[property:Boolean sizeAttenuation]</h3>
7070
<p> 精灵的大小是否会被相机深度衰减。(仅限透视摄像头。)默认为*true*。</p>
7171

72+
<h3>[property:Boolean transparent]</h3>
73+
<p>定义此材质是否透明。默认值为 *true*。</p>
74+
7275
<h2>方法(Methods)</h2>
7376
<p>共有方法请参见其基类[page:Material]。</p>
7477

docs/api/zh/textures/CubeTexture.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ <h2>属性</h2>
4545
See the base [page:Texture Texture] class for common properties.
4646
</p>
4747

48+
<h3>[property:Boolean flipY]</h3>
49+
<p>
50+
If set to *true*, the texture is flipped along the vertical axis when uploaded to the GPU. Default is *false*.
51+
</p>
52+
4853
<h2>方法</h2>
4954

5055
<p>

docs/api/zh/textures/DataTexture.html

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ <h2>构造函数</h2>
1919
<h3>[name]( data, width, height, format, type, mapping, wrapS, wrapT, magFilter, minFilter, anisotropy )</h3>
2020
<p>
2121
data 参数必须是一个 [link:https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView ArrayBufferView] 。
22-
其他参数对应于继承自 [page:Texture] 的属性,其中 magFilter 与 minFilter 默认为 THREE.NearestFilter。属性 flipY 和 generateMipmaps 初始设为 false。
22+
其他参数对应于继承自 [page:Texture] 的属性,其中 magFilter 与 minFilter 默认为 THREE.NearestFilter。
2323
</p>
2424
<p>
2525
数据的解释取决于type与format:
@@ -70,11 +70,30 @@ <h2>属性</h2>
7070
See the base [page:Texture Texture] class for common properties.
7171
</p>
7272

73+
<h3>[property:Boolean flipY]</h3>
74+
<p>
75+
If set to *true*, the texture is flipped along the vertical axis when uploaded to the GPU. Default is *false*.
76+
</p>
77+
78+
<h3>[property:Boolean generateMipmaps]</h3>
79+
<p>
80+
Whether to generate mipmaps (if possible) for a texture. False by default.
81+
</p>
82+
7383
<h3>[property:Image image]</h3>
7484
<p>
7585
Overridden with a record type holding data, width and height.
7686
</p>
7787

88+
<h3>[property:number unpackAlignment]</h3>
89+
<p>
90+
1 by default. Specifies the alignment requirements for the start of each pixel row in memory.
91+
The allowable values are 1 (byte-alignment), 2 (rows aligned to even-numbered bytes),
92+
4 (word-alignment), and 8 (rows start on double-word boundaries).
93+
See [link:http://www.khronos.org/opengles/sdk/docs/man/xhtml/glPixelStorei.xml glPixelStorei]
94+
for more information.
95+
</p>
96+
7897
<h2>方法</h2>
7998

8099
<p>

docs/api/zh/textures/VideoTexture.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,11 @@ <h2>属性</h2>
6767
共有属性请参见其基类[page:Texture Texture]。
6868
</p>
6969

70+
<h3>[property:Boolean generateMipmaps]</h3>
71+
<p>
72+
Whether to generate mipmaps. False by default.
73+
</p>
74+
7075
<h3>[property:Boolean needsUpdate]</h3>
7176
<p>
7277
在这里,你不必手动设置这个值,因为它是由[page:VideoTexture.update update]方法来进行控制的。

0 commit comments

Comments
 (0)