Class reference
SubViewport
Inherits Viewport
An interface to a game world that doesn't create a window or draw to the screen directly.
Description
SubViewport Isolates a rectangular region of a scene to be displayed independently. This can be used, for example, to display UI in 3D space. Note: SubViewport is a Viewport that isn't a Window, i.e. it doesn't draw anything by itself. To display anything, SubViewport must have a non-zero size and be either put inside a SubViewportContainer or assigned to a ViewportTexture. Note: InputEvents are not passed to a standalone SubViewport by default. To ensure InputEvent propagation, a SubViewport can be placed inside of a SubViewportContainer.
Properties
int render_target_clear_mode = 0
int render_target_clear_mode = 0The clear mode when the sub-viewport is used as a render target. Note: This property is intended for 2D usage.
int render_target_update_mode = 2
int render_target_update_mode = 2The update mode when the sub-viewport is used as a render target.
Vector2i size = Vector2i(512, 512)
Vector2i size = Vector2i(512, 512)The width and height of the sub-viewport. Must be set to a value greater than or equal to 2 pixels on both dimensions. Otherwise, nothing will be displayed. Note: If the parent node is a SubViewportContainer and its SubViewportContainer.stretch is true, the viewport size cannot be changed manually.
Vector2i size_2d_override = Vector2i(0, 0)
Vector2i size_2d_override = Vector2i(0, 0)The 2D size override of the sub-viewport. If either the width or height is 0, the override is disabled.
bool size_2d_override_stretch = false
bool size_2d_override_stretch = falseIf true, the 2D size override affects stretch as well.
Constants
CLEAR_MODE_ALWAYS = 0
Always clear the render target before drawing.
CLEAR_MODE_NEVER = 1
Never clear the render target.
CLEAR_MODE_ONCE = 2
Clear the render target on the next frame, then switch to CLEAR_MODE_NEVER.
UPDATE_DISABLED = 0
Do not update the render target.
UPDATE_ONCE = 1
Update the render target once, then switch to UPDATE_DISABLED.
UPDATE_WHEN_VISIBLE = 2
Update the render target only when it is visible. This is the default value.
UPDATE_WHEN_PARENT_VISIBLE = 3
Update the render target only when its parent is visible.
UPDATE_ALWAYS = 4
Always update the render target.