RenderSettings
The RenderSettings is a singleton class, which lets developers debug components of Roblox's graphics engine.
It can be found under the Rendering tab in Roblox Studio's settings menu.
Summary
Properties
- read parallel
Sets the starting quality level of the framerate manager, when RenderSettings.EnableFRM is set to true.
- read parallel
When set to true, all scene updates will be given an unlimited budget, regardless of how computationally expensive it may be.
- read parallel
Sets the graphics quality level in Roblox Studio, when RenderSettings.EnableFRM is set to false.
- read parallel
Toggles the enabled state of the framerate manager.
- read parallel
Sets whether materials should be generated per part, or per unique appearance in Roblox's obj exporter.
- read parallel
Specifies the behavior of the framerate manager.
- read parallel
The graphics API that Roblox will use on startup.
- read parallel
The size in bytes of the mesh cache. Defaults to 32 MBs.
- read parallel
Studio only. Used to visually verify the quality of MeshParts at lower level of detail at close range.
- read parallel
If RenderSettings.EnableFRM is set to true, this property controls the quality level in Roblox Studio.
- read parallel
When set to true, Roblox Studio will automatically reload changes that are made to files in Roblox's content folder.
- read parallel
When set to true, a wireframe of polygons will be shown on all PartOperation objects.
- read parallel
If set to true, renders bounding boxes around each individual rendered entity in the scene.
- read parallel
Methods
Returns the maximum quality level.
Properties
AutoFRMLevel
Sets the starting quality level of the framerate manager, when RenderSettings.EnableFRM is set to true.
EagerBulkExecution
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.
This is used when rendering game thumbnails.
EditQualityLevel
Sets the graphics quality level in Roblox Studio, when RenderSettings.EnableFRM is set to false.
Enable VR Mode
ExportMergeByMaterial
Sets whether materials should be generated per part, or per unique appearance in Roblox's obj exporter.
FrameRateManager
Specifies the behavior of the framerate manager.
MeshPartDetailLevel
Determines the mode for the selection of detail levels for mesh parts. For a good balance between performance and fidelity this should be set to MeshPartDetail.DistanceBased (default), which is what the client uses.
Note that the MeshPart.RenderFidelity needs to be set to Enum.RenderFidelity.Automatic for this to work. If you set it to Enum.RenderFidelity.Precise you will always see the higher resolution version and the Enum.MeshPartDetailLevel will be ignored for that MeshPart.
QualityLevel
If RenderSettings.EnableFRM is set to true, this property controls the quality level in Roblox Studio.
ReloadAssets
When set to true, Roblox Studio will automatically reload changes that are made to files in Roblox's content folder.
RenderCSGTrianglesDebug
When set to true, a wireframe of polygons will be shown on all PartOperation objects.
ShowBoundingBoxes
If set to true, renders bounding boxes around each individual rendered entity in the scene.