A class to define a provider subsystem for Adaptive Performance.
Inheritance
AdaptivePerformanceSubsystem
public class AdaptivePerformanceSubsystem : AdaptivePerformanceSubsystemBase<AdaptivePerformanceSubsystem, AdaptivePerformanceSubsystemDescriptor, AdaptivePerformanceSubsystem.APProvider>
Constructors
Main constructor, not used in the subsystem specifically.
Declaration
public AdaptivePerformanceSubsystem()
Properties
Lifecycle of the Subsystem.
Declaration
public override IApplicationLifecycle ApplicationLifecycle { get; }
Property Value
Overrides
UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.ApplicationLifecycle
Bitset of supported features.
Does not change after startup.
Declaration
public override Feature Capabilities { get; protected set; }
Property Value
Overrides
UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.Capabilities
Returns if the subsystem is initialized successfully.
Declaration
public override bool Initialized { get; protected set; }
Property Value
Type |
Description |
Boolean |
Boolean to tell if subsystem was initialized successfully.
|
Overrides
UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.Initialized
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 PerformanceLevelControl bit is not set in Capabilities.
The returned reference does not change after startup.
Declaration
public override IDevicePerformanceLevelControl PerformanceLevelControl { get; }
Property Value
Overrides
UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.PerformanceLevelControl
Generates a human readable string of subsystem internal stats.
Optional and only used for development.
Declaration
public override string Stats { get; }
Property Value
Type |
Description |
String |
String with subsystem specific statistics
|
Overrides
UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.Stats
Returns the version of the subsystem implementation.
Can be used together with SubsystemDescriptor to identify a subsystem.
Declaration
public override Version Version { get; }
Property Value
Type |
Description |
Version |
Version number
|
Overrides
UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.Version
Methods
To be called once per frame.
The returned data structure's fields are populated with the latest available data, according to the supported Capabilities.
Declaration
public override PerformanceDataRecord Update()
Returns
Overrides
UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.Update()
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.