summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2019-09-15 20:54:05 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2019-09-15 21:14:40 +0200
commit40dd544994a938d37a5ae3d0e96ed4f176c0f19a (patch)
treea215088f7a9ab35b5e9eaf76f363437f70f2caf8 /doc
parent24e1039eb6fe32115e8d1a62a84965e9be19a2ed (diff)
Mention more caveats for custom mouse cursors in the documentation
See #32147 and #32148.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Input.xml2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml
index 5fd5e8c3c0..7642c87636 100644
--- a/doc/classes/Input.xml
+++ b/doc/classes/Input.xml
@@ -316,6 +316,8 @@
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 [code]CURSOR_*[/code] for the list of shapes.
[code]image[/code]'s size must be lower than 256×256.
[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.
</description>
</method>
<method name="set_default_cursor_shape">