Struct gdnative::prelude::Input

pub struct Input { /* fields omitted */ }

core singleton class Input inherits Object (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Class hierarchy

Input inherits methods from:

• 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 Input

Constants

pub const CURSOR_ARROW: i64

pub const CURSOR_BDIAGSIZE: i64

pub const CURSOR_BUSY: i64

pub const CURSOR_CAN_DROP: i64

pub const CURSOR_CROSS: i64

pub const CURSOR_DRAG: i64

pub const CURSOR_FDIAGSIZE: i64

pub const CURSOR_FORBIDDEN: i64

pub const CURSOR_HELP: i64

pub const CURSOR_HSIZE: i64

pub const CURSOR_HSPLIT: i64

pub const CURSOR_IBEAM: i64

pub const CURSOR_MOVE: i64

pub const CURSOR_POINTING_HAND: i64

pub const CURSOR_VSIZE: i64

pub const CURSOR_VSPLIT: i64

pub const CURSOR_WAIT: i64

pub const MOUSE_MODE_CAPTURED: i64

pub const MOUSE_MODE_CONFINED: i64

pub const MOUSE_MODE_HIDDEN: i64

pub const MOUSE_MODE_VISIBLE: i64

impl Input

pub fn godot_singleton() -> &'static Input

Returns a reference to the singleton instance.

pub fn action_press(&self, action: impl Into<GodotString>, strength: f64)

pub fn action_release(&self, action: impl Into<GodotString>)

pub fn add_joy_mapping(
    &self,
    mapping: impl Into<GodotString>,
    update_existing: bool
)

pub fn get_accelerometer(&self) -> Vector3D<f32, UnknownUnit>

pub fn get_action_strength(&self, action: impl Into<GodotString>) -> f64

pub fn get_connected_joypads(&self) -> VariantArray<Shared>

pub fn get_current_cursor_shape(&self) -> CursorShape

pub fn get_gravity(&self) -> Vector3D<f32, UnknownUnit>

pub fn get_gyroscope(&self) -> Vector3D<f32, UnknownUnit>

pub fn get_joy_axis(&self, device: i64, axis: i64) -> f64

pub fn get_joy_axis_index_from_string(
    &self,
    axis: impl Into<GodotString>
) -> i64

pub fn get_joy_axis_string(&self, axis_index: i64) -> GodotString

pub fn get_joy_button_index_from_string(
    &self,
    button: impl Into<GodotString>
) -> i64

pub fn get_joy_button_string(&self, button_index: i64) -> GodotString

pub fn get_joy_guid(&self, device: i64) -> GodotString

pub fn get_joy_name(&self, device: i64) -> GodotString

pub fn get_joy_vibration_duration(&self, device: i64) -> f64

pub fn get_joy_vibration_strength(
    &self,
    device: i64
) -> Vector2D<f32, UnknownUnit>

pub fn get_last_mouse_speed(&self) -> Vector2D<f32, UnknownUnit>

pub fn get_magnetometer(&self) -> Vector3D<f32, UnknownUnit>

pub fn get_mouse_button_mask(&self) -> i64

pub fn get_mouse_mode(&self) -> MouseMode

pub fn is_action_just_pressed(&self, action: impl Into<GodotString>) -> bool

pub fn is_action_just_released(&self, action: impl Into<GodotString>) -> bool

pub fn is_action_pressed(&self, action: impl Into<GodotString>) -> bool

pub fn is_joy_button_pressed(&self, device: i64, button: i64) -> bool

pub fn is_joy_known(&self, device: i64) -> bool

pub fn is_key_pressed(&self, scancode: i64) -> bool

pub fn is_mouse_button_pressed(&self, button: i64) -> bool

pub fn joy_connection_changed(
    &self,
    device: i64,
    connected: bool,
    name: impl Into<GodotString>,
    guid: impl Into<GodotString>
)

pub fn parse_input_event(&self, event: impl AsArg<InputEvent>)

pub fn remove_joy_mapping(&self, guid: impl Into<GodotString>)

pub fn set_custom_mouse_cursor(
    &self,
    image: impl AsArg<Resource>,
    shape: i64,
    hotspot: Vector2D<f32, UnknownUnit>
)

pub fn set_default_cursor_shape(&self, shape: i64)

pub fn set_mouse_mode(&self, mode: i64)

pub fn set_use_accumulated_input(&self, enable: bool)

pub fn start_joy_vibration(
    &self,
    device: i64,
    weak_magnitude: f64,
    strong_magnitude: f64,
    duration: f64
)

pub fn stop_joy_vibration(&self, device: i64)

pub fn vibrate_handheld(&self, duration_ms: i64)

pub fn warp_mouse_position(&self, to: Vector2D<f32, UnknownUnit>)

Methods from Deref<Target = Object>

pub const CONNECT_DEFERRED: i64

pub const CONNECT_ONESHOT: i64

pub const CONNECT_PERSIST: i64

pub const CONNECT_REFERENCE_COUNTED: i64

pub const NOTIFICATION_POSTINITIALIZE: i64

pub const NOTIFICATION_PREDELETE: i64

pub fn add_user_signal(
    &self,
    signal: impl Into<GodotString>,
    arguments: VariantArray<Shared>
)

pub unsafe fn call(
    &self,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub unsafe fn call_deferred(
    &self,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn callv(
    &self,
    method: impl Into<GodotString>,
    arg_array: VariantArray<Shared>
) -> Variant

pub fn can_translate_messages(&self) -> bool

pub fn connect(
    &self,
    signal: impl Into<GodotString>,
    target: impl AsArg<Object>,
    method: impl Into<GodotString>,
    binds: VariantArray<Shared>,
    flags: i64
) -> Result<(), GodotError>

pub fn disconnect(
    &self,
    signal: impl Into<GodotString>,
    target: impl AsArg<Object>,
    method: impl Into<GodotString>
)

pub fn emit_signal(
    &self,
    signal: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn get(&self, property: impl Into<GodotString>) -> Variant

pub fn get_class(&self) -> GodotString

pub fn get_incoming_connections(&self) -> VariantArray<Shared>

pub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant

pub fn get_instance_id(&self) -> i64

pub fn get_meta(&self, name: impl Into<GodotString>) -> Variant

pub fn get_meta_list(&self) -> TypedArray<GodotString>

pub fn get_method_list(&self) -> VariantArray<Shared>

pub fn get_property_list(&self) -> VariantArray<Shared>

pub fn get_script(&self) -> Option<Ref<Reference, Shared>>

pub fn get_signal_connection_list(
    &self,
    signal: impl Into<GodotString>
) -> VariantArray<Shared>

pub fn get_signal_list(&self) -> VariantArray<Shared>

pub fn has_meta(&self, name: impl Into<GodotString>) -> bool

pub fn has_method(&self, method: impl Into<GodotString>) -> bool

pub fn has_signal(&self, signal: impl Into<GodotString>) -> bool

pub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool

pub fn is_blocking_signals(&self) -> bool

pub fn is_class(&self, class: impl Into<GodotString>) -> bool

pub fn is_connected(
    &self,
    signal: impl Into<GodotString>,
    target: impl AsArg<Object>,
    method: impl Into<GodotString>
) -> bool

pub fn is_queued_for_deletion(&self) -> bool

pub fn notification(&self, what: i64, reversed: bool)

pub fn property_list_changed_notify(&self)

pub fn remove_meta(&self, name: impl Into<GodotString>)

pub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)

pub fn set_block_signals(&self, enable: bool)

pub fn set_deferred(
    &self,
    property: impl Into<GodotString>,
    value: impl OwnedToVariant
)

pub fn set_indexed(
    &self,
    property: impl Into<NodePath>,
    value: impl OwnedToVariant
)

pub fn set_message_translation(&self, enable: bool)

pub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)

pub fn set_script(&self, script: impl AsArg<Reference>)

pub fn to_string(&self) -> GodotString

pub fn tr(&self, message: impl Into<GodotString>) -> GodotString

Trait Implementations

impl Debug for Input

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

Formats the value using the given formatter.

impl Deref for Input

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl DerefMut for Input

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

Mutably dereferences the value.

impl GodotObject for Input

type RefKind = ManuallyManaged

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 Send for Input

impl SubClass<Input> for InputDefault

impl SubClass<Object> for Input

impl Sync for Input