diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2023-04-21 02:04:58 +0200 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-04-26 14:29:27 +0200 |
| commit | f5721ca61ac0134907bf3dc20dc672f19a04b5a7 (patch) | |
| tree | 80bc90d7f9257cfdb4f3d67e3e40e11797c515fb | |
| parent | c4655010d0a907c7357a0c60519c8345639255b1 (diff) | |
Document custom mouse cursors larger than 128×128 potentially having issues
(cherry picked from commit 92730fb07dbeb7e3640d0bed60c9b9033bc30577)
| -rw-r--r-- | doc/classes/Input.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 70e629974d..ab9ed47b85 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -300,7 +300,7 @@ <param 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. - [param image]'s size must be lower than 256×256. + [param image]'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. [param hotspot] must be within [param image]'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. |