bevy/crates/bevy_winit/src
Eero Lehtinen 47c4e3084a
Add custom cursors (#14284)
# Objective

- Add custom images as cursors
- Fixes #9557 

## Solution

- Change cursor type to accommodate both native and image cursors
- I don't really like this solution because I couldn't use
`Handle<Image>` directly. I would need to import `bevy_assets` and that
causes a circular dependency. Alternatively we could use winit's
`CustomCursor` smart pointers, but that seems hard because the event
loop is needed to create those and is not easily accessable for users.
So now I need to copy around rgba buffers which is sad.
- I use a cache because especially on the web creating cursor images is
really slow
- Sorry to #14196 for yoinking, I just wanted to make a quick solution
for myself and thought that I should probably share it too.

Update:
- Now uses `Handle<Image>`, reads rgba data in `bevy_render` and uses
resources to send the data to `bevy_winit`, where the final cursors are
created.

## Testing

- Added example which works fine at least on Linux Wayland (winit side
has been tested with all platforms).
- I haven't tested if the url cursor works.

## Migration Guide

- `CursorIcon` is no longer a field in `Window`, but a separate
component can be inserted to a window entity. It has been changed to an
enum that can hold custom images in addition to system icons.
- `Cursor` is renamed to `CursorOptions` and `cursor` field of `Window`
is renamed to `cursor_options`
- `CursorIcon` is renamed to `SystemCursorIcon`

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Jan Hohenheim <jan@hohenheim.ch>
2024-08-12 15:49:03 +00:00
..
accessibility.rs Fix intra-doc links and make CI test them (#14076) 2024-07-11 13:08:31 +00:00
converters.rs Add custom cursors (#14284) 2024-08-12 15:49:03 +00:00
lib.rs Add custom cursors (#14284) 2024-08-12 15:49:03 +00:00
state.rs Add custom cursors (#14284) 2024-08-12 15:49:03 +00:00
system.rs Add custom cursors (#14284) 2024-08-12 15:49:03 +00:00
winit_config.rs Fix intra-doc links and make CI test them (#14076) 2024-07-11 13:08:31 +00:00
winit_event.rs flush key_input cache when Bevy loses focus (Adopted) (#13678) 2024-06-05 02:06:47 +00:00
winit_monitors.rs Expose winit's MonitorHandle (#13669) 2024-08-06 10:54:37 +00:00
winit_windows.rs Add custom cursors (#14284) 2024-08-12 15:49:03 +00:00