API Reference · Capturing a frame

RenderOptions

Namespace: Ava3D

public sealed class RenderOptions

How SceneRenderer.RenderAsync should draw. The defaults are a finished picture.

Properties

MemberDescription
bool Composited { get; set; }

Whether the picture is the frame as it would be shown — after bloom and the vignette — or the renderer's frame before either. True by default. See CaptureRequest.Composited.

CaptureFormat Format { get; set; }

How the pixels come back. CaptureFormat.Rgba8 by default.

double RenderScale { get; set; }

How many pixels to render for each pixel returned, along each axis. One by default. Two renders the scene at four times the size and averages it down to the size asked for — the same lever as Ava3DView.RenderScale, and the one that reaches inside a triangle where samples do not. Clamped to 0.1 to 8, and by what the device will allocate.

int SampleCount { get; set; }

Samples per pixel to rasterise with: 1, 2, 4 or 8. Four by default — the setting a screenshot wants and a live view leaves at one for the frame rate. Metal and OpenGL take it; Vulkan and the CPU renderer draw at one, as they do on screen. See Ava3DView.SampleCount.

See also