RenderSettings
This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
This class is not browsable. It is not visible in Studio's object browser.
| Memory category | Instances |
|---|
Member index 16
Removed member index 30
Description
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.
History 134
- 653 Change Default of ViewMode from to
- 653 Change Default of ShowBoundingBoxes from to
- 653 Change Default of RenderCSGTrianglesDebug from to
- 653 Change Default of ReloadAssets from to
- 653 Change Default of QualityLevel from to
- 653 Change Default of MeshPartDetailLevel from to
- 653 Change Default of MeshCacheSize from to
- 653 Change Default of GraphicsMode from to
- 653 Change Default of FrameRateManager from to
- 653 Change Default of ExportMergeByMaterial from to
- 653 Change Default of from to
- 653 Change Default of Enable VR Mode from to
- 653 Change Default of EditQualityLevel from to
- 653 Change Default of EagerBulkExecution from to
- 653 Change Default of AutoFRMLevel from to
- 653 Change Tags of RenderSettings from [NotCreatable, Service, NotBrowsable] to [NotCreatable, Service, NotReplicated, NotBrowsable]
- 588 Add Enable VR Mode
- 587 Add ViewMode
- 553 Change Default of ShowBoundingBoxes from to
- 553 Change Default of RenderCSGTrianglesDebug from to
- 553 Change Default of ReloadAssets from to
- 553 Change Default of QualityLevel from to
- 553 Change Default of MeshPartDetailLevel from to
- 553 Change Default of MeshCacheSize from to
- 553 Change Default of GraphicsMode from to
- 553 Change Default of FrameRateManager from to
- 553 Change Default of ExportMergeByMaterial from to
- 553 Change Default of from to
- 553 Change Default of EditQualityLevel from to
- 553 Change Default of EagerBulkExecution from to
- 553 Change Default of AutoFRMLevel from to
- 486 Change ThreadSafety of ShowBoundingBoxes from ReadOnly to ReadSafe
- 486 Change ThreadSafety of RenderCSGTrianglesDebug from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ReloadAssets from ReadOnly to ReadSafe
- 486 Change ThreadSafety of QualityLevel from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MeshPartDetailLevel from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MeshCacheSize from ReadOnly to ReadSafe
- 486 Change ThreadSafety of GraphicsMode from ReadOnly to ReadSafe
- 486 Change ThreadSafety of FrameRateManager from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ExportMergeByMaterial from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of EditQualityLevel from ReadOnly to ReadSafe
- 486 Change ThreadSafety of EagerBulkExecution from ReadOnly to ReadSafe
- 486 Change ThreadSafety of AutoFRMLevel from ReadOnly to ReadSafe
- 462 Change ThreadSafety of GetMaxQualityLevel from to Unsafe
- 462 Change ThreadSafety of ShowBoundingBoxes from to ReadOnly
- 462 Change ThreadSafety of RenderCSGTrianglesDebug from to ReadOnly
- 462 Change ThreadSafety of ReloadAssets from to ReadOnly
- 462 Change ThreadSafety of QualityLevel from to ReadOnly
- 462 Change ThreadSafety of MeshPartDetailLevel from to ReadOnly
- 462 Change ThreadSafety of MeshCacheSize from to ReadOnly
- 462 Change ThreadSafety of GraphicsMode from to ReadOnly
- 462 Change ThreadSafety of FrameRateManager from to ReadOnly
- 462 Change ThreadSafety of ExportMergeByMaterial from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of EditQualityLevel from to ReadOnly
- 462 Change ThreadSafety of EagerBulkExecution from to ReadOnly
- 462 Change ThreadSafety of AutoFRMLevel from to ReadOnly
- 441 Add MeshPartDetailLevel
- 413 Change Tags of RenderSettings from [Service, NotBrowsable] to [NotCreatable, Service, NotBrowsable]
- 319 Remove Resolution
- 292 Remove TextureCacheSize
- 292 Remove ShowInterpolationpath
- 292 Remove IsSynchronizedWithPhysics
- 292 Remove IsAggregationShown
- 292 Remove DebugDisableInterpolation
- 292 Remove Antialiasing
- 292 Remove AASamples
- 271 Remove ExperimentalTerrainLOD
- 254 Add RenderCSGTrianglesDebug
- 248 Add ExperimentalTerrainLOD
- 196 Remove UsesPaintMessage
- 196 Add EditQualityLevel
- 171 Remove graphicsMode
- 171 Add GraphicsMode
- 171 Add ExportMergeByMaterial
- 160 Remove AlwaysDrawConnectors
- 159 Remove Shadow
- 147 Add ReloadAssets
- 144 Add ShowInterpolationpath
- 106 Remove WoodQuality
- 106 Remove TrussDetail
- 106 Remove TextureCompositingEnabled
- 106 Remove SlateQuality
- 106 Remove PlasticQuality
- 106 Remove IceQuality
- 106 Remove GrassQuality
- 106 Remove DiamondPlateQuality
- 106 Remove DebugLogFRMLogVariables
- 106 Remove DebugFRMCullHumanoids
- 106 Remove DebugDisableDebriService
- 106 Remove DebugCullBlockCount
- 106 Remove CorrodedMetalQuality
- 106 Remove CompoundMaterialQuality
- 106 Remove Bevels
- 106 Remove BatchSize
- 106 Remove AluminumQuality
- 59 Add DebugDisableInterpolation
- 50 Add TextureCacheSize
- 50 Add MeshCacheSize
- 47 Add GetMaxQualityLevel
- 47 Add graphicsMode
- 47 Add WoodQuality
- 47 Add UsesPaintMessage
- 47 Add TrussDetail
- 47 Add TextureCompositingEnabled
- 47 Add SlateQuality
- 47 Add ShowBoundingBoxes
- 47 Add Shadow
- 47 Add Resolution
- 47 Add QualityLevel
- 47 Add PlasticQuality
- 47 Add IsSynchronizedWithPhysics
- 47 Add IsAggregationShown
- 47 Add IceQuality
- 47 Add GrassQuality
- 47 Add FrameRateManager
- 47 Add
- 47 Add EagerBulkExecution
- 47 Add DiamondPlateQuality
- 47 Add DebugLogFRMLogVariables
- 47 Add DebugFRMCullHumanoids
- 47 Add DebugDisableDebriService
- 47 Add DebugCullBlockCount
- 47 Add CorrodedMetalQuality
- 47 Add CompoundMaterialQuality
- 47 Add Bevels
- 47 Add BatchSize
- 47 Add AutoFRMLevel
- 47 Add Antialiasing
- 47 Add AlwaysDrawConnectors
- 47 Add AluminumQuality
- 47 Add AASamples
- 47 Add RenderSettings
Members 16
AutoFRMLevel
| Type | Default | |
|---|---|---|
| int | ||
Sets the starting quality level of the framerate manager, when RenderSettings.EnableFRM is set to true.
| Thread safety | ReadSafe |
|---|---|
| Category | Debug |
| Loaded/Saved | true |
History 5
- 653 Change Default of AutoFRMLevel from to
- 553 Change Default of AutoFRMLevel from to
- 486 Change ThreadSafety of AutoFRMLevel from ReadOnly to ReadSafe
- 462 Change ThreadSafety of AutoFRMLevel from to ReadOnly
- 47 Add AutoFRMLevel
EagerBulkExecution
| Type | Default | |
|---|---|---|
| bool | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Performance |
| Loaded/Saved | true |
History 5
- 653 Change Default of EagerBulkExecution from to
- 553 Change Default of EagerBulkExecution from to
- 486 Change ThreadSafety of EagerBulkExecution from ReadOnly to ReadSafe
- 462 Change ThreadSafety of EagerBulkExecution from to ReadOnly
- 47 Add EagerBulkExecution
EditQualityLevel
| Type | Default | |
|---|---|---|
| QualityLevel | ||
Sets the graphics quality level in Roblox Studio, when RenderSettings.EnableFRM is set to false.
| Thread safety | ReadSafe |
|---|---|
| Category | Performance |
| Loaded/Saved | true |
History 5
- 653 Change Default of EditQualityLevel from to
- 553 Change Default of EditQualityLevel from to
- 486 Change ThreadSafety of EditQualityLevel from ReadOnly to ReadSafe
- 462 Change ThreadSafety of EditQualityLevel from to ReadOnly
- 196 Add EditQualityLevel
Enable VR Mode
| Type | Default | |
|---|---|---|
| bool | ||
| Thread safety | ReadSafe |
|---|---|
| Category | General |
| Loaded/Saved | true |
History 2
- 653 Change Default of Enable VR Mode from to
- 588 Add Enable VR Mode
ExportMergeByMaterial
| Type | Default | |
|---|---|---|
| bool | ||
Sets whether materials should be generated per part, or per unique appearance in Roblox's obj exporter.
| Thread safety | ReadSafe |
|---|---|
| Category | General |
| Loaded/Saved | true |
History 5
- 653 Change Default of ExportMergeByMaterial from to
- 553 Change Default of ExportMergeByMaterial from to
- 486 Change ThreadSafety of ExportMergeByMaterial from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ExportMergeByMaterial from to ReadOnly
- 171 Add ExportMergeByMaterial
FrameRateManager
| Type | Default | |
|---|---|---|
| FramerateManagerMode | ||
Specifies the behavior of the framerate manager.
| Thread safety | ReadSafe |
|---|---|
| Category | General |
| Loaded/Saved | true |
History 5
- 653 Change Default of FrameRateManager from to
- 553 Change Default of FrameRateManager from to
- 486 Change ThreadSafety of FrameRateManager from ReadOnly to ReadSafe
- 462 Change ThreadSafety of FrameRateManager from to ReadOnly
- 47 Add FrameRateManager
GetMaxQualityLevel
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| int | ||
Returns the maximum quality level.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetMaxQualityLevel from to Unsafe
- 47 Add GetMaxQualityLevel
GraphicsMode
| Type | Default | |
|---|---|---|
| GraphicsMode | ||
The graphics API that Roblox will use on startup.
| Thread safety | ReadSafe |
|---|---|
| Category | General |
| Loaded/Saved | true |
History 5
- 653 Change Default of GraphicsMode from to
- 553 Change Default of GraphicsMode from to
- 486 Change ThreadSafety of GraphicsMode from ReadOnly to ReadSafe
- 462 Change ThreadSafety of GraphicsMode from to ReadOnly
- 171 Add GraphicsMode
MeshCacheSize
| Type | Default | |
|---|---|---|
| int | ||
The size in bytes of the mesh cache. Defaults to 32 MBs.
| Thread safety | ReadSafe |
|---|---|
| Category | Cache |
| Loaded/Saved | true |
History 5
- 653 Change Default of MeshCacheSize from to
- 553 Change Default of MeshCacheSize from to
- 486 Change ThreadSafety of MeshCacheSize from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MeshCacheSize from to ReadOnly
- 50 Add MeshCacheSize
MeshPartDetailLevel
| Type | Default | |
|---|---|---|
| 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 MeshPartDetailLevel.DistanceBased (default), which is what the client uses.
Note that the MeshPart.RenderFidelity needs to be set to RenderFidelity.Automatic for this to work. If you set it to RenderFidelity.Precise, you will always see the higher resolution version and the MeshPartDetailLevel value will be ignored for that MeshPart.
| Thread safety | ReadSafe |
|---|---|
| Category | Debug |
| Loaded/Saved | true |
History 5
- 653 Change Default of MeshPartDetailLevel from to
- 553 Change Default of MeshPartDetailLevel from to
- 486 Change ThreadSafety of MeshPartDetailLevel from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MeshPartDetailLevel from to ReadOnly
- 441 Add MeshPartDetailLevel
QualityLevel
| Type | Default | |
|---|---|---|
| QualityLevel | ||
If RenderSettings.EnableFRM is set to true, this property controls the quality level in Roblox Studio.
| Thread safety | ReadSafe |
|---|---|
| Category | Performance |
| Loaded/Saved | true |
History 5
- 653 Change Default of QualityLevel from to
- 553 Change Default of QualityLevel from to
- 486 Change ThreadSafety of QualityLevel from ReadOnly to ReadSafe
- 462 Change ThreadSafety of QualityLevel from to ReadOnly
- 47 Add QualityLevel
ReloadAssets
| Type | Default | |
|---|---|---|
| bool | ||
When set to true, Roblox Studio will automatically reload changes that are
made to files in Roblox's content folder.
| Thread safety | ReadSafe |
|---|---|
| Category | Debug |
| Loaded/Saved | true |
History 5
- 653 Change Default of ReloadAssets from to
- 553 Change Default of ReloadAssets from to
- 486 Change ThreadSafety of ReloadAssets from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ReloadAssets from to ReadOnly
- 147 Add ReloadAssets
RenderCSGTrianglesDebug
| Type | Default | |
|---|---|---|
| bool | ||
When set to true, a wireframe of polygons will be shown on all PartOperation objects.
| Thread safety | ReadSafe |
|---|---|
| Category | Debug |
| Loaded/Saved | true |
History 5
- 653 Change Default of RenderCSGTrianglesDebug from to
- 553 Change Default of RenderCSGTrianglesDebug from to
- 486 Change ThreadSafety of RenderCSGTrianglesDebug from ReadOnly to ReadSafe
- 462 Change ThreadSafety of RenderCSGTrianglesDebug from to ReadOnly
- 254 Add RenderCSGTrianglesDebug
ShowBoundingBoxes
| Type | Default | |
|---|---|---|
| bool | ||
If set to true, renders bounding boxes around each individual rendered entity in the scene.
| Thread safety | ReadSafe |
|---|---|
| Category | Debug |
| Loaded/Saved | true |
History 5
- 653 Change Default of ShowBoundingBoxes from to
- 553 Change Default of ShowBoundingBoxes from to
- 486 Change ThreadSafety of ShowBoundingBoxes from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ShowBoundingBoxes from to ReadOnly
- 47 Add ShowBoundingBoxes
ViewMode
| Type | Default | |
|---|---|---|
| ViewMode | ||
| Thread safety | ReadSafe |
|---|---|
| Category | Debug |
| Loaded/Saved | true |
Removed members 30
AASamples
| Type | Default | |
|---|---|---|
| AASamples | ||
| Category | |
|---|---|
| Loaded/Saved | false |
AluminumQuality
| Type | Default | |
|---|---|---|
| MaterialQuality | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove AluminumQuality
- 47 Add AluminumQuality
AlwaysDrawConnectors
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 160 Remove AlwaysDrawConnectors
- 47 Add AlwaysDrawConnectors
Antialiasing
| Type | Default | |
|---|---|---|
| Antialiasing | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 292 Remove Antialiasing
- 47 Add Antialiasing
BatchSize
| Type | Default | |
|---|---|---|
| float | ||
| Category | |
|---|---|
| Loaded/Saved | false |
Bevels
| Type | Default | |
|---|---|---|
| Bevels | ||
| Category | |
|---|---|
| Loaded/Saved | false |
CompoundMaterialQuality
| Type | Default | |
|---|---|---|
| MaterialQuality | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove CompoundMaterialQuality
- 47 Add CompoundMaterialQuality
CorrodedMetalQuality
| Type | Default | |
|---|---|---|
| MaterialQuality | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove CorrodedMetalQuality
- 47 Add CorrodedMetalQuality
DebugCullBlockCount
| Type | Default | |
|---|---|---|
| int | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove DebugCullBlockCount
- 47 Add DebugCullBlockCount
DebugDisableDebriService
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
DebugDisableInterpolation
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
DebugFRMCullHumanoids
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove DebugFRMCullHumanoids
- 47 Add DebugFRMCullHumanoids
DebugLogFRMLogVariables
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove DebugLogFRMLogVariables
- 47 Add DebugLogFRMLogVariables
DiamondPlateQuality
| Type | Default | |
|---|---|---|
| MaterialQuality | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove DiamondPlateQuality
- 47 Add DiamondPlateQuality
ExperimentalTerrainLOD
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 271 Remove ExperimentalTerrainLOD
- 248 Add ExperimentalTerrainLOD
GrassQuality
| Type | Default | |
|---|---|---|
| MaterialQuality | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove GrassQuality
- 47 Add GrassQuality
IceQuality
| Type | Default | |
|---|---|---|
| MaterialQuality | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove IceQuality
- 47 Add IceQuality
IsAggregationShown
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 292 Remove IsAggregationShown
- 47 Add IsAggregationShown
IsSynchronizedWithPhysics
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
PlasticQuality
| Type | Default | |
|---|---|---|
| MaterialQuality | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove PlasticQuality
- 47 Add PlasticQuality
Resolution
| Type | Default | |
|---|---|---|
| Resolution | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 319 Remove Resolution
- 47 Add Resolution
Shadow
| Type | Default | |
|---|---|---|
| Shadow | ||
| Category | |
|---|---|
| Loaded/Saved | false |
ShowInterpolationpath
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 292 Remove ShowInterpolationpath
- 144 Add ShowInterpolationpath
SlateQuality
| Type | Default | |
|---|---|---|
| MaterialQuality | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove SlateQuality
- 47 Add SlateQuality
TextureCacheSize
| Type | Default | |
|---|---|---|
| int | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 292 Remove TextureCacheSize
- 50 Add TextureCacheSize
TextureCompositingEnabled
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
TrussDetail
| Type | Default | |
|---|---|---|
| GeometryQuality | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove TrussDetail
- 47 Add TrussDetail
UsesPaintMessage
| Type | Default | |
|---|---|---|
| bool | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 196 Remove UsesPaintMessage
- 47 Add UsesPaintMessage
WoodQuality
| Type | Default | |
|---|---|---|
| MaterialQuality | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 106 Remove WoodQuality
- 47 Add WoodQuality
graphicsMode
| Type | Default | |
|---|---|---|
| GraphicsMode | ||
| Category | |
|---|---|
| Loaded/Saved | false |
History 2
- 171 Remove graphicsMode
- 47 Add graphicsMode