VTK  9.3.20240327
Classes | Macros
vtkRenderTimerLog.h File Reference
#include "vtkObject.h"
#include "vtkRenderingCoreModule.h"
#include "vtkType.h"
#include <sstream>
#include <string>
#include <vector>
Include dependency graph for vtkRenderTimerLog.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  vtkRenderTimerLog
 Asynchronously measures GPU execution times for a series of events. More...
 
struct  vtkRenderTimerLog::Event
 Container for a single timed event. More...
 
struct  vtkRenderTimerLog::Frame
 Container for a frame's events. More...
 
struct  vtkRenderTimerLog::ScopedEventLogger
 RAII struct for logging events. More...
 

Macros

#define VTK_SCOPED_RENDER_EVENT(eventName, timer)   VTK_SCOPED_RENDER_EVENT2(eventName, timer, _event)
 Creates a ScopedEventLogger on timer with the given name. More...
 
#define VTK_SCOPED_RENDER_EVENT2(eventName, timer, identifier)
 Creates a ScopedEventLogger on timer with the given name. More...
 

Macro Definition Documentation

◆ VTK_SCOPED_RENDER_EVENT

#define VTK_SCOPED_RENDER_EVENT (   eventName,
  timer 
)    VTK_SCOPED_RENDER_EVENT2(eventName, timer, _event)

Creates a ScopedEventLogger on timer with the given name.

name is passed into a stream and may be constructed using the << operator.

Definition at line 54 of file vtkRenderTimerLog.h.

◆ VTK_SCOPED_RENDER_EVENT2

#define VTK_SCOPED_RENDER_EVENT2 (   eventName,
  timer,
  identifier 
)
Value:
do \
{ \
std::ostringstream _eventNameStream; \
_eventNameStream << eventName; \
identifier = timer->StartScopedEvent(_eventNameStream.str()); \
(void)identifier; /* Prevent set-but-not-used var warnings */ \
} while (false) /* Do-while loop prevents duplicate semicolon warnings */
RAII struct for logging events.

Creates a ScopedEventLogger on timer with the given name.

name is passed into a stream and may be constructed using the << operator. The logger will be created with the provided identifier.

Definition at line 61 of file vtkRenderTimerLog.h.