Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

AdaptivePerformanceSubsystem

class in UnityEngine.AdaptivePerformance.Provider

/

Inherits from:AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase_3

/

Implemented in:UnityEngine.AdaptivePerformanceModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A class to define a provider subsystem for Adaptive Performance.

Properties

Property Description
ApplicationLifecycle Lifecycle of the Subsystem.
Capabilities Bitset of supported features. Does not change after startup.
Initialized Returns if the subsystem is initialized successfully.
PerformanceLevelControl Control CPU or GPU performance levels of the device. Can be null if the subsystem does not support controlling CPU/GPU performance levels. Is null when the Feature.PerformanceLevelControl bit is not set in Capabilities. The returned reference does not change after startup.
Stats Generates a human readable string of subsystem internal stats. Optional and only used for development.
Version Returns the version of the subsystem implementation. Can be used together with SubsystemDescriptor to identify a subsystem.

Constructors

Constructor Description
AdaptivePerformanceSubsystem Main constructor, not used in the subsystem specifically.

Public Methods

Method Description
Update To be called once per frame. The returned data structure's fields are populated with the latest available data, according to the supported Capabilities.

Inherited Members

Properties

PropertyDescription
ApplicationLifecycle Application lifecycle events to be consumed by subsystem. Can be null if the subsystem does not need special handling on life-cycle events. The returned reference does not change after startup.
Capabilities Bitset of supported features. Does not change after startup.
Initialized Returns if the subsystem is initialized successfully.
PerformanceLevelControl Control CPU or GPU performance levels of the device. Can be null if the subsystem does not support controlling CPU/GPU performance levels. Is null when the Feature.PerformanceLevelControl bit is not set in Capabilities. The returned reference does not change after startup.
Stats Generates a human readable string of subsystem internal stats. Optional and only used for development.
Version Returns the version of the subsystem implementation. Can be used together with SubsystemDescriptor to identify a subsystem.
runningWhether or not the subsystem is running.This returns true after Start has been called on the subsystem, and false after Stop is called.

Public Methods

MethodDescription
DestroyDestroys this instance of a subsystem.Also unloads all resources acquired during the initialization step. Call this when you no longer need this instance of a subsystem.Note: Once a subsystem is Destroyed, script can still hold a reference but calling a method on it will result in a NullArgumentException.
StartStarts an instance of a subsystem.Once the instance is started, the subsystem representing this instance is active and can be interacted with.
StopStops an instance of a subsystem.Once the instance is stopped, the subsystem representing this instance is no longer active and should not consume CPU resources.