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

Namespace: UnityEngine.AdaptivePerformance

Syntax

public interface IAdaptivePerformance

Properties

Active

Returns true if Adaptive Performance was initialized and is actively running, false otherwise. This means that Adaptive Performance is enabled in StartupSettings.

Declaration

bool Active { get; }

Property Value

Type	Description
Boolean	True when Adaptive Performance is initialized and available, false otherwise.

DevelopmentSettings

Access to development (logging) settings.

Declaration

IDevelopmentSettings DevelopmentSettings { get; }

Property Value

Type	Description
IDevelopmentSettings	Interface to control CPU and GPU performance levels of the device.

DevicePerformanceControl

Control CPU and GPU performance of the device.

Declaration

IDevicePerformanceControl DevicePerformanceControl { get; }

Property Value

Type	Description
IDevicePerformanceControl	Interface to control CPU and GPU performance levels of the device.

Indexer

Access to the Indexer system. See AdaptivePerformanceIndexer

Declaration

AdaptivePerformanceIndexer Indexer { get; }

Property Value

Type	Description
AdaptivePerformanceIndexer	Interface to scalers that are active and their associated settings.

Initialized

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

Declaration

bool Initialized { get; }

Property Value

Type	Description
Boolean	True when Adaptive Performance is initialized, running and available, false otherwise.

PerformanceModeStatus

Access performance mode status information of the device.

Declaration

IPerformanceModeStatus PerformanceModeStatus { get; }

Property Value

Type	Description
IPerformanceModeStatus	Interface to access performance mode status information of the device.

PerformanceStatus

Access performance status information of the device and your application.

Declaration

IPerformanceStatus PerformanceStatus { get; }

Property Value

Type	Description
IPerformanceStatus	Interface to access performance status information of the device and your application.

Settings

Access to the Settings. See IAdaptivePerformanceSettings.

Declaration

IAdaptivePerformanceSettings Settings { get; }

Property Value

Type	Description
IAdaptivePerformanceSettings	Interface to settings that are loaded from the provider settings object during startup.

Subsystem

Access to the active Subsystem. See AdaptivePerformanceSubsystem.

Declaration

AdaptivePerformanceSubsystem Subsystem { get; }

Property Value

Type	Description
AdaptivePerformanceSubsystem	Reference to active Subsystem.

ThermalStatus

Access thermal status information of the device.

Declaration

IThermalStatus ThermalStatus { get; }

Property Value

Type	Description
IThermalStatus	Interface to access thermal status information of the device.

Methods

DeinitializeAdaptivePerformance()

Stops Adaptive Performance (if still running) and initiates the tear down process. When this completes successfully, Initialized will be false.

Declaration

void DeinitializeAdaptivePerformance()

InitializeAdaptivePerformance()

Initiates the initialization process for Adaptive Performance by attempting to initialize the loaders. When this completes successfully, Initialized will be true. Adaptive Performance can now be started by calling the StartAdaptivePerformance() method.

Declaration

void InitializeAdaptivePerformance()

StartAdaptivePerformance()

Attempts to start Adaptive Performance by requesting the active loader and all subsystems to start. When this completes successfully, Active will be true.

Declaration

void StartAdaptivePerformance()

StopAdaptivePerformance()

Attempts to stop Adaptive Performance by requesting the active loader and all subsystems to stop. When this completes successfully, Active will be false.

Declaration

void StopAdaptivePerformance()

SupportedFeature(Feature)

List of supported Features by the loaded provider. See Feature.

Declaration

bool SupportedFeature(Feature feature)

Parameters

Type	Name	Description
Feature	feature	The feature in question. See Feature.

Returns

Type	Description
Boolean	True if the requested feature is supported, false otherwise.