asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

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

Browse source 
(cherry picked from commit 92730fb07d)
This commit is contained in:
Hugo Locurcio 2023-04-21 02:04:58 +02:00 committed by Rémi Verschelde
parent 0426e2b407
commit 42a51390a4
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/Input.xml
View file

@ -320,7 +320,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.