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

SimulatorAdaptivePerformanceSubsystem

class in UnityEditor.AdaptivePerformance.Simulator.Editor

/

Inherits from:AdaptivePerformance.Provider.AdaptivePerformanceSubsystem

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

The subsystem is used for simulating Adaptive Performance in the Editor with the Device Simulator. It is also used for Adaptive Performance tests and to simulate Adaptive Performance when it is not available on the hardware you work with.

Properties

Property Description
AcceptsPerformanceLevel Required to simulate performance changes. To change AutomaticPerformanceControl, you have to set AcceptsPerformanceLevel to true. See PerformanceDataRecord.PerformanceLevelControlAvailable.
ChangeFlags This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.ChangeFlags.
CpuPerformanceBoost This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.CpuPerformanceBoost.
CpuPerformanceLevel This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.CpuPerformanceLevel.
GpuPerformanceBoost This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.GpuPerformanceBoost.
GpuPerformanceLevel This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.GpuPerformanceLevel.
NextCpuFrameTime This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.CpuFrameTime.
NextGpuFrameTime This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.GpuFrameTime.
NextOverallFrameTime This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.OverallFrameTime.
PerformanceMode This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.PerformanceMode.
TemperatureLevel This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.TemperatureLevel.
TemperatureTrend This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.TemperatureTrend.
WarningLevel This property is a wrapper around an internal PerformanceDataRecord object. For more details, see PerformanceDataRecord.WarningLevel.

Public Methods

Method Description
SetClusterInfo Helper for the device simulator to change cluster info settings. Those settings are usually changed by a device directly.

Inherited Members

Properties

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