Skip to content

Latest commit

 

History

History
155 lines (101 loc) · 6 KB

class_texturerect.rst

File metadata and controls

155 lines (101 loc) · 6 KB
github_url:hide

TextureRect

Inherits: :ref:`Control<class_Control>` < :ref:`CanvasItem<class_CanvasItem>` < :ref:`Node<class_Node>` < :ref:`Object<class_Object>`

Control for drawing textures.

Description

Used to draw icons and sprites in a user interface. The texture's placement can be controlled with the :ref:`stretch_mode<class_TextureRect_property_stretch_mode>` property. It can scale, tile, or stay centered inside its bounding rectangle.

Properties

:ref:`bool<class_bool>` :ref:`expand<class_TextureRect_property_expand>` false
:ref:`bool<class_bool>` :ref:`flip_h<class_TextureRect_property_flip_h>` false
:ref:`bool<class_bool>` :ref:`flip_v<class_TextureRect_property_flip_v>` false
:ref:`MouseFilter<enum_Control_MouseFilter>` mouse_filter O: 1
:ref:`StretchMode<enum_TextureRect_StretchMode>` :ref:`stretch_mode<class_TextureRect_property_stretch_mode>` 0
:ref:`Texture2D<class_Texture2D>` :ref:`texture<class_TextureRect_property_texture>`  

Enumerations

enum StretchMode:

  • STRETCH_SCALE_ON_EXPAND = 0 --- Scale to fit the node's bounding rectangle, only if expand is true. Default stretch_mode, for backwards compatibility. Until you set expand to true, the texture will behave like :ref:`STRETCH_KEEP<class_TextureRect_constant_STRETCH_KEEP>`.
  • STRETCH_SCALE = 1 --- Scale to fit the node's bounding rectangle.
  • STRETCH_TILE = 2 --- Tile inside the node's bounding rectangle.
  • STRETCH_KEEP = 3 --- The texture keeps its original size and stays in the bounding rectangle's top-left corner.
  • STRETCH_KEEP_CENTERED = 4 --- The texture keeps its original size and stays centered in the node's bounding rectangle.
  • STRETCH_KEEP_ASPECT = 5 --- Scale the texture to fit the node's bounding rectangle, but maintain the texture's aspect ratio.
  • STRETCH_KEEP_ASPECT_CENTERED = 6 --- Scale the texture to fit the node's bounding rectangle, center it and maintain its aspect ratio.
  • STRETCH_KEEP_ASPECT_COVERED = 7 --- Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits.

Property Descriptions

Default false
Setter set_expand(value)
Getter has_expand()

If true, the texture scales to fit its bounding rectangle.

Default false
Setter set_flip_h(value)
Getter is_flipped_h()

If true, texture is flipped horizontally.

Default false
Setter set_flip_v(value)
Getter is_flipped_v()

If true, texture is flipped vertically.

Default 0
Setter set_stretch_mode(value)
Getter get_stretch_mode()

Controls the texture's behavior when resizing the node's bounding rectangle. See :ref:`StretchMode<enum_TextureRect_StretchMode>`.

Setter set_texture(value)
Getter get_texture()

The node's :ref:`Texture2D<class_Texture2D>` resource.