Struct gdnative_bindings::TextureButton

pub struct TextureButton { /* fields omitted */ }

core class TextureButton inherits BaseButton (unsafe).

Official documentation

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

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

TextureButton is an unsafe pointer, and all of its methods are unsafe.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using TextureButton::free.

Class hierarchy

TextureButton inherits methods from:

• BaseButton
• Control
• CanvasItem
• Node
• Object

Methods

impl TextureButton

Constants

pub const STRETCH_SCALE: i64

pub const STRETCH_KEEP_ASPECT_COVERED: i64

pub const STRETCH_TILE: i64

pub const STRETCH_KEEP_ASPECT: i64

pub const STRETCH_KEEP_CENTERED: i64

pub const STRETCH_KEEP_ASPECT_CENTERED: i64

pub const STRETCH_KEEP: i64

impl TextureButton

pub fn new() -> Self

Constructor.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed. Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using TextureButton::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn get_click_mask(&self) -> Option<BitMap>

pub unsafe fn get_disabled_texture(&self) -> Option<Texture>

pub unsafe fn get_expand(&self) -> bool

pub unsafe fn get_focused_texture(&self) -> Option<Texture>

pub unsafe fn get_hover_texture(&self) -> Option<Texture>

pub unsafe fn get_normal_texture(&self) -> Option<Texture>

pub unsafe fn get_pressed_texture(&self) -> Option<Texture>

pub unsafe fn get_stretch_mode(&self) -> TextureButtonStretchMode

pub unsafe fn set_click_mask(&mut self, mask: Option<BitMap>)

pub unsafe fn set_disabled_texture(&mut self, texture: Option<Texture>)

pub unsafe fn set_expand(&mut self, p_expand: bool)

pub unsafe fn set_focused_texture(&mut self, texture: Option<Texture>)

pub unsafe fn set_hover_texture(&mut self, texture: Option<Texture>)

pub unsafe fn set_normal_texture(&mut self, texture: Option<Texture>)

pub unsafe fn set_pressed_texture(&mut self, texture: Option<Texture>)

pub unsafe fn set_stretch_mode(&mut self, p_mode: i64)

pub unsafe fn to_base_button(&self) -> BaseButton

Up-cast.

pub unsafe fn to_control(&self) -> Control

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Methods from Deref<Target = BaseButton>

pub const DRAW_HOVER_PRESSED: i64

pub const ACTION_MODE_BUTTON_PRESS: i64

pub const DRAW_NORMAL: i64

pub const DRAW_PRESSED: i64

pub const DRAW_HOVER: i64

pub const ACTION_MODE_BUTTON_RELEASE: i64

pub const DRAW_DISABLED: i64

pub unsafe fn _gui_input(&mut self, arg0: Option<InputEvent>)

pub unsafe fn _pressed(&mut self)

pub unsafe fn _toggled(&mut self, button_pressed: bool)

pub unsafe fn _unhandled_input(&mut self, arg0: Option<InputEvent>)

pub unsafe fn get_action_mode(&self) -> BaseButtonActionMode

pub unsafe fn get_button_group(&self) -> Option<ButtonGroup>

pub unsafe fn get_button_mask(&self) -> i64

pub unsafe fn get_draw_mode(&self) -> BaseButtonDrawMode

pub unsafe fn get_enabled_focus_mode(&self) -> ControlFocusMode

pub unsafe fn get_shortcut(&self) -> Option<ShortCut>

pub unsafe fn is_disabled(&self) -> bool

pub unsafe fn is_hovered(&self) -> bool

pub unsafe fn is_pressed(&self) -> bool

pub unsafe fn is_shortcut_in_tooltip_enabled(&self) -> bool

pub unsafe fn is_toggle_mode(&self) -> bool

pub unsafe fn set_action_mode(&mut self, mode: i64)

pub unsafe fn set_button_group(&mut self, button_group: Option<ButtonGroup>)

pub unsafe fn set_button_mask(&mut self, mask: i64)

pub unsafe fn set_disabled(&mut self, disabled: bool)

pub unsafe fn set_enabled_focus_mode(&mut self, mode: i64)

pub unsafe fn set_pressed(&mut self, pressed: bool)

pub unsafe fn set_shortcut(&mut self, shortcut: Option<ShortCut>)

pub unsafe fn set_shortcut_in_tooltip(&mut self, enabled: bool)

pub unsafe fn set_toggle_mode(&mut self, enabled: bool)

pub unsafe fn to_control(&self) -> Control

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for TextureButton

fn clone(&self) -> TextureButton

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TextureButton

impl Debug for TextureButton

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

Formats the value using the given formatter.

impl Deref for TextureButton

type Target = BaseButton

The resulting type after dereferencing.

fn deref(&self) -> &BaseButton

Dereferences the value.

impl DerefMut for TextureButton

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

Mutably dereferences the value.

impl Free for TextureButton

unsafe fn godot_free(self)

impl FromVariant for TextureButton

fn from_variant(variant: &Variant) -> Option<Self>

impl GodotObject for TextureButton

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Instanciable for TextureButton

fn construct() -> Self

impl QueueFree for TextureButton

unsafe fn godot_queue_free(&mut self)

impl ToVariant for TextureButton

fn to_variant(&self) -> Variant