diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-09-19 20:13:31 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-09-19 20:13:31 +0200 |
| commit | a385c8506c8f407bd8f2bbc0928cb0d77f8131af (patch) | |
| tree | aa037f3e3b379e49104a7827275ac07be6f43c2e | |
| parent | 291f408fcf53976606382f9e7db55e672fd82a6c (diff) | |
| parent | 40dd544994a938d37a5ae3d0e96ed4f176c0f19a (diff) | |
Merge pull request #32151 from Calinou/improve-custom-cursor-documentation
Mention more caveats for custom mouse cursors in the documentation
| -rw-r--r-- | doc/classes/Input.xml | 2 |
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"> |