Class GraphicsSettings

Graphics rendering settings.

System.Object
SettingsBase
GraphicsSettings
Namespace: FlaxEditor.Content.Settings
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class GraphicsSettings : SettingsBase

Constructors

GraphicsSettings()

Initializes a new instance of the GraphicsSettings.

Declaration
public GraphicsSettings()

Fields

AAQuality

Anti Aliasing quality setting.

Declaration
[EditorOrder(1000)]
[EditorDisplay("Quality", "AA Quality")]
public Quality AAQuality
Field Value
Quality

AllowCSMBlending

Enables cascades splits blending for directional light shadows. [Deprecated in v1.9]

Declaration
[EditorOrder(1320)]
[EditorDisplay("Quality", "Allow CSM Blending")]
public bool AllowCSMBlending
Field Value
System.Boolean

DefaultProbeResolution

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

Declaration
[EditorOrder(1500)]
[EditorDisplay("Quality", null)]
public ProbeCubemapResolution DefaultProbeResolution
Field Value
ProbeCubemapResolution

EnableGlobalSDF

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

Declaration
[EditorOrder(2000)]
[EditorDisplay("Global SDF", null)]
public bool EnableGlobalSDF
Field Value
System.Boolean

FallbackFonts

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

Declaration
[EditorOrder(5000)]
[EditorDisplay("Text", null)]
public FontAsset[] FallbackFonts
Field Value
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
[EditorOrder(2010)]
[EditorDisplay("Global SDF", null)]
public bool GenerateSDFOnModelImport
Field Value
System.Boolean

GICascadesBlending

Enables cascades splits blending for Global Illumination.

Declaration
[EditorOrder(2125)]
[EditorDisplay("Global Illumination", "GI Cascades Blending")]
public bool GICascadesBlending
Field Value
System.Boolean

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
[EditorOrder(2120)]
[Limit(50F, 1000F, 1F)]
[EditorDisplay("Global Illumination", null)]
public float GIProbesSpacing
Field Value
System.Single

GIQuality

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

Declaration
[EditorOrder(2100)]
[EditorDisplay("Global Illumination", null)]
public Quality GIQuality
Field Value
Quality

GlobalSDFDistance

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

Declaration
[EditorOrder(2001)]
[EditorDisplay("Global SDF", null)]
[Limit(1000F, 3.40282347E+38F, 1F)]
[ValueCategory]
public float GlobalSDFDistance
Field Value
System.Single

GlobalSDFQuality

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

Declaration
[EditorOrder(2005)]
[EditorDisplay("Global SDF", null)]
public Quality GlobalSDFQuality
Field Value
Quality

GlobalSurfaceAtlasResolution

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

Declaration
[EditorOrder(2130)]
[Limit(256F, 8192F, 1F)]
[EditorDisplay("Global Illumination", null)]
public int GlobalSurfaceAtlasResolution
Field Value
System.Int32

PostProcessSettings

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

Declaration
[EditorOrder(10000)]
[EditorDisplay("Post Process Settings", "__inline__")]
public PostProcessSettings PostProcessSettings
Field Value
PostProcessSettings

ShadowMapsQuality

The shadow maps quality (textures resolution).

Declaration
[EditorOrder(1310)]
[EditorDisplay("Quality", null)]
public Quality ShadowMapsQuality
Field Value
Quality

ShadowsQuality

The shadows quality.

Declaration
[EditorOrder(1300)]
[EditorDisplay("Quality", null)]
public Quality ShadowsQuality
Field Value
Quality

SSAOQuality

Screen Space Ambient Occlusion quality setting.

Declaration
[EditorOrder(1200)]
[EditorDisplay("Quality", "SSAO Quality")]
public Quality SSAOQuality
Field Value
Quality

SSRQuality

Screen Space Reflections quality setting.

Declaration
[EditorOrder(1100)]
[EditorDisplay("Quality", "SSR Quality")]
public Quality SSRQuality
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
[EditorOrder(1502)]
[EditorDisplay("Quality", null)]
public bool UseHDRProbes
Field Value
System.Boolean

UseVSync

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

Declaration
[EditorOrder(20)]
[EditorDisplay("General", "Use V-Sync")]
public bool UseVSync
Field Value
System.Boolean

VolumetricFogQuality

Volumetric Fog quality setting.

Declaration
[EditorOrder(1250)]
[EditorDisplay("Quality", null)]
public Quality VolumetricFogQuality
Field Value
Quality

Extension Methods