VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkOpenGLRenderTimerLog Class Reference

OpenGL2 override for vtkRenderTimerLog. More...

#include <vtkOpenGLRenderTimerLog.h>

Inheritance diagram for vtkOpenGLRenderTimerLog:
[legend]
Collaboration diagram for vtkOpenGLRenderTimerLog:
[legend]

Classes

struct  OGLEvent
 
struct  OGLFrame
 

Public Types

typedef vtkRenderTimerLog Superclass
 
- Public Types inherited from vtkRenderTimerLog
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkOpenGLRenderTimerLogNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool IsSupported () override
 Returns true if stream timings are implemented for the current graphics backend. More...
 
bool GetLoggingEnabled () override
 Overridden to do support check before returning. More...
 
void MarkFrame () override
 Call to mark the start of a new frame, or the end of an old one. More...
 
void MarkStartEvent (const std::string &name) override
 Mark the beginning or end of an event. More...
 
void MarkEndEvent () override
 Mark the beginning or end of an event. More...
 
bool FrameReady () override
 Returns true if there are any frames ready with complete timing info. More...
 
Frame PopFirstReadyFrame () override
 Retrieve the first available frame's timing info. More...
 
void ReleaseGraphicsResources () override
 Releases any resources allocated on the graphics device. More...
 
virtual void SetMinTimerPoolSize (size_t)
 This implementations keeps a pool of vtkRenderTimers around, recycling them to avoid constantly allocating/freeing them. More...
 
virtual size_t GetMinTimerPoolSize ()
 
- Public Member Functions inherited from vtkRenderTimerLog
vtkRenderTimerLogNewInstance () const
 
ScopedEventLogger StartScopedEvent (const std::string &name)
 Create a RAII scoped event. More...
 
virtual void SetLoggingEnabled (bool)
 If false, no events are recorded. More...
 
virtual void LoggingEnabledOn ()
 If false, no events are recorded. More...
 
virtual void LoggingEnabledOff ()
 If false, no events are recorded. More...
 
virtual void SetFrameLimit (unsigned int)
 If there are more than FrameLimit frames pending/ready, drop the old ones until we are under this limit. More...
 
virtual unsigned int GetFrameLimit ()
 If there are more than FrameLimit frames pending/ready, drop the old ones until we are under this limit. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkOpenGLRenderTimerLogNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLRenderTimerLogSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderTimerLog
static vtkRenderTimerLogNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderTimerLogSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenGLRenderTimerLog ()
 
 ~vtkOpenGLRenderTimerLog () override
 
bool DoLogging ()
 
Frame Convert (const OGLFrame &oglFrame)
 
Event Convert (const OGLEvent &oglEvent)
 
OGLEventNewEvent ()
 
OGLEventDeepestOpenEvent ()
 
OGLEventWalkOpenEvents (OGLEvent &event)
 
vtkOpenGLRenderTimerNewTimer ()
 
void ReleaseTimer (vtkOpenGLRenderTimer *timer)
 
void ReleaseOGLFrame (OGLFrame &frame)
 
void ReleaseOGLEvent (OGLEvent &event)
 
void TrimTimerPool ()
 
void CheckPendingFrames ()
 
bool IsFrameReady (OGLFrame &frame)
 
bool IsEventReady (OGLEvent &event)
 
void ForceCloseFrame (OGLFrame &frame)
 
void ForceCloseEvent (OGLEvent &event)
 
- Protected Member Functions inherited from vtkRenderTimerLog
 vtkRenderTimerLog ()
 
 ~vtkRenderTimerLog () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

OGLFrame CurrentFrame
 
std::deque< OGLFramePendingFrames
 
std::queue< FrameReadyFrames
 
std::queue< vtkOpenGLRenderTimer * > TimerPool
 
size_t MinTimerPoolSize
 
- Protected Attributes inherited from vtkRenderTimerLog
bool LoggingEnabled
 
unsigned int FrameLimit
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

OpenGL2 override for vtkRenderTimerLog.

Definition at line 30 of file vtkOpenGLRenderTimerLog.h.

Member Typedef Documentation

◆ Superclass

Definition at line 52 of file vtkOpenGLRenderTimerLog.h.

Constructor & Destructor Documentation

◆ vtkOpenGLRenderTimerLog()

vtkOpenGLRenderTimerLog::vtkOpenGLRenderTimerLog ( )
protected

◆ ~vtkOpenGLRenderTimerLog()

vtkOpenGLRenderTimerLog::~vtkOpenGLRenderTimerLog ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOpenGLRenderTimerLog* vtkOpenGLRenderTimerLog::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkOpenGLRenderTimerLog::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkOpenGLRenderTimerLog::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkRenderTimerLog.

◆ SafeDownCast()

static vtkOpenGLRenderTimerLog* vtkOpenGLRenderTimerLog::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLRenderTimerLog::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRenderTimerLog.

◆ NewInstance()

vtkOpenGLRenderTimerLog* vtkOpenGLRenderTimerLog::NewInstance ( ) const

◆ PrintSelf()

void vtkOpenGLRenderTimerLog::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkRenderTimerLog.

◆ IsSupported()

bool vtkOpenGLRenderTimerLog::IsSupported ( )
overridevirtual

Returns true if stream timings are implemented for the current graphics backend.

Reimplemented from vtkRenderTimerLog.

◆ GetLoggingEnabled()

bool vtkOpenGLRenderTimerLog::GetLoggingEnabled ( )
inlineoverridevirtual

Overridden to do support check before returning.

Reimplemented from vtkRenderTimerLog.

Definition at line 60 of file vtkOpenGLRenderTimerLog.h.

◆ MarkFrame()

void vtkOpenGLRenderTimerLog::MarkFrame ( )
overridevirtual

Call to mark the start of a new frame, or the end of an old one.

Does nothing if no events have been recorded in the current frame.

Reimplemented from vtkRenderTimerLog.

◆ MarkStartEvent()

void vtkOpenGLRenderTimerLog::MarkStartEvent ( const std::string &  name)
overridevirtual

Mark the beginning or end of an event.

Reimplemented from vtkRenderTimerLog.

◆ MarkEndEvent()

void vtkOpenGLRenderTimerLog::MarkEndEvent ( )
overridevirtual

Mark the beginning or end of an event.

Reimplemented from vtkRenderTimerLog.

◆ FrameReady()

bool vtkOpenGLRenderTimerLog::FrameReady ( )
overridevirtual

Returns true if there are any frames ready with complete timing info.

Reimplemented from vtkRenderTimerLog.

◆ PopFirstReadyFrame()

Frame vtkOpenGLRenderTimerLog::PopFirstReadyFrame ( )
overridevirtual

Retrieve the first available frame's timing info.

The returned frame is removed from this log.

Reimplemented from vtkRenderTimerLog.

◆ ReleaseGraphicsResources()

void vtkOpenGLRenderTimerLog::ReleaseGraphicsResources ( )
overridevirtual

Releases any resources allocated on the graphics device.

Reimplemented from vtkRenderTimerLog.

◆ SetMinTimerPoolSize()

virtual void vtkOpenGLRenderTimerLog::SetMinTimerPoolSize ( size_t  )
virtual

This implementations keeps a pool of vtkRenderTimers around, recycling them to avoid constantly allocating/freeing them.

The pool is sometimes trimmed to free up memory if the number of timers in the pool is much greater the the number of timers currently used. This setting controls the minimum number of timers that will be kept. More may be kept if they are being used, but the pool will never be trimmed below this amount.

Default value is 32, but can be adjusted for specific use cases.

◆ GetMinTimerPoolSize()

virtual size_t vtkOpenGLRenderTimerLog::GetMinTimerPoolSize ( )
virtual

◆ DoLogging()

bool vtkOpenGLRenderTimerLog::DoLogging ( )
protected

◆ Convert() [1/2]

Frame vtkOpenGLRenderTimerLog::Convert ( const OGLFrame oglFrame)
protected

◆ Convert() [2/2]

Event vtkOpenGLRenderTimerLog::Convert ( const OGLEvent oglEvent)
protected

◆ NewEvent()

OGLEvent& vtkOpenGLRenderTimerLog::NewEvent ( )
protected

◆ DeepestOpenEvent()

OGLEvent* vtkOpenGLRenderTimerLog::DeepestOpenEvent ( )
protected

◆ WalkOpenEvents()

OGLEvent& vtkOpenGLRenderTimerLog::WalkOpenEvents ( OGLEvent event)
protected

◆ NewTimer()

vtkOpenGLRenderTimer* vtkOpenGLRenderTimerLog::NewTimer ( )
protected

◆ ReleaseTimer()

void vtkOpenGLRenderTimerLog::ReleaseTimer ( vtkOpenGLRenderTimer timer)
protected

◆ ReleaseOGLFrame()

void vtkOpenGLRenderTimerLog::ReleaseOGLFrame ( OGLFrame frame)
protected

◆ ReleaseOGLEvent()

void vtkOpenGLRenderTimerLog::ReleaseOGLEvent ( OGLEvent event)
protected

◆ TrimTimerPool()

void vtkOpenGLRenderTimerLog::TrimTimerPool ( )
protected

◆ CheckPendingFrames()

void vtkOpenGLRenderTimerLog::CheckPendingFrames ( )
protected

◆ IsFrameReady()

bool vtkOpenGLRenderTimerLog::IsFrameReady ( OGLFrame frame)
protected

◆ IsEventReady()

bool vtkOpenGLRenderTimerLog::IsEventReady ( OGLEvent event)
protected

◆ ForceCloseFrame()

void vtkOpenGLRenderTimerLog::ForceCloseFrame ( OGLFrame frame)
protected

◆ ForceCloseEvent()

void vtkOpenGLRenderTimerLog::ForceCloseEvent ( OGLEvent event)
protected

Member Data Documentation

◆ CurrentFrame

OGLFrame vtkOpenGLRenderTimerLog::CurrentFrame
protected

Definition at line 90 of file vtkOpenGLRenderTimerLog.h.

◆ PendingFrames

std::deque<OGLFrame> vtkOpenGLRenderTimerLog::PendingFrames
protected

Definition at line 92 of file vtkOpenGLRenderTimerLog.h.

◆ ReadyFrames

std::queue<Frame> vtkOpenGLRenderTimerLog::ReadyFrames
protected

Definition at line 93 of file vtkOpenGLRenderTimerLog.h.

◆ TimerPool

std::queue<vtkOpenGLRenderTimer*> vtkOpenGLRenderTimerLog::TimerPool
protected

Definition at line 95 of file vtkOpenGLRenderTimerLog.h.

◆ MinTimerPoolSize

size_t vtkOpenGLRenderTimerLog::MinTimerPoolSize
protected

Definition at line 97 of file vtkOpenGLRenderTimerLog.h.


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