summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2022-11-20 11:44:10 +0100
committerRémi Verschelde <rverschelde@gmail.com>2022-11-20 11:44:10 +0100
commit4a52fb828fd9569f1dd9a5dff625e8703219ffa9 (patch)
treecf1c70811666c7c490cb582f4f351fd89cc69edd /doc/classes
parentd5d83eefd30b42fa5e2ace98bf3990aba575b2ac (diff)
parent9ce9c959abb993b1c4edf242ff56ed5f568db791 (diff)
Merge pull request #68884 from dzil123/create_local_rendering_device_null_check_docs
RenderingServer::create_local_rendering_device - Add null check and update docs
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/RenderingServer.xml4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml
index 13e5470a56..2ffa4dc50b 100644
--- a/doc/classes/RenderingServer.xml
+++ b/doc/classes/RenderingServer.xml
@@ -838,6 +838,8 @@
<method name="create_local_rendering_device" qualifiers="const">
<return type="RenderingDevice" />
<description>
+ Creates a RenderingDevice that can be used to do draw and compute operations on a separate thread. Cannot draw to the screen nor share data with the global RenderingDevice.
+ [b]Note:[/b] When using the OpenGL backend or when running in headless mode, this function always returns [code]null[/code].
</description>
</method>
<method name="decal_create">
@@ -1273,6 +1275,8 @@
<method name="get_rendering_device" qualifiers="const">
<return type="RenderingDevice" />
<description>
+ Returns the global RenderingDevice.
+ [b]Note:[/b] When using the OpenGL backend or when running in headless mode, this function always returns [code]null[/code].
</description>
</method>
<method name="get_rendering_info">