SubViewport

Hérite de : Viewport < Node < Object

Une interface vers un monde de jeu qui ne crée pas de fenêtre ou ne dessine pas directement à l'écran.

Description

SubViewport isole une région rectangulaire d'une scène à afficher indépendamment. Cela peut être utilisé, par exemple, pour afficher l'interface utilisateur dans l'espace 3D.

Note : SubViewport est un Viewport qui n'est pas une Window, c'est-à-dire qu'il ne dessine rien par lui-même. Pour afficher quoi que ce soit, SubViewport doit avoir une taille non nulle et être placé à l'intérieur d'un SubViewportContainer ou assigné à une ViewportTexture.

Note : Les InputEvent ne sont pas transmis à un SubViewport autonome par défaut. Pour assurer la propagation des InputEvent, un SubViewport peut être placé à l'intérieur d'un SubViewportContainer.

Tutoriels

Propriétés

ClearMode	render_target_clear_mode	`0`
UpdateMode	render_target_update_mode	`2`
Vector2i	size	`Vector2i(512, 512)`
Vector2i	size_2d_override	`Vector2i(0, 0)`
bool	size_2d_override_stretch	`false`

Énumérations

enum ClearMode: 🔗

ClearMode CLEAR_MODE_ALWAYS = 0

Toujours effacer la cible de rendu avant d'y dessiner.

ClearMode CLEAR_MODE_NEVER = 1

Ne jamais nettoyer la cible de rendu.

ClearMode CLEAR_MODE_ONCE = 2

Vider la cible de rendu pour la trame suivante, puis passer en CLEAR_MODE_NEVER.

enum UpdateMode: 🔗

UpdateMode UPDATE_DISABLED = 0

Ne pas mettre à jour la cible de rendu.

UpdateMode UPDATE_ONCE = 1

Mettre à jour la cible de rendu une seule fois, puis passer en mode UPDATE_DISABLED.

UpdateMode UPDATE_WHEN_VISIBLE = 2

Mettre à jour la cible de rendu seulement quand elle est visible. Il s'agit de la valeur par défaut.

UpdateMode UPDATE_WHEN_PARENT_VISIBLE = 3

Mettre à jour la cible de rendu seulement quand son parent est visible.

UpdateMode UPDATE_ALWAYS = 4

Mettre toujours à jour la cible de rendu.

Descriptions des propriétés

ClearMode render_target_clear_mode = 0 🔗

void set_clear_mode(value: ClearMode)
ClearMode get_clear_mode()

Le mode de nettoyage quand le sub-viewport est utilisé comme cible de rendu.

Note : Cette propriété est destinée à une utilisation 2D.

UpdateMode render_target_update_mode = 2 🔗

void set_update_mode(value: UpdateMode)
UpdateMode get_update_mode()

Le mode de mise à jour lorsque le sub-viewport est utilisé comme cible de rendu.

Vector2i size = Vector2i(512, 512) 🔗

void set_size(value: Vector2i)
Vector2i get_size()

La largeur et la hauteur du sub-viewport. Doit être défini à une valeur supérieure ou égale à 2 pixels dans les deux dimensions. Sinon, rien ne sera affiché.

Note : Si le nœud parent est un SubViewportContainer et son SubViewportContainer.stretch vaut true, la taille du viewport ne peut pas être modifiée manuellement.

Vector2i size_2d_override = Vector2i(0, 0) 🔗

void set_size_2d_override(value: Vector2i)
Vector2i get_size_2d_override()

La redéfinition de la taille 2D du sub-viewport. Si la largeur ou la hauteur vaut 0, la redéfinition est désactivée.

bool size_2d_override_stretch = false 🔗

void set_size_2d_override_stretch(value: bool)
bool is_size_2d_override_stretch_enabled()

Si true, la redéfinition de la taille 2D affecte également l'étirement.