Function profiler_snapshot

unity_cli/cli/commands/profiler.py:82–124

Return metrics for the latest profiled frame (FPS, CPU/GPU ms, draw calls, GC allocs).

(
    ctx: typer.Context,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
)

@profiler_app.command("snapshot")
def profiler_snapshot(
    ctx: typer.Context,
    json_flag: Annotated[
        bool,
        typer.Option("--json", help="Output as JSON"),
    ] = False,
) -> None:
    """Return metrics for the latest profiled frame (FPS, CPU/GPU ms, draw calls, GC allocs)."""
    context: CLIContext = ctx.obj
    try:
        result = context.client.profiler.snapshot()
        if _should_json(context, json_flag):
            print_json(result)
        else:
            display_keys = [
                ("fps", "FPS"),
                ("cpuFrameTimeMs", "CPU Frame Time"),
                ("cpuRenderThreadTimeMs", "CPU Render Thread"),
                ("gpuFrameTimeMs", "GPU Frame Time"),
                ("batches", "Batches"),
                ("drawCalls", "Draw Calls"),
                ("triangles", "Triangles"),
                ("vertices", "Vertices"),
                ("setPassCalls", "SetPass Calls"),
                ("gcAllocCount", "GC Alloc Count"),
                ("gcAllocBytes", "GC Alloc Bytes"),
            ]

            rows = [[label, str(result.get(key))] for key, label in display_keys if result.get(key) is not None]

            if is_no_color():
                _print_plain_table(["Metric", "Value"], rows, f"Frame {result.get('frameIndex', '?')}")
            else:
                from rich.table import Table

                table = Table(title=f"Frame {result.get('frameIndex', '?')}")
                table.add_column("Metric")
                table.add_column("Value", justify="right")
                for r in rows:
                    table.add_row(*r)
                get_console().print(table)
    except UnityCLIError as e:
        _handle_error(e)


@profiler_app.command("frames")