2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-03-01 00:44:37 +00:00
<class name= "ViewportTexture" inherits= "Texture2D" version= "4.1" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 20:42:36 +00:00
<brief_description >
2018-06-17 18:31:17 +00:00
Texture which displays the content of a [Viewport].
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2020-02-12 08:59:06 +00:00
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.
2018-06-18 14:33:22 +00:00
To create a ViewportTexture in code, use the [method Viewport.get_texture] method on the target viewport.
2023-04-06 12:47:49 +00:00
[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 viewport textures will return incorrect data until the scene root is ready (see [signal Node.ready]).
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2020-10-01 08:34:47 +00:00
<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>
2017-09-12 20:42:36 +00:00
</tutorials>
<members >
2019-06-29 10:38:01 +00:00
<member name= "viewport_path" type= "NodePath" setter= "set_viewport_path_in_scene" getter= "get_viewport_path_in_scene" default= "NodePath("")" >
2018-06-17 18:31:17 +00:00
The path to the [Viewport] node to display. This is relative to the scene root, not to the node which uses the texture.
2017-09-12 20:42:36 +00:00
</member>
</members>
</class>