[−][src]Struct gdnative_bindings::InputEventMouse
core class InputEventMouse
inherits InputEventWithModifiers
(reference counted).
Official documentation
See the documentation of this class in the Godot engine's official documentation.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
InputEventMouse 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
impl InputEventMouse
[src]
pub fn button_mask(&self) -> i64
[src]
The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks.
pub fn global_position(&self) -> Vector2
[src]
The global mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0.
pub fn position(&self) -> Vector2
[src]
The local mouse position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] which is under the mouse.
pub fn set_button_mask(&self, button_mask: i64)
[src]
The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks.
pub fn set_global_position(&self, global_position: Vector2)
[src]
The global mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0.
pub fn set_position(&self, position: Vector2)
[src]
The local mouse position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] which is under the mouse.
Methods from Deref<Target = InputEventWithModifiers>
pub fn alt(&self) -> bool
[src]
State of the [code]Alt[/code] modifier.
pub fn command(&self) -> bool
[src]
State of the [code]Command[/code] modifier.
pub fn control(&self) -> bool
[src]
State of the [code]Ctrl[/code] modifier.
pub fn metakey(&self) -> bool
[src]
State of the [code]Meta[/code] modifier.
pub fn shift(&self) -> bool
[src]
State of the [code]Shift[/code] modifier.
pub fn set_alt(&self, enable: bool)
[src]
State of the [code]Alt[/code] modifier.
pub fn set_command(&self, enable: bool)
[src]
State of the [code]Command[/code] modifier.
pub fn set_control(&self, enable: bool)
[src]
State of the [code]Ctrl[/code] modifier.
pub fn set_metakey(&self, enable: bool)
[src]
State of the [code]Meta[/code] modifier.
pub fn set_shift(&self, enable: bool)
[src]
State of the [code]Shift[/code] modifier.
Trait Implementations
impl Debug for InputEventMouse
[src]
impl Deref for InputEventMouse
[src]
type Target = InputEventWithModifiers
The resulting type after dereferencing.
fn deref(&self) -> &InputEventWithModifiers
[src]
impl DerefMut for InputEventMouse
[src]
fn deref_mut(&mut self) -> &mut InputEventWithModifiers
[src]
impl GodotObject for InputEventMouse
[src]
type RefKind = RefCounted
The memory management kind of this type. This modifies the behavior of the
Ref
smart pointer. See its type-level documentation for more
information. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Sealed for InputEventMouse
[src]
impl SubClass<InputEvent> for InputEventMouse
[src]
impl SubClass<InputEventMouse> for InputEventMouseMotion
[src]
impl SubClass<InputEventMouse> for InputEventMouseButton
[src]
impl SubClass<InputEventWithModifiers> for InputEventMouse
[src]
impl SubClass<Object> for InputEventMouse
[src]
impl SubClass<Reference> for InputEventMouse
[src]
impl SubClass<Resource> for InputEventMouse
[src]
Auto Trait Implementations
impl RefUnwindSafe for InputEventMouse
impl !Send for InputEventMouse
impl !Sync for InputEventMouse
impl Unpin for InputEventMouse
impl UnwindSafe for InputEventMouse
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,