renoir::IProfileMarkersTracer

Object that handled profiling messages. On platforms where Renoir does not use native performance markers, these callbacks are used to tell the user code when profiling is started/stopped and what messages are emitted.

#include <CoherentRenderingLibrary.h>

Public Functions

	Name
	IProfileMarkersTracer()
virtual	~IProfileMarkersTracer()
virtual void	BeginTraceEvent(const char * systemName, const char * markerName) =0 Start a scoped profiling marker.
virtual void	BeginTraceEventWithString(const char * systemName, const char * markerName, const char * valueName, const char * value) =0 Start a scoped profiling marker with a string data attached to it.
virtual void	BeginTraceEventWithInt(const char * systemName, const char * markerName, const char * valueName, int value) =0 Start a scoped profiling marker with a integer data attached to it.
virtual void	EndTraceEvent(const char * systemName, const char * markerName) =0 End a scoped profiling marker.
virtual void	BeginTraceEventAsync(const char * systemName, const char * markerName, void * id) =0 Start a profiling event that can be started and ended on different threads.
virtual void	EndTraceEventAsync(const char * systemName, const char * markerName, void * id) =0 End a profiling event that can be started and ended on different threads.
virtual void	InstantTraceEvent(const char * systemName, const char * markerName) =0 Emit a simple event that does not have starting and beginning point.
virtual void	InstantTraceEventWithInt(const char * systemName, const char * markerName, const char * valueName, int value) =0 Emit a simple event that does not have starting and beginning point and has some integer data attached to it.
virtual void	UpdateCounter(const char * name, int value) =0 Update a profilng counter with a value. Most of the time, those are different memory counters for various subsystems of Cohtml.

Public Functions Documentation

function IProfileMarkersTracer

IProfileMarkersTracer()

function ~IProfileMarkersTracer

virtual ~IProfileMarkersTracer()

function BeginTraceEvent

virtual void BeginTraceEvent(
    const char * systemName,
    const char * markerName
) =0

Start a scoped profiling marker.

Parameters:

• systemName Name of the Cohtml’s subsystem from where the profiling event is emitted
• markerName The name of the marker that is started

function BeginTraceEventWithString

virtual void BeginTraceEventWithString(
    const char * systemName,
    const char * markerName,
    const char * valueName,
    const char * value
) =0

Start a scoped profiling marker with a string data attached to it.

Parameters:

• systemName Name of the Cohtml’s subsystem from where the profiling event is emitted
• markerName The name of the marker that is started
• valueName Name of the string variable for the event
• value The value of the string variable

function BeginTraceEventWithInt

virtual void BeginTraceEventWithInt(
    const char * systemName,
    const char * markerName,
    const char * valueName,
    int value
) =0

Start a scoped profiling marker with a integer data attached to it.

Parameters:

• systemName Name of the Cohtml’s subsystem from where the profiling event is emitted
• markerName The name of the marker that is started
• valueName Name of the integer variable for the event
• value The value of the integer variable

function EndTraceEvent

virtual void EndTraceEvent(
    const char * systemName,
    const char * markerName
) =0

End a scoped profiling marker.

Parameters:

• systemName Name of the Cohtml’s subsystem from where the profiling event is emitted
• markerName The name of the marker that is started

function BeginTraceEventAsync

virtual void BeginTraceEventAsync(
    const char * systemName,
    const char * markerName,
    void * id
) =0

Start a profiling event that can be started and ended on different threads.

Parameters:

• systemName Name of the Cohtml’s subsystem from where the profiling event is emitted
• markerName The name of the marker that is started
• id Unique pointer that can be used to identify the event

function EndTraceEventAsync

virtual void EndTraceEventAsync(
    const char * systemName,
    const char * markerName,
    void * id
) =0

End a profiling event that can be started and ended on different threads.

Parameters:

• systemName Name of the Cohtml’s subsystem from where the profiling event is emitted
• markerName The name of the marker that is started
• id Unique pointer that can be used to identify the event

function InstantTraceEvent

virtual void InstantTraceEvent(
    const char * systemName,
    const char * markerName
) =0

Emit a simple event that does not have starting and beginning point.

Parameters:

• systemName Name of the Cohtml’s subsystem from where the event is emitted
• markerName The name of the marker that is emitted

function InstantTraceEventWithInt

virtual void InstantTraceEventWithInt(
    const char * systemName,
    const char * markerName,
    const char * valueName,
    int value
) =0

Emit a simple event that does not have starting and beginning point and has some integer data attached to it.

Parameters:

• systemName Name of the Cohtml’s subsystem from where the event is emitted
• markerName The name of the marker that is emitted
• valueName Name of the integer variable for the event
• value The value of the integer variable

function UpdateCounter

virtual void UpdateCounter(
    const char * name,
    int value
) =0

Update a profilng counter with a value. Most of the time, those are different memory counters for various subsystems of Cohtml.

Parameters:

• name The name of the counter
• value The new value of the counter

---