godot-docs/classes/class_viewportcontainer.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.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>`

Control for holding :ref:`Viewport<class_Viewport>`\ s.

Description
-----------

A :ref:`Container<class_Container>` node that holds a :ref:`Viewport<class_Viewport>`, automatically setting its size.

**Note:** Changing a ViewportContainer's :ref:`Control.rect_scale<class_Control_property_rect_scale>` will cause its contents to appear distorted. To change its visual size without causing distortion, adjust the node's margins instead (if it's not already in a container).

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``     |
+-------------------------+------------------------------------------------------------------------+-----------+

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()      |
+-----------+---------------------------+

Divides the viewport's effective resolution by this value while preserving its scale. This can be used to speed up rendering.

For example, a 1280×720 viewport with :ref:`stretch_shrink<class_ViewportContainer_property_stretch_shrink>` set to ``2`` will be rendered at 640×360 while occupying the same size in the container.

**Note:** :ref:`stretch<class_ViewportContainer_property_stretch>` must be ``true`` for this property to work.

.. |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.)`