Struct ambient_api::input::CursorLockGuard

pub struct CursorLockGuard { /* private fields */ }

Helper utility that will lock and hide the cursor if necessary.

Will unlock the cursor when dropped.

Implementations

impl CursorLockGuard

pub fn new(locked: bool) -> CursorLockGuard

Creates a new CursorLockGuard with the given lock state.

pub fn set_locked(&mut self, locked: bool)

Locks and hides the cursor if necessary.

pub fn is_locked(&self) -> bool

Returns whether or not the cursor is currently locked.

pub fn lock(&mut self)

Helper that calls Self::set_locked with true.

pub fn unlock(&mut self)

Helper that calls Self::set_locked with false.

pub fn auto_unlock_on_escape(&mut self, input: &Input) -> bool

Helper that will unlock if Escape has been pressed, and lock if anything else is pressed.

Returns whether or not the cursor is currently locked.

Trait Implementations

impl Drop for CursorLockGuard

fn drop(&mut self)

Executes the destructor for this type.