Emitted when a Control node grabs keyboard focus.

Emitted when the size of the viewport is changed, whether by resizing of window, or some other means.

If true, the viewport will process 2D audio streams.

If true, the viewport will process 3D audio streams.

The rendering layers in which this Viewport renders CanvasItem nodes.

Sets the default filter mode used by CanvasItems in this Viewport. See DefaultCanvasItemTextureFilter for options.

Sets the default repeat mode used by CanvasItems in this Viewport. See DefaultCanvasItemTextureRepeat for options.

The canvas transform of the viewport, useful for changing the on-screen positions of all child CanvasItems. This is relative to the global canvas transform of the viewport.

The overlay mode for test rendered geometry in debug purposes.

Disable 3D rendering (but keep 2D rendering).

Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference.

The global canvas transform of the viewport. The canvas transform is relative to this.

If true, the viewport will not receive input events.

If true, sub-windows (popups and dialogs) will be embedded inside application window as control-like nodes. If false, they will appear as separate windows handled by the operating system.

If true, the GUI controls on the viewport will lay pixel perfectly.

If true, this viewport will mark incoming input events as handled by itself. If false, this is instead done by the first parent viewport that is set to handle input locally.

The automatic LOD bias to use for meshes rendered within the Viewport (this is analogous to ReflectionProbe.mesh_lod_threshold). Higher values will use less detailed versions of meshes that have LOD variations generated. If set to 0.0, automatic LOD is disabled. Increase mesh_lod_threshold to improve performance at the cost of geometry detail.

The multisample anti-aliasing mode for 2D/Canvas rendering. A higher number results in smoother edges at the cost of significantly worse performance. A value of 2 or 4 is best unless targeting very high-end systems. This has no effect on shader-induced aliasing or texture aliasing.

The multisample anti-aliasing mode for 3D rendering. A higher number results in smoother edges at the cost of significantly worse performance. A value of 2 or 4 is best unless targeting very high-end systems. See also bilinear scaling 3d scaling_3d_mode for supersampling, which provides higher quality but is much more expensive. This has no effect on shader-induced aliasing or texture aliasing.

If true, the viewport will use a unique copy of the World3D defined in world_3d.

If true, the objects rendered by viewport become subjects of mouse picking process.

If true, objects receive mouse picking events sorted primarily by their CanvasItem.z_index and secondarily by their position in the scene tree. If false, the order is undetermined.

Use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices.

The subdivision amount of the first quadrant on the shadow atlas.

The subdivision amount of the second quadrant on the shadow atlas.

The subdivision amount of the third quadrant on the shadow atlas.

The subdivision amount of the fourth quadrant on the shadow atlas.

The shadow atlas' resolution (used for omni and spot lights). The value is rounded up to the nearest power of 2.

Sets scaling 3d mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible.

Scales the 3D render buffer based on the viewport size uses an image filter specified in ProjectSettings.rendering/scaling_3d/mode to scale the output image to the full viewport size. Values lower than 1.0 can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than 1.0 are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also ProjectSettings.rendering/anti_aliasing/quality/msaa_3d for multi-sample antialiasing, which is significantly cheaper but only smooths the edges of polygons.

Sets the screen-space antialiasing method used. Screen-space antialiasing works by selectively blurring edges in a post-process shader. It differs from MSAA which takes multiple coverage samples while rendering objects. Screen-space AA methods are typically faster than MSAA and will smooth out specular aliasing, but tend to make scenes appear blurry.

Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close).

If true, the viewport should render its background as transparent.

If true, uses a fast post-processing filter to make banding significantly less visible in 3D. 2D rendering is not affected by debanding unless the Environment.background_mode is Environment.BG_CANVAS. See also ProjectSettings.rendering/anti_aliasing/quality/use_debanding.

If true, 2D rendering will use an high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be a RGBA16 framebuffer, while when using the Mobile renderer it will be a RGB10_A2 framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the 0-1 range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients.

If true, OccluderInstance3D nodes will be usable for occlusion culling in 3D for this viewport. For the root viewport, ProjectSettings.rendering/occlusion_culling/use_occlusion_culling must be set to true instead.

Enables Temporal Anti-Aliasing for this viewport. TAA works by jittering the camera and accumulating the images of the last rendered frames, motion vector rendering is used to account for camera and object motion.

If true, the viewport will use the primary XR interface to render XR output. When applicable this can result in a stereoscopic image and the resulting render being output to a headset.

The Variable Rate Shading (VRS) mode that is used for this viewport. Note, if hardware does not support VRS this property is ignored.

Texture to use when vrs_mode is set to VRS_TEXTURE.

The custom World2D which can be used as 2D environment source.

The custom World3D which can be used as 3D environment source.

Returns the first valid World2D for this viewport, searching the world_2d property of itself and any Viewport ancestor.

Returns the first valid World3D for this viewport, searching the world_3d property of itself and any Viewport ancestor.

Returns the currently active 2D camera. Returns null if there are no active cameras.

Returns the currently active 3D camera.

Returns an individual bit on the rendering layer mask.

Returns a list of the visible embedded Windows inside the viewport.

Returns the transform from the viewport's coordinate system to the embedder's coordinate system.

Returns the mouse's position in this Viewport using the coordinate system of this Viewport.

Returns the positional shadow atlas quadrant subdivision of the specified quadrant.

Returns rendering statistics of the given type. See RenderInfoType and RenderInfo for options.

Returns the transform from the Viewport's coordinates to the screen coordinates of the containing window manager window.

Returns the viewport's texture.

Returns the viewport's RID from the RenderingServer.

Returns the visible rectangle in global screen coordinates.

Returns the drag data from the GUI, that was previously returned by Control._get_drag_data.

Returns the Control having the focus within this viewport. If no Control has the focus, returns null.

Returns the Control that the mouse is currently hovering over in this viewport. If no Control has the cursor, returns null.

Returns true if the drag operation is successful.

Returns true if the viewport is currently performing a drag operation.

Removes the focus from the currently focused Control within this viewport. If no Control has the focus, does nothing.

Returns whether the current InputEvent has been handled. Input events are not handled until set_input_as_handled has been called during the lifetime of an InputEvent.

Triggers the given event in this Viewport. This can be used to pass an InputEvent between viewports, or to locally apply inputs that were sent over the network or saved to a file.

Helper method which calls the set_text() method on the currently focused Control, provided that it is defined (e.g. if the focused Control is Button or LineEdit).

Triggers the given InputEvent in this Viewport. This can be used to pass input events between viewports, or to locally apply inputs that were sent over the network or saved to a file.

Set/clear individual bits on the rendering layer mask. This simplifies editing this Viewport's layers.

Stops the input from propagating further down the SceneTree.

Sets the number of subdivisions to use in the specified quadrant. A higher number of subdivisions allows you to have more shadows in the scene at once, but reduces the quality of the shadows. A good practice is to have quadrants with a varying number of subdivisions and to have as few subdivisions as possible.

Force instantly updating the display based on the current mouse cursor position. This includes updating the mouse cursor shape and sending necessary Control.mouse_entered, CollisionObject2D.mouse_entered, CollisionObject3D.mouse_entered and Window.mouse_entered signals and their respective mouse_exited counterparts.

Moves the mouse pointer to the specified position in this Viewport using the coordinate system of this Viewport.