瀏覽代碼

Document custom mouse cursors larger than 128×128 potentially having issues

(cherry picked from commit 92730fb07dbeb7e3640d0bed60c9b9033bc30577)
Hugo Locurcio 2 年之前
父節點
當前提交
ff8c53d9eb
共有 1 個文件被更改,包括 1 次插入1 次删除
  1. 1 1
      doc/classes/Input.xml

+ 1 - 1
doc/classes/Input.xml

@@ -318,7 +318,7 @@
 			<argument index="2" name="hotspot" type="Vector2" default="Vector2( 0, 0 )" />
 			<description>
 				Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See [enum CursorShape] for the list of shapes.
-				[code]image[/code]'s size must be lower than 256×256.
+				[code]image[/code]'s size must be lower than or equal to 256×256. To avoid rendering issues, sizes lower than or equal to 128×128 are recommended.
 				[code]hotspot[/code] must be within [code]image[/code]'s size.
 				[b]Note:[/b] [AnimatedTexture]s aren't supported as custom mouse cursors. If using an [AnimatedTexture], only the first frame will be displayed.
 				[b]Note:[/b] Only images imported with the [b]Lossless[/b], [b]Lossy[/b] or [b]Uncompressed[/b] compression modes are supported. The [b]Video RAM[/b] compression mode can't be used for custom cursors.