Performance

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts

The Performance API provides control and information on graphics performance settings.

Name	Type	Summary
performancePreset	Performance.PerformancePreset	The current graphics performance preset.
refreshRateProfile	Performance.RefreshRateProfile	The current refresh rate profile.

Name	Return Value	Summary
`getActiveRefreshRate`	number	Gets the current target refresh rate, in Hz, per the current refresh rate profile and refresh rate regime if in desktop mode; a higher rate if in VR mode.
`getPerformancePreset`	Performance.PerformancePreset	Gets the current graphics performance preset in use.
`getPerformancePresetNames`	Array.<string>	Gets the names of the graphics performance presets.
`getRefreshRateProfile`	Performance.RefreshRateProfile	Gets the current refresh rate profile in use.
`getRefreshRateProfileNames`	Array.<string>	Gets the names of the refresh rate profiles.
`getRefreshRateRegime`	RefreshRateRegime	Gets the current refresh rate regime that's in effect.
`getUXMode`	UXMode	Gets the current user experience mode.
`setPerformancePreset`	None	Sets graphics performance to a preset.
`setRefreshRateProfile`	None	Sets the curfrent refresh rate profile.

Name	Summary
`settingsChanged`	Triggered when the performance preset or refresh rate profile is changed.

PerformancePreset
Type: number

Graphics performance presets.

Value	Name	Description
`0`	UNKNOWN	Custom settings of world detail, rendering effects, and refresh rate.
`1`	LOW	Low world detail, no rendering effects, lo refresh rate.
`2`	MID	Medium world detail, some rendering effects, medium refresh rate.
`3`	HIGH	Maximum world detail, all rendering effects, high refresh rate.

RefreshRateProfile
Type: number

Refresh rate profile.

Value	Name	Description
`0`	ECO	Low refresh rate, which is reduced when Interface doesn't have focus or is minimized.
`1`	INTERACTIVE	Medium refresh rate, which is reduced when Interface doesn't have focus or is minimized.
`2`	REALTIME	High refresh rate, even when Interface doesn't have focus or is minimized.

(static) getActiveRefreshRate( ) → {number} Returns: The current target refresh rate, in Hz.
Gets the current target refresh rate, in Hz, per the current refresh rate profile and refresh rate regime if in desktop mode; a higher rate if in VR mode.

(static) getPerformancePreset( ) → {Performance.PerformancePreset} Returns: The current graphics performance preset in use.
Gets the current graphics performance preset in use.

(static) getPerformancePresetNames( ) → {Array.<string>} Returns: The names of the graphics performance presets. The array index values correspond to Performance.PerformancePreset values.
Gets the names of the graphics performance presets.

(static) getRefreshRateProfile( ) → {Performance.RefreshRateProfile} Returns: The refresh rate profile.
Gets the current refresh rate profile in use.

(static) getRefreshRateProfileNames( ) → {Array.<string>} Returns: The names of the refresh rate profiles. The array index values correspond to Performance.RefreshRateProfile values.
Gets the names of the refresh rate profiles.

(static) getRefreshRateRegime( ) → {RefreshRateRegime} Returns: The current refresh rate regime.
Gets the current refresh rate regime that's in effect.

(static) getUXMode( ) → {UXMode} Returns: The current user experience mode.
Gets the current user experience mode.

(static) setPerformancePreset( performancePreset )

Sets graphics performance to a preset.

Name	Type	Description
`performancePreset`	Performance.PerformancePreset	The graphics performance preset to to use.

(static) setRefreshRateProfile( refreshRateProfile )

Sets the curfrent refresh rate profile.

Name	Type	Description
`refreshRateProfile`	Performance.RefreshRateProfile	The refresh rate profile.

settingsChanged( ) Returns: Signal
Triggered when the performance preset or refresh rate profile is changed.