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.
Checking the stable version of the documentation...
ViewportTexture
Hérite de : Texture2D < Texture < Resource < RefCounted < Object
Fournit le contenu d'un Viewport en tant que texture dynamique.
Description
A ViewportTexture provides the content of a Viewport as a dynamic Texture2D. This can be used to combine the rendering of Control, Node2D and Node3D nodes. For example, you can use this texture to display a 3D scene inside a TextureRect, or a 2D overlay in a Sprite3D.
To get a ViewportTexture in code, use the Viewport.get_texture() method on the target viewport.
Note: A ViewportTexture is always local to its scene (see Resource.resource_local_to_scene). If the scene root is not ready, it may return incorrect data (see Node.ready).
Note: Instantiating scenes containing a high-resolution ViewportTexture may cause noticeable stutter.
Note: When using a Viewport with Viewport.use_hdr_2d set to true, the returned texture will be an HDR image that uses linear encoding. This may look darker than normal when displayed directly on screen. To convert to nonlinear sRGB encoding, you can do the following:
img.convert(Image.FORMAT_RGBA8)
img.linear_to_srgb()
Note: Some nodes such as Decal, Light3D, and PointLight2D do not support using ViewportTexture directly. To use texture data from a ViewportTexture in these nodes, you need to create an ImageTexture by calling Texture2D.get_image() on the ViewportTexture and passing the result to ImageTexture.create_from_image(). This conversion is a slow operation, so it should not be performed every frame.
Tutoriels
Propriétés
|
Descriptions des propriétés
NodePath viewport_path = NodePath("") 🔗
Le chemin vers le nœud Viewport à afficher. Ceci est relatif à la racine de la scène locale (voir Resource.get_local_scene()), pas aux nœuds qui utilisent cette texture.
Note : Dans l'éditeur, ce chemin est automatiquement mis à jour lorsque le viewport cible ou l'un de ses ancêtres est renommé ou déplacé. Durant l'exécution, ce chemin peut ne pas être automatiquement mis à jour si la racine de la scène ne peut pas être trouvée.