RenderSettingsclass
User graphics settings
Constructors1
Showing 1 constructors
public RenderSettings()
No results match this filter.
Methods6
Showing 6 methods
public void Apply()
void—public Sandbox.Engine.Settings.RenderSettings.VideoDisplayMode[] DisplayModes(bool windowed)
| Parameter | Type | Description |
|---|---|---|
| windowed | bool | — |
public static bool IsUpscalerModeSupported(Sandbox.Engine.Settings.UpscalerMode mode)
Returns whether the given `Sandbox.Engine.Settings.RenderSettings.UpscalerMode` is usable on the current graphics device. Off / Stretch / FSR1 / FSR3 are always available; DLSS requires NVIDIA hardware with NGX support and is queried from the native render device.
| Parameter | Type | Description |
|---|---|---|
| mode | UpscalerMode | — |
bool—public void ResetDisplayConfig()
Window, resolution, vsync, frame rate caps and field of view.
void—public void ResetGraphicsConfig()
Quality and upscaling, back to whatever this machine detects.
void—public void ResetVideoConfig()
void—No results match this filter.
Properties26
Showing 26 properties
public Sandbox.Engine.Settings.EffectQuality Sandbox.Engine.Settings.RenderSettings.AmbientOcclusionQuality { get; set; }
Contact shading where surfaces meet. Its resolution and denoise passes ride with the level.
public Sandbox.MultisampleAmount Sandbox.Engine.Settings.RenderSettings.AntiAliasQuality { get; set; }
public bool Sandbox.Engine.Settings.RenderSettings.BloomEnabled { get; set; }
Bloom is on or off, it has no quality levels.
bool—public bool Sandbox.Engine.Settings.RenderSettings.Borderless { get; set; }
bool—public float Sandbox.Engine.Settings.RenderSettings.DefaultFOV { get; set; }
float—public Sandbox.Engine.Settings.EffectQuality Sandbox.Engine.Settings.RenderSettings.DepthOfFieldQuality { get; set; }
public Sandbox.Engine.Settings.DlssQuality Sandbox.Engine.Settings.RenderSettings.DlssQuality { get; set; }
DLSS quality preset (Ultra Performance / Performance / Balanced / Quality / DLAA), maps to a discrete render-resolution multiplier. Only used when `Sandbox.Engine.Settings.RenderSettings.UpscalerMode` is `Sandbox.Engine.Settings.UpscalerMode.DLSS`. DLSS has no sharpness control.
public float Sandbox.Engine.Settings.RenderSettings.Fsr1Sharpness { get; set; }
FSR1 RCAS sharpness in [0..1]. Only used when `Sandbox.Engine.Settings.RenderSettings.UpscalerMode` is FSR1.
float—public float Sandbox.Engine.Settings.RenderSettings.Fsr3Sharpness { get; set; }
FSR3 RCAS sharpness in [0..1]. Only used when `Sandbox.Engine.Settings.RenderSettings.UpscalerMode` is FSR3.
float—public Sandbox.Engine.Settings.Fsr3UpscalerQuality Sandbox.Engine.Settings.RenderSettings.Fsr3UpscalerQuality { get; set; }
FSR3 quality preset (Ultra Performance / Performance / Balanced / Quality), maps to a discrete render-resolution multiplier. Only used when `Sandbox.Engine.Settings.RenderSettings.UpscalerMode` is `Sandbox.Engine.Settings.UpscalerMode.FSR3`.
public bool Sandbox.Engine.Settings.RenderSettings.Fullscreen { get; set; }
bool—public int Sandbox.Engine.Settings.RenderSettings.MaxFrameRate { get; set; }
int—public int Sandbox.Engine.Settings.RenderSettings.MaxFrameRateInactive { get; set; }
int—public int Sandbox.Engine.Settings.RenderSettings.MaxFrameRateMenu { get; set; }
int—public Sandbox.Engine.Settings.EffectQuality Sandbox.Engine.Settings.RenderSettings.MotionBlurQuality { get; set; }
How many samples motion blur takes, and whether it runs at all.
public float Sandbox.Engine.Settings.RenderSettings.MotionBlurScale { get; set; }
float—public Sandbox.Engine.Settings.PostProcessQuality Sandbox.Engine.Settings.RenderSettings.PostProcessQuality { get; set; }
What the individual effects add up to, or `Sandbox.Engine.Settings.PostProcessQuality.Custom`. Derived rather than stored, so it can't drift from the effects it describes. Setting it writes them all.
public int Sandbox.Engine.Settings.RenderSettings.ResolutionHeight { get; set; }
int—public int Sandbox.Engine.Settings.RenderSettings.ResolutionWidth { get; set; }
int—public Sandbox.Engine.Settings.EffectQuality Sandbox.Engine.Settings.RenderSettings.ScreenSpaceReflectionQuality { get; set; }
public Sandbox.Engine.Settings.ShadowQuality Sandbox.Engine.Settings.RenderSettings.ShadowQuality { get; set; }
public Sandbox.Engine.Settings.TextureQuality Sandbox.Engine.Settings.RenderSettings.TextureQuality { get; set; }
public Sandbox.Engine.Settings.UpscalerMode Sandbox.Engine.Settings.RenderSettings.UpscalerMode { get; set; }
public float Sandbox.Engine.Settings.RenderSettings.UpscalerRenderScale { get; set; }
Render-resolution scale used by Stretch (40-100%) and FSR1 (50-100%) modes.
float—public Sandbox.Engine.Settings.VolumetricFogQuality Sandbox.Engine.Settings.RenderSettings.VolumetricFogQuality { get; set; }
public bool Sandbox.Engine.Settings.RenderSettings.VSync { get; set; }
bool—No results match this filter.