#include <sgct/engine.h>

Collaboration diagram for sgct::Engine::Settings::SS:

[legend]

Public Attributes
std::filesystem::path	capturePath
	The location where the screenshots are being saved.
int	nCaptureThreads = std::max(std::thread::hardware_concurrency() / 2, 1u)
bool	addNodeName = false
	If set to true, the node name is added to screenshots.
bool	addWindowName = true
	If set to true, the window name is added to screenshots.
std::string	prefix
	The prefix to be used for all screenshots.
std::optional< std::pair< uint64_t, uint64_t > >	limits
	Information about the screenshot limits.

Member Data Documentation

◆ addNodeName

bool sgct::Engine::Settings::SS::addNodeName = false

If set to true, the node name is added to screenshots.

◆ addWindowName

bool sgct::Engine::Settings::SS::addWindowName = true

If set to true, the window name is added to screenshots.

◆ capturePath

std::filesystem::path sgct::Engine::Settings::SS::capturePath

The location where the screenshots are being saved.

◆ limits

std::optional<std::pair<uint64_t, uint64_t> > sgct::Engine::Settings::SS::limits

Information about the screenshot limits.

If there is no screenshot limit, this function returns std::nullopt. Otherwise the first component is the index of the first screenshot that will be rendered. The second component is the index of the last screenshot that will not be rendered anymore.

◆ nCaptureThreads

int sgct::Engine::Settings::SS::nCaptureThreads = std::max(std::thread::hardware_concurrency() / 2, 1u)

◆ prefix

std::string sgct::Engine::Settings::SS::prefix

The prefix to be used for all screenshots.

The documentation for this struct was generated from the following file:

sgct/engine.h