Wayland Cursor custom image doesn't update when using Image instead of Texture2D

[wakeofluna]

Tested versions

• v4.4.beta.gentoo [4ce466d]

System information

Linux Gentoo using Wayland

Issue description

When using the Wayland DisplayServer you can only update the custom mouse cursor once if you are using Image instead of Texture2D resources and the images have the same hotspot.

The function Input.set_custom_mouse_cursor claims that it is okay to use either an Image or a Texture2D as a custom cursor image. The caching code in DisplayServerWayland::cursor_set_custom_image checks for cursor reuse using "get_rid()" on the provided resource. Since an Image does not have a RID, any image will always enter the branch // We have a cached cursor. Nice..

Bug is visible since #96647 was fixed, although the underlying bug was already older than that.

Workarounds

• Use Texture2D instead of image resources - may cause undesired overhead to convert back to image
• Reset the cursor in between - may cause cursor flickering
• Move the hotspot locations to force a cache miss - unwanted extra work to make images suitable with different hotspots

Steps to reproduce

• Force editor and game to use the Wayland display server
• Make sure the referenced img1 and img2 are imported as Image and not as Texture.

Input.set_custom_mouse_cursor(img1, Input.CURSOR_ARROW)
# Correctly shows img1 as the cursor
Input.set_custom_mouse_cursor(img2, Input.CURSOR_ARROW)
# Still shows img1 as the cursor

Minimal reproduction project (MRP)

wayland-cursor-reproducer.zip

[Riteo]

Hi, thank you for you report and for the thorough analysis!

Since an Image does not have a RID

Shoot, I really had no idea. You just saved me from a lot of debugging :D

You see, this Image thing is actually relatively new. For a long time the custom cursor method only supported Texture2D but then #88970 allowed images and this quirk slipped right through.

I'll fix this ASAP!

[Riteo]

PR #101987 is up! Could you please test it and confirm me that it fixes the issue?

[wakeofluna]

@Riteo Thank you for your swift response! Can confirm, while testing with build v4.4.beta.custom_build [c808756] from your PR that it solves my problem in both the reproducer and in my main project. I can now switch mouse cursors to my hearts content without converting them to texture2d first.