Signal support.
class Signal1Use the connect(flags:_:) method to connect to the signal on the container object, and disconnect(_:) to drop the connection.
You can also await the emitted property for waiting for a single emission of the signal.
import SwiftGodotFramework to write Godot Game Extensions using the Swift Programming Language.
class ViewportAbstract base class for viewports. Encapsulates drawing and interaction with a game world.
@discardableResult func connect(flags: Object.ConnectFlags = [], _ callback: @escaping (_ node: Control) -> ()) -> Object Connects the signal to the specified callback
func disconnect(_ token: Object) Disconnects a signal that was previously connected, the return value from calling connect(flags:_:)
var emitted: Void { get async }You can await this property to wait for the signal to be emitted once
override class var godotClassName: StringName { get }final var audioListenerEnable2d: Bool { get set }If true, the viewport will process 2D audio streams.
final var audioListenerEnable3d: Bool { get set }If true, the viewport will process 3D audio streams.
final var canvasCullMask: UInt32 { get set }The rendering layers in which this Viewport renders CanvasItem nodes.
final var canvasItemDefaultTextureFilter: Viewport.DefaultCanvasItemTextureFilter { get set }Sets the default filter mode used by CanvasItems in this Viewport. See DefaultCanvasItemTextureFilter for options.
final var canvasItemDefaultTextureRepeat: Viewport.DefaultCanvasItemTextureRepeat { get set }Sets the default repeat mode used by CanvasItems in this Viewport. See DefaultCanvasItemTextureRepeat for options.
final var canvasTransform: Transform2D { get set }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.
final var debugDraw: Viewport.DebugDraw { get set }The overlay mode for test rendered geometry in debug purposes.
final var disable3d: Bool { get set }Disable 3D rendering (but keep 2D rendering).
final var fsrSharpness: Double { get set }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.
final var globalCanvasTransform: Transform2D { get set }The global canvas transform of the viewport. The canvas transform is relative to this.
final var guiDisableInput: Bool { get set }If true, the viewport will not receive input events.
final var guiEmbedSubwindows: Bool { get set }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.
var guiFocusChanged: Signal1 { get }Emitted when a Control node grabs keyboard focus.
final var guiSnapControlsToPixels: Bool { get set }If true, the GUI controls on the viewport will lay pixel perfectly.
final var handleInputLocally: Bool { get set }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.
final var meshLodThreshold: Double { get set }The automatic LOD bias to use for meshes rendered within the Viewport (this is analogous to meshLodThreshold). Higher values will use less detailed versions of meshes that have LOD variations generated. If set to 0.0, automatic LOD is disabled. Increase meshLodThreshold to improve performance at the cost of geometry detail.
final var msaa2d: Viewport.MSAA { get set }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.
final var msaa3d: Viewport.MSAA { get set }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 scaling3dMode for supersampling, which provides higher quality but is much more expensive. This has no effect on shader-induced aliasing or texture aliasing.
final var ownWorld3d: Bool { get set }If true, the viewport will use a unique copy of the World3D defined in world3d.
final var physicsObjectPicking: Bool { get set }If true, the objects rendered by viewport become subjects of mouse picking process.
final var physicsObjectPickingFirstOnly: Bool { get set }If true, the input_event signal will only be sent to one physics object in the mouse picking process. If you want to get the top object only, you must also enable physicsObjectPickingSort.
final var physicsObjectPickingSort: Bool { get set }If true, objects receive mouse picking events sorted primarily by their zIndex and secondarily by their position in the scene tree. If false, the order is undetermined.
final var positionalShadowAtlas16Bits: Bool { get set }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.
final var positionalShadowAtlasQuad0: Viewport.PositionalShadowAtlasQuadrantSubdiv { get set }The subdivision amount of the first quadrant on the shadow atlas.
final var positionalShadowAtlasQuad1: Viewport.PositionalShadowAtlasQuadrantSubdiv { get set }The subdivision amount of the second quadrant on the shadow atlas.
final var positionalShadowAtlasQuad2: Viewport.PositionalShadowAtlasQuadrantSubdiv { get set }The subdivision amount of the third quadrant on the shadow atlas.
final var positionalShadowAtlasQuad3: Viewport.PositionalShadowAtlasQuadrantSubdiv { get set }The subdivision amount of the fourth quadrant on the shadow atlas.
final var positionalShadowAtlasSize: Int32 { get set }The shadow atlas’ resolution (used for omni and spot lights). The value is rounded up to the nearest power of 2.
final var scaling3dMode: Viewport.Scaling3DMode { get set }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.
final var scaling3dScale: Double { get set }Scales the 3D render buffer based on the viewport size uses an image filter specified in ProjectSettings/rendering/scaling3d/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/antiAliasing/quality/msaa3d for multi-sample antialiasing, which is significantly cheaper but only smooths the edges of polygons.
final var screenSpaceAa: Viewport.ScreenSpaceAA { get set }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.
final var sdfOversize: Viewport.SDFOversize { get set }Controls how much of the original viewport’s size should be covered by the 2D signed distance field. This SDF can be sampled in CanvasItem shaders and is also used for GPUParticles2D collision. Higher values allow portions of occluders located outside the viewport to still be taken into account in the generated signed distance field, at the cost of performance. If you notice particles falling through LightOccluder2Ds as the occluders leave the viewport, increase this setting.
final var sdfScale: Viewport.SDFScale { get set }The resolution scale to use for the 2D signed distance field. Higher values lead to a more precise and more stable signed distance field as the camera moves, at the cost of performance.
var sizeChanged: SimpleSignal { get }Emitted when the size of the viewport is changed, whether by resizing of window, or some other means.
final var snap2dTransformsToPixel: Bool { get set }If true, CanvasItem nodes will internally snap to full pixels. Their position can still be sub-pixel, but the decimals will not have effect. This can lead to a crisper appearance at the cost of less smooth movement, especially when Camera2D smoothing is enabled.
final var snap2dVerticesToPixel: Bool { get set }If true, vertices of CanvasItem nodes will snap to full pixels. Only affects the final vertex positions, not the transforms. This can lead to a crisper appearance at the cost of less smooth movement, especially when Camera2D smoothing is enabled.
final var textureMipmapBias: Double { get set }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).
final var transparentBg: Bool { get set }If true, the viewport should render its background as transparent.
final var useDebanding: Bool { get set }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 backgroundMode is Environment/BGMode/bgCanvas. See also ProjectSettings/rendering/antiAliasing/quality/useDebanding.
final var useHdr2d: Bool { get set }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 an RGBA16 framebuffer, while when using the Mobile renderer it will be an 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.
final var useOcclusionCulling: Bool { get set }If true, OccluderInstance3D nodes will be usable for occlusion culling in 3D for this viewport. For the root viewport, ProjectSettings/rendering/occlusionCulling/useOcclusionCulling must be set to true instead.
final var useTaa: Bool { get set }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.
final var useXr: Bool { get set }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.
final var vrsMode: Viewport.VRSMode { get set }The Variable Rate Shading (VRS) mode that is used for this viewport. Note, if hardware does not support VRS this property is ignored.
final var vrsTexture: Texture2D? { get set }Texture to use when vrsMode is set to Viewport/VRSMode/vrsTexture.
final var vrsUpdateMode: Viewport.VRSUpdateMode { get set }Sets the update mode for Variable Rate Shading (VRS) for the viewport. VRS requires the input texture to be converted to the format usable by the VRS method supported by the hardware. The update mode defines how often this happens. If the GPU does not support VRS, or VRS is not enabled, this property is ignored.
final var world2d: World2D? { get set }The custom World2D which can be used as 2D environment source.
final var world3d: World3D? { get set }The custom World3D which can be used as 3D environment source.
final func findWorld2d() -> World2D? Returns the first valid World2D for this viewport, searching the world2d property of itself and any Viewport ancestor.
final func findWorld3d() -> World3D? Returns the first valid World3D for this viewport, searching the world3d property of itself and any Viewport ancestor.
final func getCamera2d() -> Camera2D? Returns the currently active 2D camera. Returns null if there are no active cameras.
final func getCamera3d() -> Camera3D? Returns the currently active 3D camera.
final func getCanvasCullMaskBit(layer: UInt32) -> Bool Returns an individual bit on the rendering layer mask.
final func getEmbeddedSubwindows() -> ObjectCollection<Window> Returns a list of the visible embedded Windows inside the viewport.
final func getFinalTransform() -> Transform2D Returns the transform from the viewport’s coordinate system to the embedder’s coordinate system.
final func getMousePosition() -> Vector2 Returns the mouse’s position in this Viewport using the coordinate system of this Viewport.
final func getRenderInfo(type: Viewport.RenderInfoType, info: Viewport.RenderInfo) -> Int32 Returns rendering statistics of the given type. See RenderInfoType and RenderInfo for options.
final func getScreenTransform() -> Transform2D Returns the transform from the Viewport’s coordinates to the screen coordinates of the containing window manager window.
final func getTexture() -> ViewportTexture? Returns the viewport’s texture.
final func getViewportRid() -> RID Returns the viewport’s RID from the RenderingServer.
final func getVisibleRect() -> Rect2 Returns the visible rectangle in global screen coordinates.
final func guiGetDragData() -> Variant Returns the drag data from the GUI, that was previously returned by _getDragData(atPosition:).
final func guiGetFocusOwner() -> Control? Returns the Control having the focus within this viewport. If no Control has the focus, returns null.
final func guiGetHoveredControl() -> Control? Returns the Control that the mouse is currently hovering over in this viewport. If no Control has the cursor, returns null.
final func guiIsDragSuccessful() -> Bool Returns true if the drag operation is successful.
final func guiIsDragging() -> Bool Returns true if the viewport is currently performing a drag operation.
final func guiReleaseFocus() Removes the focus from the currently focused Control within this viewport. If no Control has the focus, does nothing.
final func isInputHandled() -> Bool Returns whether the current InputEvent has been handled. Input events are not handled until setInputAsHandled has been called during the lifetime of an InputEvent.
final func pushInput(event: InputEvent?, inLocalCoords: Bool = false) 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.
final func pushTextInput(text: String) 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).
final func pushUnhandledInput(event: InputEvent?, inLocalCoords: Bool = false) 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.
final func setCanvasCullMaskBit(layer: UInt32, enable: Bool) Set/clear individual bits on the rendering layer mask. This simplifies editing this Viewport’s layers.
final func setInputAsHandled() Stops the input from propagating further down the SceneTree.
final func updateMouseCursorState() Force instantly updating the display based on the current mouse cursor position. This includes updating the mouse cursor shape and sending necessary [signal Control.mouse_entered], [signal CollisionObject2D.mouse_entered], [signal CollisionObject3D.mouse_entered] and [signal Window.mouse_entered] signals and their respective mouse_exited counterparts.
final func warpMouse(position: Vector2) Moves the mouse pointer to the specified position in this Viewport using the coordinate system of this Viewport.
enum DebugDrawenum DefaultCanvasItemTextureFilterenum DefaultCanvasItemTextureRepeatenum MSAAenum PositionalShadowAtlasQuadrantSubdivenum RenderInfoenum RenderInfoTypeenum SDFOversizeenum SDFScaleenum Scaling3DModeenum ScreenSpaceAAenum VRSModeenum VRSUpdateModeclass WindowBase class for all windows, dialogs, and popups.