LDKProfilerZoneKind
typedef enum LDKProfilerZoneKind{
LDK_PROFILER_ZONE_USER=0,
LDK_PROFILER_ZONE_FRAME,
LDK_PROFILER_ZONE_PHASE,
LDK_PROFILER_ZONE_BUCKET,
LDK_PROFILER_ZONE_SYSTEM
}LDKProfilerZoneKind;ldk_profiler.h
homeRuntime profiling
Lightweight engine profiling instrumentation.
The engine owns the collector in shared and monolithic builds.
LDKProfilerSource
typedef struct LDKProfilerSource{
volatile i32 id;
}LDKProfilerSource;LDKProfilerCounter
typedef struct LDKProfilerCounter{
volatile i32 id;
}LDKProfilerCounter;ldk_profiler_initialize
Initialize the profiler.
LDK_API bool ldk_profiler_initialize(const char *runtree_path);Parameters
const char *runtree_path- Path of the runtree.
Returns
True if the operation succeeds; false otherwise.
ldk_profiler_terminate
Shut down the profiler.
LDK_API void ldk_profiler_terminate(void);ldk_profiler_capture_start
Start the profiler capture.
LDK_API bool ldk_profiler_capture_start(const char *path);Parameters
const char *path- Path identifying the file or resource.
Returns
True if the operation succeeds; false otherwise.
ldk_profiler_capture_stop
Stop the profiler capture.
LDK_API void ldk_profiler_capture_stop(void);ldk_profiler_capture_collect
Collect the current profiler sample data.
LDK_API void ldk_profiler_capture_collect(bool enabled);Parameters
bool enabled- Enabled used by this operation.
ldk_profiler_capture_toggle
Toggle profiler capture state.
LDK_API void ldk_profiler_capture_toggle(void);ldk_profiler_capture_is_active
Check whether the profiler capture is active.
LDK_API bool ldk_profiler_capture_is_active(void);Returns
True when the queried condition holds; false otherwise.
ldk_profiler_capture_path_get
Get the profiler capture path.
LDK_API const char * ldk_profiler_capture_path_get(void);Returns
Pointer to the requested object or data; NULL when unavailable.
ldk_profiler_frame_begin
Begin the profiler frame.
LDK_API void ldk_profiler_frame_begin(void);ldk_profiler_frame_end
Finish the profiler frame.
LDK_API void ldk_profiler_frame_end(void);ldk_profiler_zone_begin_source
Begin a profiling zone tagged with a source location.
LDK_API void ldk_profiler_zone_begin_source(
LDKProfilerSource *source,
LDKProfilerZoneKind kind,
const char *name,
const char *file,
const char *function,
u32 line
);Parameters
LDKProfilerSource *source- Source object or source data for this operation.
LDKProfilerZoneKind kind- Kind used by this operation.
const char *name- Name identifying the object or setting.
const char *file- File used by this operation.
const char *function- Function to run as a scheduled job.
u32 line- Line used by this operation.
ldk_profiler_zone_end
Finish the profiler zone.
LDK_API void ldk_profiler_zone_end(void);ldk_profiler_zone_end_kind
Close an active profiling zone of the specified kind.
LDK_API void ldk_profiler_zone_end_kind(LDKProfilerZoneKind kind);Parameters
LDKProfilerZoneKind kind- Kind used by this operation.
ldk_profiler_counter_set_source
Assign a profiler counter value at a source location.
LDK_API void ldk_profiler_counter_set_source(
LDKProfilerCounter *counter,
const char *name,
double value
);Parameters
LDKProfilerCounter *counter- Counter used by this operation.
const char *name- Name identifying the object or setting.
double value- Input value or current widget value.
ldk_profiler_counter_add_source
Increment a profiler counter at a source location.
LDK_API void ldk_profiler_counter_add_source(
LDKProfilerCounter *counter,
const char *name,
double value
);Parameters
LDKProfilerCounter *counter- Counter used by this operation.
const char *name- Name identifying the object or setting.
double value- Input value or current widget value.
ldk_profiler_thread_name_set
Set the profiler thread name.
LDK_API void ldk_profiler_thread_name_set(const char *name);Parameters
const char *name- Name identifying the object or setting.
LDK_PROFILE_CONCAT_INNER
#define LDK_PROFILE_CONCAT_INNER(a, b) a##bLDK_PROFILE_CONCAT
#define LDK_PROFILE_CONCAT(a, b) LDK_PROFILE_CONCAT_INNER(a, b)LDK_PROFILE_BEGIN
#define LDK_PROFILE_BEGIN(name) \
LDK_PROFILE_BEGIN_IMPL(name, __LINE__)LDK_PROFILE_BEGIN_IMPL
#define LDK_PROFILE_BEGIN_IMPL(name, line) \
do\
{\
static LDKProfilerSource LDK_PROFILE_CONCAT(\
ldk_profiler_source_, line)={0};\
ldk_profiler_zone_begin_source(\
&LDK_PROFILE_CONCAT(ldk_profiler_source_, line), \
LDK_PROFILER_ZONE_USER, (name), __FILE__, __func__, (u32)(line));\
}while(0)LDK_PROFILE_END
#define LDK_PROFILE_END() ldk_profiler_zone_end()LDK_PROFILE_COUNTER_SET
#define LDK_PROFILE_COUNTER_SET(name, value) \
LDK_PROFILE_COUNTER_SET_IMPL(name, value, __LINE__)LDK_PROFILE_COUNTER_SET_IMPL
#define LDK_PROFILE_COUNTER_SET_IMPL(name, value, line) \
do\
{\
static LDKProfilerCounter LDK_PROFILE_CONCAT(\
ldk_profiler_counter_, line)={0};\
ldk_profiler_counter_set_source(\
&LDK_PROFILE_CONCAT(ldk_profiler_counter_, line), (name), \
(double)(value));\
}while(0)LDK_PROFILE_COUNTER_ADD
#define LDK_PROFILE_COUNTER_ADD(name, value) \
LDK_PROFILE_COUNTER_ADD_IMPL(name, value, __LINE__)LDK_PROFILE_COUNTER_ADD_IMPL
#define LDK_PROFILE_COUNTER_ADD_IMPL(name, value, line) \
do\
{\
static LDKProfilerCounter LDK_PROFILE_CONCAT(\
ldk_profiler_counter_, line)={0};\
ldk_profiler_counter_add_source(\
&LDK_PROFILE_CONCAT(ldk_profiler_counter_, line), (name), \
(double)(value));\
}while(0)