VTK  9.3.20240424
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.
 
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.
 

Public Attributes

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

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 78 of file vtkRenderTimerLog.h.

Member Function Documentation

◆ ElapsedTimeSeconds()

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

Convenience methods to compute times.

Definition at line 89 of file vtkRenderTimerLog.h.

◆ ElapsedTimeMilliseconds()

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

Definition at line 90 of file vtkRenderTimerLog.h.

◆ ElapsedTimeNanoseconds()

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

Definition at line 91 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 101 of file vtkRenderTimerLog.h.

◆ Print() [2/2]

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

Friends And Related Symbol Documentation

◆ vtkRenderTimerLog::Frame

friend struct vtkRenderTimerLog::Frame
friend

Definition at line 106 of file vtkRenderTimerLog.h.

Member Data Documentation

◆ Name

std::string vtkRenderTimerLog::Event::Name

Event name.

Definition at line 81 of file vtkRenderTimerLog.h.

◆ StartTime

vtkTypeUInt64 vtkRenderTimerLog::Event::StartTime

Times are in nanoseconds.

Definition at line 84 of file vtkRenderTimerLog.h.

◆ EndTime

vtkTypeUInt64 vtkRenderTimerLog::Event::EndTime

Times are in nanoseconds.

Definition at line 85 of file vtkRenderTimerLog.h.

◆ Events

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

Child events that occurred while this event was running.

Definition at line 94 of file vtkRenderTimerLog.h.


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