Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: f26bdbbcd4
Branches Tags
godot-docs
/
classes
/
class_viewporttexture.rst

class_viewporttexture.rst 2.2 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the ViewportTexture.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_ViewportTexture:
    8. 

  8. 

  9. ViewportTexture
    10. 

  10. ===============
    11. 

  11. 

  12. **Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Texture which displays the content of a :ref:`Viewport<class_Viewport>`.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. 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.
    20. 

  20. 

  21. To create a ViewportTexture in code, use the :ref:`Viewport.get_texture<class_Viewport_method_get_texture>` method on the target viewport.
    22. 

  22. 

  23. Properties
    24. 

  24. ----------
    25. 

  25. 

  26. +---------------------------------+--------------------------------------------------------------------+------------------+
    27. 

  27. | :ref:`bool<class_bool>`         | resource_local_to_scene                                            | **O:** ``true``  |
    28. 

  28. +---------------------------------+--------------------------------------------------------------------+------------------+
    29. 

  29. | :ref:`NodePath<class_NodePath>` | :ref:`viewport_path<class_ViewportTexture_property_viewport_path>` | ``NodePath("")`` |
    30. 

  30. +---------------------------------+--------------------------------------------------------------------+------------------+
    31. 

  31. 

  32. Property Descriptions
    33. 

  33. ---------------------
    34. 

  34. 

  35. .. _class_ViewportTexture_property_viewport_path:
    36. 

  36. 

  37. - :ref:`NodePath<class_NodePath>` **viewport_path**
    38. 

  38. 

  39. +-----------+-----------------------------------+
    40. 

  40. | *Default* | ``NodePath("")``                  |
    41. 

  41. +-----------+-----------------------------------+
    42. 

  42. | *Setter*  | set_viewport_path_in_scene(value) |
    43. 

  43. +-----------+-----------------------------------+
    44. 

  44. | *Getter*  | get_viewport_path_in_scene()      |
    45. 

  45. +-----------+-----------------------------------+
    46. 

  46. 

  47. 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.
    48. 

  48.