Struct HitboxId 

pub struct HitboxId(/* private fields */);

Identifies a Hitbox in the frame that inserted it.

Ids are assigned in insertion order during prepaint, so they are stable within one frame but not across frames. Compare them only with ids from the same frame.

Implementations

impl HitboxId

pub const fn placeholder() -> Self

Returns an id that is valid for tests which need a HitboxId but don’t use its value.

Only available with the test-support feature. Don’t pass it to window methods that look up a real hitbox.

impl HitboxId

pub fn is_hovered(self, window: &Window) -> bool

Returns whether the mouse is over this hitbox and it isn’t covered by a blocking hitbox.

Always true if this hitbox has captured the pointer. Returns false during keyboard input, so keyboard navigation hides hover styles. See Hitbox::is_hovered for details.

pub fn should_handle_scroll(self, window: &Window) -> bool

Returns whether the mouse is over this hitbox and it should handle scroll events.

Use this for ScrollWheelEvent handlers, and HitboxId::is_hovered for everything else. See Hitbox::is_hovered for why the two differ.

Trait Implementations

impl Clone for HitboxId

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for HitboxId

impl Debug for HitboxId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for HitboxId

impl Hash for HitboxId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HitboxId

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for HitboxId