infoAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games exploreDiscover Games
categoryWorkshop
sports_esportsGames landscapeMaps view_in_arModels textureMaterials apparelClothing constructionMore..
forumForum menu_bookLearn
docsDocumentation apiApi Reference schoolTutorials manage_searchCode Search
Api
Classes
RenderSettings
chevron_left Classes
class
RenderSettings

Properties

data_objectAntiAliasQualitydata_objectBorderlessdata_objectDefaultFOVdata_objectDlssQualitydata_objectFsr1Sharpnessdata_objectFsr3Sharpnessdata_objectFsr3UpscalerQualitydata_objectFullscreendata_objectMaxFrameRatedata_objectMaxFrameRateInactivedata_objectMaxFrameRateMenudata_objectMotionBlurScaledata_objectPostProcessQualitydata_objectResolutionHeightdata_objectResolutionWidthdata_objectShadowQualitydata_objectTextureQualitydata_objectUpscalerModedata_objectUpscalerRenderScaledata_objectVolumetricFogQualitydata_objectVSync

Methods

functionsApplyfunctionsDisplayModesfunctionsResetVideoConfig

Static Methods

functionsIsUpscalerModeSupported
RenderSettings
User graphics settings
class Sandbox.Engine.Settings .
Sandbox.Engine

data_object Properties 21

AntiAliasQuality
MultisampleAmount
Borderless
bool
DefaultFOV
float
DlssQuality
DlssQuality
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.
Fsr1Sharpness
float
FSR1 RCAS sharpness in [0..1]. Only used when Sandbox.Engine.Settings.RenderSettings.UpscalerMode is FSR1.
Fsr3Sharpness
float
FSR3 RCAS sharpness in [0..1]. Only used when Sandbox.Engine.Settings.RenderSettings.UpscalerMode is FSR3.
Fsr3UpscalerQuality
Fsr3UpscalerQuality
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.
Fullscreen
bool
MaxFrameRate
int
MaxFrameRateInactive
int
MaxFrameRateMenu
int
MotionBlurScale
float
PostProcessQuality
PostProcessQuality
ResolutionHeight
int
ResolutionWidth
int
ShadowQuality
ShadowQuality
TextureQuality
TextureQuality
UpscalerMode
UpscalerMode
UpscalerRenderScale
float
Render-resolution scale used by Stretch (40-100%) and FSR1 (50-100%) modes.
VolumetricFogQuality
VolumetricFogQuality
VSync
bool

functions Methods 3

Apply ()
DisplayModes (windowed)
VideoDisplayMode[]
ResetVideoConfig ()

functions Static Methods 1

IsUpscalerModeSupported (mode)
bool
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.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.