Files
godot-docs/classes/class_viewportcontainer.rst
2019-01-07 10:14:12 +01:00

58 lines
1.9 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ViewportContainer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ViewportContainer:
ViewportContainer
=================
**Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Control for holding :ref:`Viewport<class_Viewport>`\ s.
Properties
----------
+-------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`stretch<class_ViewportContainer_property_stretch>` |
+-------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`stretch_shrink<class_ViewportContainer_property_stretch_shrink>` |
+-------------------------+------------------------------------------------------------------------+
Description
-----------
A :ref:`Container<class_Container>` node that holds a :ref:`Viewport<class_Viewport>`, automatically setting its size.
Property Descriptions
---------------------
.. _class_ViewportContainer_property_stretch:
- :ref:`bool<class_bool>` **stretch**
+----------+----------------------+
| *Setter* | set_stretch(value) |
+----------+----------------------+
| *Getter* | is_stretch_enabled() |
+----------+----------------------+
If ``true``, the viewport will be scaled to the control's size. Default value:``false``.
.. _class_ViewportContainer_property_stretch_shrink:
- :ref:`int<class_int>` **stretch_shrink**
+----------+---------------------------+
| *Setter* | set_stretch_shrink(value) |
+----------+---------------------------+
| *Getter* | get_stretch_shrink() |
+----------+---------------------------+