Skip to content
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

Jump to bottom

feat: deprecate disable render #772

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: deprecate disable render #772

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5ed57c4
feat: add deprecation warnings to disableRender
alvarosabu Jul 12, 2024
98884bf
docs: updated docs with deprecation
alvarosabu Jul 12, 2024
4fa8066
chore(playground): remove unusued method
alvarosabu Jul 12, 2024
9c00c9f
chore: fix lint
alvarosabu Jul 12, 2024
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
Prev Previous commit
Next Next commit
docs: updated docs with deprecation
  • Loading branch information
@alvarosabu
alvarosabu committed Jul 12, 2024
commit 98884bf8a82cf895f7dd3cce027762daffad28f9
2 changes: 1 addition & 1 deletion docs/api/tres-canvas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ renderer.shadowMap.type = PCFSoftShadowMap
| **context** | This can be used to attach the renderer to an existing [RenderingContext](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext) | |
| **depth** | Whether the drawing buffer has a [depth buffer](https://en.wikipedia.org/wiki/Z-buffering) of at least 16 bits. | `true` |
| **renderMode** | Render mode, can be `always`, `on-demand` or `manual`. See [Performance](../advanced/performance) | `always` |
| **disableRender** | Disable render on requestAnimationFrame, useful for PostProcessing | `false` |
| **~~disableRender~~** | **⚠️ Deprecated**: since version 4.2. Use [`take-over render` approach](https://docs.tresjs.org/api/composables.html#take-over-the-render-loop) instead. | `false` |
| **failIfMajorPerformanceCaveat** | Whether the renderer creation will fail upon low performance is detected. See [WebGL spec](https://registry.khronos.org/webgl/specs/latest/1.0/#5.2) for details. | `false` |
| **logarithmicDepthBuffer** | Whether to use a logarithmic depth buffer. It may be necessary 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 [Early Fragment Test](https://www.khronos.org/opengl/wiki/Early_Fragment_Test) optimization and can cause a decrease in performance. | `false` |
| **outputColorSpace** | Defines the output encoding | `LinearEncoding` |
Expand Down
Loading