Texture2D #

virtual const func _draw(transpose: bool) -> void#

Called 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.

virtual const func _draw_rect(transpose: bool) -> void#

Called 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.

virtual const func _draw_rect_region(clip_uv: bool) -> void#

Called 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.

virtual const func _get_height() -> int#

Called when the Texture2D's height is queried.

virtual const func _get_width() -> int#

Called when the Texture2D's width is queried.

virtual const func _has_alpha() -> bool#

Called when the presence of an alpha channel in the Texture2D is queried.

virtual const func _is_pixel_opaque(y: int) -> bool#

Called when a pixel's opaque state in the Texture2D is queried at the specified (x, y) position.

const func create_placeholder() -> Resource#

Creates a placeholder version of this resource (PlaceholderTexture2D).

const func draw(transpose: bool = false) -> void#

Draws the texture using a CanvasItem with the RenderingServer API at the specified position.

const func draw_rect(transpose: bool = false) -> void#

Draws the texture using a CanvasItem with the RenderingServer API.

const func draw_rect_region(clip_uv: bool = true) -> void#

Draws a part of the texture using a CanvasItem with the RenderingServer API.

const func get_height() -> int#

Returns the texture height in pixels.

const func get_image() -> Image#

Returns 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.

const func get_size() -> Vector2#

Returns the texture size in pixels.

const func get_width() -> int#

Returns the texture width in pixels.

const func has_alpha() -> bool#

Returns true if this Texture2D has an alpha channel.