RenderSettings¶
A singleton settings class that exposes rendering configuration for graphics quality, framerate management, and debug visualization in Roblox Studio.
Description¶
RenderSettings is a singleton class which lets developers debug components
of Roblox's graphics engine. It can be found in Roblox Studio's settings under
the Rendering tab.
Inheritance¶
Object → Instance → RenderSettings
Nova inheritance: Instance → RenderSettings
Properties¶
AASamples Supported Property
Antialiasing Supported Property
AutoFRMLevel Supported Property Sets the starting quality level of the framerate manager.
Sets the starting quality level of the framerate manager.
Sets the starting quality level of the framerate manager when
EnableFRM is set to true.
DebugDisableInterpolation Supported Property
EagerBulkExecution Supported Property Whether all scene updates will be given an unlimited budget, regardless of how computationally expensive it may be.
Whether all scene updates will be given an unlimited budget, regardless of how computationally expensive it may be.
When set to true, all scene updates will be given an unlimited budget,
regardless of how computationally expensive it may be. This ensures each
frame will look as it should, at the cost of a more unstable frame rate.
EditQualityLevel Supported Property Sets the graphics quality level in Roblox Studio.
Sets the graphics quality level in Roblox Studio.
Sets the graphics quality level in Roblox Studio when
EnableFRM is set to false.
EnableFRM Supported Property Toggles the enabled state of the framerate manager.
Toggles the enabled state of the framerate manager.
When set to true, the framerate manager (FRM) dynamically adjusts the
rendering quality level during gameplay to maintain a stable framerate.
When set to false, the quality level is fixed at
RenderSettings.EditQualityLevel and no automatic adjustment
occurs. Defaults to true.
The AutoFRMLevel property reports the current quality level that the FRM has assigned when this property is enabled.
ExportMergeByMaterial Supported Property Sets whether materials should be generated per part, or per unique appearance in Roblox's exporter.
Sets whether materials should be generated per part, or per unique appearance in Roblox's exporter.
Controls how materials are written during .obj export from Studio. When
set to true, parts that share the same material appearance are merged
into shared material definitions in the exported .obj file, reducing
material count. When set to false, each part receives its own
independent material definition. Defaults to false.
FrameRateCap Supported Property
FrameRateManager Supported Property Specifies the behavior of the framerate manager.
Specifies the behavior of the framerate manager.
Determines how the framerate manager (FRM) manages rendering quality using a FramerateManagerMode value. When set to FramerateManagerMode.Automatic, the engine decides whether to enable FRM quality adjustment based on context (typically enabled during gameplay). When set to FramerateManagerMode.On, the FRM is always active. When set to FramerateManagerMode.Off, the FRM does not adjust quality and block culling is forced to the lowest-quality distance setting. Defaults to FramerateManagerMode.Automatic.
GraphicsMode Supported Property The graphics API that Roblox will use on startup.
The graphics API that Roblox will use on startup.
Determines which graphics rendering API Roblox uses on startup, specified as a GraphicsMode value. When set to GraphicsMode.Automatic, the engine selects the best available backend for the current platform. Available options are platform-dependent; for example, GraphicsMode.Metal is only available on macOS and GraphicsMode.Direct3D11 is only available on Windows. If an unsupported mode is selected, the engine silently falls back to GraphicsMode.Automatic. Defaults to GraphicsMode.Automatic.
Because the graphics API is initialized at startup, changing this property only takes effect after restarting Roblox Studio.
IsAggregationShown Supported Property
IsSynchronizedWithPhysics Supported Property
MeshCacheSize Supported Property The size in bytes of the mesh cache.
QualityLevel Supported Property Controls the quality level in Roblox Studio.
If EnableFRM is set to true, this
property controls the quality level in Roblox Studio.
ReloadAssets Supported Property Whether Roblox Studio will automatically reload changes that are made to files in Roblox's content folder.
Whether Roblox Studio will automatically reload changes that are made to
files in Roblox's content folder.
When set to true, Roblox Studio will automatically reload changes that
are made to files in Roblox's content folder.
Resolution Supported Property
ShowBoundingBoxes Supported Property Whether bounding boxes are rendered around each individual rendered entity in the scene.
Whether bounding boxes are rendered around each individual rendered entity in the scene.
If set to true, renders bounding boxes around each individual rendered
entity in the scene.
ShowInterpolationpath Supported Property
TextureCacheSize Supported Property
Methods¶
GetMaxQualityLevel Supported Function Returns the maximum quality level.
Returns the maximum quality level.
Returns the total number of quality levels available in the rendering
quality system. Quality levels are numbered from
QualityLevel.Automatic (0) through QualityLevel.Level21
(21), so this method returns 22. Use GetMaxQualityLevel() - 1 to obtain
the highest numeric quality level.
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
4 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's RenderSettings class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
Enable VR Mode |
Enable VR Mode: bool |
Not yet | — | PluginSecurity |
MeshPartDetailLevel |
MeshPartDetailLevel: MeshPartDetailLevel |
Not yet | Studio only. Used to visually verify the quality of MeshParts at lower level of detail at close range. | PluginSecurity |
RenderCSGTrianglesDebug |
RenderCSGTrianglesDebug: bool |
Not yet | Whether a wireframe of polygons will be shown on all PartOperation objects. | PluginSecurity |
ViewMode |
ViewMode: ViewMode |
Not yet | Studio only. Selects a debug rendering visualization overlay for the viewport. | PluginSecurity |
Roblox reference: RenderSettings
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.