Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


IAdaptivePerformance

The main interface to access Adaptive Performance. None of the properties in this interface change after startup. This means the references returned by the properties may be cached by the user.
Read time 2 minutesLast updated 6 days ago

Definition

public interface IAdaptivePerformance

Properties

Property

Description

ActiveReturns true if Adaptive Performance was initialized and is actively running, false otherwise. This means that Adaptive Performance is enabled in StartupSettings.
DevelopmentSettingsAccess to development (logging) settings.
DevicePerformanceControlControl CPU and GPU performance of the device.
IndexerAccess to the Indexer system. See AdaptivePerformanceIndexer
InitializedReturns true if Adaptive Performance was initialized successfully, false otherwise. This means that Adaptive Performance is enabled in StartupSettings and the application runs on a device that supports Adaptive Performance.
OperationModeStatusAccess to the active operation mode.
PerformanceModeStatusAccess performance mode status information of the device.
PerformanceStatusAccess performance status information of the device and your application.
SettingsAccess to the Settings. See IAdaptivePerformanceSettings.
SubsystemAccess to the active Subsystem. See AdaptivePerformanceSubsystem.
ThermalStatusAccess thermal status information of the device.

Methods

Method

Description

DeinitializeAdaptivePerformanceStops Adaptive Performance (if still running) and initiates the tear down process. When this completes successfully, IAdaptivePerformance.Initialized will be
false
.
InitializeAdaptivePerformanceInitiates the initialization process for Adaptive Performance by attempting to initialize the loaders. When this completes successfully, IAdaptivePerformance.Initialized will be
true
. Adaptive Performance can now be started by calling the IAdaptivePerformance.StartAdaptivePerformance method.
StartAdaptivePerformanceAttempts to start Adaptive Performance by requesting the active loader and all subsystems to start. When this completes successfully, IAdaptivePerformance.Active will be
true
.
StopAdaptivePerformanceAttempts to stop Adaptive Performance by requesting the active loader and all subsystems to stop. When this completes successfully, IAdaptivePerformance.Active will be
false
.
SupportedFeatureList of supported Features by the loaded provider. See Feature.