ImageTexture¶

Inherits: Texture < Resource < Reference < Object

Description¶

A Texture based on an Image. For an image to be displayed, an ImageTexture has to be created from it using the create_from_image method:

var texture = ImageTexture.new()
var image = Image.new()
image.load("res://icon.png")
texture.create_from_image(image)
$Sprite.texture = texture

This way, textures can be created at run-time by loading images both from within the editor and externally.

Warning: Prefer to load imported textures with @GDScript.load over loading them from within the filesystem dynamically with Image.load, as it may not work in exported projects:

var texture = load("res://icon.png")
$Sprite.texture = texture

This is because images have to be imported as StreamTexture first to be loaded with @GDScript.load. If you'd still like to load an image file just like any other Resource, import it as an Image resource instead, and then load it normally using the @GDScript.load method.

But do note that the image data can still be retrieved from an imported texture as well using the Texture.get_data method, which returns a copy of the data:

var texture = load("res://icon.png")
var image : Image = texture.get_data()

An ImageTexture is not meant to be operated from within the editor interface directly, and is mostly useful for rendering images on screen dynamically via code. If you need to generate images procedurally from within the editor, consider saving and importing images as custom texture resources implementing a new EditorImportPlugin.

Note: The maximum texture size is 16384×16384 pixels due to graphics hardware limitations.

Note: Mipmap generation can fail with some graphics drivers (especially on Android), resulting in black textures. In these cases, consider either calling Image.generate_mipmaps, or creating an ImageTexture without Texture.FLAG_MIPMAPS.

Tutorials¶

Importing images

Properties¶

int	flags	`7` (overrides Texture)
float	lossy_quality	`0.7`
Storage	storage	`0`

Methods¶

void	create ( int width, int height, Format format, int flags=7 )
void	create_from_image ( Image image, int flags=7 )
Format	get_format ( ) const
Error	load ( String path )
void	set_data ( Image image )
void	set_size_override ( Vector2 size )

Enumerations¶

enum Storage:

Storage STORAGE_RAW = 0

Image data is stored raw and unaltered.

Storage STORAGE_COMPRESS_LOSSY = 1

Image data is compressed with a lossy algorithm. You can set the storage quality with lossy_quality.

Storage STORAGE_COMPRESS_LOSSLESS = 2

Image data is compressed with a lossless algorithm.

Property Descriptions¶

float lossy_quality = 0.7

void set_lossy_storage_quality ( float value )
float get_lossy_storage_quality ( )

The storage quality for STORAGE_COMPRESS_LOSSY.

Storage storage = 0

void set_storage ( Storage value )
Storage get_storage ( )

The storage type (raw, lossy, or compressed).

Method Descriptions¶

void create ( int width, int height, Format format, int flags=7 )

Create a new ImageTexture with width and height.

format is a value from Format, flags is any combination of Flags.

void create_from_image ( Image image, int flags=7 )

Initializes the texture by allocating and setting the data from an Image with flags from Flags. An sRGB to linear color space conversion can take place, according to Format.

Format get_format ( ) const

Returns the format of the texture, one of Format.

Error load ( String path )

Loads an image from a file path and creates a texture from it.

Note: This method is deprecated and will be removed in Redot 4.0, use Image.load and create_from_image instead.

void set_data ( Image image )

Replaces the texture's data with a new Image.

Note: The texture has to be initialized first with the create_from_image method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration, otherwise it has to be re-created with the create_from_image method.

Use this method over create_from_image if you need to update the texture frequently, which is faster than allocating additional memory for a new texture each time.

void set_size_override ( Vector2 size )

Resizes the texture to the specified dimensions.