Class XrPerformanceSettingsFeature

Allows interaction with the Performance settings API, which allows the application to provide hints to the runtime about the performance characteristics of the application, and to receive notifications from the runtime about changes in performance state.

Inheritance
object
Object
ScriptableObject
OpenXRFeature
XrPerformanceSettingsFeature
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.XR.OpenXR.Features.Extensions.PerformanceSettings
Assembly: Unity.XR.OpenXR.dll
Syntax
public class XrPerformanceSettingsFeature : OpenXRFeature
Remarks

Refer to XR performance settings for additional information.

Fields

extensionString

Name of the OpenXR extension for performance settings.

Declaration
public const string extensionString = "XR_EXT_performance_settings"
Field Value
Type Description
string

featureId

The feature id string.

Declaration
public const string featureId = "com.unity.openxr.feature.extension.performance_settings"
Field Value
Type Description
string

Methods

OnInstanceCreate(ulong)

When an instance of the Performance setting feature is created, it allows us to confirm that the instance has been created, that the extension is enabled and we have successfully registed the performance notification callback

Declaration
protected override bool OnInstanceCreate(ulong xrInstance)
Parameters
Type Name Description
ulong xrInstance

XR Session Instance
Returns
Type Description
bool

True if the instance has successfully been created. Otherwise it returns false.
Overrides

SetPerformanceLevelHint(PerformanceDomain, PerformanceLevelHint)

Provides the OpenXR runtime with the desired performance level to be used for the specified ___domain.

Declaration
public static bool SetPerformanceLevelHint(PerformanceDomain ___domain, PerformanceLevelHint level)
Parameters
Type Name Description
PerformanceDomain ___domain

Domain for which the performance hit will be sent.
PerformanceLevelHint level

Desired performance asked by the application.
Returns
Type Description
bool

True if the performance level hint was successfully set, false otherwise.
Remarks

Refer to [Performance level hints](xref: openxr-performance-settings#performance-settings-level-hints) for additional information.

Events

OnXrPerformanceChangeNotification

Subscribe to this event to receive performance change notifications from the OpenXR runtime.

Declaration
public static event UnityAction<PerformanceChangeNotification> OnXrPerformanceChangeNotification
Event Type
Type Description
UnityAction<PerformanceChangeNotification>
Remarks

Refer to Performance notifications for additional information.

Examples

Example of subscribing to the event and handling the performance change notification: 

XrPerformanceSettingsFeature.OnXrPerformanceChangeNotification += OnGPUPerformanceChange;

Example of handling the performance change notification: 

void OnGPUPerformanceChange(PerformanceChangeNotification notification)
{
    if (notification.___domain != Domain.GPU)
    {
        return;
    }

if (notification.toLevel ==  PerformanceNotificationLevel.Normal)
{
    // Performance has improved
    UseDefaultQuality();
}
else
{
    // Performance has degraded
    UseReducedQuality();
}



}