ViewportTexture

Provides the content of a Viewport as a dynamic texture.

A ViewportTexture provides the content of a Viewport as a dynamic Texture2D. This can be used to combine the rendering of Control, Entity2D and Entity3D 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 Entity.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 that uses linear encoding. This may look darker than normal when displayed directly on screen. To convert to nonlinear sRGB encoding, use Image.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.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

public ViewportTexture();

public EntityPath ViewportPath { get; set; }

public EntityPath GetViewportPathInScene();

public void SetViewportPathInScene(EntityPath path);