godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #82376 from MewPurPur/add-missing-docs

Browse Source 
Document worker thread pool project settings and `TreeItem.uncollapse_tree()`
This commit is contained in:
Rémi Verschelde 2024-02-08 13:45:50 +01:00
commit fd6f6a05bf
No known key found for this signature in database
GPG Key ID: C3336907360768E1
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/ProjectSettings.xml
View File

@ -2792,6 +2792,7 @@
[/codeblock] [/codeblock]
</member> </member>
<member name="threading/worker_pool/low_priority_thread_ratio" type="float" setter="" getter="" default="0.3"> <member name="threading/worker_pool/low_priority_thread_ratio" type="float" setter="" getter="" default="0.3">
The ratio of [WorkerThreadPool]'s threads that will be reserved for low-priority tasks. For example, if 10 threads are available and this value is set to [code]0.3[/code], 3 of the worker threads will be reserved for low-priority tasks. The actual value won't exceed the number of CPU cores minus one, and if possible, at least one worker thread will be dedicated to low-priority tasks.
</member> </member>
<member name="threading/worker_pool/max_threads" type="int" setter="" getter="" default="-1"> <member name="threading/worker_pool/max_threads" type="int" setter="" getter="" default="-1">
Maximum number of threads to be used by [WorkerThreadPool]. Value of [code]-1[/code] means no limit. Maximum number of threads to be used by [WorkerThreadPool]. Value of [code]-1[/code] means no limit.
@ -2800,7 +2801,7 @@
Action map configuration to load by default. Action map configuration to load by default.
</member> </member>
<member name="xr/openxr/enabled" type="bool" setter="" getter="" default="false"> <member name="xr/openxr/enabled" type="bool" setter="" getter="" default="false">
If [code]true[/code] Godot will setup and initialize OpenXR on startup. If [code]true[/code], Godot will setup and initialize OpenXR on startup.
</member> </member>
<member name="xr/openxr/environment_blend_mode" type="int" setter="" getter="" default="&quot;0&quot;"> <member name="xr/openxr/environment_blend_mode" type="int" setter="" getter="" default="&quot;0&quot;">
Specify how OpenXR should blend in the environment. This is specific to certain AR and passthrough devices where camera images are blended in by the XR compositor. Specify how OpenXR should blend in the environment. This is specific to certain AR and passthrough devices where camera images are blended in by the XR compositor.

1
doc/classes/TreeItem.xml
View File

@ -779,6 +779,7 @@
<method name="uncollapse_tree"> <method name="uncollapse_tree">
<return type="void" /> <return type="void" />
<description> <description>
Uncollapses all [TreeItem]s necessary to reveal this [TreeItem], i.e. all ancestor [TreeItem]s.
</description> </description>
</method> </method>
</methods> </methods>