OGRE-Next: OgreProfiler.h File Reference

| OGRE-Next 3.0.0 Object-Oriented Graphics Rendering Engine

Loading...
Searching...
No Matches
OgreProfiler.h File Reference
`#include "OgrePrerequisites.h"`
`#include "OgreProfilerCommon.h"`
`#include "OgreSingleton.h"`
`#include "ogrestd/map.h"`
`#include "ogrestd/set.h"`
`#include "ogrestd/vector.h"`
`#include "Remotery.h"`
`#include "OgreHeaderPrefix.h"`
`#include "OgreHeaderSuffix.h"`

## Classes
class | Ogre::Profile
| An individual profile that will be processed by the Profiler. More...
struct | Ogre::ProfileFrame
| Represents the total timing information of a profile since profiles can be called more than once each frame. More...
struct | Ogre::ProfileHistory
| Represents a history of each profile during the duration of the app. More...
class | Ogre::ProfileInstance
| Represents an individual profile call. More...
class | Ogre::Profiler
| The profiler allows you to measure the performance of your code. More...
class | Ogre::ProfileSessionListener
| ProfileSessionListener should be used to visualize profile results. More...

## Namespaces
namespace | Ogre
| bswapNN may be defined as macros in <sys/endian.h> or <sys/bswap.h>

## Macros
#define | OgreProfile(a)
#define | OgreProfileBegin(a)
#define | OgreProfileBeginDynamic(a)
#define | OgreProfileBeginDynamicHashed(a, hash)
#define | OgreProfileBeginGPUEvent(g)
#define | OgreProfileBeginGroup(a, g)
#define | OgreProfileEnd(a)
#define | OgreProfileEndGPUEvent(g)
#define | OgreProfileEndGroup(a, g)
#define | OgreProfileGpuBegin(a)
#define | OgreProfileGpuBeginDynamic(a)
#define | OgreProfileGpuBeginDynamicHashed(a, hash)
#define | OgreProfileGpuEnd(a)
#define | OgreProfileGroup(a, g)
#define | OgreProfileGroupAggregate(a, g)
#define | OgreProfileGroupL(a, g, f, line)
#define | OgreProfileGroupL2(a, g, f, line)
#define | OgreProfileL(a, line)
#define | OgreProfileL2(a, line)
#define | OgreProfileMarkGPUEvent(e)
#define | OgreProfilerUseStableMarkers true

## Enumerations
enum | Ogre::ProfileGroupMask { Ogre::OGREPROF_USER_DEFAULT = 0x00000001 , Ogre::OGREPROF_ALL = 0xFF000000 , Ogre::OGREPROF_GENERAL = 0x80000000 , Ogre::OGREPROF_CULLING = 0x40000000 , Ogre::OGREPROF_RENDERING = 0x20000000 }
| List of reserved profiling masks. More...

## Macro Definition Documentation

## ◆ OgreProfile

#define OgreProfile | ( |  | a | ) |

Value:
OgreProfileL( a, __LINE__ )
OgreProfileL
#define OgreProfileL(a, line)
Definition OgreProfiler.h:65

## ◆ OgreProfileBegin

#define OgreProfileBegin | ( |  | a | ) |

Value:
Ogre::Profiler::getSingleton().beginProfile( ( a ) )
Ogre::Profiler::beginProfile
void beginProfile(const String &profileName, uint32 groupID=(uint32) OGREPROF_USER_DEFAULT, ProfileSampleFlags::ProfileSampleFlags flags=ProfileSampleFlags::FlagsNone)
Begins a profile.
Ogre::Profiler::getSingleton
static Profiler & getSingleton()
Override standard Singleton retrieval.

## ◆ OgreProfileBeginDynamic

#define OgreProfileBeginDynamic | ( |  | a | ) |

Value:
OgreProfileBegin( a )
OgreProfileBegin
#define OgreProfileBegin(a)
Definition OgreProfiler.h:71

## ◆ OgreProfileBeginDynamicHashed

#define OgreProfileBeginDynamicHashed | ( |  | a,
|  |  | hash )

Value:
OgreProfileBegin( a )

## ◆ OgreProfileBeginGPUEvent

#define OgreProfileBeginGPUEvent | ( |  | g | ) |

Value:
Ogre::Profiler::getSingleton().beginGPUEvent( g )
Ogre::Profiler::beginGPUEvent
void beginGPUEvent(const String &event)
Mark the beginning of a GPU event group.

## ◆ OgreProfileBeginGroup

#define OgreProfileBeginGroup | ( |  | a,
|  |  | g )

Value:
Ogre::Profiler::getSingleton().beginProfile( ( a ), ( g ) )

## ◆ OgreProfileEnd

#define OgreProfileEnd | ( |  | a | ) |

Value:
Ogre::Profiler::getSingleton().endProfile( ( a ) )
Ogre::Profiler::endProfile
void endProfile(const String &profileName, uint32 groupID=(uint32) OGREPROF_USER_DEFAULT)
Ends a profile.

## ◆ OgreProfileEndGPUEvent

#define OgreProfileEndGPUEvent | ( |  | g | ) |

Value:
Ogre::Profiler::getSingleton().endGPUEvent( g )
Ogre::Profiler::endGPUEvent
void endGPUEvent(const String &event)
Mark the end of a GPU event group.

## ◆ OgreProfileEndGroup

#define OgreProfileEndGroup | ( |  | a,
|  |  | g )

Value:
Ogre::Profiler::getSingleton().endProfile( ( a ), ( g ) )

## ◆ OgreProfileGpuBegin

#define OgreProfileGpuBegin | ( |  | a | ) |

## ◆ OgreProfileGpuBeginDynamic

#define OgreProfileGpuBeginDynamic | ( |  | a | ) |

## ◆ OgreProfileGpuBeginDynamicHashed

#define OgreProfileGpuBeginDynamicHashed | ( |  | a,
|  |  | hash )

## ◆ OgreProfileGpuEnd

#define OgreProfileGpuEnd | ( |  | a | ) |

## ◆ OgreProfileGroup

#define OgreProfileGroup | ( |  | a,
|  |  | g )

Value:
OgreProfileGroupL( a, g, ProfileSampleFlags::FlagsNone, __LINE__ )
OgreProfileGroupL
#define OgreProfileGroupL(a, g, f, line)
Definition OgreProfiler.h:77
ProfileSampleFlags::FlagsNone
@ FlagsNone
Default behaviour.
Definition OgreProfilerCommon.h:37

## ◆ OgreProfileGroupAggregate

#define OgreProfileGroupAggregate | ( |  | a,
|  |  | g )

Value:
OgreProfileGroupL( a, g, ProfileSampleFlags::Aggregate, __LINE__ )
ProfileSampleFlags::Aggregate
@ Aggregate
Search parent for same-named samples and merge timing instead of adding a new sample.
Definition OgreProfilerCommon.h:39

## ◆ OgreProfileGroupL

#define OgreProfileGroupL | ( |  | a,
|  |  | g,
|  |  | f,
|  |  | line )

Value:
OgreProfileGroupL2( a, g, f, line )
OgreProfileGroupL2
#define OgreProfileGroupL2(a, g, f, line)
Definition OgreProfiler.h:75

## ◆ OgreProfileGroupL2

#define OgreProfileGroupL2 | ( |  | a,
|  |  | g,
|  |  | f,
|  |  | line )

Value:
Ogre::Profile _OgreProfileInstance##line( ( a ), ( f ), ( g ) )
Ogre::Profile
An individual profile that will be processed by the Profiler.
Definition OgreProfiler.h:236

## ◆ OgreProfileL

#define OgreProfileL | ( |  | a,
|  |  | line )

Value:
OgreProfileL2( a, line )
OgreProfileL2
#define OgreProfileL2(a, line)
Definition OgreProfiler.h:63

## ◆ OgreProfileL2

#define OgreProfileL2 | ( |  | a,
|  |  | line )

Value:
Ogre::Profile _OgreProfileInstance##line( ( a ), ProfileSampleFlags::FlagsNone )

## ◆ OgreProfileMarkGPUEvent

#define OgreProfileMarkGPUEvent | ( |  | e | ) |

Value:
Ogre::Profiler::getSingleton().markGPUEvent( e )
Ogre::Profiler::markGPUEvent
void markGPUEvent(const String &event)
Mark a specific, ungrouped, GPU event.

## ◆ OgreProfilerUseStableMarkers

#define OgreProfilerUseStableMarkers true