:github_url: hide

.. 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>`               | false |
+-------------------------+------------------------------------------------------------------------+-------+
| :ref:`int<class_int>`   | :ref:`stretch_shrink<class_ViewportContainer_property_stretch_shrink>` | 1     |
+-------------------------+------------------------------------------------------------------------+-------+

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**

+-----------+----------------------+
| *Default* | false                |
+-----------+----------------------+
| *Setter*  | set_stretch(value)   |
+-----------+----------------------+
| *Getter*  | is_stretch_enabled() |
+-----------+----------------------+

If ``true``, the viewport will be scaled to the control's size.

.. _class_ViewportContainer_property_stretch_shrink:

- :ref:`int<class_int>` **stretch_shrink**

+-----------+---------------------------+
| *Default* | 1                         |
+-----------+---------------------------+
| *Setter*  | set_stretch_shrink(value) |
+-----------+---------------------------+
| *Getter*  | get_stretch_shrink()      |
+-----------+---------------------------+