#include <RenderingParameters.h>

Inheritance diagram for core::RenderingParameters:

Collaboration diagram for core::RenderingParameters:

Public Member Functions
	RenderingParameters ()

void	print () final

const auto &	getRenderers () const

void	addRenderer (const std::string &renderer)

const std::string &	getCurrentCamera () const

const auto &	getCameras () const

void	addCamera (const std::string &camera)

double	getVarianceThreshold () const

void	setVarianceThreshold (const double value)

AccumulationType	getAccumulationType () const

const std::string	getAccumulationTypeAsString (const AccumulationType value)

void	setNumNonDenoisedFrames (const uint32_t value)

uint32_t	getNumNonDenoisedFrames () const

void	setDenoiseBlend (const float value)

float	getDenoiseBlend () const

void	setToneMapperExposure (const float value)

float	getToneMapperExposure () const

void	setToneMapperGamma (const float value)

float	getToneMapperGamma () const

Public Member Functions inherited from core::AbstractParameters
	AbstractParameters (const std::string &name)

virtual	~AbstractParameters ()=default

po::options_description &	parameters ()

Public Member Functions inherited from core::BaseObject
	BaseObject ()=default

virtual	~BaseObject ()=default

	BaseObject (const BaseObject &)

BaseObject &	operator= (const BaseObject &rhs)

bool	isModified () const

void	resetModified ()

void	markModified (const bool triggerCallback=true)

void	onModified (const ModifiedCallback &callback)

void	clearModifiedCallback ()

Protected Member Functions
void	parse (const po::variables_map &vm) final

Protected Member Functions inherited from core::BaseObject
template<typename T >
void	_updateValue (T &member, const T &newValue, const bool triggerCallback=true)

template<class T >
bool	_isEqual (const T &a, const T &b, typename std::enable_if< std::is_floating_point< T >::value >::type *=0)

template<class T >
bool	_isEqual (const T &a, const T &b, typename std::enable_if<!std::is_floating_point< T >::value >::type *=0)

Protected Attributes
std::deque< std::string >	_renderers

std::string	_camera {"perspective"}

std::deque< std::string >	_cameras

double	_varianceThreshold {-1.}

uint32_t	_numNonDenoisedFrames {2}

float	_denoiseBlend {0.1f}

float	_toneMapperExposure {1.5f}

float	_toneMapperGamma {1.f}

AccumulationType	_accumulationType {AccumulationType::linear}

Protected Attributes inherited from core::AbstractParameters
std::string	_name

po::options_description	_parameters

Additional Inherited Members
Public Types inherited from core::BaseObject
using	ModifiedCallback = std::function< void(const BaseObject &)>

Static Protected Member Functions inherited from core::AbstractParameters
static std::string	asString (const bool flag)

Detailed Description

Manages rendering parameters

Definition at line 38 of file RenderingParameters.h.

Constructor & Destructor Documentation

◆ RenderingParameters()

core::RenderingParameters::RenderingParameters ( )

Definition at line 41 of file RenderingParameters.cpp.

Member Function Documentation

◆ addCamera()

void core::RenderingParameters::addCamera ( const std::string & camera )

inline

Definition at line 57 of file RenderingParameters.h.

◆ addRenderer()

void core::RenderingParameters::addRenderer ( const std::string & renderer )

inline

Definition at line 48 of file RenderingParameters.h.

◆ getAccumulationType()

AccumulationType core::RenderingParameters::getAccumulationType ( ) const

inline

If the rendering should be refined by accumulating multiple passes

Definition at line 70 of file RenderingParameters.h.

◆ getAccumulationTypeAsString()

const std::string core::RenderingParameters::getAccumulationTypeAsString ( const AccumulationType value )

Definition at line 80 of file RenderingParameters.cpp.

◆ getCameras()

const auto& core::RenderingParameters::getCameras ( ) const

inline

All registered cameras

Definition at line 56 of file RenderingParameters.h.

◆ getCurrentCamera()

const std::string& core::RenderingParameters::getCurrentCamera ( ) const

inline

Definition at line 53 of file RenderingParameters.h.

◆ getDenoiseBlend()

float core::RenderingParameters::getDenoiseBlend ( ) const

inline

Definition at line 82 of file RenderingParameters.h.

◆ getNumNonDenoisedFrames()

uint32_t core::RenderingParameters::getNumNonDenoisedFrames ( ) const

inline

Definition at line 78 of file RenderingParameters.h.

◆ getRenderers()

const auto& core::RenderingParameters::getRenderers ( ) const

inline

All registered renderers

Definition at line 47 of file RenderingParameters.h.

◆ getToneMapperExposure()

float core::RenderingParameters::getToneMapperExposure ( ) const

inline

Definition at line 86 of file RenderingParameters.h.

◆ getToneMapperGamma()

float core::RenderingParameters::getToneMapperGamma ( ) const

inline

Definition at line 90 of file RenderingParameters.h.

◆ getVarianceThreshold()

double core::RenderingParameters::getVarianceThreshold ( ) const

inline

Returns: the threshold where accumulation stops if the variance error reaches this value.

Definition at line 62 of file RenderingParameters.h.

◆ parse()

void core::RenderingParameters::parse ( const po::variables_map & )

finalprotectedvirtual

Parses parameters managed by the class

Parameters

vm	the variables map of all arguments passed by the user

Reimplemented from core::AbstractParameters.

Definition at line 63 of file RenderingParameters.cpp.

◆ print()

void core::RenderingParameters::print ( )

finalvirtual

Displays values of registered parameters

Reimplemented from core::AbstractParameters.

Definition at line 85 of file RenderingParameters.cpp.

◆ setDenoiseBlend()

void core::RenderingParameters::setDenoiseBlend ( const float value )

inline

Definition at line 81 of file RenderingParameters.h.

◆ setNumNonDenoisedFrames()

void core::RenderingParameters::setNumNonDenoisedFrames ( const uint32_t value )

inline

Denoising parameters: Used by the Optix 6 engine only Number of frames that show the original image before switching on denoising

Definition at line 77 of file RenderingParameters.h.

◆ setToneMapperExposure()

void core::RenderingParameters::setToneMapperExposure ( const float value )

inline

Definition at line 85 of file RenderingParameters.h.

◆ setToneMapperGamma()

void core::RenderingParameters::setToneMapperGamma ( const float value )

inline

Definition at line 89 of file RenderingParameters.h.

◆ setVarianceThreshold()

void core::RenderingParameters::setVarianceThreshold ( const double value )

inline

The threshold where accumulation stops if the variance error reaches this value.

Definition at line 67 of file RenderingParameters.h.

Member Data Documentation

◆ _accumulationType

AccumulationType core::RenderingParameters::_accumulationType {AccumulationType::linear}

protected

Definition at line 103 of file RenderingParameters.h.

◆ _camera

std::string core::RenderingParameters::_camera {"perspective"}

protected

Definition at line 96 of file RenderingParameters.h.

◆ _cameras

std::deque<std::string> core::RenderingParameters::_cameras

protected

Definition at line 97 of file RenderingParameters.h.

◆ _denoiseBlend

float core::RenderingParameters::_denoiseBlend {0.1f}

protected

Definition at line 100 of file RenderingParameters.h.

◆ _numNonDenoisedFrames

uint32_t core::RenderingParameters::_numNonDenoisedFrames {2}

protected

Definition at line 99 of file RenderingParameters.h.

◆ _renderers

std::deque<std::string> core::RenderingParameters::_renderers

protected

Definition at line 95 of file RenderingParameters.h.

◆ _toneMapperExposure

float core::RenderingParameters::_toneMapperExposure {1.5f}

protected

Definition at line 101 of file RenderingParameters.h.

◆ _toneMapperGamma

float core::RenderingParameters::_toneMapperGamma {1.f}

protected

Definition at line 102 of file RenderingParameters.h.

◆ _varianceThreshold

double core::RenderingParameters::_varianceThreshold {-1.}

protected

Definition at line 98 of file RenderingParameters.h.

The documentation for this class was generated from the following files:

platform/core/parameters/RenderingParameters.h
platform/core/parameters/RenderingParameters.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RenderingParameters()

Member Function Documentation

◆ addCamera()

◆ addRenderer()

◆ getAccumulationType()

◆ getAccumulationTypeAsString()

◆ getCameras()

◆ getCurrentCamera()

◆ getDenoiseBlend()

◆ getNumNonDenoisedFrames()

◆ getRenderers()

◆ getToneMapperExposure()

◆ getToneMapperGamma()

◆ getVarianceThreshold()

◆ parse()

◆ print()

◆ setDenoiseBlend()

◆ setNumNonDenoisedFrames()

◆ setToneMapperExposure()

◆ setToneMapperGamma()

◆ setVarianceThreshold()

Member Data Documentation

◆ _accumulationType

◆ _camera

◆ _cameras

◆ _denoiseBlend

◆ _numNonDenoisedFrames

◆ _renderers

◆ _toneMapperExposure

◆ _toneMapperGamma

◆ _varianceThreshold