ViewportTexture

Overview ¶

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 Viewport.GetTexture method on the target viewport.

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

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

Note: When using a Viewport with Viewport.UseHdr2d set to true, the returned texture will be an HDR image encoded in linear space. This may look darker than normal when displayed directly on screen. To convert to gamma space, you can do the following:

package main

import "graphics.gd/classdb/Image"

func ExampleViewportTexture(img Image.Instance) {
	img.Convert(Image.FormatRgba8)
	img.LinearToSrgb()
}

Note: Some nodes such as Decal, Light3D, and PointLight2D do not support using ViewportTexture directly. To use texture data from a ViewportTexture in these nodes, you need to create an ImageTexture by calling Texture2D.GetImage on the ViewportTexture and passing the result to ImageTexture.CreateFromImage. This conversion is a slow operation, so it should not be performed every frame.