GlobalGraphicsSettings.h

Go to the documentation of this file.

// Copyright (c) 2023 FrostBit Software Lab at the Lapland University of Applied Sciences
//
// This work is licensed under the terms of the MIT license.
// For a copy, see <https://opensource.org/licenses/MIT>.
 
#pragma once
 
#include "AntiAliasing.h"
#include "QualityLevel.h"
 
#include "SceneTypes.h"
#include "GlobalGraphicsSettings.generated.h"
 
USTRUCT(Blueprintable)
struct AGRARSENSE_API FGlobalGraphicsSettings
{
    GENERATED_BODY()
 
    /*
    * Graphics preset. Default Ultra.
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    EQualityLevel QualityLevel = EQualityLevel::Balanced;
 
    /*
    * AntiAliasing method. Default TAA.
    * This is linked with QualityLevel. Changing QualityLevel will change Antialiasing method back to TAA.
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    EAntiAliasing AntiAliasingMethod = EAntiAliasing::TAA;
 
    /*
    * Should Grass be rendered.
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Transient)
    bool RenderGrass = true;
 
    /*
    * Should disable Spectator camera 3D rendering.
    * Disabling this improves performance with multiple camera sensors.
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Transient)
    bool DisableSpectatorRendering = false;
 
    /*
    * How far should World Position Offset be rendered in cm.
    * World Position Offset handles foliage wind and other meshes snow.
    * Only applies for meshes rendered by InstancedRenderer system.
    * 0 = unlimited
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Transient)
    int32 WorldPositionOffsetDistance = 30000;
 
    /*
    * Nanite max pixels per edge multiplier. Default is 1.0 by the engine.
    * Lower value means more detail but more performance heavy.
    * Higher value means less detailed models but better performance.
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Transient)
    float NaniteMaxPixelsPerEdge = 1.0f;
 
    /*
    * Shadow cache invalidation behavior option.
    * Meshes with World Position Offset (WPO) is very expensive for shadows to be recalculated,
    * for that reason default option is Rigid, meaning mesh shadows do not move when WPO (wind for example) moves a mesh.
    * Set this to Auto or Always if you want mesh shadows to move accurately.
    * Only applies to meshes rendered with InstancedRenderer system.
    * https://docs.unrealengine.com/5.3/en-US/PythonAPI/class/ShadowCacheInvalidationBehavior.html
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Transient)
    EShadowCacheInvalidationBehavior FoliageShadowCacheInvalidationBehaviour = EShadowCacheInvalidationBehavior::Rigid;
 
    /*
    * Enables the use of Virtual Shadow Maps (VSM), a technique that improves shadow quality and scalability
    * in large, complex scenes by providing detailed shadows with better memory management.
    * Disabled due high amount of flickering with foliage.
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Transient)
    bool UseVirtualShadowMaps = false;
 
    /*
    * Enables caching for Cascaded Shadow Maps (CSM) to improve performance by reusing shadow map data
    * instead of recalculating it every frame.
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Transient)
    bool ShadowCSMCaching = true;
};