summaryrefslogtreecommitdiff
path: root/doc/classes/ViewportTexture.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ViewportTexture.xml')
-rw-r--r--doc/classes/ViewportTexture.xml4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/ViewportTexture.xml b/doc/classes/ViewportTexture.xml
index 83ffc6bcfd..67f1e09c75 100644
--- a/doc/classes/ViewportTexture.xml
+++ b/doc/classes/ViewportTexture.xml
@@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ViewportTexture" inherits="Texture" category="Core" version="3.1">
<brief_description>
+ Texture which displays the content of a [Viewport].
</brief_description>
<description>
+ Displays the content of a [Viewport] node as a dynamic [Texture]. This can be used to mix controls, 2D, and 3D elements in the same scene.
+ To create a ViewportTexture in code, use the [method Viewport.get_texture] method on the target viewport.
</description>
<tutorials>
</tutorials>
@@ -12,6 +15,7 @@
</methods>
<members>
<member name="viewport_path" type="NodePath" setter="set_viewport_path_in_scene" getter="get_viewport_path_in_scene">
+ The path to the [Viewport] node to display. This is relative to the scene root, not to the node which uses the texture.
</member>
</members>
<constants>