docs.unity3d.com
    Show / Hide Table of Contents

    Class AdaptivePerformanceSubsystem

    A class to define a provider subsystem for Adaptive Performance.

    Inheritance
    Object
    AdaptivePerformanceSubsystemBase<AdaptivePerformanceSubsystem, AdaptivePerformanceSubsystemDescriptor, AdaptivePerformanceSubsystem.APProvider>
    AdaptivePerformanceSubsystem
    FailToLoadSubsystem
    SimulatorAdaptivePerformanceSubsystem
    StandaloneSubsystem
    Inherited Members
    AdaptivePerformanceSubsystemBase<AdaptivePerformanceSubsystem, AdaptivePerformanceSubsystemDescriptor, AdaptivePerformanceSubsystem.APProvider>.Capabilities
    AdaptivePerformanceSubsystemBase<AdaptivePerformanceSubsystem, AdaptivePerformanceSubsystemDescriptor, AdaptivePerformanceSubsystem.APProvider>.Update()
    AdaptivePerformanceSubsystemBase<AdaptivePerformanceSubsystem, AdaptivePerformanceSubsystemDescriptor, AdaptivePerformanceSubsystem.APProvider>.ApplicationLifecycle
    AdaptivePerformanceSubsystemBase<AdaptivePerformanceSubsystem, AdaptivePerformanceSubsystemDescriptor, AdaptivePerformanceSubsystem.APProvider>.PerformanceLevelControl
    AdaptivePerformanceSubsystemBase<AdaptivePerformanceSubsystem, AdaptivePerformanceSubsystemDescriptor, AdaptivePerformanceSubsystem.APProvider>.Version
    AdaptivePerformanceSubsystemBase<AdaptivePerformanceSubsystem, AdaptivePerformanceSubsystemDescriptor, AdaptivePerformanceSubsystem.APProvider>.Stats
    AdaptivePerformanceSubsystemBase<AdaptivePerformanceSubsystem, AdaptivePerformanceSubsystemDescriptor, AdaptivePerformanceSubsystem.APProvider>.Initialized
    Namespace: UnityEngine.AdaptivePerformance.Provider
    Syntax
    public class AdaptivePerformanceSubsystem : AdaptivePerformanceSubsystemBase<AdaptivePerformanceSubsystem, AdaptivePerformanceSubsystemDescriptor, AdaptivePerformanceSubsystem.APProvider>

    Constructors

    AdaptivePerformanceSubsystem()

    Main constructor, not used in the subsystem specifically.

    Declaration
    public AdaptivePerformanceSubsystem()

    Properties

    ApplicationLifecycle

    Lifecycle of the Subsystem.

    Declaration
    public override IApplicationLifecycle ApplicationLifecycle { get; }
    Property Value
    Type Description
    IApplicationLifecycle
    Overrides
    UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.ApplicationLifecycle

    Capabilities

    Bitset of supported features. Does not change after startup.

    Declaration
    public override Feature Capabilities { get; protected set; }
    Property Value
    Type Description
    Feature

    Bitset

    Overrides
    UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.Capabilities

    Initialized

    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

    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 PerformanceLevelControl bit is not set in Capabilities. The returned reference does not change after startup.

    Declaration
    public override IDevicePerformanceLevelControl PerformanceLevelControl { get; }
    Property Value
    Type Description
    IDevicePerformanceLevelControl

    Performance level control object

    Overrides
    UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.PerformanceLevelControl

    Stats

    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

    Version

    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

    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.

    Declaration
    public override PerformanceDataRecord Update()
    Returns
    Type Description
    PerformanceDataRecord

    Data structure with the most recent performance data.

    Overrides
    UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemBase<UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystemDescriptor, UnityEngine.AdaptivePerformance.Provider.AdaptivePerformanceSubsystem.APProvider>.Update()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023