diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2023-03-26 19:42:00 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2023-06-14 08:37:04 +0200 |
| commit | 061397835d4636ae74496738e9c94cc7e2bc233a (patch) | |
| tree | bd84c7a640b02ea076ec8b1e5a4384a40d31df0e /doc | |
| parent | 49243a9a9816b334002f7d73d9e940d00b49158d (diff) | |
| download | redot-engine-061397835d4636ae74496738e9c94cc7e2bc233a.tar.gz | |
Document known bugs with the Multi-Threaded thread model project setting
- Add a warning on project startup when using the Multi-Threaded option.
- Improve command line validation for the `--render-thread` CLI argument.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index ffb61ab20d..57387aa65a 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -2226,7 +2226,8 @@ [b]Note:[/b] Depth prepass is only supported when using the Forward+ or Compatibility rendering method. When using the Mobile rendering method, there is no depth prepass performed. </member> <member name="rendering/driver/threads/thread_model" type="int" setter="" getter="" default="1"> - Thread model for rendering. Rendering on a thread can vastly improve performance, but synchronizing to the main thread can cause a bit more jitter. + The thread model to use for rendering. Rendering on a thread may improve performance, but synchronizing to the main thread can cause a bit more jitter. + [b]Note:[/b] The [b]Multi-Threaded[/b] option is experimental, and has several known bugs which can lead to crashing, especially when using particles or resizing the window. Not recommended for use in production at this stage. </member> <member name="rendering/environment/defaults/default_clear_color" type="Color" setter="" getter="" default="Color(0.3, 0.3, 0.3, 1)"> Default background clear color. Overridable per [Viewport] using its [Environment]. See [member Environment.background_mode] and [member Environment.background_color] in particular. To change this default color programmatically, use [method RenderingServer.set_default_clear_color]. |