TextureRect¶
Inherits: Control < CanvasItem < Node < 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 stretch_mode property. It can scale, tile, or stay centered inside its bounding rectangle.
Tutorials¶
Properties¶
|
||
|
||
|
||
mouse_filter |
|
|
|
||
Enumerations¶
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¶
bool flip_h
Default |
|
Setter |
set_flip_h(value) |
Getter |
is_flipped_h() |
If true
, texture is flipped horizontally.
bool flip_v
Default |
|
Setter |
set_flip_v(value) |
Getter |
is_flipped_v() |
If true
, texture is flipped vertically.
bool ignore_texture_size
Default |
|
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 TextureRect
can be shrunk down past the texture size. Useful for preventing TextureRect
s from breaking GUI layout regardless of their texture size.
StretchMode stretch_mode
Default |
|
Setter |
set_stretch_mode(value) |
Getter |
get_stretch_mode() |
Controls the texture's behavior when resizing the node's bounding rectangle. See StretchMode.
Texture2D texture
Setter |
set_texture(value) |
Getter |
get_texture() |
The node's Texture2D resource.