Struct gdnative_bindings_lily::InputEventMouseMotion [−][src]
pub struct InputEventMouseMotion { /* fields omitted */ }
Expand description
core class InputEventMouseMotion
inherits InputEventMouse
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
InputEventMouseMotion inherits methods from:
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Represents the pressure the user puts on the pen. Ranges from 0.0
to 1.0
.
The mouse position relative to the previous position (position at the last frame).
Note: Since InputEventMouseMotion is only emitted when the mouse moves, the last event won’t have a relative position of Vector2(0, 0)
when the user stops moving the mouse.
Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from -1.0
to 1.0
for both axes.
Represents the pressure the user puts on the pen. Ranges from 0.0
to 1.0
.
The mouse position relative to the previous position (position at the last frame).
Note: Since InputEventMouseMotion is only emitted when the mouse moves, the last event won’t have a relative position of Vector2(0, 0)
when the user stops moving the mouse.
Methods from Deref<Target = InputEventMouse>
The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks.
The global mouse position relative to the current Viewport when used in [method Control._gui_input], otherwise is at 0,0.
The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks.
The global mouse position relative to the current Viewport when used in [method Control._gui_input], otherwise is at 0,0.
Trait Implementations
type Target = InputEventMouse
type Target = InputEventMouse
The resulting type after dereferencing.
Dereferences the value.
Mutably dereferences the value.
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for InputEventMouseMotion
impl !Send for InputEventMouseMotion
impl !Sync for InputEventMouseMotion
impl Unpin for InputEventMouseMotion
impl UnwindSafe for InputEventMouseMotion