Document low performance when using `SurfaceTool.append_from()` in thread

(cherry picked from commit f39375d315)
This commit is contained in:
Hugo Locurcio 2021-11-14 22:46:42 +01:00 committed by Rémi Verschelde
parent 7de023e192
commit a49e3bb449
No known key found for this signature in database
GPG Key ID: C3336907360768E1
1 changed files with 1 additions and 0 deletions

View File

@ -113,6 +113,7 @@
<argument index="2" name="transform" type="Transform" /> <argument index="2" name="transform" type="Transform" />
<description> <description>
Append vertices from a given [Mesh] surface onto the current vertex array with specified [Transform]. Append vertices from a given [Mesh] surface onto the current vertex array with specified [Transform].
[b]Note:[/b] Using [method append_from] on a [Thread] is much slower as the GPU must communicate data back to the CPU, while also causing the main thread to stall (as OpenGL is not thread-safe). Consider requesting a copy of the mesh, converting it to an [ArrayMesh] and adding vertices manually instead.
</description> </description>
</method> </method>
<method name="begin"> <method name="begin">