#include <RenderSettings.h>

Inheritance diagram for ne::RenderSettings:

Public Member Functions
void	setFpsLimit (unsigned int iNewFpsLimit)

void	setShadowQuality (ShadowQuality quality)

void	setAntialiasingQuality (AntialiasingQuality quality)

void	setTextureFilteringQuality (TextureFilteringQuality quality)

void	setTextureQuality (TextureQuality quality)

void	setRenderResolution (std::pair< unsigned int, unsigned int > resolution)

void	setVsyncEnabled (bool bEnableVsync)

void	setRefreshRate (std::pair< unsigned int, unsigned int > refreshRate)

void	setGpuToUse (const std::string &sGpuName)

void	setPreferredRenderer (RendererType preferredRenderer)

unsigned int	getFpsLimit () const

AntialiasingQuality	getAntialiasingQuality () const

ShadowQuality	getShadowQuality () const

std::variant< AntialiasingQuality, Error >	getMaxSupportedAntialiasingQuality () const

TextureFilteringQuality	getTextureFilteringQuality () const

TextureQuality	getTextureQuality () const

std::pair< unsigned int, unsigned int >	getRenderResolution () const

bool	isVsyncEnabled () const

std::pair< unsigned int, unsigned int >	getRefreshRate () const

std::string	getGpuToUse () const

Public Member Functions inherited from ne::Serializable
std::optional< Error >	serialize (std::filesystem::path pathToFile, bool bEnableBackup, const std::unordered_map< std::string, std::string > &customAttributes={})

std::variant< std::string, Error >	serialize (toml::value &tomlData, const std::string &sEntityId="", const std::unordered_map< std::string, std::string > &customAttributes={}, const std::optional< std::filesystem::path > &optionalPathToFile={}, bool bEnableBackup=false)

std::variant< std::string, Error >	serialize (toml::value &tomlData, Serializable *pOriginalObject, std::string sEntityId="", const std::unordered_map< std::string, std::string > &customAttributes={}, const std::optional< std::filesystem::path > &optionalPathToFile={}, bool bEnableBackup=false)

std::optional< std::pair< std::string, std::string > >	getPathDeserializedFromRelativeToRes () const

Static Public Member Functions
static std::filesystem::path	getPathToConfigurationFile ()

Static Public Member Functions inherited from ne::Serializable
static std::optional< Error >	serializeMultiple (std::filesystem::path pathToFile, std::vector< SerializableObjectInformation > vObjects, bool bEnableBackup)

static std::variant< std::set< std::string >, Error >	getIdsFromFile (std::filesystem::path pathToFile)

template<typename SmartPointer , typename InnerType = typename SmartPointer::element_type> requires std::derived_from<InnerType, Serializable> && (std::same_as<SmartPointer, sgc::GcPtr<InnerType>> \|\| std::same_as<SmartPointer, std::unique_ptr<InnerType>>)
static std::variant< SmartPointer, Error >	deserialize (const std::filesystem::path &pathToFile)

template<typename SmartPointer , typename InnerType = typename SmartPointer::element_type> requires std::derived_from<InnerType, Serializable> && (std::same_as<SmartPointer, sgc::GcPtr<InnerType>> \|\| std::same_as<SmartPointer, std::unique_ptr<InnerType>>)
static std::variant< SmartPointer, Error >	deserialize (const std::filesystem::path &pathToFile, std::unordered_map< std::string, std::string > &customAttributes)

template<typename SmartPointer , typename InnerType = typename SmartPointer::element_type> requires std::derived_from<InnerType, Serializable> && (std::same_as<SmartPointer, sgc::GcPtr<InnerType>> \|\| std::same_as<SmartPointer, std::unique_ptr<InnerType>>)
static std::variant< SmartPointer, Error >	deserialize (std::filesystem::path pathToFile, std::unordered_map< std::string, std::string > &customAttributes, const std::string &sEntityId)

template<typename SmartPointer , typename InnerType = typename SmartPointer::element_type> requires std::derived_from<InnerType, Serializable> && (std::same_as<SmartPointer, sgc::GcPtr<InnerType>> \|\| std::same_as<SmartPointer, std::unique_ptr<InnerType>>)
static std::variant< SmartPointer, Error >	deserialize (const std::filesystem::path &pathToFile, const std::string &sEntityId)

template<typename SmartPointer , typename InnerType = typename SmartPointer::element_type> requires std::same_as<SmartPointer, sgc::GcPtr<Serializable>> \|\| std::same_as<SmartPointer, std::unique_ptr<Serializable>>
static std::variant< std::vector< DeserializedObjectInformation< SmartPointer > >, Error >	deserializeMultiple (std::filesystem::path pathToFile, const std::set< std::string > &ids)

template<typename SmartPointer , typename InnerType = typename SmartPointer::element_type> requires std::derived_from<InnerType, Serializable> && (std::same_as<SmartPointer, sgc::GcPtr<InnerType>> \|\| std::same_as<SmartPointer, std::unique_ptr<InnerType>>)
static std::variant< SmartPointer, Error >	deserialize (const toml::value &tomlData, std::unordered_map< std::string, std::string > &customAttributes, std::string sEntityId="", std::optional< std::filesystem::path > optionalPathToFile={})

Protected Member Functions
virtual void	onAfterDeserialized () override

virtual void	onAfterDeserialized ()

Private Member Functions
void	setRenderer (Renderer *pRenderer)

std::optional< Error >	clampSettingsToMaxSupported ()

std::optional< Error >	saveConfigurationToDisk ()

void	notifyRendererAboutChangedSettings (bool bShadowMapSizeChanged=false)

Static Private Member Functions
static std::string	getConfigurationFileName (bool bIncludeFileExtension)

Private Attributes
unsigned int	iRenderResolutionWidth = 0

unsigned int	iRenderResolutionHeight = 0

unsigned int	iRefreshRateNumerator = 0

unsigned int	iRefreshRateDenominator = 0

unsigned int	iFpsLimit = 0

std::string	sGpuToUse

unsigned int	iRendererType = 0

unsigned int	iShadowMapSize = static_cast<unsigned int>(ShadowQuality::HIGH)

unsigned int	iAntialiasingSampleCount = static_cast<unsigned int>(AntialiasingQuality::HIGH)

unsigned int	iTextureFilteringQuality = static_cast<unsigned int>(TextureFilteringQuality::HIGH)

unsigned int	iTextureQuality = static_cast<unsigned int>(TextureQuality::VERY_HIGH)

bool	bIsVsyncEnabled = false

Renderer *	pRenderer = nullptr

bool	bAllowSavingConfigurationToDisk = false

Static Private Attributes
static const char *	sRenderSettingsConfigurationFileName = "render"

Friends
class	Renderer

Detailed Description

Controls renderer settings.

Member Function Documentation

◆ clampSettingsToMaxSupported()

std::optional< Error > ne::RenderSettings::clampSettingsToMaxSupported ( )

private

Called by the renderer when it has finished initializing its essential entities so that RenderSettings can query maximum supported settings and clamp the current values (if needed).

Returns: Error if something went wrong.

◆ getAntialiasingQuality()

AntialiasingQuality ne::RenderSettings::getAntialiasingQuality ( ) const

Returns current anti-aliasing (AA) quality.

Returns: Returns DISABLED if AA is not supported (see getMaxSupportedAntialiasingQuality), otherwise current AA quality.

◆ getConfigurationFileName()

std::string ne::RenderSettings::getConfigurationFileName ( bool bIncludeFileExtension )

staticprivate

Returns name of the file that is used to store setting configuration.

Parameters

bIncludeFileExtension Whether to include file extension in the returned string or not.

Returns: Name of the file.

◆ getFpsLimit()

unsigned int ne::RenderSettings::getFpsLimit ( ) const

Returns the maximum number of FPS that is allowed to be produced in a second.

Returns: Maximum allowed FPS, 0 means disabled.

◆ getGpuToUse()

std::string ne::RenderSettings::getGpuToUse ( ) const

Returns name of the GPU to use.

Remarks: This value is taken from the renderer's settings file (see setGpuToUse) which sometimes might not represent the actual GPU being used. Instead you might be interested in Renderer::getCurrentlyUsedGpuName.

Returns: Name of the GPU specified in the settings.

◆ getMaxSupportedAntialiasingQuality()

std::variant< AntialiasingQuality, Error > ne::RenderSettings::getMaxSupportedAntialiasingQuality ( ) const

Returns the maximum anti-aliasing quality that can be used on the picked GPU (see Renderer::getCurrentlyUsedGpuName).

Remarks: Note that the maximum supported AA quality can differ depending on the used GPU/renderer.

Returns: Error if something went wrong, otherwise DISABLED if AA is not supported or the maximum supported AA quality.

◆ getPathToConfigurationFile()

std::filesystem::path ne::RenderSettings::getPathToConfigurationFile ( )

static

Returns path to the file that is used to store setting configuration.

Returns: Path to file.

◆ getRefreshRate()

std::pair< unsigned int, unsigned int > ne::RenderSettings::getRefreshRate ( ) const

Returns currently used screen's refresh rate.

Returns: Numerator and denominator of the refresh rate.

◆ getRenderResolution()

std::pair< unsigned int, unsigned int > ne::RenderSettings::getRenderResolution ( ) const

Returns currently used render resolution (width and height).

Returns: Width and height in pixels.

◆ getShadowQuality()

ShadowQuality ne::RenderSettings::getShadowQuality ( ) const

Returns current shadow quality.

Returns: Shadow quality.

◆ getTextureFilteringQuality()

TextureFilteringQuality ne::RenderSettings::getTextureFilteringQuality ( ) const

Returns currently used texture filtering quality.

Returns: Texture filtering quality.

◆ getTextureQuality()

TextureQuality ne::RenderSettings::getTextureQuality ( ) const

Returns currently used texture quality.

Returns: Texture quality.

◆ isVsyncEnabled()

bool ne::RenderSettings::isVsyncEnabled ( ) const

Tells if vertical synchronization is currently enabled or not.

Returns: Whether vertical synchronization is currently enabled or not.

◆ notifyRendererAboutChangedSettings()

void ne::RenderSettings::notifyRendererAboutChangedSettings ( bool bShadowMapSizeChanged = false )

private

Notifies the renderer to change its internal state to match the current settings.

Remarks: Does nothing if the renderer is not initialized yet. The renderer will take values from the settings upon initialization.

Parameters

bShadowMapSizeChanged true if shadow map size was changed, false otherwise.

◆ onAfterDeserialized()

void ne::RenderSettings::onAfterDeserialized ( )

overrideprotectedvirtual

Called after the object was successfully deserialized. Used to execute post-deserialization logic.

Warning: If overriding you must call the parent's version of this function first (before executing your login) to execute parent's logic.

Reimplemented from ne::Serializable.

◆ saveConfigurationToDisk()

std::optional< Error > ne::RenderSettings::saveConfigurationToDisk ( )

private

Saves the current configuration to disk.

Remarks: Does nothing if bAllowSavingConfigurationToDisk is false.

Returns: Error if something went wrong.

◆ setAntialiasingQuality()

void ne::RenderSettings::setAntialiasingQuality ( AntialiasingQuality quality )

Sets anti-aliasing (AA) quality.

Warning: Use getMaxSupportedAntialiasingQuality to query for maximum supported AA quality, if the specified quality is not supported an error will be logged.

Parameters

quality AA quality.

◆ setFpsLimit()

void ne::RenderSettings::setFpsLimit ( unsigned int iNewFpsLimit )

Sets the maximum number of FPS that is allowed to be produced in a second.

Parameters

iNewFpsLimit Maximum allowed FPS, specify 0 to disable.

◆ setGpuToUse()

void ne::RenderSettings::setGpuToUse ( const std::string & sGpuName )

Sets GPU to be used next time the engine starts.

Remarks: Use Renderer to get available GPU names.; In order for this setting to be applied the engine needs to be restarted.

Parameters

sGpuName Name of the GPU to use.

◆ setPreferredRenderer()

void ne::RenderSettings::setPreferredRenderer ( RendererType preferredRenderer )

Changes renderer's config file setting about preferred renderer.

Remarks: In order for this setting to be applied the engine needs to be restarted.; Note that this setting will be ignored if you use Window::setPreferredRenderer.

Parameters

preferredRenderer Renderer to prefer (test the first one) next time the game is started.

◆ setRefreshRate()

void ne::RenderSettings::setRefreshRate ( std::pair< unsigned int, unsigned int > refreshRate )

Sets screen's refresh rate to use.

Remarks: In order for this setting to be applied the engine needs to be restarted.

Parameters

refreshRate Numerator and denominator of the refresh rate to use.

◆ setRenderer()

void ne::RenderSettings::setRenderer ( Renderer * pRenderer )

private

Sets renderer to be used.

Remarks: It is essential to call this function to initialize the object.

Parameters

pRenderer Game's renderer.

◆ setRenderResolution()

void ne::RenderSettings::setRenderResolution ( std::pair< unsigned int, unsigned int > resolution )

Sets the width and the height of the render resolution.

Remarks: Use Renderer::getSupportedRenderResolutions to query for available render resolutions.

Parameters

resolution Width and height in pixels.

◆ setShadowQuality()

void ne::RenderSettings::setShadowQuality ( ShadowQuality quality )

Sets shadow quality.

Parameters

quality Quality to use.

◆ setTextureFilteringQuality()

void ne::RenderSettings::setTextureFilteringQuality ( TextureFilteringQuality quality )

Sets texture filtering quality to be used.

Parameters

quality Quality to use.

◆ setTextureQuality()

void ne::RenderSettings::setTextureQuality ( TextureQuality quality )

Sets texture quality to be used.

Remarks: In order for this setting to be applied the engine needs to be restarted.

Parameters

quality Quality to use.

◆ setVsyncEnabled()

void ne::RenderSettings::setVsyncEnabled ( bool bEnableVsync )

Sets whether to enable vertical synchronization or not.

Parameters

bEnableVsync Whether to enable vertical synchronization or not.

Member Data Documentation

◆ bAllowSavingConfigurationToDisk

bool ne::RenderSettings::bAllowSavingConfigurationToDisk = false

private

Defines whether or not changes to render settings trigger saving on disk.

Remarks: Disabled by default as render settings can be modified by a renderer during its initialization (some settings getting clamped/fixed due to render/hardware capabilities) and because a renderer can fail to initialize (for example if the hardware does not support it) we don't want any of these modifications to be saved. Once a renderer was initialized the base Renderer class will enable saving on disk and will trigger a manual resave to apply possibly fixed/clamped settings.

◆ bIsVsyncEnabled

bool ne::RenderSettings::bIsVsyncEnabled = false

private

Whether VSync is enabled or not.

◆ iAntialiasingSampleCount

unsigned int ne::RenderSettings::iAntialiasingSampleCount = static_cast<unsigned int>(AntialiasingQuality::HIGH)

private

Sample count of AA.

◆ iFpsLimit

unsigned int ne::RenderSettings::iFpsLimit = 0

private

The maximum number of FPS that is allowed to be produced in a second.

Remarks: Disabled if zero.

◆ iRefreshRateDenominator

unsigned int ne::RenderSettings::iRefreshRateDenominator = 0

private

Denominator of screen's refresh rate.

◆ iRefreshRateNumerator

unsigned int ne::RenderSettings::iRefreshRateNumerator = 0

private

Numerator of screen's refresh rate.

◆ iRendererType

unsigned int ne::RenderSettings::iRendererType = 0

private

Stored used type of the renderer (DirectX/Vulkan/etc.).

Remarks: Can be changed from the config file to change preferred renderer.

◆ iRenderResolutionHeight

unsigned int ne::RenderSettings::iRenderResolutionHeight = 0

private

Height of the back buffer.

◆ iRenderResolutionWidth

unsigned int ne::RenderSettings::iRenderResolutionWidth = 0

private

Width of the back buffer.

◆ iShadowMapSize

unsigned int ne::RenderSettings::iShadowMapSize = static_cast<unsigned int>(ShadowQuality::HIGH)

private

Shadow map resolution in pixels.

◆ iTextureFilteringQuality

unsigned int ne::RenderSettings::iTextureFilteringQuality = static_cast<unsigned int>(TextureFilteringQuality::HIGH)

private

Texture filtering mode.

◆ iTextureQuality

unsigned int ne::RenderSettings::iTextureQuality = static_cast<unsigned int>(TextureQuality::VERY_HIGH)

private

Defines how much mipmaps we will skip when loading textures from disk.

◆ pRenderer

Renderer* ne::RenderSettings::pRenderer = nullptr

private

Do not delete (free) this pointer. Game's renderer.

◆ sGpuToUse

std::string ne::RenderSettings::sGpuToUse

private

Name of the GPU to use.

◆ sRenderSettingsConfigurationFileName

const char* ne::RenderSettings::sRenderSettingsConfigurationFileName = "render"

inlinestaticprivate

Name of the file we use to store render settings.

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

src/engine_lib/public/render/RenderSettings.h
src/engine_lib/private/render/general/RenderSettings.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Function Documentation

◆ clampSettingsToMaxSupported()

◆ getAntialiasingQuality()

◆ getConfigurationFileName()

◆ getFpsLimit()

◆ getGpuToUse()

◆ getMaxSupportedAntialiasingQuality()

◆ getPathToConfigurationFile()

◆ getRefreshRate()

◆ getRenderResolution()

◆ getShadowQuality()

◆ getTextureFilteringQuality()

◆ getTextureQuality()

◆ isVsyncEnabled()

◆ notifyRendererAboutChangedSettings()

◆ onAfterDeserialized()

◆ saveConfigurationToDisk()

◆ setAntialiasingQuality()

◆ setFpsLimit()

◆ setGpuToUse()

◆ setPreferredRenderer()

◆ setRefreshRate()

◆ setRenderer()

◆ setRenderResolution()

◆ setShadowQuality()

◆ setTextureFilteringQuality()

◆ setTextureQuality()

◆ setVsyncEnabled()

Member Data Documentation

◆ bAllowSavingConfigurationToDisk

◆ bIsVsyncEnabled

◆ iAntialiasingSampleCount

◆ iFpsLimit

◆ iRefreshRateDenominator

◆ iRefreshRateNumerator

◆ iRendererType

◆ iRenderResolutionHeight

◆ iRenderResolutionWidth

◆ iShadowMapSize

◆ iTextureFilteringQuality

◆ iTextureQuality

◆ pRenderer

◆ sGpuToUse

◆ sRenderSettingsConfigurationFileName