Skip to content

Commit

Permalink
Slightly improve CursorIcon doc. (bevyengine#10289)
Browse files Browse the repository at this point in the history
# Objective

- When finding the `CursorIcon` doc, it should be easier to find out
where to use it.
- When saying it is partially copied from the browser, be more clear
about the provenance and link to the spec document.

## Solution

- Link to the example code.
- Link to the CSS3 UI spec document.
  • Loading branch information
waywardmonkeys authored and ameknite committed Nov 6, 2023
1 parent 0370a09 commit 0c2e256
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion crates/bevy_window/src/cursor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ use bevy_reflect::{ReflectDeserialize, ReflectSerialize};
///
/// Examples of all of these cursors can be found [here](https://www.w3schools.com/cssref/playit.php?filename=playcss_cursor&preval=crosshair).
/// This `enum` is simply a copy of a similar `enum` found in [`winit`](https://docs.rs/winit/latest/winit/window/enum.CursorIcon.html).
/// `winit`, in turn, mostly copied cursor types available in the browser.
/// `winit`, in turn, is based upon the [CSS3 UI spec](https://www.w3.org/TR/css-ui-3/#cursor).
///
/// See the [`window_settings`] example for usage.
///
/// [`window_settings`]: https://github.com/bevyengine/bevy/blob/latest/examples/window/window_settings.rs
#[derive(Default, Debug, Hash, PartialEq, Eq, Clone, Copy, Reflect)]
#[cfg_attr(
feature = "serialize",
Expand Down

0 comments on commit 0c2e256

Please sign in to comment.