RenderSettings.h

#pragma once
 
// Custom.
#include "io/Serializable.h"
 
#include "RenderSettings.generated.h"
 
namespace ne RNAMESPACE() {
    class Renderer;
 
    enum class RendererType : unsigned int { DIRECTX = 0, VULKAN = 1 };
 
    enum class AntialiasingQuality : unsigned int {
        DISABLED = 1,
        MEDIUM = 2,
        HIGH = 4,
        // no x8 MSAA because it has an absurd performance penalty with very little visual changes
    };
 
    enum class ShadowQuality : unsigned int {
        LOW = 256,
        MEDIUM = 512,
        HIGH = 1024,
    };
 
    enum class TextureFilteringQuality : unsigned int {
        LOW = 0,    //< Point filtering.
        MEDIUM = 1, //< Linear filtering.
        HIGH = 2    //< Anisotropic filtering.
    };
 
    enum class TextureQuality : unsigned int {
        VERY_HIGH = 0,
        HIGH = 1,
        MEDIUM = 2,
        LOW = 3,
    };
 
    class RCLASS(Guid("eb477c6d-cdc4-4b7a-9349-296fb38e6bfc")) RenderSettings : public Serializable {
        // Renderer will initialize this object.
        friend class Renderer;
 
    public:
        RenderSettings() = default;
        virtual ~RenderSettings() override = default;
 
        static std::filesystem::path getPathToConfigurationFile();
 
        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;
 
    protected:
        virtual void onAfterDeserialized() override;
 
    private:
        static std::string getConfigurationFileName(bool bIncludeFileExtension);
 
        void setRenderer(Renderer* pRenderer);
 
        [[nodiscard]] std::optional<Error> clampSettingsToMaxSupported();
 
        [[nodiscard]] std::optional<Error> saveConfigurationToDisk();
 
        void notifyRendererAboutChangedSettings(bool bShadowMapSizeChanged = false);
 
        RPROPERTY(Serialize)
        unsigned int iRenderResolutionWidth = 0;
 
        RPROPERTY(Serialize)
        unsigned int iRenderResolutionHeight = 0;
 
        RPROPERTY(Serialize)
        unsigned int iRefreshRateNumerator = 0;
 
        RPROPERTY(Serialize)
        unsigned int iRefreshRateDenominator = 0;
 
        RPROPERTY(Serialize)
        unsigned int iFpsLimit = 0;
 
        RPROPERTY(Serialize)
        std::string sGpuToUse;
 
        RPROPERTY(Serialize)
        unsigned int iRendererType = 0;
 
        RPROPERTY(Serialize)
        unsigned int iShadowMapSize = static_cast<unsigned int>(ShadowQuality::HIGH);
 
        RPROPERTY(Serialize)
        unsigned int iAntialiasingSampleCount = static_cast<unsigned int>(AntialiasingQuality::HIGH);
 
        RPROPERTY(Serialize)
        unsigned int iTextureFilteringQuality = static_cast<unsigned int>(TextureFilteringQuality::HIGH);
 
        RPROPERTY(Serialize)
        unsigned int iTextureQuality = static_cast<unsigned int>(TextureQuality::VERY_HIGH);
 
        RPROPERTY(Serialize)
        bool bIsVsyncEnabled = false;
 
        Renderer* pRenderer = nullptr;
 
        bool bAllowSavingConfigurationToDisk = false;
 
        static inline const char* sRenderSettingsConfigurationFileName = "render";
 
        ne_RenderSettings_GENERATED
    };
} // namespace ne RNAMESPACE()
 
File_RenderSettings_GENERATED