API ReferenceSandbox.Engine.Settings

RenderSettingsclass

User graphics settings

object→RenderSettings
Namespace
Sandbox.Engine.Settings
Assembly
Sandbox.Engine
Declaration
public class Sandbox.Engine.Settings.RenderSettings

Constructors1

Showing 1 constructors

Methods7

Showing 7 methods

public void Apply()PUBLIC

Returns:void—

public Sandbox.Engine.Settings.RenderSettings.VideoDisplayMode[] DisplayModes(bool windowed)PUBLIC

Lists SDL fullscreen modes for the current display. Both windowed and fullscreen settings use this list; `windowed` is retained for compatibility and does not filter it. All returned formats are RGBA8888, matching the game swapchain.

ParameterTypeDescription
windowedbool—
Returns:VideoDisplayMode[]—

public static bool IsUpscalerModeSupported(Sandbox.Engine.Settings.UpscalerMode mode)PUBLICSTATIC

Returns whether the given `Sandbox.Engine.Settings.RenderSettings.UpscalerMode` is usable on the current graphics device. Off / FSR1 / FSR3 are always available; Stretch is legacy and not selectable. DLSS requires NVIDIA hardware with NGX support and is queried from the native render device.

ParameterTypeDescription
modeUpscalerMode—
Returns:bool—

public void ResetDisplayConfig()PUBLIC

Window, resolution, vsync, frame rate caps and field of view.

Returns:void—

public void ResetGraphicsConfig()PUBLIC

Quality and upscaling, back to whatever this machine detects.

Returns:void—

public void ResetVideoConfig()PUBLIC

Returns:void—

Properties27

Showing 27 properties

public Sandbox.Engine.Settings.EffectQuality Sandbox.Engine.Settings.RenderSettings.AmbientOcclusionQuality { get; set; }PUBLICGETSET

Contact shading where surfaces meet. Its resolution and denoise passes ride with the level.

Returns:EffectQuality—

public Sandbox.Engine.Settings.AntiAliasMode Sandbox.Engine.Settings.RenderSettings.AntiAliasMode { get; set; }PUBLICGETSET

Anti-aliasing method. CMAA2 filters the finished image and combines with `Sandbox.Engine.Settings.RenderSettings.AntiAliasQuality`.

Returns:AntiAliasMode—

public Sandbox.MultisampleAmount Sandbox.Engine.Settings.RenderSettings.AntiAliasQuality { get; set; }PUBLICGETSET

Hardware MSAA sample count. Applies on its own and underneath `Sandbox.Engine.Settings.AntiAliasMode.Cmaa2`.

public bool Sandbox.Engine.Settings.RenderSettings.BloomEnabled { get; set; }PUBLICGETSET

Bloom is on or off, it has no quality levels.

Returns:bool—

public bool Sandbox.Engine.Settings.RenderSettings.Borderless { get; set; }PUBLICGETSET

Returns:bool—

public float Sandbox.Engine.Settings.RenderSettings.DefaultFOV { get; set; }PUBLICGETSET

Returns:float—

public Sandbox.Engine.Settings.DlssQuality Sandbox.Engine.Settings.RenderSettings.DlssQuality { get; set; }PUBLICGETSET

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.

Returns:DlssQuality—

public float Sandbox.Engine.Settings.RenderSettings.Fsr1Sharpness { get; set; }PUBLICGETSET

FSR1 RCAS sharpness in [0..1]. Only used when `Sandbox.Engine.Settings.RenderSettings.UpscalerMode` is FSR1.

Returns:float—

public float Sandbox.Engine.Settings.RenderSettings.Fsr3Sharpness { get; set; }PUBLICGETSET

FSR3 RCAS sharpness in [0..1]. Only used when `Sandbox.Engine.Settings.RenderSettings.UpscalerMode` is FSR3.

Returns:float—

public Sandbox.Engine.Settings.Fsr3UpscalerQuality Sandbox.Engine.Settings.RenderSettings.Fsr3UpscalerQuality { get; set; }PUBLICGETSET

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; }PUBLICGETSET

Returns:bool—

public int Sandbox.Engine.Settings.RenderSettings.MaxFrameRate { get; set; }PUBLICGETSET

Returns:int—

public int Sandbox.Engine.Settings.RenderSettings.MaxFrameRateInactive { get; set; }PUBLICGETSET

Returns:int—

public int Sandbox.Engine.Settings.RenderSettings.MaxFrameRateMenu { get; set; }PUBLICGETSET

Returns:int—

public Sandbox.Engine.Settings.EffectQuality Sandbox.Engine.Settings.RenderSettings.MotionBlurQuality { get; set; }PUBLICGETSET

How many samples motion blur takes, and whether it runs at all.

Returns:EffectQuality—

public float Sandbox.Engine.Settings.RenderSettings.MotionBlurScale { get; set; }PUBLICGETSET

Returns:float—

public Sandbox.Engine.Settings.PostProcessQuality Sandbox.Engine.Settings.RenderSettings.PostProcessQuality { get; set; }PUBLICGETSET

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; }PUBLICGETSET

Returns:int—

public int Sandbox.Engine.Settings.RenderSettings.ResolutionWidth { get; set; }PUBLICGETSET

Returns:int—

public float Sandbox.Engine.Settings.RenderSettings.UpscalerRenderScale { get; set; }PUBLICGETSET

Render-resolution scale used by Off (including MSAA and CMAA2) and FSR1 (40-100%).

Returns:float—

public bool Sandbox.Engine.Settings.RenderSettings.VSync { get; set; }PUBLICGETSET

Returns:bool—

On this page

Constructorspublic RenderSettings()Methodspublic System.Void Apply()public Sandbox.Engine.Settings.RenderSettings.VideoDisplayMode[] DisplayModes(System.Boolean windowed)public static Sandbox.MultisampleAmount GetSupportedAntiAliasQuality(Sandbox.MultisampleAmount amount)public static System.Boolean IsUpscalerModeSupported(Sandbox.Engine.Settings.UpscalerMode mode)public System.Void ResetDisplayConfig()public System.Void ResetGraphicsConfig()public System.Void ResetVideoConfig()Propertiespublic Sandbox.Engine.Settings.EffectQuality Sandbox.Engine.Settings.RenderSettings.AmbientOcclusionQuality { get; set; }public Sandbox.Engine.Settings.AntiAliasMode Sandbox.Engine.Settings.RenderSettings.AntiAliasMode { get; set; }public Sandbox.MultisampleAmount Sandbox.Engine.Settings.RenderSettings.AntiAliasQuality { get; set; }public System.Boolean Sandbox.Engine.Settings.RenderSettings.BloomEnabled { get; set; }public System.Boolean Sandbox.Engine.Settings.RenderSettings.Borderless { get; set; }public System.Single Sandbox.Engine.Settings.RenderSettings.DefaultFOV { get; set; }public Sandbox.Engine.Settings.EffectQuality Sandbox.Engine.Settings.RenderSettings.DepthOfFieldQuality { get; set; }public Sandbox.Engine.Settings.DlssQuality Sandbox.Engine.Settings.RenderSettings.DlssQuality { get; set; }public System.Single Sandbox.Engine.Settings.RenderSettings.Fsr1Sharpness { get; set; }public System.Single Sandbox.Engine.Settings.RenderSettings.Fsr3Sharpness { get; set; }public Sandbox.Engine.Settings.Fsr3UpscalerQuality Sandbox.Engine.Settings.RenderSettings.Fsr3UpscalerQuality { get; set; }public System.Boolean Sandbox.Engine.Settings.RenderSettings.Fullscreen { get; set; }public System.Int32 Sandbox.Engine.Settings.RenderSettings.MaxFrameRate { get; set; }public System.Int32 Sandbox.Engine.Settings.RenderSettings.MaxFrameRateInactive { get; set; }public System.Int32 Sandbox.Engine.Settings.RenderSettings.MaxFrameRateMenu { get; set; }public Sandbox.Engine.Settings.EffectQuality Sandbox.Engine.Settings.RenderSettings.MotionBlurQuality { get; set; }public System.Single Sandbox.Engine.Settings.RenderSettings.MotionBlurScale { get; set; }public Sandbox.Engine.Settings.PostProcessQuality Sandbox.Engine.Settings.RenderSettings.PostProcessQuality { get; set; }public System.Int32 Sandbox.Engine.Settings.RenderSettings.ResolutionHeight { get; set; }public System.Int32 Sandbox.Engine.Settings.RenderSettings.ResolutionWidth { get; set; }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 System.Single Sandbox.Engine.Settings.RenderSettings.UpscalerRenderScale { get; set; }public Sandbox.Engine.Settings.VolumetricFogQuality Sandbox.Engine.Settings.RenderSettings.VolumetricFogQuality { get; set; }public System.Boolean Sandbox.Engine.Settings.RenderSettings.VSync { get; set; }Metadata