Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

ImageTexture

Hérite de : Texture2D < Texture < Resource < RefCounted < Object

Une Texture2D basée sur une Image.

Description

Une Texture2D basée sur une Image. Pour qu'une image soit affichée, une ImageTexture doit être créée avec la méthode create_from_image() :

var image = Image.load_from_file("res://icon.svg")
var texture = ImageTexture.create_from_image(image)
$Sprite2D.texture = texture

De cette façon, les textures peuvent être créées durant l'exécution en chargent les images à la fois depuis l'éditeur et de manière externe.

Avertissement : Préférez charger les texture importées avec @GDScript.load() plutôt que dynamiquement depuis le système de fichier avec Image.load(), car cela peut ne pas fonctionner dans des projets exportés :

var texture = load("res://icon.svg")
$Sprite2D.texture = texture

C'est parce que les images doivent d'abord être importées en tant que CompressedTexture2D d'abord pour être chargées avec @GDScript.load(). Si vous préférez charger un fichier image comme n'importe quelle Resource, importez-la comme une ressource Image, et ensuite chargez-la normalement avec la méthode @GDScript.load().

Note : L'image peut toujours être récupérée à partir d'une texture importée avec la méthode Texture2D.get_image(), qui renvoie une copie des données de l'image :

var texture = load("res://icon.svg")
var image = texture.get_image()

Une ImageTexture n'est pas prévue pour être opérée directement depuis l'interface de l'éditeur, et est principalement utilisée pour rendre des images à l'écran de manière dynamique depuis du code. Si vous devez générer des images de manière procédurale depuis l'éditeur, préférez enregistrer puis importer des imanges sous forme de texture personnalisée en implémentant un nouveau EditorImportPlugin.

Note : La taille maximale de texture est de 16384×16384 pixels à cause des limitations des matériels graphiques.

Tutoriels

Propriétés

bool

resource_local_to_scene

false (overrides Resource)

Méthodes

ImageTexture

create_from_image(image: Image) static

void

set_image(image: Image)

void

set_size_override(size: Vector2i)

void

update(image: Image)


Descriptions des méthodes

ImageTexture create_from_image(image: Image) static 🔗

Crée une nouvelle ImageTexture et l'initialise en allouant et en définissant les données depuis une Image.


void set_image(image: Image) 🔗

Remplace les données de la texture par une nouvelle Image. Cela réattribuera de la nouvelle mémoire pour la texture.

Si vous voulez mettre à jour l'image, mais n'avez pas besoin de changer ses paramètres (format, taille), utilisez update() à la place pour de meilleures performances.


void set_size_override(size: Vector2i) 🔗

Redimensionne la texture aux dimensions spécifiées.


void update(image: Image) 🔗

Remplacer les données de la texture par une nouvelle Image.

Note : La texture doit être créée en utilisant create_from_image() ou initialisée en premier avec la méthode set_image() avant qu'elle puisse être mise à jour. Les nouvelles dimensions, format et configuration des mipmaps doivent correspondre à la configuration de l'image de la texture existante.

Utilisez cette méthode au lieu de set_image() si vous devez mettre à jour la texture fréquemment, car elle est plus rapide qu'allouer de la mémoire supplémentaire pour une nouvelle texture à chaque fois.