Struct CursorLocation

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

A resource that provides the Location data of the cursor.

The Location is available only if the cursor is currently inside one of the windows area.

Example

fn print_cursor_location(cursor: Res<CursorLocation>) {
    if let Some(position) = cursor.position() {
        info!("Cursor position: {position:?}");
    } else {
        info!("The cursor is not in any window");
    }
}

Implementations

impl CursorLocation

pub fn get(&self) -> Option<&Location>

The Location of the cursor.

Returns None if the cursor is outside any window area.

pub fn position(&self) -> Option<Vec2>

The cursor position in the window in logical pixels.

See Window::cursor_position.

Returns None if the cursor is outside any window area.

pub fn window(&self) -> Option<Entity>

The entity id of the window that contains the cursor.

Returns None if the cursor is outside any window area.

pub fn camera(&self) -> Option<Entity>

The entity id of the camera used to compute the world position of the cursor.

Returns None if the cursor is outside any window area.

pub fn world_position(&self) -> Option<Vec2>

Available on crate feature 2d only.

The position of the cursor in the world coordinates.

This value is computed with Camera::viewport_to_world_2d.

Returns None if the cursor is outside any window area.

pub fn ray(&self) -> Option<Ray3d>

Available on crate feature 3d only.

The Ray3d emitted by the cursor from the camera.

This value is computed with Camera::viewport_to_world.

Returns None if the cursor is outside any window area.

Trait Implementations

impl Default for CursorLocation

fn default() -> CursorLocation

Returns the “default value” for a type.

impl Resource for CursorLocation

where Self: Send + Sync + 'static,