Unravel Engine C++ Reference
Loading...
Searching...
No Matches
unravel::frame_snapshot Struct Reference

Compacted copy of one frame's profiling data across all threads. More...

#include <profiler.h>

Classes

struct  thread_snapshot
 

Public Attributes

int64_t frame_start_ns {0}
 
int64_t frame_end_ns {0}
 
int64_t event_min_ns {0}
 
int64_t event_max_ns {0}
 
int64_t cpu_heap_used_bytes {0}
 Managed heap used (e.g. Mono GC) sampled at capture; bytes.
 
int64_t gpu_memory_used_bytes {0}
 Total GPU memory reported by bgfx at capture; bytes.
 
int64_t process_resident_bytes {0}
 Process resident set (RSS / working set) at capture; bytes.
 
float frame_wall_ms {0.0f}
 Wall-clock frame duration in milliseconds (cached at capture for UI).
 
float frame_busy_ms {0.0f}
 Main-thread busy time in milliseconds (Frame Loop CPU, or longest main root).
 
float frame_cpu_ratio {1.0f}
 frame_busy_ms / frame_wall_ms — fraction of the frame the main thread was running.
 
std::vector< thread_snapshotthreads
 

Detailed Description

Compacted copy of one frame's profiling data across all threads.

Definition at line 200 of file profiler.h.

Member Data Documentation

◆ cpu_heap_used_bytes

int64_t unravel::frame_snapshot::cpu_heap_used_bytes {0}

Managed heap used (e.g. Mono GC) sampled at capture; bytes.

Definition at line 207 of file profiler.h.

◆ event_max_ns

int64_t unravel::frame_snapshot::event_max_ns {0}

Definition at line 205 of file profiler.h.

◆ event_min_ns

int64_t unravel::frame_snapshot::event_min_ns {0}

Definition at line 204 of file profiler.h.

◆ frame_busy_ms

float unravel::frame_snapshot::frame_busy_ms {0.0f}

Main-thread busy time in milliseconds (Frame Loop CPU, or longest main root).

Definition at line 215 of file profiler.h.

◆ frame_cpu_ratio

float unravel::frame_snapshot::frame_cpu_ratio {1.0f}

frame_busy_ms / frame_wall_ms — fraction of the frame the main thread was running.

Definition at line 217 of file profiler.h.

◆ frame_end_ns

int64_t unravel::frame_snapshot::frame_end_ns {0}

Definition at line 203 of file profiler.h.

◆ frame_start_ns

int64_t unravel::frame_snapshot::frame_start_ns {0}

Definition at line 202 of file profiler.h.

◆ frame_wall_ms

float unravel::frame_snapshot::frame_wall_ms {0.0f}

Wall-clock frame duration in milliseconds (cached at capture for UI).

Definition at line 213 of file profiler.h.

◆ gpu_memory_used_bytes

int64_t unravel::frame_snapshot::gpu_memory_used_bytes {0}

Total GPU memory reported by bgfx at capture; bytes.

Definition at line 209 of file profiler.h.

◆ process_resident_bytes

int64_t unravel::frame_snapshot::process_resident_bytes {0}

Process resident set (RSS / working set) at capture; bytes.

Definition at line 211 of file profiler.h.

◆ threads

std::vector<thread_snapshot> unravel::frame_snapshot::threads

Definition at line 226 of file profiler.h.


The documentation for this struct was generated from the following file: