Enum Cursor

pub enum Cursor {
    Available(Point),
    Levitating(Point),
    Unavailable,
}

The mouse cursor state.

Variants

Available(Point)

The cursor has a defined position.

Levitating(Point)

The cursor has a defined position, but it’s levitating over a layer above.

Unavailable

The cursor is currently unavailable (i.e. out of bounds or busy).

Implementations

impl Cursor

pub fn position(self) -> Option<Point>

Returns the absolute position of the Cursor, if available.

pub fn position_over(self, bounds: Rectangle) -> Option<Point>

Returns the absolute position of the Cursor, if available and inside the given bounds.

If the Cursor is not over the provided bounds, this method will return None.

pub fn position_in(self, bounds: Rectangle) -> Option<Point>

Returns the relative position of the Cursor inside the given bounds, if available.

If the Cursor is not over the provided bounds, this method will return None.

pub fn position_from(self, origin: Point) -> Option<Point>

Returns the relative position of the Cursor from the given origin, if available.

pub fn is_over(self, bounds: Rectangle) -> bool

Returns true if the Cursor is over the given bounds.

pub fn is_levitating(self) -> bool

Returns true if the Cursor is levitating over a layer above.

pub fn levitate(self) -> Self

Makes the Cursor levitate over a layer above.

pub fn land(self) -> Self

Brings the Cursor back to the current layer.

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl Default for Cursor

fn default() -> Cursor

Returns the “default value” for a type.

impl Mul<Transformation> for Cursor

type Output = Cursor

The resulting type after applying the * operator.

fn mul(self, transformation: Transformation) -> Self

Performs the * operation.

impl PartialEq for Cursor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Cursor

impl StructuralPartialEq for Cursor