Class GraphicsSettings

Graphics rendering settings.

GraphicsSettings

Inherited Members

SettingsBase::Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

ISerializable::DeserializeIfExists(DeserializeStream& stream, const char* memberName, ISerializeModifier* modifier)

GraphicsSettings

SettingsBase::Serialize(SerializeStream& stream, const void* otherObj)

GraphicsSettings

ISerializable::~ISerializable()

Assembly: FlaxEngine.dll

File: Engine/Core/Config/GraphicsSettings.h

Syntax

public class GraphicsSettings : public SettingsBase

Fields

AAQuality

Anti Aliasing quality setting.

Declaration

public Quality AAQuality = Quality::Medium

Field Value

Quality

AllowCSMBlending

Enables cascades splits blending for directional light shadows.

Declaration

public bool AllowCSMBlending = false

Field Value

bool

DefaultProbeResolution

Default probes cubemap resolution (use for Environment Probes, can be overriden per-actor).

Declaration

public ProbeCubemapResolution DefaultProbeResolution = ProbeCubemapResolution::_128

Field Value

ProbeCubemapResolution

EnableGlobalSDF

If checked, enables Global SDF rendering. This can be used in materials, shaders, and particles.

Declaration

public bool EnableGlobalSDF = false

Field Value

bool

FallbackFonts

The list of fallback fonts used for text rendering. Ignored if empty.

Declaration

public Array<AssetReference<FontAsset>> FallbackFonts

Field Value

Array<AssetReference<FontAsset>>

GenerateSDFOnModelImport

If checked, the 'Generate SDF' option will be checked on model import options by default. Use it if your project uses Global SDF (eg. for Global Illumination or particles).

Declaration

public bool GenerateSDFOnModelImport = false

Field Value

bool

GICascadesBlending

Enables cascades splits blending for Global Illumination.

Declaration

public bool GICascadesBlending = false

Field Value

bool

GIProbesSpacing

The Global Illumination probes spacing distance (in world units). Defines the quality of the GI resolution. Adjust to 200-500 to improve performance and lower frequency GI data.

Declaration

public float GIProbesSpacing = 100

Field Value

float

GIQuality

The Global Illumination quality. Controls the quality of the GI effect.

Declaration

public Quality GIQuality = Quality::High

Field Value

Quality

GlobalSDFDistance

Draw distance of the Global SDF. Actual value can be large when using DDGI.

Declaration

public float GlobalSDFDistance = 15000.0f

Field Value

float

GlobalSDFQuality

The Global SDF quality. Controls the volume texture resolution and amount of cascades to use.

Declaration

public Quality GlobalSDFQuality = Quality::High

Field Value

Quality

GlobalSurfaceAtlasResolution

The Global Surface Atlas resolution. Adjust it if atlas flickers due to overflow (eg. to 4096).

Declaration

public int32 GlobalSurfaceAtlasResolution = 2048

Field Value

int32

PostProcessSettings

The default Post Process settings. Can be overriden by PostFxVolume on a level locally, per camera or for a whole map.

Declaration

public PostProcessSettings PostProcessSettings

Field Value

PostProcessSettings

ShadowMapsQuality

The shadow maps quality (textures resolution).

Declaration

public Quality ShadowMapsQuality = Quality::Medium

Field Value

Quality

ShadowsQuality

The shadows quality.

Declaration

public Quality ShadowsQuality = Quality::Medium

Field Value

Quality

SSAOQuality

Screen Space Ambient Occlusion quality setting.

Declaration

public Quality SSAOQuality = Quality::Medium

Field Value

Quality

SSRQuality

Screen Space Reflections quality setting.

Declaration

public Quality SSRQuality = Quality::Medium

Field Value

Quality

UseHDRProbes

If checked, Environment Probes will use HDR texture format. Improves quality in very bright scenes at cost of higher memory usage.

Declaration

public bool UseHDRProbes = false

Field Value

bool

UseVSync

Enables rendering synchronization with the refresh rate of the display device to avoid "tearing" artifacts.

Declaration

public bool UseVSync = false

Field Value

bool

VolumetricFogQuality

Volumetric Fog quality setting.

Declaration

public Quality VolumetricFogQuality = Quality::High

Field Value

Quality

Methods

Apply()

Applies the settings to the target system.

Declaration

public virtual void Apply() override

Overrides

SettingsBase::Apply()

Get()

Gets the instance of the settings asset (default value if missing). Object returned by this method is always loaded with valid data to use.

Declaration

public static GraphicsSettings* Get()

Returns

GraphicsSettings