Skip to content

Commit

Permalink
tweak docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mgi388 committed Jan 26, 2025
1 parent 4a4f5ad commit b317a72
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions crates/bevy_winit/src/custom_cursor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,13 @@ pub struct CustomCursorImage {
pub texture_atlas: Option<TextureAtlas>,
/// Whether the image should be flipped along its x-axis.
///
/// If true, the cursor's hotspot will be automatically flipped along with
/// the image. You don't need to adjust the `hotspot` field to account for
/// the flip.
/// If true, the cursor's `hotspot` automatically flips along with the
/// image.
pub flip_x: bool,
/// Whether the image should be flipped along its y-axis.
///
/// If true, the cursor's hotspot will be automatically flipped along with
/// the image. You don't need to adjust the `hotspot` field to account for
/// the flip.
/// If true, the cursor's `hotspot` automatically flips along with the
/// image.
pub flip_y: bool,
/// An optional rectangle representing the region of the image to render,
/// instead of rendering the full image. This is an easy one-off alternative
Expand All @@ -37,6 +35,10 @@ pub struct CustomCursorImage {
pub rect: Option<URect>,
/// X and Y coordinates of the hotspot in pixels. The hotspot must be within
/// the image bounds.
///
/// If you are flipping the image using `flip_x` or `flip_y`, you don't need
/// to adjust this field to account for the flip because it is adjusted
/// automatically.
pub hotspot: (u16, u16),
}

Expand Down

0 comments on commit b317a72

Please sign in to comment.