SubViewport class

Inheritance

• Object
• ExtensionType
• GodotObject
• Node
• Viewport
• SubViewport

Available extensions

• GodotObjectCast
• TNode

Constructors

SubViewport()

SubViewport.withNonNullOwner(Pointer<Void> owner)

Properties

childEnteredTree → Signal1<Node?>

late, final, inherited

childExitingTree → Signal1<Node?>

late, final, inherited

childOrderChanged → Signal0

late, final, inherited

editorDescriptionChanged → Signal1<Node?>

late, final, inherited

guiFocusChanged → Signal1<Control?>

late, final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

nativePointerAddress → int

Since Pointer.address isn's tagged 'vm:entry-point', supply an entry point that can get the raw pointer address for this object

no setter, inherited

nativePtr → GDExtensionObjectPtr

no setter, inherited

propertyListChanged → Signal0

late, final, inherited

ready → Signal0

late, final, inherited

renamed → Signal0

late, final, inherited

replacingBy → Signal1<Node?>

late, final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scriptChanged → Signal0

late, final, inherited

sizeChanged → Signal0

late, final, inherited

treeEntered → Signal0

late, final, inherited

treeExited → Signal0

late, final, inherited

treeExiting → Signal0

late, final, inherited

typeInfo → ExtensionTypeInfo<SubViewport>

no setter, override

Methods

addChild(Node? node, {bool forceReadableName = false, NodeInternalMode? internal}) → void

inherited

addSibling(Node? sibling, {bool forceReadableName = false}) → void

inherited

addToGroup(String group, {bool persistent = false}) → void

inherited

addUserSignal(String signal, {Array? arguments}) → void

inherited

as<T>() → T?

Available on GodotObject, provided by the GodotObjectCast extension

atr(String message, {String context = ''}) → String

inherited

atrN(String message, String pluralMessage, int n, {String context = ''}) → String

inherited

attachSignal(SignalCallable signal) → void

inherited

call(String method, {List<Variant> vargs = const []}) → Variant

inherited

callDeferred(String method, {List<Variant> vargs = const []}) → Variant

inherited

callDeferredThreadGroup(String method, {List<Variant> vargs = const []}) → Variant

inherited

callThreadSafe(String method, {List<Variant> vargs = const []}) → Variant

inherited

callv(String method, Array argArray) → Variant

inherited

cancelFree() → void

inherited

canProcess() → bool

inherited

canTranslateMessages() → bool

inherited

connect(String signal, Callable callable, {int flags = 0}) → GDError

inherited

createTween() → Tween?

inherited

detachSignal(SignalCallable signal) → void

inherited

disconnect(String signal, Callable callable) → void

inherited

duplicate({int flags = 15}) → Node?

inherited

emitSignal(String signal, {List<Variant> vargs = const []}) → GDError

inherited

findChild(String pattern, {bool recursive = true, bool owned = true}) → Node?

inherited

findChildren(String pattern, {String type = '', bool recursive = true, bool owned = true}) → TypedArray<Node>

inherited

findParent(String pattern) → Node?

inherited

findWorld_2d() → World2D?

inherited

findWorld_3d() → World3D?

inherited

get(String property) → Variant

inherited

getAutoTranslateMode() → NodeAutoTranslateMode

inherited

getCamera_2d() → Camera2D?

inherited

getCamera_3d() → Camera3D?

inherited

getCanvasCullMask() → int

inherited

getCanvasCullMaskBit(int layer) → bool

inherited

getCanvasTransform() → Transform2D

inherited

getChild(int idx, {bool includeInternal = false}) → Node?

inherited

getChildCount({bool includeInternal = false}) → int

inherited

getChildren({bool includeInternal = false}) → TypedArray<Node>

inherited

getClass() → String

inherited

getClearMode() → SubViewportClearMode

getDebugDraw() → ViewportDebugDraw

inherited

getDefaultCanvasItemTextureFilter() → ViewportDefaultCanvasItemTextureFilter

inherited

getDefaultCanvasItemTextureRepeat() → ViewportDefaultCanvasItemTextureRepeat

inherited

getEditorDescription() → String

inherited

getEmbeddedSubwindows() → TypedArray<Window>

inherited

getFinalTransform() → Transform2D

inherited

getFsrSharpness() → double

inherited

getGlobalCanvasTransform() → Transform2D

inherited

getGroups() → TypedArray<StringName>

inherited

getIncomingConnections() → TypedArray<Dictionary>

inherited

getIndex({bool includeInternal = false}) → int

inherited

getIndexed(NodePath propertyPath) → Variant

inherited

getInstanceId() → int

inherited

getLastExclusiveWindow() → Window?

inherited

getMeshLodThreshold() → double

inherited

getMeta(String name, {Variant? defaultval}) → Variant

inherited

getMetaList() → TypedArray<StringName>

inherited

getMethodArgumentCount(String method) → int

inherited

getMethodList() → TypedArray<Dictionary>

inherited

getMousePosition() → Vector2

inherited

getMsaa_2d() → ViewportMSAA

inherited

getMsaa_3d() → ViewportMSAA

inherited

getMultiplayer() → MultiplayerAPI?

inherited

getMultiplayerAuthority() → int

inherited

getName() → String

inherited

getNode(NodePath path) → Node?

inherited

getNodeAndResource(NodePath path) → Array

inherited

getNodeOrNull(NodePath path) → Node?

inherited

getNodeT<T>([String? path]) → T?

Available on Node, provided by the TNode extension

getOwner() → Node?

inherited

getParent() → Node?

inherited

getPath() → NodePath

inherited

getPathTo(Node? node, {bool useUniquePath = false}) → NodePath

inherited

getPhysicsInterpolationMode() → NodePhysicsInterpolationMode

inherited

getPhysicsObjectPicking() → bool

inherited

getPhysicsObjectPickingFirstOnly() → bool

inherited

getPhysicsObjectPickingSort() → bool

inherited

getPhysicsProcessDeltaTime() → double

inherited

getPhysicsProcessPriority() → int

inherited

getPositionalShadowAtlas_16Bits() → bool

inherited

getPositionalShadowAtlasQuadrantSubdiv(int quadrant) → ViewportPositionalShadowAtlasQuadrantSubdiv

inherited

getPositionalShadowAtlasSize() → int

inherited

getProcessDeltaTime() → double

inherited

getProcessMode() → NodeProcessMode

inherited

getProcessPriority() → int

inherited

getProcessThreadGroup() → NodeProcessThreadGroup

inherited

getProcessThreadGroupOrder() → int

inherited

getProcessThreadMessages() → int

inherited

getPropertyList() → TypedArray<Dictionary>

inherited

getRenderInfo(ViewportRenderInfoType type, ViewportRenderInfo info) → int

inherited

getScaling_3dMode() → ViewportScaling3DMode

inherited

getScaling_3dScale() → double

inherited

getSceneFilePath() → String

inherited

getSceneInstanceLoadPlaceholder() → bool

inherited

getScreenSpaceAa() → ViewportScreenSpaceAA

inherited

getScreenTransform() → Transform2D

inherited

getScript() → Variant

inherited

getSdfOversize() → ViewportSDFOversize

inherited

getSdfScale() → ViewportSDFScale

inherited

getSignalConnectionList(String signal) → TypedArray<Dictionary>

inherited

getSignalList() → TypedArray<Dictionary>

inherited

getSize() → Vector2i

getSize_2dOverride() → Vector2i

getTexture() → ViewportTexture?

inherited

getTextureMipmapBias() → double

inherited

getTree() → SceneTree?

inherited

getTreeString() → String

inherited

getTreeStringPretty() → String

inherited

getUpdateMode() → SubViewportUpdateMode

getViewport() → Viewport?

inherited

getViewportRid() → RID

inherited

getVisibleRect() → Rect2

inherited

getVrsMode() → ViewportVRSMode

inherited

getVrsTexture() → Texture2D?

inherited

getVrsUpdateMode() → ViewportVRSUpdateMode

inherited

getWindow() → Window?

inherited

getWorld_2d() → World2D?

inherited

getWorld_3d() → World3D?

inherited

guiGetDragData() → Variant

inherited

guiGetFocusOwner() → Control?

inherited

guiGetHoveredControl() → Control?

inherited

guiIsDragging() → bool

inherited

guiIsDragSuccessful() → bool

inherited

guiReleaseFocus() → void

inherited

hasMeta(String name) → bool

inherited

hasMethod(String method) → bool

inherited

hasNode(NodePath path) → bool

inherited

hasNodeAndResource(NodePath path) → bool

inherited

hasSignal(String signal) → bool

inherited

hasTransparentBackground() → bool

inherited

hasUserSignal(String signal) → bool

inherited

is_3dDisabled() → bool

inherited

isAncestorOf(Node? node) → bool

inherited

isAudioListener_2d() → bool

inherited

isAudioListener_3d() → bool

inherited

isBlockingSignals() → bool

inherited

isClass(String klass) → bool

inherited

isConnected(String signal, Callable callable) → bool

inherited

isDisplayedFolded() → bool

inherited

isEditableInstance(Node? node) → bool

inherited

isEmbeddingSubwindows() → bool

inherited

isGreaterThan(Node? node) → bool

inherited

isHandlingInputLocally() → bool

inherited

isInGroup(String group) → bool

inherited

isInputDisabled() → bool

inherited

isInputHandled() → bool

inherited

isInsideTree() → bool

inherited

isMultiplayerAuthority() → bool

inherited

isNodeReady() → bool

inherited

isPartOfEditedScene() → bool

inherited

isPhysicsInterpolated() → bool

inherited

isPhysicsInterpolatedAndEnabled() → bool

inherited

isPhysicsProcessing() → bool

inherited

isPhysicsProcessingInternal() → bool

inherited

isProcessing() → bool

inherited

isProcessingInput() → bool

inherited

isProcessingInternal() → bool

inherited

isProcessingShortcutInput() → bool

inherited

isProcessingUnhandledInput() → bool

inherited

isProcessingUnhandledKeyInput() → bool

inherited

isQueuedForDeletion() → bool

inherited

isSize_2dOverrideStretchEnabled() → bool

isSnap_2dTransformsToPixelEnabled() → bool

inherited

isSnap_2dVerticesToPixelEnabled() → bool

inherited

isSnapControlsToPixelsEnabled() → bool

inherited

isUniqueNameInOwner() → bool

inherited

isUsingDebanding() → bool

inherited

isUsingHdr_2d() → bool

inherited

isUsingOcclusionCulling() → bool

inherited

isUsingOwnWorld_3d() → bool

inherited

isUsingTaa() → bool

inherited

isUsingXr() → bool

inherited

moveChild(Node? childNode, int toIndex) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notification(int what, {bool reversed = false}) → void

inherited

notifyDeferredThreadGroup(int what) → void

inherited

notifyPropertyListChanged() → void

inherited

notifyThreadSafe(int what) → void

inherited

printTree() → void

inherited

printTreePretty() → void

inherited

propagateCall(String method, {Array? argsparam, bool parentFirst = false}) → void

inherited

propagateNotification(int what) → void

inherited

propertyCanRevert(String property) → bool

inherited

propertyGetRevert(String property) → Variant

inherited

pushInput(InputEvent? event, {bool inLocalCoords = false}) → void

inherited

pushTextInput(String text) → void

inherited

pushUnhandledInput(InputEvent? event, {bool inLocalCoords = false}) → void

inherited

queueFree() → void

inherited

removeChild(Node? node) → void

inherited

removeFromGroup(String group) → void

inherited

removeMeta(String name) → void

inherited

removeUserSignal(String signal) → void

inherited

reparent(Node? newParent, {bool keepGlobalTransform = true}) → void

inherited

replaceBy(Node? node, {bool keepGroups = false}) → void

inherited

requestReady() → void

inherited

resetPhysicsInterpolation() → void

inherited

rpc(String method, {List<Variant> vargs = const []}) → GDError

inherited

rpcConfig(String method, Variant config) → void

inherited

rpcId(int peerId, String method, {List<Variant> vargs = const []}) → GDError

inherited

set(String property, Variant value) → void

inherited

setAsAudioListener_2d(bool enable) → void

inherited

setAsAudioListener_3d(bool enable) → void

inherited

setAutoTranslateMode(NodeAutoTranslateMode mode) → void

inherited

setBlockSignals(bool enable) → void

inherited

setCanvasCullMask(int mask) → void

inherited

setCanvasCullMaskBit(int layer, bool enable) → void

inherited

setCanvasTransform(Transform2D xform) → void

inherited

setClearMode(SubViewportClearMode mode) → void

setDebugDraw(ViewportDebugDraw debugDraw) → void

inherited

setDefaultCanvasItemTextureFilter(ViewportDefaultCanvasItemTextureFilter mode) → void

inherited

setDefaultCanvasItemTextureRepeat(ViewportDefaultCanvasItemTextureRepeat mode) → void

inherited

setDeferred(String property, Variant value) → void

inherited

setDeferredThreadGroup(String property, Variant value) → void

inherited

setDisable_3d(bool disable) → void

inherited

setDisableInput(bool disable) → void

inherited

setDisplayFolded(bool fold) → void

inherited

setEditableInstance(Node? node, bool isEditable) → void

inherited

setEditorDescription(String editorDescription) → void

inherited

setEmbeddingSubwindows(bool enable) → void

inherited

setFsrSharpness(double fsrSharpness) → void

inherited

setGlobalCanvasTransform(Transform2D xform) → void

inherited

setHandleInputLocally(bool enable) → void

inherited

setIndexed(NodePath propertyPath, Variant value) → void

inherited

setInputAsHandled() → void

inherited

setMeshLodThreshold(double pixels) → void

inherited

setMessageTranslation(bool enable) → void

inherited

setMeta(String name, Variant value) → void

inherited

setMsaa_2d(ViewportMSAA msaa) → void

inherited

setMsaa_3d(ViewportMSAA msaa) → void

inherited

setMultiplayerAuthority(int id, {bool recursive = true}) → void

inherited

setName(String name) → void

inherited

setOwner(Node? owner) → void

inherited

setPhysicsInterpolationMode(NodePhysicsInterpolationMode mode) → void

inherited

setPhysicsObjectPicking(bool enable) → void

inherited

setPhysicsObjectPickingFirstOnly(bool enable) → void

inherited

setPhysicsObjectPickingSort(bool enable) → void

inherited

setPhysicsProcess(bool enable) → void

inherited

setPhysicsProcessInternal(bool enable) → void

inherited

setPhysicsProcessPriority(int priority) → void

inherited

setPositionalShadowAtlas_16Bits(bool enable) → void

inherited

setPositionalShadowAtlasQuadrantSubdiv(int quadrant, ViewportPositionalShadowAtlasQuadrantSubdiv subdiv) → void

inherited

setPositionalShadowAtlasSize(int size) → void

inherited

setProcess(bool enable) → void

inherited

setProcessInput(bool enable) → void

inherited

setProcessInternal(bool enable) → void

inherited

setProcessMode(NodeProcessMode mode) → void

inherited

setProcessPriority(int priority) → void

inherited

setProcessShortcutInput(bool enable) → void

inherited

setProcessThreadGroup(NodeProcessThreadGroup mode) → void

inherited

setProcessThreadGroupOrder(int order) → void

inherited

setProcessThreadMessages(int flags) → void

inherited

setProcessUnhandledInput(bool enable) → void

inherited

setProcessUnhandledKeyInput(bool enable) → void

inherited

setScaling_3dMode(ViewportScaling3DMode scaling_3dMode) → void

inherited

setScaling_3dScale(double scale) → void

inherited

setSceneFilePath(String sceneFilePath) → void

inherited

setSceneInstanceLoadPlaceholder(bool loadPlaceholder) → void

inherited

setScreenSpaceAa(ViewportScreenSpaceAA screenSpaceAa) → void

inherited

setScript(Variant script) → void

inherited

setSdfOversize(ViewportSDFOversize oversize) → void

inherited

setSdfScale(ViewportSDFScale scale) → void

inherited

setSize(Vector2i size) → void

setSize_2dOverride(Vector2i size) → void

setSize_2dOverrideStretch(bool enable) → void

setSnap_2dTransformsToPixel(bool enabled) → void

inherited

setSnap_2dVerticesToPixel(bool enabled) → void

inherited

setSnapControlsToPixels(bool enabled) → void

inherited

setTextureMipmapBias(double textureMipmapBias) → void

inherited

setThreadSafe(String property, Variant value) → void

inherited

setTransparentBackground(bool enable) → void

inherited

setUniqueNameInOwner(bool enable) → void

inherited

setUpdateMode(SubViewportUpdateMode mode) → void

setUseDebanding(bool enable) → void

inherited

setUseHdr_2d(bool enable) → void

inherited

setUseOcclusionCulling(bool enable) → void

inherited

setUseOwnWorld_3d(bool enable) → void

inherited

setUseTaa(bool enable) → void

inherited

setUseXr(bool use) → void

inherited

setVrsMode(ViewportVRSMode mode) → void

inherited

setVrsTexture(Texture2D? texture) → void

inherited

setVrsUpdateMode(ViewportVRSUpdateMode mode) → void

inherited

setWorld_2d(World2D? world_2d) → void

inherited

setWorld_3d(World3D? world_3d) → void

inherited

toString() → String

A string representation of this object.

inherited

tr(String message, {String context = ''}) → String

inherited

trN(String message, String pluralMessage, int n, {String context = ''}) → String

inherited

updateConfigurationWarnings() → void

inherited

updateMouseCursorState() → void

inherited

vEnterTree() → void

inherited

vExitTree() → void

inherited

vGetConfigurationWarnings() → PackedStringArray

inherited

vInput(InputEvent? event) → void

inherited

vPhysicsProcess(double delta) → void

inherited

vProcess(double delta) → void

inherited

vReady() → void

inherited

vShortcutInput(InputEvent? event) → void

inherited

vUnhandledInput(InputEvent? event) → void

inherited

vUnhandledKeyInput(InputEvent? event) → void

inherited

warpMouse(Vector2 position) → void

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

sTypeInfo → ExtensionTypeInfo<SubViewport>

no setter

Constants

nativeTypeName → const String