Skip to content

ludus::graphics::renderer::RenderGraphCaptureSettings

Ludus Wiki · API overview · Browse API

Struct

Choices for one RenderGraphCapture.

Declared in modules/graphics/renderer/include/ludus/graphics/renderer/render_graph_capture.hpp

#include <ludus/graphics/renderer/render_graph_capture.hpp>
struct ludus::graphics::renderer::RenderGraphCaptureSettings final

Fields

Output

foundation::uint32 ludus::graphics::renderer::RenderGraphCaptureSettings::Output = content::render_graph_format::ABSENT
Logical plan resource to capture; ABSENT selects the plan's only exported colour resource.

Related types: foundation::uint32

Declared in modules/graphics/renderer/include/ludus/graphics/renderer/render_graph_capture.hpp

TargetSamples

foundation::uint32 ludus::graphics::renderer::RenderGraphCaptureSettings::TargetSamples = DEFAULT_RENDER_GRAPH_CAPTURE_SAMPLES
Invocations per pixel to collect after the programs' declared warm-up. The sum must fit MAX_RENDER_GRAPH_CAPTURE_SAMPLES; IID graphs have no warm-up.

Related types: foundation::uint32

Declared in modules/graphics/renderer/include/ludus/graphics/renderer/render_graph_capture.hpp

PreviewInterval

foundation::uint32 ludus::graphics::renderer::RenderGraphCaptureSettings::PreviewInterval = 0
Samples between progress read-backs, after the first sample and then every interval; zero reads back only at the end. Each progress read-back pauses rendering until it completes, then GetPixels shows it.

Related types: foundation::uint32

Declared in modules/graphics/renderer/include/ludus/graphics/renderer/render_graph_capture.hpp

TileCount

foundation::uint32 ludus::graphics::renderer::RenderGraphCaptureSettings::TileCount = 0
Bands per sample, from one to MAX_RENDER_GRAPH_RAY_TILES, each rendered by its own submission; zero chooses ComputeRenderGraphCaptureTileCount of the scene's workload. More than one band needs RenderGraphPrograms::HasRayTiles.

Related types: foundation::uint32

Declared in modules/graphics/renderer/include/ludus/graphics/renderer/render_graph_capture.hpp

PackageIdentity

RenderGraphCaptureIdentity ludus::graphics::renderer::RenderGraphCaptureSettings::PackageIdentity {}
Identity of the runtime package, recorded in the file; zero when unknown.

Related types: RenderGraphCaptureIdentity

Declared in modules/graphics/renderer/include/ludus/graphics/renderer/render_graph_capture.hpp

SceneIdentity

RenderGraphCaptureIdentity ludus::graphics::renderer::RenderGraphCaptureSettings::SceneIdentity {}
Identity of the caller's scene inputs, recorded in the file; zero when unknown.

Related types: RenderGraphCaptureIdentity

Declared in modules/graphics/renderer/include/ludus/graphics/renderer/render_graph_capture.hpp