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.

ViewportTexture

Inherits: Texture2D < Texture < Resource < RefCounted < Object

以动态纹理的形式提供 Viewport 的内容。

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

NodePath

viewport_path

NodePath("")


Property Descriptions

NodePath viewport_path = NodePath("")

  • void set_viewport_path_in_scene ( NodePath value )

  • NodePath get_viewport_path_in_scene ( )

要显示的 Viewport 节点的路径。相对于场景的根节点,而不是使用纹理的节点。

注意:在编辑器中,目标视口或其祖级节点发生重命名或移动时会自动更新这个路径。在运行时,该路径可能无法自动更新,因为无法确定场景的根节点。