Reference API Roblox

Engine API

Website

Related

Reference API Roblox

RenderSettings

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, NotBrowsable]

Member index 16

HistoryMember
553AutoFRMLevel: int
553EagerBulkExecution: bool
553EditQualityLevel: QualityLevel
588Enable VR Mode: bool
553ExportMergeByMaterial: bool
553FrameRateManager: FramerateManagerMode
553GraphicsMode: GraphicsMode
553MeshCacheSize: int
553MeshPartDetailLevel: MeshPartDetailLevel
553QualityLevel: QualityLevel
553ReloadAssets: bool
553RenderCSGTrianglesDebug: bool
553ShowBoundingBoxes: bool
587ViewMode: ViewMode
462GetMaxQualityLevel(): int
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

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

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 118

Members 16

AutoFRMLevel

TypeDefault
int

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

History 4

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.

This is used when rendering game thumbnails.

History 4

EditQualityLevel

TypeDefault
QualityLevel

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

History 4

Enable VR Mode

TypeDefault
bool

History 1

ExportMergeByMaterial

TypeDefault
bool

Sets whether materials should be generated per part, or per unique appearance in Roblox's obj exporter.

History 4

FrameRateManager

TypeDefault
FramerateManagerMode

Specifies the behavior of the framerate manager.

History 4

GetMaxQualityLevel

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

Returns the maximum quality level.

History 2

GraphicsMode

TypeDefault
GraphicsMode

The graphics API that Roblox will use on startup.

History 4

MeshCacheSize

TypeDefault
int

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

History 4

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 4

QualityLevel

TypeDefault
QualityLevel

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

History 4

ReloadAssets

TypeDefault
bool

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

History 4

RenderCSGTrianglesDebug

TypeDefault
bool

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

History 4

ShowBoundingBoxes

TypeDefault
bool

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

History 4

ViewMode

TypeDefault
ViewMode

History 1

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