ViewportTexture

Inherits: Texture2D < Texture < Resource < RefCounted < Object

Texture which displays the content of a Viewport.

Description

Displays the content of a Viewport node as a dynamic Texture2D. This can be used to mix controls, 2D, and 3D elements in the same scene.

To create a ViewportTexture in code, use the Viewport.get_texture method on the target viewport.

Tutorials

• GUI in 3D Demo

• 3D in 2D Demo

• 2D in 3D Demo

• 3D Viewport Scaling Demo

Properties

bool	resource_local_to_scene	true (overrides Resource)
NodePath	viewport_path	NodePath("")

Property Descriptions

• NodePath viewport_path

Default	NodePath("")
Setter	set_viewport_path_in_scene(value)
Getter	get_viewport_path_in_scene()

The path to the Viewport node to display. This is relative to the scene root, not to the node which uses the texture.