irr::CProfileScope Class Reference

Class where the objects profile their own life-time. More...

#include <IProfiler.h>

Public Member Functions
	CProfileScope (s32 id)
	Construct with an known id. More...
	CProfileScope (s32 id, const core::stringw &name, const core::stringw &groupName)
	Object will create the given name, groupName combination for the id if it doesn't exist already. More...
	CProfileScope (const core::stringw &name, const core::stringw &groupName)
	Object will create an id for the given name, groupName combination if they don't exist already. More...
	~CProfileScope ()

Protected Attributes
s32	Id
IProfiler &	Profiler

Detailed Description

Class where the objects profile their own life-time.

This is a comfort wrapper around the IProfiler start/stop mechanism which is easier to use when you want to profile a scope. You only have to create an object and it will profile it's own lifetime for the given id.

Definition at line 233 of file IProfiler.h.

Constructor & Destructor Documentation

CProfileScope() [1/3]

irr::CProfileScope::CProfileScope ( s32  id )

inline

Construct with an known id.

This is the fastest scope constructor, but the id must have been added before.

Parameters

id	Any id which you did add to the profiler before.

Definition at line 239 of file IProfiler.h.

        : Id(id), Profiler(getProfiler())
        {
                Profiler.start(Id);
        }

CProfileScope() [2/3]

irr::CProfileScope::CProfileScope ( s32  id, const core::stringw &  name, const core::stringw &  groupName  )

inline

Object will create the given name, groupName combination for the id if it doesn't exist already.

Parameters

id	Should be >= 0 as negative id's are reserved for Irrlicht. Also very large numbers (near INT_MAX) might have been created already by the automatic add function of ::IProfiler.
name	Name for displaying profile data.
groupName	Each id belongs into a group - this helps on displaying profile data.

Definition at line 250 of file IProfiler.h.

        : Id(id), Profiler(getProfiler())
        {
                Profiler.add(Id, name, groupName);
                Profiler.start(Id);
        }

CProfileScope() [3/3]

irr::CProfileScope::CProfileScope ( const core::stringw &  name, const core::stringw &  groupName  )

inline

Object will create an id for the given name, groupName combination if they don't exist already.

Slowest scope constructor, but usually still fine unless speed is very critical.

Parameters

name	Name for displaying profile data.
groupName	Each id belongs into a group - this helps on displaying profile data.

Definition at line 261 of file IProfiler.h.

        : Profiler(getProfiler())
        {
                Id = Profiler.add(name, groupName);
                Profiler.start(Id);
        }

~CProfileScope()

irr::CProfileScope::~CProfileScope ( )

inline

Definition at line 268 of file IProfiler.h.

        {
                Profiler.stop(Id);
        }

Member Data Documentation

Id

s32 irr::CProfileScope::Id

protected

Definition at line 274 of file IProfiler.h.

Profiler

IProfiler& irr::CProfileScope::Profiler

protected

Definition at line 275 of file IProfiler.h.

---

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

• include/irrlicht/IProfiler.h