VTK  9.0.20201018
Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
vtkRenderTimerLog::Event Struct Reference

Container for a single timed event. More...

#include <vtkRenderTimerLog.h>

Public Member Functions

float ElapsedTimeSeconds () const
 Convenience methods to compute times. More...
 
float ElapsedTimeMilliseconds () const
 
vtkTypeUInt64 ElapsedTimeNanoseconds () const
 
void Print (std::ostream &os, float threshMs=0.f, vtkIndent indent=vtkIndent())
 Print details of the event to a stream. More...
 

Public Attributes

std::string Name
 Event name. More...
 
std::vector< EventEvents
 Child events that occurred while this event was running. More...
 
vtkTypeUInt64 StartTime
 Times are in nanoseconds. More...
 
vtkTypeUInt64 EndTime
 Times are in nanoseconds. More...
 

Protected Member Functions

void Print (std::ostream &os, float parentTime, float threshMs, vtkIndent indent)
 

Friends

struct vtkRenderTimerLog::Frame
 

Detailed Description

Container for a single timed event.

Definition at line 86 of file vtkRenderTimerLog.h.

Member Function Documentation

◆ ElapsedTimeSeconds()

float vtkRenderTimerLog::Event::ElapsedTimeSeconds ( ) const
inline

Convenience methods to compute times.

Definition at line 97 of file vtkRenderTimerLog.h.

◆ ElapsedTimeMilliseconds()

float vtkRenderTimerLog::Event::ElapsedTimeMilliseconds ( ) const
inline

Definition at line 98 of file vtkRenderTimerLog.h.

◆ ElapsedTimeNanoseconds()

vtkTypeUInt64 vtkRenderTimerLog::Event::ElapsedTimeNanoseconds ( ) const
inline

Definition at line 99 of file vtkRenderTimerLog.h.

◆ Print() [1/2]

void vtkRenderTimerLog::Event::Print ( std::ostream &  os,
float  threshMs = 0.f,
vtkIndent  indent = vtkIndent() 
)
inline

Print details of the event to a stream.

Parameters
osThe stream.
threshMsOnly print events with a time > threshMs milliseconds.
indentStarting indentation for the first event.

Definition at line 109 of file vtkRenderTimerLog.h.

◆ Print() [2/2]

void vtkRenderTimerLog::Event::Print ( std::ostream &  os,
float  parentTime,
float  threshMs,
vtkIndent  indent 
)
protected

Friends And Related Function Documentation

◆ vtkRenderTimerLog::Frame

friend struct vtkRenderTimerLog::Frame
friend

Definition at line 114 of file vtkRenderTimerLog.h.

Member Data Documentation

◆ Name

std::string vtkRenderTimerLog::Event::Name

Event name.

Definition at line 89 of file vtkRenderTimerLog.h.

◆ StartTime

vtkTypeUInt64 vtkRenderTimerLog::Event::StartTime

Times are in nanoseconds.

Definition at line 92 of file vtkRenderTimerLog.h.

◆ EndTime

vtkTypeUInt64 vtkRenderTimerLog::Event::EndTime

Times are in nanoseconds.

Definition at line 93 of file vtkRenderTimerLog.h.

◆ Events

std::vector<Event> vtkRenderTimerLog::Event::Events

Child events that occurred while this event was running.

Definition at line 102 of file vtkRenderTimerLog.h.


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