CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::ShadowMapUpdateStrategy Struct Reference

A structure that describes the strategy that should be used to update a shadow map. More...

#include <CeresEngine/Renderer/RendererLightSettings.hpp>

Public Member Functions

constexpr ShadowMapUpdateStrategy (const UInt32 frequency)
 Creates a new ShadowMapUpdateStrategy descriptor.
 

Static Public Member Functions

static constexpr ShadowMapUpdateStrategy Every (const UInt32 frequency) noexcept
 The shadow map will be updated according to the frequency parameter.
 
template<typename Processor >
static constexpr void reflect (Processor &&RTTI)
 Executes the given processor for every field of the struct.
 

Public Attributes

UInt32 frequency = 1
 The update frequency.
 

Static Public Attributes

static const ShadowMapUpdateStrategy Once
 Updates the shadow map once and then uses it as static map.
 
static const ShadowMapUpdateStrategy EveryFrame
 The shadow map will be updated according to the updateFrequency parameter.
 
static const ShadowMapUpdateStrategy Never
 Never updates the shadow map.
 

Detailed Description

A structure that describes the strategy that should be used to update a shadow map.

Constructor & Destructor Documentation

◆ ShadowMapUpdateStrategy()

constexpr CeresEngine::ShadowMapUpdateStrategy::ShadowMapUpdateStrategy ( const UInt32  frequency)
inlineconstexpr

Creates a new ShadowMapUpdateStrategy descriptor.

Parameters
frequencyThe update frequency.

Member Function Documentation

◆ Every()

static constexpr ShadowMapUpdateStrategy CeresEngine::ShadowMapUpdateStrategy::Every ( const UInt32  frequency)
inlinestaticconstexprnoexcept

The shadow map will be updated according to the frequency parameter.

If frequency is set to 1, the shadow map is updated every frame.

◆ reflect()

template<typename Processor >
static constexpr void CeresEngine::ShadowMapUpdateStrategy::reflect ( Processor &&  RTTI)
inlinestaticconstexpr

Executes the given processor for every field of the struct.

Parameters
RTTIThe processor to be ran for every field.

Member Data Documentation

◆ EveryFrame

const ShadowMapUpdateStrategy CeresEngine::ShadowMapUpdateStrategy::EveryFrame
static

The shadow map will be updated according to the updateFrequency parameter.

If updateFrequency is set to either 0 or 1, the shadow map is updated every frame.

◆ frequency

UInt32 CeresEngine::ShadowMapUpdateStrategy::frequency = 1

The update frequency.

Setting this to 0 will cause the shadow map to never be updated. Setting it to 1 will cause the shadow map to be updated on every frame. Setting it to ~0u will cause the shadow map to be updated once and then never again. Any other value will cause it to be updated after every frequency frames.

◆ Never

const ShadowMapUpdateStrategy CeresEngine::ShadowMapUpdateStrategy::Never
static

Never updates the shadow map.

◆ Once

const ShadowMapUpdateStrategy CeresEngine::ShadowMapUpdateStrategy::Once
static

Updates the shadow map once and then uses it as static map.


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