mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
67 lines
3.2 KiB
ReStructuredText
67 lines
3.2 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ViewportTexture.xml.
|
|
|
|
.. _class_ViewportTexture:
|
|
|
|
ViewportTexture
|
|
===============
|
|
|
|
**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Texture which displays the content of a :ref:`Viewport<class_Viewport>`.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Displays the content of a :ref:`Viewport<class_Viewport>` node as a dynamic :ref:`Texture2D<class_Texture2D>`. This can be used to mix controls, 2D, and 3D elements in the same scene.
|
|
|
|
To create a ViewportTexture in code, use the :ref:`Viewport.get_texture<class_Viewport_method_get_texture>` method on the target viewport.
|
|
|
|
\ **Note:** When local to scene, this texture uses :ref:`Resource.setup_local_to_scene<class_Resource_method_setup_local_to_scene>` to set the proxy texture and flags in the local viewport.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- `GUI in 3D Demo <https://godotengine.org/asset-library/asset/127>`__
|
|
|
|
- `3D in 2D Demo <https://godotengine.org/asset-library/asset/128>`__
|
|
|
|
- `2D in 3D Demo <https://godotengine.org/asset-library/asset/129>`__
|
|
|
|
- `3D Viewport Scaling Demo <https://godotengine.org/asset-library/asset/586>`__
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------+--------------------------------------------------------------------+------------------+
|
|
| :ref:`NodePath<class_NodePath>` | :ref:`viewport_path<class_ViewportTexture_property_viewport_path>` | ``NodePath("")`` |
|
|
+---------------------------------+--------------------------------------------------------------------+------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_ViewportTexture_property_viewport_path:
|
|
|
|
- :ref:`NodePath<class_NodePath>` **viewport_path**
|
|
|
|
+-----------+-----------------------------------+
|
|
| *Default* | ``NodePath("")`` |
|
|
+-----------+-----------------------------------+
|
|
| *Setter* | set_viewport_path_in_scene(value) |
|
|
+-----------+-----------------------------------+
|
|
| *Getter* | get_viewport_path_in_scene() |
|
|
+-----------+-----------------------------------+
|
|
|
|
The path to the :ref:`Viewport<class_Viewport>` node to display. This is relative to the scene root, not to the node which uses the texture.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|