s&
About
The Project
info
About s&box
map
Roadmap
monitoring
Metrics
Engine startup and usage numbers
Updates
newspaper
Latest News
published_with_changes
Changes
Release-by-release changelog
Games
Browse Games
Discover Games
gamejams
live now
Game Jam III
Ends
Fri 25 Sep
Theme
One More Round
The jam is running. Build something, or play the entries.
£
50,000
prizepool
View the jam
Workshop
Playable
sports_esports
Games
Standalone games and gamemodes
Assets
landscape
Maps
view_in_ar
Models
texture
Materials
apparel
Clothing
apps
Everything
Every asset type in one list
Forum
Learn
Documentation
rocket_launch
Getting Started
docs
Documentation
api
API Reference
Resources
school
Tutorials
manage_search
Code Search
input
Log in with Steam
Api
Classes
RenderSettings
chevron_left
Classes
class
RenderSettings
Constructors
functions
RenderSettings
Properties
data_object
AmbientOcclusionQuality
data_object
AntiAliasQuality
data_object
BloomEnabled
data_object
Borderless
data_object
DefaultFOV
data_object
DepthOfFieldQuality
data_object
DlssQuality
data_object
Fsr1Sharpness
data_object
Fsr3Sharpness
data_object
Fsr3UpscalerQuality
data_object
Fullscreen
data_object
MaxFrameRate
data_object
MaxFrameRateInactive
data_object
MaxFrameRateMenu
data_object
MotionBlurQuality
data_object
MotionBlurScale
data_object
PostProcessQuality
data_object
ResolutionHeight
data_object
ResolutionWidth
data_object
ScreenSpaceReflectionQuality
data_object
ShadowQuality
data_object
TextureQuality
data_object
UpscalerMode
data_object
UpscalerRenderScale
data_object
VolumetricFogQuality
data_object
VSync
Methods
functions
Apply
functions
DisplayModes
functions
ResetDisplayConfig
functions
ResetGraphicsConfig
functions
ResetVideoConfig
Static Methods
functions
GetSupportedAntiAliasQuality
functions
IsUpscalerModeSupported
RenderSettings
User graphics settings
class
Sandbox.Engine.Settings
.
Sandbox.Engine
build
Constructors
1
RenderSettings
(
)
data_object
Properties
26
AmbientOcclusionQuality
EffectQuality
Contact shading where surfaces meet. Its resolution and denoise passes ride with the level.
AntiAliasQuality
MultisampleAmount
BloomEnabled
bool
Bloom is on or off, it has no quality levels.
Borderless
bool
DefaultFOV
float
DepthOfFieldQuality
EffectQuality
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
MotionBlurQuality
EffectQuality
How many samples motion blur takes, and whether it runs at all.
MotionBlurScale
float
PostProcessQuality
PostProcessQuality
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.
ResolutionHeight
int
ResolutionWidth
int
ScreenSpaceReflectionQuality
EffectQuality
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
5
Apply
(
)
DisplayModes
(
windowed
)
VideoDisplayMode[]
Lists SDL fullscreen modes for the current display. Both windowed and fullscreen settings use this list;
is retained for compatibility and does not filter it. All returned formats are RGBA8888, matching the game swapchain.
ResetDisplayConfig
(
)
Window, resolution, vsync, frame rate caps and field of view.
ResetGraphicsConfig
(
)
Quality and upscaling, back to whatever this machine detects.
ResetVideoConfig
(
)
functions
Static Methods
2
GetSupportedAntiAliasQuality
(
amount
)
MultisampleAmount
Returns the requested MSAA amount when supported, or the best available amount.
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.