Struct gdnative_bindings_lily::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. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

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

TextureButton is a reference-only type. Persistent references can only exist in the unsafe Ref<TextureButton> form.

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 Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

TextureButton inherits methods from:

• BaseButton
• Control
• CanvasItem
• Node
• 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 TextureButton

Constants

pub const STRETCH_KEEP: i64

pub const STRETCH_KEEP_ASPECT: i64

pub const STRETCH_KEEP_ASPECT_CENTERED: i64

pub const STRETCH_KEEP_ASPECT_COVERED: i64

pub const STRETCH_KEEP_CENTERED: i64

pub const STRETCH_SCALE: i64

pub const STRETCH_TILE: i64

impl TextureButton

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

Creates a new instance of this object.

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 Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn click_mask(&self) -> Option<Ref<BitMap, Shared>>

Pure black and white BitMap image to use for click detection. On the mask, white pixels represent the button’s clickable area. Use it to create buttons with curved shapes.

pub fn disabled_texture(&self) -> Option<Ref<Texture, Shared>>

Texture to display when the node is disabled. See [member BaseButton.disabled].

pub fn expand(&self) -> bool

If true, the texture stretches to the edges of the node’s bounding rectangle using the [member stretch_mode]. If false, the texture will not scale with the node.

pub fn focused_texture(&self) -> Option<Ref<Texture, Shared>>

Texture to display when the node has mouse or keyboard focus.

pub fn hover_texture(&self) -> Option<Ref<Texture, Shared>>

Texture to display when the mouse hovers the node.

pub fn normal_texture(&self) -> Option<Ref<Texture, Shared>>

Texture to display by default, when the node is not in the disabled, focused, hover or pressed state.

pub fn pressed_texture(&self) -> Option<Ref<Texture, Shared>>

Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the Enter key or if the player presses the [member BaseButton.shortcut] key.

pub fn stretch_mode(&self) -> StretchMode

Controls the texture’s behavior when you resize the node’s bounding rectangle, only if [member expand] is true. Set it to one of the [enum StretchMode] constants. See the constants to learn more.

pub fn set_click_mask(&self, mask: impl AsArg<BitMap>)

Pure black and white BitMap image to use for click detection. On the mask, white pixels represent the button’s clickable area. Use it to create buttons with curved shapes.

pub fn set_disabled_texture(&self, texture: impl AsArg<Texture>)

Texture to display when the node is disabled. See [member BaseButton.disabled].

pub fn set_expand(&self, p_expand: bool)

If true, the texture stretches to the edges of the node’s bounding rectangle using the [member stretch_mode]. If false, the texture will not scale with the node.

pub fn set_focused_texture(&self, texture: impl AsArg<Texture>)

Texture to display when the node has mouse or keyboard focus.

pub fn set_hover_texture(&self, texture: impl AsArg<Texture>)

Texture to display when the mouse hovers the node.

pub fn set_normal_texture(&self, texture: impl AsArg<Texture>)

Texture to display by default, when the node is not in the disabled, focused, hover or pressed state.

pub fn set_pressed_texture(&self, texture: impl AsArg<Texture>)

Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the Enter key or if the player presses the [member BaseButton.shortcut] key.

pub fn set_stretch_mode(&self, p_mode: i64)

Controls the texture’s behavior when you resize the node’s bounding rectangle, only if [member expand] is true. Set it to one of the [enum StretchMode] constants. See the constants to learn more.

Methods from Deref<Target = BaseButton>

pub const ACTION_MODE_BUTTON_PRESS: i64

pub const ACTION_MODE_BUTTON_RELEASE: i64

pub const DRAW_DISABLED: i64

pub const DRAW_HOVER: i64

pub const DRAW_HOVER_PRESSED: i64

pub const DRAW_NORMAL: i64

pub const DRAW_PRESSED: i64

pub fn action_mode(&self) -> ActionMode

Determines when the button is considered clicked, one of the [enum ActionMode] constants.

pub fn button_group(&self) -> Option<Ref<ButtonGroup, Shared>>

ButtonGroup associated to the button.

pub fn button_mask(&self) -> i64

Binary mask to choose which mouse buttons this button will respond to. To allow both left-click and right-click, use BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT.

pub fn get_draw_mode(&self) -> DrawMode

Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to “draw” signal. The visual state of the button is defined by the [enum DrawMode] enum.

pub fn enabled_focus_mode(&self) -> FocusMode

Focus access mode to use when switching between enabled/disabled (see [member Control.focus_mode] and [member disabled]).

pub fn shortcut(&self) -> Option<Ref<ShortCut, Shared>>

ShortCut associated to the button.

pub fn is_disabled(&self) -> bool

If true, the button is in disabled state and can’t be clicked or toggled.

pub fn is_hovered(&self) -> bool

Returns true if the mouse has entered the button and has not left it yet.

pub fn is_keep_pressed_outside(&self) -> bool

If true, the button stays pressed when moving the cursor outside the button while pressing it. Note: This property only affects the button’s visual appearance. Signals will be emitted at the same moment regardless of this property’s value.

pub fn is_pressed(&self) -> bool

If true, the button’s state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active).

pub fn is_shortcut_in_tooltip_enabled(&self) -> bool

If true, the button will add information about its shortcut in the tooltip.

pub fn is_toggle_mode(&self) -> bool

If true, the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.

pub fn set_action_mode(&self, mode: i64)

Determines when the button is considered clicked, one of the [enum ActionMode] constants.

pub fn set_button_group(&self, button_group: impl AsArg<ButtonGroup>)

ButtonGroup associated to the button.

pub fn set_button_mask(&self, mask: i64)

Binary mask to choose which mouse buttons this button will respond to. To allow both left-click and right-click, use BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT.

pub fn set_disabled(&self, disabled: bool)

If true, the button is in disabled state and can’t be clicked or toggled.

pub fn set_enabled_focus_mode(&self, mode: i64)

Focus access mode to use when switching between enabled/disabled (see [member Control.focus_mode] and [member disabled]).

pub fn set_keep_pressed_outside(&self, enabled: bool)

If true, the button stays pressed when moving the cursor outside the button while pressing it. Note: This property only affects the button’s visual appearance. Signals will be emitted at the same moment regardless of this property’s value.

pub fn set_pressed(&self, pressed: bool)

If true, the button’s state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active).

pub fn set_shortcut(&self, shortcut: impl AsArg<ShortCut>)

ShortCut associated to the button.

pub fn set_shortcut_in_tooltip(&self, enabled: bool)

If true, the button will add information about its shortcut in the tooltip.

pub fn set_toggle_mode(&self, enabled: bool)

If true, the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.

Trait Implementations

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 GodotObject for TextureButton

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.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for TextureButton

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

impl QueueFree for TextureButton

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for TextureButton

impl SubClass<BaseButton> for TextureButton

impl SubClass<CanvasItem> for TextureButton

impl SubClass<Control> for TextureButton

impl SubClass<Node> for TextureButton

impl SubClass<Object> for TextureButton