Add custom cursors #14284
Add custom cursors #14284
Conversation
BD103
added
C-Feature
|
Would it be more clear to have |
alice-i-cecile
added
S-Waiting-on-Author
There was a problem hiding this comment.
I really want this feature, and I'm excited to see that there's a path forward.
That said, I really dislike the custom image buffer :( That's really unpleasant to use, and hard to maintain. Can you say more about the circular dependency? What exactly is going on here: can we refactor things to get a nice API?
We also can't use |
|
Here is a graph of bevy workspace dependencies if someone wants to think about it. It doesn't show Basically it would be best if both |
|
Is moving |
|
I'd really prefer not to move that into For reference, the same problem is encountered with #1031: we really want to feed normal image data (loaded via the asset system) back into windowing. |
alice-i-cecile
added
A-Cross-Cutting
|
Having |
|
Great. Can you link to the Android stuff? We should pull this out into its own issue; I think this is a pretty reasonable plan of attack. |
|
bevy/crates/bevy_asset/src/io/android.rs Line 20 in e512cb6 On android, we get the asset path from winit. It should be possible to just reverse the dependency and smuggle the paths with resources or call functions the other way. (Or I guess its a whole asset manager, so might be more difficult) |
eero-lehtinen
force-pushed
the
custom-cursors
branch
2 times, most recently
from
46da546 to
cbafc20
Compare
alice-i-cecile
added
X-Contentious
tychedelia
added
S-Ready-For-Final-Review
The window_settings example is modified to include an image cursor. |
Ah great :) I just saw the system cursors and missed the custom. Perfect! |
alice-i-cecile
added
the
M-Needs-Release-Note
Co-authored-by: Jan Hohenheim <[email protected]>
|
For folks looking in the future, #14351 talks about the web of dependencies and why this implementation was chosen. |
# Objective - CI broke after #14284 because of the `cursor_options` rename ## Solution - Update the broken patch ## Testing - Patch tested with `git apply`.
alice-i-cecile
added
the
A-UI
|
Thank you to everyone involved with the authoring or reviewing of this PR! This work is relatively important and needs release notes! Head over to bevyengine/bevy-website#1670 if you'd like to help out. |
# Objective - Bevy 0.15 added support for custom cursor images in #14284. - However, to do animated cursors using the initial support shipped in 0.15 means you'd have to animate the `Handle<Image>`: You can't use a `TextureAtlas` like you can with sprites and UI images. - For my use case, my cursors are spritesheets. To animate them, I'd have to break them down into multiple `Image` assets, but that seems less than ideal. ## Solution - Allow users to specify a `TextureAtlas` field when creating a custom cursor image. - To create parity with Bevy's `TextureAtlas` support on `Sprite`s and `ImageNode`s, this also allows users to specify `rect`, `flip_x` and `flip_y`. In fact, for my own use case, I need to `flip_y`. ## Testing - I added unit tests for `calculate_effective_rect` and `extract_and_transform_rgba_pixels`. - I added a brand new example for custom cursor images. It has controls to toggle fields on and off. I opted to add a new example because the existing cursor example (`window_settings`) would be far too messy for showcasing these custom cursor features (I did start down that path but decided to stop and make a brand new example). - The new example uses a [Kenny cursor icon] sprite sheet. I included the licence even though it's not required (and it's CC0). - I decided to make the example just loop through all cursor icons for its animation even though it's not a _realistic_ in-game animation sequence. - I ran the PNG through https://tinypng.com. Looks like it's about 35KB. - I'm open to adjusting the example spritesheet if required, but if it's fine as is, great. [Kenny cursor icon]: https://kenney-assets.itch.io/crosshair-pack --- ## Showcase https://github.com/user-attachments/assets/8f6be8d7-d1d4-42f9-b769-ef8532367749 ## Migration Guide The `CustomCursor::Image` enum variant has some new fields. Update your code to set them. Before: ```rust CustomCursor::Image { handle: asset_server.load("branding/icon.png"), hotspot: (128, 128), } ``` After: ```rust CustomCursor::Image { handle: asset_server.load("branding/icon.png"), texture_atlas: None, flip_x: false, flip_y: false, rect: None, hotspot: (128, 128), } ``` ## References - Feature request [originally raised in Discord]. [originally raised in Discord]: https://discord.com/channels/691052431525675048/692572690833473578/1319836362219847681
# Objective - Bevy 0.15 added support for custom cursor images in bevyengine#14284. - However, to do animated cursors using the initial support shipped in 0.15 means you'd have to animate the `Handle<Image>`: You can't use a `TextureAtlas` like you can with sprites and UI images. - For my use case, my cursors are spritesheets. To animate them, I'd have to break them down into multiple `Image` assets, but that seems less than ideal. ## Solution - Allow users to specify a `TextureAtlas` field when creating a custom cursor image. - To create parity with Bevy's `TextureAtlas` support on `Sprite`s and `ImageNode`s, this also allows users to specify `rect`, `flip_x` and `flip_y`. In fact, for my own use case, I need to `flip_y`. ## Testing - I added unit tests for `calculate_effective_rect` and `extract_and_transform_rgba_pixels`. - I added a brand new example for custom cursor images. It has controls to toggle fields on and off. I opted to add a new example because the existing cursor example (`window_settings`) would be far too messy for showcasing these custom cursor features (I did start down that path but decided to stop and make a brand new example). - The new example uses a [Kenny cursor icon] sprite sheet. I included the licence even though it's not required (and it's CC0). - I decided to make the example just loop through all cursor icons for its animation even though it's not a _realistic_ in-game animation sequence. - I ran the PNG through https://tinypng.com. Looks like it's about 35KB. - I'm open to adjusting the example spritesheet if required, but if it's fine as is, great. [Kenny cursor icon]: https://kenney-assets.itch.io/crosshair-pack --- ## Showcase https://github.com/user-attachments/assets/8f6be8d7-d1d4-42f9-b769-ef8532367749 ## Migration Guide The `CustomCursor::Image` enum variant has some new fields. Update your code to set them. Before: ```rust CustomCursor::Image { handle: asset_server.load("branding/icon.png"), hotspot: (128, 128), } ``` After: ```rust CustomCursor::Image { handle: asset_server.load("branding/icon.png"), texture_atlas: None, flip_x: false, flip_y: false, rect: None, hotspot: (128, 128), } ``` ## References - Feature request [originally raised in Discord]. [originally raised in Discord]: https://discord.com/channels/691052431525675048/692572690833473578/1319836362219847681
Objective
Solution
Handle<Image>directly. I would need to importbevy_assetsand that causes a circular dependency. Alternatively we could use winit'sCustomCursorsmart 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.Update:
Handle<Image>, reads rgba data inbevy_renderand uses resources to send the data tobevy_winit, where the final cursors are created.Testing
Migration Guide
CursorIconis no longer a field inWindow, 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.Cursoris renamed toCursorOptionsandcursorfield ofWindowis renamed tocursor_optionsCursorIconis renamed toSystemCursorIcon