Class Screenshot

The utility class for capturing game screenshots.

Inheritance

System.Object

Screenshot

Namespace: FlaxEngine

Assembly: FlaxEngine.CSharp.dll

Syntax

[Unmanaged]
public static class Screenshot : Object

Methods

Capture(GPUTexture, String)

Captures the specified render target contents and saves it to the file. Remember that downloading data from the GPU may take a while so screenshot may be taken one or more frames later due to latency. Staging textures are saved immediately.

Declaration

[Unmanaged]
public static void Capture(GPUTexture target, string path = null)

Parameters

GPUTexture target The target render target to capture it's contents.

System.String path The custom file location. Use null or empty to use default one.

Capture(SceneRenderTask, String)

Captures the specified render task backbuffer contents and saves it to the file. Remember that downloading data from the GPU may take a while so screenshot may be taken one or more frames later due to latency.

Declaration

[Unmanaged]
public static void Capture(SceneRenderTask target = null, string path = null)

Parameters

SceneRenderTask target The target task to capture it's backbuffer.

System.String path The custom file location. Use null or empty to use default one.

Capture(String)

Captures the main render task backbuffer contents and saves it to the file. Remember that downloading data from the GPU may take a while so screenshot may be taken one or more frames later due to latency.

Declaration

[DebugCommand]
[Unmanaged]
public static void Capture(string path = null)

Parameters

System.String path The custom file location. Use null or empty to use default one.