Function profiler_frames

unity_cli/cli/commands/profiler.py:128–182

Return a table of the most recent N profiled frames with per-frame metrics. Example: u profiler frames -c 30

(
    ctx: typer.Context,
    count: Annotated[
        int,
        typer.Option("--count", "-c", help="Number of frames to retrieve"),
    ] = 10,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
)

@profiler_app.command("frames")
def profiler_frames(
    ctx: typer.Context,
    count: Annotated[
        int,
        typer.Option("--count", "-c", help="Number of frames to retrieve"),
    ] = 10,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
) -> None:
    """Return a table of the most recent N profiled frames with per-frame metrics.

    Example:
        u profiler frames -c 30
    """
    context: CLIContext = ctx.obj
    try:
        result = context.client.profiler.frames(count=count)
        if _should_json(context, json_flag):
            print_json(result)
        else:
            frames = result.get("frames", [])
            if not frames:
                print_line("[dim]No profiler frames available[/dim]")
                return

            title = f"Profiler Frames ({result.get('firstFrameIndex', '?')}-{result.get('lastFrameIndex', '?')})"
            headers = ["Frame", "FPS", "CPU (ms)", "GPU (ms)", "Batches", "Draw Calls", "GC Alloc"]
            rows = [
                [
                    str(f.get("frameIndex", "")),
                    str(f.get("fps", "-")),
                    str(f.get("cpuFrameTimeMs", "-")),
                    str(f.get("gpuFrameTimeMs", "-")),
                    str(f.get("batches", "-")),
                    str(f.get("drawCalls", "-")),
                    str(f.get("gcAllocBytes", "-")),
                ]
                for f in frames
            ]

            if is_no_color():
                _print_plain_table(headers, rows, title)
            else:
                from rich.table import Table

                table = Table(title=title)
                for h in headers:
                    table.add_column(h, justify="right")
                for r in rows:
                    table.add_row(*r)
                get_console().print(table)
    except UnityCLIError as e:
        _handle_error(e)