docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.AdaptivePerformance

    Classes

    Constants

    Constants used by Adaptive Performance.

    Holder

    Global access to the default AdaptivePerformance interface.

    StartupSettings

    Changes to the startup settings are only respected when those are made before Adaptive Performance starts, for instance, from a method with the attribute [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]).

    Structs

    FrameTiming

    FrameTiming stores timing information about CPU, GPU, and the overall frame time.

    PerformanceBottleneckChangeEventArgs

    Performance bottleneck change event arguments used in the PerformanceBottleneckChangeHandler.

    PerformanceLevelChangeEventArgs

    Performance level change event arguments used in the PerformanceLevelChangeHandler.

    PerformanceMetrics

    PerformanceMetrics store the current bottleneck, CPU, and GPU levels

    ThermalMetrics

    ThermalMetrics stores the thermal state as TemperatureLevel, TemperatureTrend, and WarningLevel.

    Interfaces

    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.

    IDevelopmentSettings

    Use the developer settings interface to access and change settings which are available only in development mode.

    IDevicePerformanceControl

    The device performance control interface handles all control elements related to the device performance. You can change the AutomaticPerformanceControl settings or retrieve information about the CpuLevel and GpuLevel.

    IPerformanceStatus

    You can use the performance status interface to obtain performance metrics, frame timing, and subscribe to bottleneck and performance event changes.

    IThermalStatus

    Use the thermal status interface to receive thermal status events and thermal metrics of the device.

    Enums

    PerformanceBottleneck

    The performance bottleneck enum is used to describe what the system is currently limited by.

    PerformanceControlMode

    Enum used to describe the performance control mode used by Adaptive Performance. Can be read from PerformanceControlMode.

    WarningLevel

    The warning levels are used in the ThermalMetrics and describe the thermal status of the device in 3 categories.

    Delegates

    PerformanceBottleneckChangeHandler

    You can subscribe to the bottleneck event delegate which sends the PerformanceBottleneckChangeEventArgs when the bottleneck changes.

    PerformanceLevelChangeHandler

    You can subscribe to the performance level event delegate which sends the PerformanceLevelChangeEventArgs when the performance level changes.

    ThermalEventHandler

    You can subscribe to the thermal event delegate which sends the ThermalMetrics when the thermal state changes.

    Back to top
    Terms of use
    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