Struct bevy_window::Cursor

pub struct Cursor {
    pub icon: CursorIcon,
    pub visible: bool,
    pub grab_mode: CursorGrabMode,
    pub hit_test: bool,
}

Cursor data for a Window.

Fields

icon: CursorIcon

What the cursor should look like while inside the window.

visible: bool

Whether the cursor is visible or not.

Platform-specific

• Windows, X11, and Wayland: The cursor is hidden only when inside the window. To stop the cursor from leaving the window, change Cursor::grab_mode to CursorGrabMode::Locked or CursorGrabMode::Confined
• macOS: The cursor is hidden only when the window is focused.
• iOS and Android do not have cursors

grab_mode: CursorGrabMode

Whether or not the cursor is locked by or confined within the window.

Platform-specific

• Windows doesn’t support CursorGrabMode::Locked
• macOS doesn’t support CursorGrabMode::Confined
• iOS/Android don’t have cursors.

Since Windows and macOS have different CursorGrabMode support, we first try to set the grab mode that was asked for. If it doesn’t work then use the alternate grab mode.

hit_test: bool

Set whether or not mouse events within this window are captured or fall through to the Window below.

Platform-specific

• iOS / Android / Web / X11: Unsupported.

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() -> Self

Returns the “default value” for a type.

impl FromReflect for Cursor

where Self: Any + Send + Sync, CursorIcon: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection, CursorGrabMode: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Cursor

where Self: Any + Send + Sync, CursorIcon: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection, CursorGrabMode: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Reflect for Cursor

where Self: Any + Send + Sync, CursorIcon: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection, CursorGrabMode: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for Cursor

where Self: Any + Send + Sync, CursorIcon: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection, CursorGrabMode: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for Cursor

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Cursor

where Self: Any + Send + Sync, CursorIcon: FromReflect + TypePath + RegisterForReflection, bool: FromReflect + TypePath + RegisterForReflection, CursorGrabMode: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Cursor