Skip to content

Docs: Update logarithmicDepthBuffer with performance caveat #17412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 16, 2019
Merged

Docs: Update logarithmicDepthBuffer with performance caveat #17412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77d5647
Update WebGLRenderer.html
gkjohnson Sep 3, 2019
1bf0131
Update WebGLRenderer.html
gkjohnson Sep 3, 2019
1822ac6
Update logarithmic depth buffer docs to add link
gkjohnson Sep 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/api/en/renderers/WebGLRenderer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ <h3>[name]( [param:Object parameters] )</h3>
Default is *true*.<br />

[page:Boolean logarithmicDepthBuffer] - whether to use a logarithmic depth buffer. It may
be neccesary to use this if dealing with huge differences in scale in a single scene.
be neccesary to use this if dealing with huge differences in scale in a single scene. Note that this setting
uses gl_FragDepth if available which disables the [link:https://www.khronos.org/opengl/wiki/Early_Fragment_Test Early Fragment Test]
optimization and can cause a decrease in performance.
Default is *false*. See the [example:webgl_camera_logarithmicdepthbuffer camera / logarithmicdepthbuffer] example.
</p>

Expand Down
2 changes: 2 additions & 0 deletions docs/api/zh/renderers/WebGLRenderer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ <h3>[name]( [param:Object parameters] )</h3>
默认是*true*.<br />

[page:Boolean logarithmicDepthBuffer] - 是否使用对数深度缓存。如果要在单个场景中处理巨大的比例差异，就有必要使用。
Note that this setting uses gl_FragDepth if available which disables the [link:https://www.khronos.org/opengl/wiki/Early_Fragment_Test Early Fragment Test]
optimization and can cause a decrease in performance.
默认是*false*。 示例：[example:webgl_camera_logarithmicdepthbuffer camera / logarithmicdepthbuffer]
</p>

Expand Down