godot-docs/classes/class_texturebutton.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.

.. _class_TextureButton:

TextureButton
=============

**Inherits:** :ref:`BaseButton<class_basebutton>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Button that can be themed with textures.

Member Functions
----------------

+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`BitMap<class_bitmap>`    | :ref:`get_click_mask<class_TextureButton_get_click_mask>`  **(** **)** const                                              |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`  | :ref:`get_disabled_texture<class_TextureButton_get_disabled_texture>`  **(** **)** const                                  |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`get_expand<class_TextureButton_get_expand>`  **(** **)** const                                                      |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`  | :ref:`get_focused_texture<class_TextureButton_get_focused_texture>`  **(** **)** const                                    |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`  | :ref:`get_hover_texture<class_TextureButton_get_hover_texture>`  **(** **)** const                                        |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`  | :ref:`get_normal_texture<class_TextureButton_get_normal_texture>`  **(** **)** const                                      |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`  | :ref:`get_pressed_texture<class_TextureButton_get_pressed_texture>`  **(** **)** const                                    |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_stretch_mode<class_TextureButton_get_stretch_mode>`  **(** **)** const                                          |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_click_mask<class_TextureButton_set_click_mask>`  **(** :ref:`BitMap<class_bitmap>` mask  **)**                  |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_disabled_texture<class_TextureButton_set_disabled_texture>`  **(** :ref:`Texture<class_texture>` texture  **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_expand<class_TextureButton_set_expand>`  **(** :ref:`bool<class_bool>` p_expand  **)**                          |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_focused_texture<class_TextureButton_set_focused_texture>`  **(** :ref:`Texture<class_texture>` texture  **)**   |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_hover_texture<class_TextureButton_set_hover_texture>`  **(** :ref:`Texture<class_texture>` texture  **)**       |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_normal_texture<class_TextureButton_set_normal_texture>`  **(** :ref:`Texture<class_texture>` texture  **)**     |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_pressed_texture<class_TextureButton_set_pressed_texture>`  **(** :ref:`Texture<class_texture>` texture  **)**   |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_stretch_mode<class_TextureButton_set_stretch_mode>`  **(** :ref:`int<class_int>` p_mode  **)**                  |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`bool<class_bool>` **expand**
- :ref:`int<class_int>` **stretch_mode**
- :ref:`BitMap<class_bitmap>` **texture_click_mask**
- :ref:`Texture<class_texture>` **texture_disabled**
- :ref:`Texture<class_texture>` **texture_focused**
- :ref:`Texture<class_texture>` **texture_hover**
- :ref:`Texture<class_texture>` **texture_normal**
- :ref:`Texture<class_texture>` **texture_pressed**

Numeric Constants
-----------------

- **STRETCH_SCALE** = **0**
- **STRETCH_TILE** = **1**
- **STRETCH_KEEP** = **2**
- **STRETCH_KEEP_CENTERED** = **3**
- **STRETCH_KEEP_ASPECT** = **4**
- **STRETCH_KEEP_ASPECT_CENTERED** = **5**
- **STRETCH_KEEP_ASPECT_COVERED** = **6**

Description
-----------

Button that can be themed with textures. This is like a regular :ref:`Button<class_button>` but can be themed by assigning textures to it. This button is intended to be easy to theme, however a regular button can expand (that uses styleboxes) and still be better if the interface is expect to have internationalization of texts.

Only the normal texture is required, the others are optional.

Member Function Description
---------------------------

.. _class_TextureButton_get_click_mask:

- :ref:`BitMap<class_bitmap>`  **get_click_mask**  **(** **)** const

.. _class_TextureButton_get_disabled_texture:

- :ref:`Texture<class_texture>`  **get_disabled_texture**  **(** **)** const

.. _class_TextureButton_get_expand:

- :ref:`bool<class_bool>`  **get_expand**  **(** **)** const

.. _class_TextureButton_get_focused_texture:

- :ref:`Texture<class_texture>`  **get_focused_texture**  **(** **)** const

.. _class_TextureButton_get_hover_texture:

- :ref:`Texture<class_texture>`  **get_hover_texture**  **(** **)** const

.. _class_TextureButton_get_normal_texture:

- :ref:`Texture<class_texture>`  **get_normal_texture**  **(** **)** const

.. _class_TextureButton_get_pressed_texture:

- :ref:`Texture<class_texture>`  **get_pressed_texture**  **(** **)** const

.. _class_TextureButton_get_stretch_mode:

- :ref:`int<class_int>`  **get_stretch_mode**  **(** **)** const

.. _class_TextureButton_set_click_mask:

- void  **set_click_mask**  **(** :ref:`BitMap<class_bitmap>` mask  **)**

.. _class_TextureButton_set_disabled_texture:

- void  **set_disabled_texture**  **(** :ref:`Texture<class_texture>` texture  **)**

.. _class_TextureButton_set_expand:

- void  **set_expand**  **(** :ref:`bool<class_bool>` p_expand  **)**

.. _class_TextureButton_set_focused_texture:

- void  **set_focused_texture**  **(** :ref:`Texture<class_texture>` texture  **)**

.. _class_TextureButton_set_hover_texture:

- void  **set_hover_texture**  **(** :ref:`Texture<class_texture>` texture  **)**

.. _class_TextureButton_set_normal_texture:

- void  **set_normal_texture**  **(** :ref:`Texture<class_texture>` texture  **)**

.. _class_TextureButton_set_pressed_texture:

- void  **set_pressed_texture**  **(** :ref:`Texture<class_texture>` texture  **)**

.. _class_TextureButton_set_stretch_mode:

- void  **set_stretch_mode**  **(** :ref:`int<class_int>` p_mode  **)**