profiling_category.hpp File Reference
#include <boost/preprocessor/tuple/elem.hpp>

Macros

#define KZ_PROFILING_ENABLED_CATEGORY
 Disabled category. More...
 
#define KZ_PROFILING_DISABLED_CATEGORY
 Enabled category. More...
 
#define KZ_PROFILING_CREATE_CATEGORY(state, name)
 Creates new profiling category. More...
 
#define KZ_PROFILING_GET_CATEGORY_STATE(category)
 Returns category status (enabled/disabled). More...
 
#define KZ_PROFILING_GET_CATEGORY_NAME(category)
 Returns category name. More...
 
#define KZ_PROFILING_IS_CATEGORY_ENABLED(category)
 Tests if category is enabled. More...
 
#define KZ_PROFILING_CATEGORY_GENERIC_ENABLED
 
#define KZ_PROFILING_CATEGORY_GENERIC
 Generic Profiling Category. More...
 

Macro Definition Documentation

#define KZ_PROFILING_ENABLED_CATEGORY

Disabled category.

#define KZ_PROFILING_DISABLED_CATEGORY

Enabled category.

#define KZ_PROFILING_CREATE_CATEGORY (   state,
  name 
)

Creates new profiling category.

Parameters
statesets category to enabled (KZ_PROFILING_ENABLED_CATEGORY) or disabled (KZ_PROFILING_DISABLED_CATEGORY) state.
nameThe name of the category.
#define KZ_PROFILING_GET_CATEGORY_STATE (   category)

Returns category status (enabled/disabled).

Parameters
categoryThe profiling category macro to fetch status.
Returns
Evaluates to state of category: KZ_PROFILING_ENABLED_CATEGORY or KZ_PROFILING_DISABLED_CATEGORY.
#define KZ_PROFILING_GET_CATEGORY_NAME (   category)

Returns category name.

Parameters
categoryThe profiling category macro to fetch name.
Returns
Evaluates to character string of category.
#define KZ_PROFILING_IS_CATEGORY_ENABLED (   category)

Tests if category is enabled.

Parameters
categoryThe profiling category macro to test status.
#define KZ_PROFILING_CATEGORY_GENERIC_ENABLED
#define KZ_PROFILING_CATEGORY_GENERIC

Generic Profiling Category.

This should be used to profile code not specific to other profiling categories, having general meaning or debug code that is not going to be present in release build and do not have specific context.