Struct FrameTiming | Adaptive Performance | 2.0.2
docs.unity3d.com
    Show / Hide Table of Contents

    Struct FrameTiming

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

    Namespace: UnityEngine.AdaptivePerformance
    Syntax
    public struct FrameTiming

    Properties

    AverageCpuFrameTime

    Returns the main thread CPU time as an average over the past 100 frames (in seconds). Returns -1.0f if this is not available (for example, in the first frame or directly after resume). The CPU time includes only the time the CPU spent executing Unity's main and/or render threads.

    Declaration
    public float AverageCpuFrameTime { get; set; }
    Property Value
    Type Description
    Single

    Frame time in seconds

    AverageFrameTime

    The overall frame time as an average over the past 100 frames (in seconds). Returns -1.0f if no timing information is available (for example, in the first frame or directly after resume).

    Declaration
    public float AverageFrameTime { get; set; }
    Property Value
    Type Description
    Single

    Frame time in seconds

    AverageGpuFrameTime

    Returns the overall frame time as an average over the past 100 frames (in seconds). Returns -1.0f if no timing information is available. The GPU time only includes the time the GPU spent on rendering a frame (for example, in the first frame or directly after resume).

    Declaration
    public float AverageGpuFrameTime { get; set; }
    Property Value
    Type Description
    Single

    Frame time value in seconds

    CurrentCpuFrameTime

    Returns the main thread CPU time of the last frame (in seconds). The CPU time includes only time the CPU spent executing Unity's main and/or render threads. Returns -1.0f if no timing information is available (for example, in the first frame or directly after resume).

    Declaration
    public float CurrentCpuFrameTime { get; set; }
    Property Value
    Type Description
    Single

    Frame time value in seconds

    CurrentFrameTime

    The overall frame time in seconds. Returns -1.0f if no timing information is available (for example, in the first frame or directly after resume).

    Declaration
    public float CurrentFrameTime { get; set; }
    Property Value
    Type Description
    Single

    Frame time in seconds

    CurrentGpuFrameTime

    Returns the GPU time of the last completely rendered frame (in seconds). Returns -1.0f if no timing information is available. The GPU time only includes the time the GPU spent on rendering a frame (for example, in the first frame or directly after resume).

    Declaration
    public float CurrentGpuFrameTime { get; set; }
    Property Value
    Type Description
    Single

    Frame time in seconds

    In This Article
    • Properties
      • AverageCpuFrameTime
      • AverageFrameTime
      • AverageGpuFrameTime
      • CurrentCpuFrameTime
      • CurrentFrameTime
      • CurrentGpuFrameTime
    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