Up to date
This page is up to date for Godot 4.2
.
If you still find outdated information, please open an issue.
ViewportTexture¶
Inherits: Texture2D < Texture < Resource < RefCounted < Object
Provides the content of a Viewport as a dynamic texture.
Description¶
Provides the content of a Viewport as a dynamic Texture2D. This can be used to mix controls, 2D game objects, and 3D game objects in the same scene.
To create 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).
Tutorials¶
Properties¶
|
Property Descriptions¶
NodePath viewport_path = NodePath("")
The path to the Viewport node to display. This is relative to the scene root, not to the node that uses the texture.
Note: In the editor, this path is automatically updated when the target viewport or one of its ancestors is renamed or moved. At runtime, the path may not be able to automatically update due to the inability to determine the scene root.