Reference API Roblox

Engine API

Website

Related

Reference API Roblox

RenderSettings

A singleton settings class that exposes rendering configuration for graphics quality, framerate management, and debug visualization in Roblox Studio.

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.
Tags: [NotCreatable, Service, NotReplicated, NotBrowsable]

Member index 16

HistoryMember
731AutoFRMLevel: int
731EagerBulkExecution: bool
731EditQualityLevel: QualityLevel
731Enable VR Mode: bool
731ExportMergeByMaterial: bool
731FrameRateManager: FramerateManagerMode
731GraphicsMode: GraphicsMode
731MeshCacheSize: int
731MeshPartDetailLevel: MeshPartDetailLevel
731QualityLevel: QualityLevel
731ReloadAssets: bool
731RenderCSGTrianglesDebug: bool
731ShowBoundingBoxes: bool
731ViewMode: ViewMode
725GetMaxQualityLevel(): int
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Removed member index 30

HistoryMember
292AASamples: AASamples
106AluminumQuality: MaterialQuality
160AlwaysDrawConnectors: bool
292Antialiasing: Antialiasing
106BatchSize: float
106Bevels: Bevels
106CompoundMaterialQuality: MaterialQuality
106CorrodedMetalQuality: MaterialQuality
106DebugCullBlockCount: int
106DebugDisableDebriService: bool
292DebugDisableInterpolation: bool
106DebugFRMCullHumanoids: bool
106DebugLogFRMLogVariables: bool
106DiamondPlateQuality: MaterialQuality
271ExperimentalTerrainLOD: bool
106GrassQuality: MaterialQuality
106IceQuality: MaterialQuality
292IsAggregationShown: bool
292IsSynchronizedWithPhysics: bool
106PlasticQuality: MaterialQuality
319Resolution: Resolution
159Shadow: Shadow
292ShowInterpolationpath: bool
106SlateQuality: MaterialQuality
292TextureCacheSize: int
106TextureCompositingEnabled: bool
106TrussDetail: GeometryQuality
196UsesPaintMessage: bool
106WoodQuality: MaterialQuality
171graphicsMode: GraphicsMode

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.

History 195

Members 16

AutoFRMLevel

TypeDefault
int

Sets the starting quality level of the framerate manager when EnableFRM is set to true.

History 9

EagerBulkExecution

TypeDefault
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.

History 9

EditQualityLevel

TypeDefault
QualityLevel

Sets the graphics quality level in Roblox Studio when EnableFRM is set to false.

History 9

Enable VR Mode

TypeDefault
bool

When set to true, virtual reality (VR) mode is enabled. This property reflects the same underlying setting as UserGameSettings.VREnabled, so reading or writing it reads or writes that shared value. Defaults to false.

History 6

ExportMergeByMaterial

TypeDefault
bool

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.

History 9

FrameRateManager

TypeDefault
FramerateManagerMode

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.

History 9

GetMaxQualityLevel

Parameters (0)
No parameters.
Returns (1)
int

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.

History 3

GraphicsMode

TypeDefault
GraphicsMode

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.

History 9

MeshCacheSize

TypeDefault
int

The size in bytes of the mesh cache. Defaults to 32 MiB.

History 9

MeshPartDetailLevel

TypeDefault
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.

History 9

QualityLevel

TypeDefault
QualityLevel

If EnableFRM is set to true, this property controls the quality level in Roblox Studio.

History 9

ReloadAssets

TypeDefault
bool

When set to true, Roblox Studio will automatically reload changes that are made to files in Roblox's content folder.

History 9

RenderCSGTrianglesDebug

TypeDefault
bool

When set to true, a wireframe of polygons will be shown on all PartOperation objects.

History 9

ShowBoundingBoxes

TypeDefault
bool

If set to true, renders bounding boxes around each individual rendered entity in the scene.

History 9

ViewMode

TypeDefault
ViewMode

Studio only. Determines which debug rendering visualization is drawn over the viewport, using a value of ViewMode. Defaults to ViewMode.None, which disables the overlay. Other values enable overdraw visualizations for geometry complexity, transparency, or decals.

History 6

Removed members 30

AASamples

TypeDefault
AASamples

History 2

AluminumQuality

TypeDefault
MaterialQuality

History 2

AlwaysDrawConnectors

TypeDefault
bool

History 2

Antialiasing

TypeDefault
Antialiasing

History 2

BatchSize

TypeDefault
float

History 2

Bevels

TypeDefault
Bevels

History 2

CompoundMaterialQuality

TypeDefault
MaterialQuality

History 2

CorrodedMetalQuality

TypeDefault
MaterialQuality

History 2

DebugCullBlockCount

TypeDefault
int

History 2

DebugDisableDebriService

TypeDefault
bool

History 2

DebugDisableInterpolation

TypeDefault
bool

History 2

DebugFRMCullHumanoids

TypeDefault
bool

History 2

DebugLogFRMLogVariables

TypeDefault
bool

History 2

DiamondPlateQuality

TypeDefault
MaterialQuality

History 2

ExperimentalTerrainLOD

TypeDefault
bool

History 2

GrassQuality

TypeDefault
MaterialQuality

History 2

IceQuality

TypeDefault
MaterialQuality

History 2

IsAggregationShown

TypeDefault
bool

History 2

IsSynchronizedWithPhysics

TypeDefault
bool

History 2

PlasticQuality

TypeDefault
MaterialQuality

History 2

Resolution

TypeDefault
Resolution

History 2

Shadow

TypeDefault
Shadow

History 2

ShowInterpolationpath

TypeDefault
bool

History 2

SlateQuality

TypeDefault
MaterialQuality

History 2

TextureCacheSize

TypeDefault
int

History 2

TextureCompositingEnabled

TypeDefault
bool

History 2

TrussDetail

TypeDefault
GeometryQuality

History 2

UsesPaintMessage

TypeDefault
bool

History 2

WoodQuality

TypeDefault
MaterialQuality

History 2

graphicsMode

TypeDefault
GraphicsMode

History 2

Settings