浏览代码

Document `Image.generate_mipmaps()` always running on the main thread

(cherry picked from commit 30a88f464ba6e0dc08b7cc84029df0e50e1a75b6)
Hugo Locurcio 4 年之前
父节点
当前提交
9aee1a3992
共有 1 个文件被更改,包括 1 次插入0 次删除
  1. 1 0
      doc/classes/Image.xml

+ 1 - 0
doc/classes/Image.xml

@@ -163,6 +163,7 @@
 			<argument index="0" name="renormalize" type="bool" default="false" />
 			<description>
 				Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is [code]0[/code].
+				[b]Note:[/b] Mipmap generation is done on the CPU, is single-threaded and is [i]always[/i] done on the main thread. This means generating mipmaps will result in noticeable stuttering during gameplay, even if [method generate_mipmaps] is called from a [Thread].
 			</description>
 		</method>
 		<method name="get_data" qualifiers="const">