An interface to a game world that doesn't create a window or draw to the screen directly.
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.
The clear mode when the sub-viewport is used as a render target.
Note: This property is intended for 2D usage.
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.
The 2D size override of the sub-viewport. If either the width or height is 0, the override is disabled.
CLEAR_MODE_ALWAYS = 0Always clear the render target before drawing.
CLEAR_MODE_NEVER = 1Never clear the render target.
CLEAR_MODE_ONCE = 2Clear the render target on the next frame, then switch to CLEAR_MODE_NEVER.
UPDATE_DISABLED = 0Do not update the render target.
UPDATE_ONCE = 1Update the render target once, then switch to UPDATE_DISABLED.
UPDATE_WHEN_VISIBLE = 2Update the render target only when it is visible. This is the default value.
UPDATE_WHEN_PARENT_VISIBLE = 3Update the render target only when its parent is visible.
UPDATE_ALWAYS = 4Always update the render target.