Browse Source

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

Hugo Locurcio 3 years ago
parent
commit
f39375d315
1 changed files with 1 additions and 0 deletions
  1. 1 0
      doc/classes/SurfaceTool.xml

+ 1 - 0
doc/classes/SurfaceTool.xml

@@ -113,6 +113,7 @@
 			<argument index="2" name="transform" type="Transform" />
 			<description>
 				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>
 		</method>
 		<method name="begin">