Struct gdnative_bindings_lily::input_event_mouse_button::InputEventMouseButton [−][src]
pub struct InputEventMouseButton { /* fields omitted */ }
Expand description
core class InputEventMouseButton
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
InputEventMouseButton 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
.
The mouse button identifier, one of the [enum ButtonList] button or button wheel constants.
The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be 0
if not supported.
If true
, the mouse button’s state is a double-click.
The mouse button identifier, one of the [enum ButtonList] button or button wheel constants.
If true
, the mouse button’s state is a double-click.
The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be 0
if not supported.
If true
, the mouse button’s state is pressed. If false
, the mouse button’s state is released.
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 InputEventMouseButton
impl !Send for InputEventMouseButton
impl !Sync for InputEventMouseButton
impl Unpin for InputEventMouseButton
impl UnwindSafe for InputEventMouseButton