:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextureButton.xml. .. _class_TextureButton: TextureButton ============= **Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Texture-based button. Supports Pressed, Hover, Disabled and Focused states. Description ----------- ``TextureButton`` has the same functionality as :ref:`Button`, except it uses sprites instead of Godot's :ref:`Theme` resource. It is faster to create, but it doesn't support localization like more complex :ref:`Control`\ s. The "normal" state must contain a texture (:ref:`texture_normal`); other textures are optional. See also :ref:`BaseButton` which contains common properties and methods associated with this node. Tutorials --------- - `3D Voxel Demo `__ Properties ---------- +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`flip_h` | ``false`` | +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`flip_v` | ``false`` | +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`ignore_texture_size` | ``false`` | +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`StretchMode` | :ref:`stretch_mode` | ``2`` | +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`BitMap` | :ref:`texture_click_mask` | | +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`Texture2D` | :ref:`texture_disabled` | | +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`Texture2D` | :ref:`texture_focused` | | +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`Texture2D` | :ref:`texture_hover` | | +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`Texture2D` | :ref:`texture_normal` | | +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`Texture2D` | :ref:`texture_pressed` | | +----------------------------------------------------+------------------------------------------------------------------------------+-----------+ Enumerations ------------ .. _enum_TextureButton_StretchMode: .. _class_TextureButton_constant_STRETCH_SCALE: .. _class_TextureButton_constant_STRETCH_TILE: .. _class_TextureButton_constant_STRETCH_KEEP: .. _class_TextureButton_constant_STRETCH_KEEP_CENTERED: .. _class_TextureButton_constant_STRETCH_KEEP_ASPECT: .. _class_TextureButton_constant_STRETCH_KEEP_ASPECT_CENTERED: .. _class_TextureButton_constant_STRETCH_KEEP_ASPECT_COVERED: enum **StretchMode**: - **STRETCH_SCALE** = **0** --- Scale to fit the node's bounding rectangle. - **STRETCH_TILE** = **1** --- Tile inside the node's bounding rectangle. - **STRETCH_KEEP** = **2** --- The texture keeps its original size and stays in the bounding rectangle's top-left corner. - **STRETCH_KEEP_CENTERED** = **3** --- The texture keeps its original size and stays centered in the node's bounding rectangle. - **STRETCH_KEEP_ASPECT** = **4** --- Scale the texture to fit the node's bounding rectangle, but maintain the texture's aspect ratio. - **STRETCH_KEEP_ASPECT_CENTERED** = **5** --- Scale the texture to fit the node's bounding rectangle, center it, and maintain its aspect ratio. - **STRETCH_KEEP_ASPECT_COVERED** = **6** --- Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits. Property Descriptions --------------------- .. _class_TextureButton_property_flip_h: - :ref:`bool` **flip_h** +-----------+-------------------+ | *Default* | ``false`` | +-----------+-------------------+ | *Setter* | set_flip_h(value) | +-----------+-------------------+ | *Getter* | is_flipped_h() | +-----------+-------------------+ If ``true``, texture is flipped horizontally. ---- .. _class_TextureButton_property_flip_v: - :ref:`bool` **flip_v** +-----------+-------------------+ | *Default* | ``false`` | +-----------+-------------------+ | *Setter* | set_flip_v(value) | +-----------+-------------------+ | *Getter* | is_flipped_v() | +-----------+-------------------+ If ``true``, texture is flipped vertically. ---- .. _class_TextureButton_property_ignore_texture_size: - :ref:`bool` **ignore_texture_size** +-----------+--------------------------------+ | *Default* | ``false`` | +-----------+--------------------------------+ | *Setter* | set_ignore_texture_size(value) | +-----------+--------------------------------+ | *Getter* | get_ignore_texture_size() | +-----------+--------------------------------+ If ``true``, the size of the texture won't be considered for minimum size calculation, so the ``TextureButton`` can be shrunk down past the texture size. ---- .. _class_TextureButton_property_stretch_mode: - :ref:`StretchMode` **stretch_mode** +-----------+-------------------------+ | *Default* | ``2`` | +-----------+-------------------------+ | *Setter* | set_stretch_mode(value) | +-----------+-------------------------+ | *Getter* | get_stretch_mode() | +-----------+-------------------------+ Controls the texture's behavior when you resize the node's bounding rectangle. See the :ref:`StretchMode` constants for available options. ---- .. _class_TextureButton_property_texture_click_mask: - :ref:`BitMap` **texture_click_mask** +----------+-----------------------+ | *Setter* | set_click_mask(value) | +----------+-----------------------+ | *Getter* | get_click_mask() | +----------+-----------------------+ Pure black and white :ref:`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. ---- .. _class_TextureButton_property_texture_disabled: - :ref:`Texture2D` **texture_disabled** +----------+-----------------------------+ | *Setter* | set_disabled_texture(value) | +----------+-----------------------------+ | *Getter* | get_disabled_texture() | +----------+-----------------------------+ Texture to display when the node is disabled. See :ref:`BaseButton.disabled`. ---- .. _class_TextureButton_property_texture_focused: - :ref:`Texture2D` **texture_focused** +----------+----------------------------+ | *Setter* | set_focused_texture(value) | +----------+----------------------------+ | *Getter* | get_focused_texture() | +----------+----------------------------+ Texture to display when the node has mouse or keyboard focus. :ref:`texture_focused` is displayed *over* the base texture, so a partially transparent texture should be used to ensure the base texture remains visible. A texture that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a fully transparent texture of any size. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons. ---- .. _class_TextureButton_property_texture_hover: - :ref:`Texture2D` **texture_hover** +----------+--------------------------+ | *Setter* | set_hover_texture(value) | +----------+--------------------------+ | *Getter* | get_hover_texture() | +----------+--------------------------+ Texture to display when the mouse hovers the node. ---- .. _class_TextureButton_property_texture_normal: - :ref:`Texture2D` **texture_normal** +----------+---------------------------+ | *Setter* | set_normal_texture(value) | +----------+---------------------------+ | *Getter* | get_normal_texture() | +----------+---------------------------+ Texture to display by default, when the node is **not** in the disabled, focused, hover or pressed state. ---- .. _class_TextureButton_property_texture_pressed: - :ref:`Texture2D` **texture_pressed** +----------+----------------------------+ | *Setter* | set_pressed_texture(value) | +----------+----------------------------+ | *Getter* | get_pressed_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 :ref:`BaseButton.shortcut` key. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`