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.

Texture2D

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

Hérité par : AnimatedTexture, AtlasTexture, CameraTexture, CanvasTexture, CompressedTexture2D, CurveTexture, CurveXYZTexture, DPITexture, DrawableTexture2D, ExternalTexture, GradientTexture1D, GradientTexture2D, ImageTexture, MeshTexture, NoiseTexture2D, PlaceholderTexture2D, PortableCompressedTexture2D, Texture2DRD, ViewportTexture

Texture pour 2D et 3D.

Description

Une texture fonctionne en inscrivant une image dans le matériel vidéo, qui peut ensuite être utilisée dans des modèles 3D ou deSprite2D 2D ou des Control de GUI.

Les textures sont souvent créées en les chargeant depuis un fichier. Voir @GDScript.load().

Texture2D est une base pour d'autres ressources. Elle ne peut pas être utilisée directement.

Note : La taille maximale d'une texture est de 16384×16384 pixels en raison des limitations matérielles graphiques. Les textures plus grandes peuvent ne pas s'importer.

Méthodes

void

_draw(to_canvas_item: RID, pos: Vector2, modulate: Color, transpose: bool) virtual const

void

_draw_rect(to_canvas_item: RID, rect: Rect2, tile: bool, modulate: Color, transpose: bool) virtual const

void

_draw_rect_region(to_canvas_item: RID, rect: Rect2, src_rect: Rect2, modulate: Color, transpose: bool, clip_uv: bool) virtual const

Format

_get_format() virtual const

int

_get_height() virtual required const

Image

_get_image() virtual const

int

_get_mipmap_count() virtual const

int

_get_width() virtual required const

bool

_has_alpha() virtual const

bool

_has_mipmaps() virtual const

bool

_is_pixel_opaque(x: int, y: int) virtual const

Resource

create_placeholder() const

void

draw(canvas_item: RID, position: Vector2, modulate: Color = Color(1, 1, 1, 1), transpose: bool = false) const

void

draw_rect(canvas_item: RID, rect: Rect2, tile: bool, modulate: Color = Color(1, 1, 1, 1), transpose: bool = false) const

void

draw_rect_region(canvas_item: RID, rect: Rect2, src_rect: Rect2, modulate: Color = Color(1, 1, 1, 1), transpose: bool = false, clip_uv: bool = true) const

Format

get_format() const

int

get_height() const

Image

get_image() const

int

get_mipmap_count() const

Vector2

get_size() const

int

get_width() const

bool

has_alpha() const

bool

has_mipmaps() const


Descriptions des méthodes

void _draw(to_canvas_item: RID, pos: Vector2, modulate: Color, transpose: bool) virtual const 🔗

Appelée lorsque la Texture2D entière est demandée à être dessinée sur un CanvasItem, avec le décalage supérieur gauche spécifié dans pos. modulate spécifie un multiplicateur pour les couleurs dessinées, tandis que transpose spécifie si le dessin doit être effectué dans l'ordre des colonnes plutôt que dans l'ordre des lignes (résultant en une rotation de 90 degrés).

Note : Ceci est seulement utilisé dans le rendu 2D, pas 3D.


void _draw_rect(to_canvas_item: RID, rect: Rect2, tile: bool, modulate: Color, transpose: bool) virtual const 🔗

Appelée lorsque la Texture2D est demandée à être dessinée sur le rect spécifié d'un CanvasItem. modulate spécifie un multiplicateur pour les couleurs dessinées, tandis que transpose spécifie si le dessin doit être effectué dans l'ordre des colonnes plutôt que dans l'ordre des lignes (résultant en une rotation de 90 degrés).

Note : Ceci est seulement utilisé dans le rendu 2D, pas 3D.


void _draw_rect_region(to_canvas_item: RID, rect: Rect2, src_rect: Rect2, modulate: Color, transpose: bool, clip_uv: bool) virtual const 🔗

Appelée lorsque une partie de la Texture2D spécifiée par les coordonnées de src_rect est demandée à être dessinée sur le rect spécifié d'un CanvasItem. modulate spécifie un multiplicateur pour les couleurs dessinées, tandis que transpose spécifie si le dessin doit être effectué dans l'ordre des colonnes plutôt que dans l'ordre des lignes (résultant en une rotation de 90 degrés).

Note : Ceci est seulement utilisé dans le rendu 2D, pas 3D.


Format _get_format() virtual const 🔗

Called when get_format() is called.


int _get_height() virtual required const 🔗

Appelée quand la hauteur de la Texture2D est demandée.


Image _get_image() virtual const 🔗

Called when get_image() is called.


int _get_mipmap_count() virtual const 🔗

Called when get_mipmap_count() is called.


int _get_width() virtual required const 🔗

Appelée quand la largeur de la Texture2D est demandée.


bool _has_alpha() virtual const 🔗

Appelée lorsque la présence d'un canal alpha dans la Texture2D est demandé.


bool _has_mipmaps() virtual const 🔗

Called when has_mipmaps() is called.


bool _is_pixel_opaque(x: int, y: int) virtual const 🔗

Appelée lorsque l'état d'opacité d'un pixel dans la Texture2D est demandé à la position (x, y) spécifiée.


Resource create_placeholder() const 🔗

Crée une version placeholder de cette ressource (PlaceholderTexture2D).


void draw(canvas_item: RID, position: Vector2, modulate: Color = Color(1, 1, 1, 1), transpose: bool = false) const 🔗

Dessine la texture en utilisant un CanvasItem avec l'API RenderingServer à la position spécifiée.


void draw_rect(canvas_item: RID, rect: Rect2, tile: bool, modulate: Color = Color(1, 1, 1, 1), transpose: bool = false) const 🔗

Dessine la texture en utilisant un CanvasItem avec l'API RenderingServer.


void draw_rect_region(canvas_item: RID, rect: Rect2, src_rect: Rect2, modulate: Color = Color(1, 1, 1, 1), transpose: bool = false, clip_uv: bool = true) const 🔗

Dessine une partie de la texture en utilisant un CanvasItem avec l'API RenderingServer.


Format get_format() const 🔗

Returns the image format of the texture.


int get_height() const 🔗

Renvoie la hauteur de la texture en pixels.


Image get_image() const 🔗

Renvoie une Image qui est une copie des données de cette Texture2D (une nouvelle Image est créée à chaque fois). Les Images peuvent être accédées et manipulées directement.

Note : Cela renverra null si cette Texture2D est invalide.

Note : Cela récupérera les données de texture du GPU, ce qui pourrait causer des problèmes de performance lorsque surutilisé. Évitez d'appeler get_image() à chaque trame, en particulier sur de grandes textures.


int get_mipmap_count() const 🔗

Returns the number of mipmaps of the texture.


Vector2 get_size() const 🔗

Renvoie la taille de la texture en pixels.


int get_width() const 🔗

Renvoie la largeur de texture en pixels.


bool has_alpha() const 🔗

Renvoie true si cette Texture2D a un canal alpha.


bool has_mipmaps() const 🔗

Returns true if the texture has mipmaps.