23 lines
1.5 KiB
XML
23 lines
1.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="ViewportTexture" inherits="Texture2D" version="4.0" 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>
|
|
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 [method Viewport.get_texture] method on the target viewport.
|
|
[b]Note:[/b] When local to scene, this texture uses [method Resource.setup_local_to_scene] to set the proxy texture and flags in the local viewport. Local to scene [ViewportTexture]s will return incorrect data until the scene root is ready (see [signal Node.ready]).
|
|
</description>
|
|
<tutorials>
|
|
<link title="GUI in 3D Demo">https://godotengine.org/asset-library/asset/127</link>
|
|
<link title="3D in 2D Demo">https://godotengine.org/asset-library/asset/128</link>
|
|
<link title="2D in 3D Demo">https://godotengine.org/asset-library/asset/129</link>
|
|
<link title="3D Viewport Scaling Demo">https://godotengine.org/asset-library/asset/586</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 scene root, not to the node that uses the texture.
|
|
</member>
|
|
</members>
|
|
</class>
|