mirror of
https://github.com/godotengine/godot.git
synced 2024-12-09 10:09:20 +08:00
25 lines
2.0 KiB
XML
25 lines
2.0 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="ViewportTexture" inherits="Texture2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Provides the content of a [Viewport] as a dynamic texture.
|
|
</brief_description>
|
|
<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 [method Viewport.get_texture] method on the target viewport.
|
|
[b]Note:[/b] A [ViewportTexture] is always local to its scene (see [member Resource.resource_local_to_scene]). If the scene root is not ready, it may return incorrect data (see [signal Node.ready]).
|
|
[b]Note:[/b] Instantiating scenes containing a high-resolution [ViewportTexture] may cause noticeable stutter.
|
|
</description>
|
|
<tutorials>
|
|
<link title="GUI in 3D Viewport Demo">https://godotengine.org/asset-library/asset/2807</link>
|
|
<link title="3D in 2D Viewport Demo">https://godotengine.org/asset-library/asset/2804</link>
|
|
<link title="2D in 3D Viewport Demo">https://godotengine.org/asset-library/asset/2803</link>
|
|
<link title="3D Resolution Scaling Demo">https://godotengine.org/asset-library/asset/2805</link>
|
|
</tutorials>
|
|
<members>
|
|
<member name="viewport_path" type="NodePath" setter="set_viewport_path_in_scene" getter="get_viewport_path_in_scene" default="NodePath("")">
|
|
The path to the [Viewport] node to display. This is relative to the local scene root (see [method Resource.get_local_scene]), [b]not[/b] to the nodes that use this texture.
|
|
[b]Note:[/b] In the editor, this path is automatically updated when the target viewport or one of its ancestors is renamed or moved. At runtime, this path may not automatically update if the scene root cannot be found.
|
|
</member>
|
|
</members>
|
|
</class>
|