Skip to content

Commit 59de3c0

Browse files
ycwycw
authored
grp prop items (#23532)
1 parent 97557b6 commit 59de3c0

File tree

5 files changed

+74
-97
lines changed

5 files changed

+74
-97
lines changed

‎docs/api/en/core/InterleavedBuffer.html‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,9 @@ <h3>[property:Integer count]</h3>
4545

4646
<h3>[property:Object updateRange]</h3>
4747
<p>
48-
Object containing offset and count.
49-
</p>
50-
51-
<h3>[property:Number updateRange.offset]</h3>
52-
<p>
53-
Default is *0*.
54-
</p>
55-
56-
<h3>[property:Number updateRange.count]</h3>
57-
<p>
58-
Default is *-1*.
48+
Object containing offset and count.<br />
49+
- [page:Number offset]: Default is *0*.<br />
50+
- [page:Number count]: Default is *-1*.<br />
5951
</p>
6052

6153
<h3>[property:String uuid]</h3>

‎docs/api/en/renderers/WebGLRenderer.html‎

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,10 @@ <h3>[property:Boolean autoClearStencil]</h3>
9696
Default is *true*.
9797
</p>
9898

99-
<h3>[property:Boolean debug.checkShaderErrors]</h3>
99+
<h3>[property:Object debug]</h3>
100100
<p>
101-
If [page:.checkShaderErrors checkShaderErrors] is true, defines whether material shader programs are checked
101+
- [page:Boolean checkShaderErrors]:
102+
If it is true, defines whether material shader programs are checked
102103
for errors during compilation and linkage process. It may be useful to disable this check in production for performance gain.
103104
It is strongly recommended to keep these checks enabled during development.
104105
If the shader does not compile and link - it will not work and associated material will not render.
@@ -154,8 +155,17 @@ <h3>[property:DOMElement domElement]</h3>
154155

155156
<h3>[property:Object extensions]</h3>
156157
<p>
157-
A wrapper for the [page:WebGLRenderer.extensions.get .extensions.get] method, used to check whether
158-
various WebGL extensions are supported.
158+
- [page:Object get]( [param:String extensionName] ):
159+
Used to check whether various extensions are supported and returns an object with details of the extension if available.
160+
This method can check for the following extensions:<br />
161+
162+
<ul>
163+
<li>*WEBGL_depth_texture*</li>
164+
<li>*EXT_texture_filter_anisotropic*</li>
165+
<li>*WEBGL_compressed_texture_s3tc*</li>
166+
<li>*WEBGL_compressed_texture_pvrtc*</li>
167+
<li>*WEBGL_compressed_texture_etc1*</li>
168+
</ul>
159169
</p>
160170

161171
<h3>[property:number outputEncoding]</h3>
@@ -218,24 +228,27 @@ <h3>[property:WebGLRenderLists renderLists]</h3>
218228

219229
<h3>[property:WebGLShadowMap shadowMap]</h3>
220230
<p>
221-
This contains the reference to the shadow map, if used.
231+
This contains the reference to the shadow map, if used.<br />
232+
- [page:Boolean enabled]:
233+
If set, use shadow maps in the scene. Default is *false*.<br />
234+
- [page:Boolean autoUpdate]:
235+
Enables automatic updates to the shadows in the scene. Default is *true*.<br />
236+
If you do not require dynamic lighting / shadows, you may set this to *false* when the renderer is instantiated.<br />
237+
- [page:Boolean needsUpdate]:
238+
When set to *true*, shadow maps in the scene will be updated in the next *render* call. Default is *false*.<br />
239+
If you have disabled automatic updates to shadow maps (*shadowMap.autoUpdate = false*), you will need to set this to *true* and then make a render call to update the shadows in your scene.<br />
240+
- [page:Integer type]:
241+
Defines shadow map type (unfiltered, percentage close filtering, percentage close filtering with bilinear filtering in shader).
242+
Options are:
243+
<ul>
244+
<li>THREE.BasicShadowMap</li>
245+
<li>THREE.PCFShadowMap (default)</li>
246+
<li>THREE.PCFSoftShadowMap</li>
247+
<li>THREE.VSMShadowMap</li>
248+
</ul>
249+
See [page:Renderer Renderer constants] for details.<br />
222250
</p>
223251

224-
<h3>[property:Boolean shadowMap.enabled]</h3>
225-
<p>If set, use shadow maps in the scene. Default is *false*.</p>
226-
227-
<h3>[property:Boolean shadowMap.autoUpdate]</h3>
228-
<p>Enables automatic updates to the shadows in the scene. Default is *true*.</p>
229-
<p>If you do not require dynamic lighting / shadows, you may set this to *false* when the renderer is instantiated.</p>
230-
231-
<h3>[property:Boolean shadowMap.needsUpdate]</h3>
232-
<p>When set to *true*, shadow maps in the scene will be updated in the next *render* call. Default is *false*. </p>
233-
<p>If you have disabled automatic updates to shadow maps (*shadowMap.autoUpdate = false*), you will need to set this to *true* and then make a render call to update the shadows in your scene.</p>
234-
235-
<h3>[property:Integer shadowMap.type]</h3>
236-
<p>Defines shadow map type (unfiltered, percentage close filtering, percentage close filtering with bilinear filtering in shader)</p>
237-
<p>Options are THREE.BasicShadowMap, THREE.PCFShadowMap (default), THREE.PCFSoftShadowMap and THREE.VSMShadowMap. See [page:Renderer Renderer constants] for details.</p>
238-
239252
<h3>[property:Boolean sortObjects]</h3>
240253
<p>
241254
Defines whether the renderer should sort objects. Default is *true*.<br /><br />
@@ -299,18 +312,6 @@ <h3>[method:undefined copyTextureToTexture3D]( [param:Box3 sourceBox], [param:Ve
299312
<h3>[method:undefined dispose]( )</h3>
300313
<p>Dispose of the current rendering context.</p>
301314

302-
<h3>[method:Object extensions.get]( [param:String extensionName] )</h3>
303-
<p>
304-
Used to check whether various extensions are supported and returns an object with details of the extension if available.
305-
This method can check for the following extensions:<br /><br />
306-
307-
- *WEBGL_depth_texture*<br />
308-
- *EXT_texture_filter_anisotropic*<br />
309-
- *WEBGL_compressed_texture_s3tc*<br />
310-
- *WEBGL_compressed_texture_pvrtc*<br />
311-
- *WEBGL_compressed_texture_etc1*
312-
</p>
313-
314315
<h3>[method:undefined forceContextLoss]()</h3>
315316
<p>
316317
Simulate loss of the WebGL context. This requires support for the

‎docs/api/ko/core/InterleavedBuffer.html‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,9 @@ <h3>[property:Integer count]</h3>
4545

4646
<h3>[property:Object updateRange]</h3>
4747
<p>
48-
오프셋과 카운트를 가지고 있는 객체입니다.
49-
</p>
50-
51-
<h3>[property:Number updateRange.offset]</h3>
52-
<p>
53-
기본값은 *0* 입니다.
54-
</p>
55-
56-
<h3>[property:Number updateRange.count]</h3>
57-
<p>
58-
기본값은 *-1* 입니다.
48+
오프셋과 카운트를 가지고 있는 객체입니다.<br />
49+
- [page:Number offset]: 기본값은 *0* 입니다.<br />
50+
- [page:Number count]: 기본값은 *-1* 입니다. <br />
5951
</p>
6052

6153
<h3>[property:String uuid]</h3>

‎docs/api/zh/core/InterleavedBuffer.html‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,9 @@ <h3>[property:Integer count]</h3>
4545

4646
<h3>[property:Object updateRange]</h3>
4747
<p>
48-
对象存储着需要更新的数据的偏移量和数量。
49-
</p>
50-
51-
<h3>[property:Number updateRange.offset]</h3>
52-
<p>
53-
默认值为 *0*。
54-
</p>
55-
56-
<h3>[property:Number updateRange.count]</h3>
57-
<p>
58-
默认值为 *-1*。
48+
对象存储着需要更新的数据的偏移量和数量。<br />
49+
- [page:Number offset]: 默认值为 *0*。<br />
50+
- [page:Number count]: 默认值为 *-1*。<br />
5951
</p>
6052

6153
<h3>[property:String uuid]</h3>

‎docs/api/zh/renderers/WebGLRenderer.html‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,10 @@ <h3>[property:Boolean autoClearStencil]</h3>
8282
默认是*true*
8383
</p>
8484

85-
<h3>[property:Boolean debug.checkShaderErrors]</h3>
85+
<h3>[property:Object debug]</h3>
8686
<p>
87-
如果[page:.checkShaderErrors checkShaderErrors]为true，定义是否检查材质着色器程序
87+
- [page:Boolean checkShaderErrors]:
88+
如果为true，定义是否检查材质着色器程序
8889
编译和链接过程中的错误。 禁用此检查生产以获得性能增益可能很有用。
8990
强烈建议在开发期间保持启用这些检查。
9091
如果着色器没有编译和链接 - 它将无法工作，并且相关材料将不会呈现。
@@ -132,7 +133,17 @@ <h3>[property:DOMElement domElement]</h3>
132133

133134
<h3>[property:Object extensions]</h3>
134135
<p>
135-
[page:WebGLRenderer.extensions.get .extensions.get]方法的包装, 用于检查是否支持各种WebGL扩展
136+
- [page:Object get]( [param:String extensionName] ):
137+
用于检查是否支持各种扩展，并返回一个对象，其中包含扩展的详细信息。
138+
该方法检查以下扩展：<br />
139+
140+
<ul>
141+
<li>*WEBGL_depth_texture*</li>
142+
<li>*EXT_texture_filter_anisotropic*</li>
143+
<li>*WEBGL_compressed_texture_s3tc*</li>
144+
<li>*WEBGL_compressed_texture_pvrtc*</li>
145+
<li>*WEBGL_compressed_texture_etc1*</li>
146+
</ul>
136147
</p>
137148

138149
<h3>[property:number outputEncoding]</h3>
@@ -194,23 +205,24 @@ <h3>[property:WebGLRenderLists renderLists]</h3>
194205

195206
<h3>[property:WebGLShadowMap shadowMap]</h3>
196207
<p>
197-
如果使用，它包含阴影贴图的引用。
198-
</p>
199-
200-
<h3>[property:Boolean shadowMap.enabled]</h3>
201-
<p>如果设置开启，允许在场景中使用阴影贴图。默认是 *false*。</p>
202-
203-
<h3>[property:Boolean shadowMap.autoUpdate]</h3>
204-
<p>启用场景中的阴影自动更新。默认是*true*</p>
205-
<p>如果不需要动态光照/阴影, 则可以在实例化渲染器时将之设为false</p>
206-
207-
<h3>[property:Boolean shadowMap.needsUpdate]</h3>
208-
<p>当被设为*true*, 场景中的阴影贴图会在下次*render*调用时刷新。默认是*false* </p>
209-
<p>如果你已经禁用了阴影贴图的自动更新(*shadowMap.autoUpdate = false*), 那么想要在下一次渲染时更新阴影的话就需要将此值设为*true*</p>
210-
211-
<h3>[property:Integer shadowMap.type]</h3>
212-
<p>定义阴影贴图类型 (未过滤, 关闭部分过滤, 关闭部分双线性过滤)</p>
213-
<p>可选值有THREE.BasicShadowMap, THREE.PCFShadowMap (默认), THREE.PCFSoftShadowMap 和 THREE.VSMShadowMap。详见[page:Renderer Renderer constants]</p>
208+
如果使用，它包含阴影贴图的引用。<br />
209+
- [page:Boolean enabled]:
210+
如果设置开启，允许在场景中使用阴影贴图。默认是 *false*。<br />
211+
- [page:Boolean autoUpdate]:
212+
启用场景中的阴影自动更新。默认是*true*<br />
213+
如果不需要动态光照/阴影, 则可以在实例化渲染器时将之设为false<br />
214+
- [page:Boolean needsUpdate]:
215+
当被设为*true*, 场景中的阴影贴图会在下次*render*调用时刷新。默认是*false* <br />
216+
如果你已经禁用了阴影贴图的自动更新(*shadowMap.autoUpdate = false*), 那么想要在下一次渲染时更新阴影的话就需要将此值设为*true*<br />
217+
- [page:Integer type]:
218+
定义阴影贴图类型 (未过滤, 关闭部分过滤, 关闭部分双线性过滤), 可选值有:
219+
<ul>
220+
<li>THREE.BasicShadowMap</li>
221+
<li>THREE.PCFShadowMap (默认)</li>
222+
<li>THREE.PCFSoftShadowMap</li>
223+
<li>THREE.VSMShadowMap</li>
224+
</ul>
225+
详见[page:Renderer Renderer constants]<br />
214226

215227
<h3>[property:Boolean sortObjects]</h3>
216228
<p>
@@ -269,18 +281,6 @@ <h3>[method:undefined copyTextureToTexture]( [param:Vector2 position], [param:Te
269281
<h3>[method:undefined dispose]( )</h3>
270282
<p>处理当前的渲染环境</p>
271283

272-
<h3>[method:Object extensions.get]( [param:String extensionName] )</h3>
273-
<p>
274-
用于检查是否支持各种扩展，并返回一个对象，其中包含扩展的详细信息。
275-
该方法检查以下扩展：<br /><br />
276-
277-
- *WEBGL_depth_texture*<br />
278-
- *EXT_texture_filter_anisotropic*<br />
279-
- *WEBGL_compressed_texture_s3tc*<br />
280-
- *WEBGL_compressed_texture_pvrtc*<br />
281-
- *WEBGL_compressed_texture_etc1*
282-
</p>
283-
284284
<h3>[method:undefined forceContextLoss]()</h3>
285285
<p>
286286
模拟WebGL环境的丢失。需要支持

0 commit comments

Comments
 (0)