.. 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/docs/gdscript/doc/classes/SubViewport.xml. .. _class_SubViewport: SubViewport =========== **Inherits:** :ref:`Viewport` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +------------------------------------------------+----------------------------------------------------------------------------------------+------------------------+ | :ref:`ClearMode` | :ref:`render_target_clear_mode` | ``0`` | +------------------------------------------------+----------------------------------------------------------------------------------------+------------------------+ | :ref:`UpdateMode` | :ref:`render_target_update_mode` | ``2`` | +------------------------------------------------+----------------------------------------------------------------------------------------+------------------------+ | :ref:`Vector2i` | :ref:`size` | ``Vector2i(512, 512)`` | +------------------------------------------------+----------------------------------------------------------------------------------------+------------------------+ | :ref:`Vector2i` | :ref:`size_2d_override` | ``Vector2i(0, 0)`` | +------------------------------------------------+----------------------------------------------------------------------------------------+------------------------+ | :ref:`bool` | :ref:`size_2d_override_stretch` | ``false`` | +------------------------------------------------+----------------------------------------------------------------------------------------+------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_SubViewport_ClearMode: .. rst-class:: classref-enumeration enum **ClearMode**: .. _class_SubViewport_constant_CLEAR_MODE_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`ClearMode` **CLEAR_MODE_ALWAYS** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SubViewport_constant_CLEAR_MODE_NEVER: .. rst-class:: classref-enumeration-constant :ref:`ClearMode` **CLEAR_MODE_NEVER** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SubViewport_constant_CLEAR_MODE_ONCE: .. rst-class:: classref-enumeration-constant :ref:`ClearMode` **CLEAR_MODE_ONCE** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_SubViewport_UpdateMode: .. rst-class:: classref-enumeration enum **UpdateMode**: .. _class_SubViewport_constant_UPDATE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`UpdateMode` **UPDATE_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SubViewport_constant_UPDATE_ONCE: .. rst-class:: classref-enumeration-constant :ref:`UpdateMode` **UPDATE_ONCE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SubViewport_constant_UPDATE_WHEN_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`UpdateMode` **UPDATE_WHEN_VISIBLE** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SubViewport_constant_UPDATE_WHEN_PARENT_VISIBLE: .. rst-class:: classref-enumeration-constant :ref:`UpdateMode` **UPDATE_WHEN_PARENT_VISIBLE** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SubViewport_constant_UPDATE_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`UpdateMode` **UPDATE_ALWAYS** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SubViewport_property_render_target_clear_mode: .. rst-class:: classref-property :ref:`ClearMode` **render_target_clear_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_clear_mode** **(** :ref:`ClearMode` value **)** - :ref:`ClearMode` **get_clear_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SubViewport_property_render_target_update_mode: .. rst-class:: classref-property :ref:`UpdateMode` **render_target_update_mode** = ``2`` .. rst-class:: classref-property-setget - void **set_update_mode** **(** :ref:`UpdateMode` value **)** - :ref:`UpdateMode` **get_update_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SubViewport_property_size: .. rst-class:: classref-property :ref:`Vector2i` **size** = ``Vector2i(512, 512)`` .. rst-class:: classref-property-setget - void **set_size** **(** :ref:`Vector2i` value **)** - :ref:`Vector2i` **get_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SubViewport_property_size_2d_override: .. rst-class:: classref-property :ref:`Vector2i` **size_2d_override** = ``Vector2i(0, 0)`` .. rst-class:: classref-property-setget - void **set_size_2d_override** **(** :ref:`Vector2i` value **)** - :ref:`Vector2i` **get_size_2d_override** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SubViewport_property_size_2d_override_stretch: .. rst-class:: classref-property :ref:`bool` **size_2d_override_stretch** = ``false`` .. rst-class:: classref-property-setget - void **set_size_2d_override_stretch** **(** :ref:`bool` value **)** - :ref:`bool` **is_size_2d_override_stretch_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`