ViewportTexture

继承： Texture2D < Texture < Resource < RefCounted < Object

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

描述

以动态 Texture2D 的形式提供 Viewport 的内容。可用于在同一场景中混合 Control、Node2D 和 Node3D。例如可以使用这种纹理在 TextureRect 中显示 3D 场景，也可以在 Sprite3D 中显示 2D 覆盖层。

要在代码中获取 ViewportTexture，请在目标视口上使用 Viewport.get_texture 方法。

注意：**ViewportTexture** 始终是局部于其场景的（见 Resource.resource_local_to_scene）。如果该场景的根节点尚未就绪，可能会返回不正确的数据（见 Node.ready）。

注意：实例化包含高分辨率 ViewportTexture 的场景可能引起显著的卡顿。

教程

• 3D 视口中的 GUI 演示

• 2D 视口中的 3D 演示

• 3D 视口中的 2D 演示

• 3D 分辨率缩放演示

属性

属性说明

NodePath viewport_path = NodePath("") 🔗

• void set_viewport_path_in_scene(value: NodePath)

• NodePath get_viewport_path_in_scene()

要显示的 Viewport 节点的路径。相对于本地场景的根节点（见 Resource.get_local_scene），并非相对于使用该纹理的节点。

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