Enum winit::window::CursorGrabMode

pub enum CursorGrabMode {
    None,
    Confined,
    Locked,
}

The behavior of cursor grabbing.

Use this enum with Window::set_cursor_grab to grab the cursor.

Variants

None

No grabbing of the cursor is performed.

Confined

The cursor is confined to the window area.

There’s no guarantee that the cursor will be hidden. You should hide it by yourself if you want to do so.

Platform-specific

• macOS: Not implemented. Always returns ExternalError::NotSupported for now.
• iOS / Android / Web / Orbital: Always returns an ExternalError::NotSupported.

Locked

The cursor is locked inside the window area to the certain position.

There’s no guarantee that the cursor will be hidden. You should hide it by yourself if you want to do so.

Platform-specific

• X11 / Windows: Not implemented. Always returns ExternalError::NotSupported for now.
• iOS / Android / Orbital: Always returns an ExternalError::NotSupported.

Trait Implementations

impl Clone for CursorGrabMode

fn clone(&self) -> CursorGrabMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CursorGrabMode

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

Formats the value using the given formatter.

impl Hash for CursorGrabMode

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<CursorGrabMode> for CursorGrabMode

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for CursorGrabMode

impl Eq for CursorGrabMode

impl StructuralEq for CursorGrabMode

impl StructuralPartialEq for CursorGrabMode