pub struct Cursor {
pub icon: CursorIcon,
pub visible: bool,
pub grab_mode: CursorGrabMode,
pub hit_test: bool,
/* private fields */
}
Expand description
Stores data about the window’s cursor.
Fields§
§icon: CursorIcon
Get the current CursorIcon
while inside the window.
visible: bool
Whether the cursor is visible or not.
Platform-specific
Windows
,X11
, andWayland
: The cursor is hidden only when inside the window. To stop the cursor from leaving the window, changeCursor::grab_mode
toCursorGrabMode::Locked
orCursorGrabMode::Confined
macOS
: The cursor is hidden only when the window is focused.iOS
andAndroid
do not have cursors
grab_mode: CursorGrabMode
Whether or not the cursor is locked.
Platform-specific
Windows
doesn’t supportCursorGrabMode::Locked
macOS
doesn’t supportCursorGrabMode::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 FromReflect for Cursorwhere
CursorIcon: FromReflect,
bool: FromReflect,
CursorGrabMode: FromReflect,
Option<DVec2>: FromReflect,
impl FromReflect for Cursorwhere CursorIcon: FromReflect, bool: FromReflect, CursorGrabMode: FromReflect, Option<DVec2>: FromReflect,
§fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Cursor>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Cursor>
Constructs a concrete instance of
Self
from a reflected value.§impl GetTypeRegistration for Cursorwhere
CursorIcon: Reflect,
bool: Reflect,
CursorGrabMode: Reflect,
Option<DVec2>: Reflect,
impl GetTypeRegistration for Cursorwhere CursorIcon: Reflect, bool: Reflect, CursorGrabMode: Reflect, Option<DVec2>: Reflect,
§impl Reflect for Cursorwhere
CursorIcon: Reflect,
bool: Reflect,
CursorGrabMode: Reflect,
Option<DVec2>: Reflect,
impl Reflect for Cursorwhere CursorIcon: Reflect, bool: Reflect, CursorGrabMode: Reflect, Option<DVec2>: Reflect,
§fn get_type_info(&self) -> &'static TypeInfo
fn get_type_info(&self) -> &'static TypeInfo
§fn into_any(self: Box<Cursor, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<Cursor, Global>) -> Box<dyn Any + 'static, Global>
Returns the value as a
Box<dyn Any>
.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Returns the value as a
&mut dyn Any
.§fn into_reflect(self: Box<Cursor, Global>) -> Box<dyn Reflect + 'static, Global>
fn into_reflect(self: Box<Cursor, Global>) -> Box<dyn Reflect + 'static, Global>
Casts this type to a boxed reflected value.
§fn as_reflect(&self) -> &(dyn Reflect + 'static)
fn as_reflect(&self) -> &(dyn Reflect + 'static)
Casts this type to a reflected value.
§fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
Casts this type to a mutable reflected value.
§fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
Clones the value as a
Reflect
trait object. Read more§fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
fn set( &mut self, value: Box<dyn Reflect + 'static, Global> ) -> Result<(), Box<dyn Reflect + 'static, Global>>
Performs a type-checked assignment of a reflected value to this value. Read more
§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
Applies a reflected value to this value. Read more
§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
Returns an enumeration of “kinds” of type. Read more
§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
Returns a mutable enumeration of “kinds” of type. Read more
§fn reflect_owned(self: Box<Cursor, Global>) -> ReflectOwned
fn reflect_owned(self: Box<Cursor, Global>) -> ReflectOwned
Returns an owned enumeration of “kinds” of type. Read more
§fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
Returns a “partial equality” comparison result. Read more
§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Debug formatter for the value. Read more
§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
Returns a hash of the value (which includes the type). Read more
§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
Returns a serializable version of the value. Read more
§impl Struct for Cursorwhere
CursorIcon: Reflect,
bool: Reflect,
CursorGrabMode: Reflect,
Option<DVec2>: Reflect,
impl Struct for Cursorwhere CursorIcon: Reflect, bool: Reflect, CursorGrabMode: Reflect, Option<DVec2>: Reflect,
§fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
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 + 'static)>
fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>
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 + 'static)>
fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>
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 + 'static)>
fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
Returns a mutable reference to the value of the field with index
index
as a &mut dyn Reflect
.§fn iter_fields(&self) -> FieldIter<'_> ⓘ
fn iter_fields(&self) -> FieldIter<'_> ⓘ
Returns an iterator over the values of the reflectable fields for this struct.
§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
Clones the struct into a
DynamicStruct
.§impl Typed for Cursorwhere
CursorIcon: Reflect,
bool: Reflect,
CursorGrabMode: Reflect,
Option<DVec2>: Reflect,
impl Typed for Cursorwhere CursorIcon: Reflect, bool: Reflect, CursorGrabMode: Reflect, Option<DVec2>: Reflect,
impl Copy for Cursor
Auto Trait Implementations§
impl RefUnwindSafe for Cursor
impl Send for Cursor
impl Sync for Cursor
impl Unpin for Cursor
impl UnwindSafe for Cursor
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
Return the
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere T: Default,
§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates
Self
using data from the given World§impl<T> GetPath for Twhere
T: Reflect,
impl<T> GetPath for Twhere T: Reflect,
§fn reflect_path<'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'r, 'p>( &'r self, path: &'p str ) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
Returns a reference to the value specified by
path
. Read more§fn reflect_path_mut<'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'r, 'p>( &'r mut self, path: &'p str ) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
Returns a mutable reference to the value specified by
path
. Read more