Class reference
Texture2D
Inherits Texture
Texture for 2D and 3D.
Description
A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D Sprite2D or GUI Control. Textures are often created by loading them from a file. See @GDScript.load(). Texture2D is a base for other resources. It cannot be used directly. Note: The maximum texture size is 16384×16384 pixels due to graphics hardware limitations. Larger textures may fail to import.
Methods
void _draw(RID to_canvas_item, Vector2 pos, Color modulate, bool transpose) virtual const
RID to_canvas_item, Vector2 pos, Color modulate, bool transpose) virtual constCalled when the entire Texture2D is requested to be drawn over a CanvasItem, with the top-left offset specified in pos. modulate specifies a multiplier for the colors being drawn, while transpose specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). Note: This is only used in 2D rendering, not 3D.
void _draw_rect(RID to_canvas_item, Rect2 rect, bool tile, Color modulate, bool transpose) virtual const
RID to_canvas_item, Rect2 rect, bool tile, Color modulate, bool transpose) virtual constCalled when the Texture2D is requested to be drawn onto CanvasItem's specified rect. modulate specifies a multiplier for the colors being drawn, while transpose specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). Note: This is only used in 2D rendering, not 3D.
void _draw_rect_region(RID to_canvas_item, Rect2 rect, Rect2 src_rect, Color modulate, bool transpose, bool clip_uv) virtual const
RID to_canvas_item, Rect2 rect, Rect2 src_rect, Color modulate, bool transpose, bool clip_uv) virtual constCalled when a part of the Texture2D specified by src_rect's coordinates is requested to be drawn onto CanvasItem's specified rect. modulate specifies a multiplier for the colors being drawn, while transpose specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). Note: This is only used in 2D rendering, not 3D.
int _get_height() virtual required const
int _get_height() virtual required constCalled when the Texture2D's height is queried.
int _get_width() virtual required const
int _get_width() virtual required constCalled when the Texture2D's width is queried.
bool _has_alpha() virtual const
bool _has_alpha() virtual constCalled when the presence of an alpha channel in the Texture2D is queried.
bool _is_pixel_opaque(int x, int y) virtual const
bool _is_pixel_opaque(int x, int y) virtual constCalled when a pixel's opaque state in the Texture2D is queried at the specified (x, y) position.
Resource create_placeholder() const
Resource create_placeholder() constCreates a placeholder version of this resource (PlaceholderTexture2D).
void draw(RID canvas_item, Vector2 position, Color modulate = Color(1, 1, 1, 1), bool transpose = false) const
RID canvas_item, Vector2 position, Color modulate = Color(1, 1, 1, 1), bool transpose = false) constDraws the texture using a CanvasItem with the RenderingServer API at the specified position.
void draw_rect(RID canvas_item, Rect2 rect, bool tile, Color modulate = Color(1, 1, 1, 1), bool transpose = false) const
RID canvas_item, Rect2 rect, bool tile, Color modulate = Color(1, 1, 1, 1), bool transpose = false) constDraws the texture using a CanvasItem with the RenderingServer API.
void draw_rect_region(RID canvas_item, Rect2 rect, Rect2 src_rect, Color modulate = Color(1, 1, 1, 1), bool transpose = false, bool clip_uv = true) const
RID canvas_item, Rect2 rect, Rect2 src_rect, Color modulate = Color(1, 1, 1, 1), bool transpose = false, bool clip_uv = true) constDraws a part of the texture using a CanvasItem with the RenderingServer API.
int get_height() const
int get_height() constReturns the texture height in pixels.
Image get_image() const
Image get_image() constReturns an Image that is a copy of data from this Texture2D (a new Image is created each time). Images can be accessed and manipulated directly. Note: This will return null if this Texture2D is invalid. Note: This will fetch the texture data from the GPU, which might cause performance problems when overused. Avoid calling get_image() every frame, especially on large textures.
Vector2 get_size() const
Vector2 get_size() constReturns the texture size in pixels.
int get_width() const
int get_width() constReturns the texture width in pixels.
bool has_alpha() const
bool has_alpha() constReturns true if this Texture2D has an alpha channel.