Struct gdnative_bindings::InputEventMouse

pub struct InputEventMouse { /* fields omitted */ }

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:

• InputEventWithModifiers
• InputEvent
• Resource
• Reference
• Object

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

pub fn button_mask(&self) -> i64

The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks.

pub fn global_position(&self) -> Vector2

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

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)

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)

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)

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

State of the [code]Alt[/code] modifier.

pub fn command(&self) -> bool

State of the [code]Command[/code] modifier.

pub fn control(&self) -> bool

State of the [code]Ctrl[/code] modifier.

pub fn metakey(&self) -> bool

State of the [code]Meta[/code] modifier.

pub fn shift(&self) -> bool

State of the [code]Shift[/code] modifier.

pub fn set_alt(&self, enable: bool)

State of the [code]Alt[/code] modifier.

pub fn set_command(&self, enable: bool)

State of the [code]Command[/code] modifier.

pub fn set_control(&self, enable: bool)

State of the [code]Ctrl[/code] modifier.

pub fn set_metakey(&self, enable: bool)

State of the [code]Meta[/code] modifier.

pub fn set_shift(&self, enable: bool)

State of the [code]Shift[/code] modifier.

Trait Implementations

impl Debug for InputEventMouse

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

Formats the value using the given formatter.

impl Deref for InputEventMouse

type Target = InputEventWithModifiers

The resulting type after dereferencing.

fn deref(&self) -> &InputEventWithModifiers

Dereferences the value.

impl DerefMut for InputEventMouse

fn deref_mut(&mut self) -> &mut InputEventWithModifiers

Mutably dereferences the value.

impl GodotObject for InputEventMouse

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.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

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.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Sealed for InputEventMouse

impl SubClass<InputEvent> for InputEventMouse

impl SubClass<InputEventMouse> for InputEventMouseMotion

impl SubClass<InputEventMouse> for InputEventMouseButton

impl SubClass<InputEventWithModifiers> for InputEventMouse

impl SubClass<Object> for InputEventMouse

impl SubClass<Reference> for InputEventMouse

impl SubClass<Resource> for InputEventMouse