ProfilerImpl Class Reference

Interface to be implemented by profiler implementations. More...

#include <ProfilerImpl.hh>

Public Member Functions
	ProfilerImpl ()=default
	Constructor. More...
virtual	~ProfilerImpl ()=default
	Destructor. More...
virtual void	BeginSample (const char *_name, uint32_t *_hash)=0
	Begin a named profiling sample. Begins a CPU profiler sample with a given name. Can optionally take a hash parameter to be cached between executions of BeginSample, so that hashes don't need to be recomputed. More...
virtual void	EndSample ()=0
	End a profiling sample. More...
virtual void	LogText (const char *_text)=0
	Log text to profiler output (if supported) If the underlying profiler implementation supports additional log messages, this can be used to send. More...
virtual std::string	Name () const =0
	Retrieve profiler name. More...
virtual void	SetThreadName (const char *_name)=0
	Set the name of the current thread. More...

Detailed Description

Interface to be implemented by profiler implementations.

Constructor & Destructor Documentation

ProfilerImpl()

ProfilerImpl ( )

default

Constructor.

~ProfilerImpl()

virtual ~ProfilerImpl ( )

virtualdefault

Destructor.

Member Function Documentation

BeginSample()

virtual void BeginSample ( const char *  _name, uint32_t *  _hash  )

pure virtual

Begin a named profiling sample. Begins a CPU profiler sample with a given name. Can optionally take a hash parameter to be cached between executions of BeginSample, so that hashes don't need to be recomputed.

Parameters

[in]	_name	Name of the sample
[in,out]	_hash	An optional hash value that can be cached between executions.

EndSample()

virtual void EndSample ( )

pure virtual

End a profiling sample.

LogText()

virtual void LogText ( const char *  _text )

pure virtual

Log text to profiler output (if supported) If the underlying profiler implementation supports additional log messages, this can be used to send.

Parameters

[in]

_text

Text to log.

Name()

virtual std::string Name ( ) const

pure virtual

Retrieve profiler name.

SetThreadName()

virtual void SetThreadName ( const char *  _name )

pure virtual

Set the name of the current thread.

Parameters

[in]

_name

Name to set

---

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

• ProfilerImpl.hh