Table of Contents

Class ViewportTexture

Namespace
Godot
Assembly
GodotSharp.dll

A ViewportTexture provides the content of a Viewport as a dynamic Texture2D. This can be used to combine the rendering of Control, Node2D and Node3D nodes. For example, you can use this texture to display a 3D scene inside a TextureRect, or a 2D overlay in a Sprite3D.

To get a ViewportTexture in code, use the GetTexture() method on the target viewport.

Note: A ViewportTexture is always local to its scene (see ResourceLocalToScene). If the scene root is not ready, it may return incorrect data (see Ready).

Note: Instantiating scenes containing a high-resolution ViewportTexture may cause noticeable stutter.

public class ViewportTexture : Texture2D, IDisposable
Inheritance
ViewportTexture
Implements
Inherited Members

Constructors

ViewportTexture() 

public ViewportTexture()

Properties

ViewportPath

The path to the Viewport node to display. This is relative to the local scene root (see GetLocalScene()), not to the nodes that use this texture.

Note: In the editor, this path is automatically updated when the target viewport or one of its ancestors is renamed or moved. At runtime, this path may not automatically update if the scene root cannot be found.

public NodePath ViewportPath { get; set; }

Property Value

NodePath

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool
Edit this page