Struct gdnative::api::InputEventMouseButton

pub struct InputEventMouseButton { /* fields omitted */ }

core class InputEventMouseButton inherits InputEventMouse (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

InputEventMouseButton inherits methods from:

• InputEventMouse
• 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 InputEventMouseButton

pub fn new() -> Ref<InputEventMouseButton, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn button_index(&self) -> i64

The mouse button identifier, one of the [enum ButtonList] button or button wheel constants.

pub fn factor(&self) -> f64

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 [code]0[/code] if not supported.

pub fn is_doubleclick(&self) -> bool

If [code]true[/code], the mouse button's state is a double-click.

pub fn set_button_index(&self, button_index: i64)

The mouse button identifier, one of the [enum ButtonList] button or button wheel constants.

pub fn set_doubleclick(&self, doubleclick: bool)

If [code]true[/code], the mouse button's state is a double-click.

pub fn set_factor(&self, factor: f64)

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 [code]0[/code] if not supported.

pub fn set_pressed(&self, pressed: bool)

If [code]true[/code], the mouse button's state is pressed. If [code]false[/code], the mouse button's state is released.

Methods from Deref<Target = 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) -> Vector2D<f32, UnknownUnit>

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) -> Vector2D<f32, UnknownUnit>

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: Vector2D<f32, UnknownUnit>)

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: Vector2D<f32, UnknownUnit>)

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.

Trait Implementations

impl Debug for InputEventMouseButton

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

Formats the value using the given formatter.

impl Deref for InputEventMouseButton

type Target = InputEventMouse

The resulting type after dereferencing.

fn deref(&self) -> &InputEventMouse

Dereferences the value.

impl DerefMut for InputEventMouseButton

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

Mutably dereferences the value.

impl GodotObject for InputEventMouseButton

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 Instanciable for InputEventMouseButton

fn construct() -> Ref<InputEventMouseButton, Unique>

impl SubClass<InputEvent> for InputEventMouseButton

impl SubClass<InputEventMouse> for InputEventMouseButton

impl SubClass<InputEventWithModifiers> for InputEventMouseButton

impl SubClass<Object> for InputEventMouseButton

impl SubClass<Reference> for InputEventMouseButton

impl SubClass<Resource> for InputEventMouseButton