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.

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

DefaultProbeCubemapFormat

Environment Probes texture storage format. Controls the quality fo reflections and memory usage of probes data.

Declaration
[EditorOrder(1502)]
[EditorDisplay("Quality", null)]
public GraphicsSettings.ProbeCubemapFormats DefaultProbeCubemapFormat
Field Value
GraphicsSettings.ProbeCubemapFormats

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[]

GammaColorSpace

If checked, color space workflow will use Gamma instead of Linear. Gamma color space defines colors with an applied a gamma curve (sRGB) so they are perceptually linear. This makes sense when the output of the rendering represent final color values that will be presented to a non-HDR screen.

Declaration
[EditorOrder(3000)]
[EditorDisplay("Colors", null)]
public bool GammaColorSpace
Field Value
System.Boolean

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 smooth blending between Global Illumination cascade splits. If disabled, the transition uses dithering intended for temporal anti-aliasing. Smooth blending can expose rounded cascade boundaries when adjacent cascades contain significantly different lighting.

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

GIProbesSpacing

The global spacing between Global Illumination probes (in world units). Smaller values improve interior detail at a higher GPU cost. Values around 100-150 are a useful starting point for mixed interiors and exteriors; adjust to 200-500 for mostly outdoor scenes and lower-frequency GI. Changing this value recreates the DDGI probe resources and can change the automatic cascade layout.

Declaration
[EditorOrder(2120)]
[Limit(50F, 1000F, 1F)]
[EditorDisplay("Global Illumination", null)]
[ValueCategory]
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 larger 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

OcclusionBoundsScale

The object bounds scale for occlusion culling to reduce popping artifacts caused by latency of visibility readback from GPU to CPU. Higher values inflate bounds which improves visual stability but lowers occlusion culling efficiency.

Declaration
[EditorOrder(1461)]
[EditorDisplay("Culling", null)]
[Limit(1F, 1.5F, 1F)]
public float OcclusionBoundsScale
Field Value
System.Single

OcclusionBufferedFrames

The number of buffered frames for the visibility query results readback from GPU (to avoid stalls). The higher value the more latency but less CPU stalls (to wait for GPU results). Higher values increase object popping artifacts.

Declaration
[EditorOrder(1460)]
[EditorDisplay("Culling", null)]
[Limit(1F, 4F, 1F)]
public int OcclusionBufferedFrames
Field Value
System.Int32

OcclusionCulling

The type of the occlusion culling (implements IOcclusionCulling) that will be used to test visibility of the objects and skip rendering occluded ones. Can be left empty to use frustum-culling only.

Declaration
[EditorOrder(1450)]
[EditorDisplay("Culling", null)]
[TypeReference]
[CustomEditorAlias("FlaxEditor.CustomEditors.Editors.TypeNameEditor")]
public string OcclusionCulling
Field Value
System.String

PostProcessSettings

The default Post Process settings. Can be overridden 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

RenderColorFormat

Pixel format used by the rendering pipeline (for light buffer and post-processing).

Declaration
[EditorOrder(3010)]
[EditorDisplay("Colors", null)]
public GraphicsSettings.RenderColorFormats RenderColorFormat
Field Value
GraphicsSettings.RenderColorFormats

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

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