Class RenderConfigs

ClassList > RenderConfigs

Rendering configuration container for pipeline and algorithm settings. More...

• #include <RenderConfigs.h>

Public Types

Type	Name
enum char	AAAlg Anti-aliasing algorithm.
enum char	AOAlg Ambient occlusion algorithm.
enum char	OptFlwAlg Optical flow algorithm for motion vectors.
enum char	RenderPipeLine Rendering pipeline architecture.
enum char	SSRAlg Screen-space reflection algorithm.
enum char	SamplingType Temporal sampling accumulation strategy.
enum char	ShadowAlg Shadow rendering algorithm.

Public Attributes

Type	Name
AAAlg	r_anti_alias = AAAlg::FXAA Anti-aliasing (default: FXAA)
AOAlg	r_ao_algorithm = AOAlg::SSAO Ambient occlusion (default: SSAO)
int	r_ao_ksize = 16 Ambient occlusion kernel size (number of samples)
float	r_ao_radius = 0.5 Ambient occlusion sample radius (world space)
float	r_gamma = 1.0f Gamma correction factor.
OptFlwAlg	r_of_algorithm = OptFlwAlg::Backward Optical flow mode.
RenderPipeLine	r_pipeline = RenderPipeLine::Deferred Rendering pipeline (default: Deferred)
int	r_sample_pf = 128 Samples per frame for progressive rendering.
SamplingType	r_sampling_average = SamplingType::Average Sampling strategy.
ShadowAlg	r_shadow_algorithm = ShadowAlg::VSSM Shadow algorithm (default: VSSM)
SSRAlg	r_ssr_algorithm = SSRAlg::SDFResolvedRayMarching Screen-space reflections.

Public Functions

Type	Name
	RenderConfigs () Default constructor with default rendering settings.
bool	RequiresBwdOF () const Checks if backward optical flow is required.
bool	RequiresFXAA () const Checks if FXAA is enabled.
bool	RequiresFwdOF () const Checks if forward optical flow is required.
bool	RequiresMomentShadow () const Checks if moment-based shadow algorithm is selected.
bool	RequiresSDF () const Checks if SDF (Signed Distance Field ) is required.
bool	RequiresSSR () const Checks if screen-space reflections are enabled.
bool	RequiresShadow () const Checks if shadow rendering is enabled.

Detailed Description

RenderConfigs provides enums for algorithm selection and parameters for quality tuning. The Renderer queries these settings to configure the rendering pipeline dynamically.

Key Features: * Pipeline selection (Forward, Deferred, Custom) * Anti-aliasing (MSAA, FXAA) * Ambient occlusion (SSAO, HBAO) * Shadow algorithms (shadow mapping, SDF, VSM, MSM) * Screen-space reflections (SSR) * Post-processing options

Note:

Changes to RenderConfigs take effect on the next Render() call.

Public Types Documentation

enum AAAlg

Anti-aliasing algorithm.

enum RenderConfigs::AAAlg {
    None,
    MSAA,
    FXAA
};

---

enum AOAlg

Ambient occlusion algorithm.

enum RenderConfigs::AOAlg {
    None,
    SSAO,
    HBAO
};

---

enum OptFlwAlg

Optical flow algorithm for motion vectors.

enum RenderConfigs::OptFlwAlg {
    None,
    Forward,
    Backward
};

---

enum RenderPipeLine

Rendering pipeline architecture.

enum RenderConfigs::RenderPipeLine {
    Forward,
    Deferred,
    Custom0
};

---

enum SSRAlg

Screen-space reflection algorithm.

enum RenderConfigs::SSRAlg {
    None,
    RayMarching,
    SDFRayMarching,
    SDFResolvedRayMarching
};

---

enum SamplingType

Temporal sampling accumulation strategy.

enum RenderConfigs::SamplingType {
    Average,
    IncrementAverage
};

---

enum ShadowAlg

Shadow rendering algorithm.

enum RenderConfigs::ShadowAlg {
    None,
    ShadowMapping,
    SDFSoftShadow,
    VSSM,
    MSSM,
    TMSSM
};

---

Public Attributes Documentation

variable r_anti_alias

Anti-aliasing (default: FXAA)

AAAlg RenderConfigs::r_anti_alias;

---

variable r_ao_algorithm

Ambient occlusion (default: SSAO)

AOAlg RenderConfigs::r_ao_algorithm;

---

variable r_ao_ksize

Ambient occlusion kernel size (number of samples)

int RenderConfigs::r_ao_ksize;

---

variable r_ao_radius

Ambient occlusion sample radius (world space)

float RenderConfigs::r_ao_radius;

---

variable r_gamma

Gamma correction factor.

float RenderConfigs::r_gamma;

---

variable r_of_algorithm

Optical flow mode.

OptFlwAlg RenderConfigs::r_of_algorithm;

---

variable r_pipeline

Rendering pipeline (default: Deferred)

RenderPipeLine RenderConfigs::r_pipeline;

---

variable r_sample_pf

Samples per frame for progressive rendering.

int RenderConfigs::r_sample_pf;

---

variable r_sampling_average

Sampling strategy.

SamplingType RenderConfigs::r_sampling_average;

---

variable r_shadow_algorithm

Shadow algorithm (default: VSSM)

ShadowAlg RenderConfigs::r_shadow_algorithm;

---

variable r_ssr_algorithm

Screen-space reflections.

SSRAlg RenderConfigs::r_ssr_algorithm;

---

Public Functions Documentation

function RenderConfigs

Default constructor with default rendering settings.

inline RenderConfigs::RenderConfigs () 

---

function RequiresBwdOF

Checks if backward optical flow is required.

bool RenderConfigs::RequiresBwdOF () const

Returns:

true if backward optical flow should be computed

---

function RequiresFXAA

Checks if FXAA is enabled.

bool RenderConfigs::RequiresFXAA () const

Returns:

true if FXAA anti-aliasing is active

---

function RequiresFwdOF

Checks if forward optical flow is required.

bool RenderConfigs::RequiresFwdOF () const

Returns:

true if forward optical flow should be computed

---

function RequiresMomentShadow

Checks if moment-based shadow algorithm is selected.

bool RenderConfigs::RequiresMomentShadow () const

Returns:

true if MSSM or TMSSM is active

---

function RequiresSDF

Checks if SDF (Signed Distance Field ) is required.

bool RenderConfigs::RequiresSDF () const

Returns:

true if SDF construction is needed for shadows or SSR

---

function RequiresSSR

Checks if screen-space reflections are enabled.

bool RenderConfigs::RequiresSSR () const

Returns:

true if any SSR algorithm is active

---

function RequiresShadow

Checks if shadow rendering is enabled.

bool RenderConfigs::RequiresShadow () const

Returns:

true if any shadow algorithm is active

---

---

The documentation for this class was generated from the following file src/render/RenderConfigs.h