OpenGL2 override for vtkRenderTimerLog. More...

#include <vtkOpenGLRenderTimerLog.h>

Inheritance diagram for vtkOpenGLRenderTimerLog:

Collaboration diagram for vtkOpenGLRenderTimerLog:

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

vtkOpenGLRenderTimerLog *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

bool	IsSupported () VTK_FUTURE_CONST override
	Returns true if stream timings are implemented for the current graphics backend. More...

bool	GetLoggingEnabled () VTK_FUTURE_CONST 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
vtkRenderTimerLog *	NewInstance () 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...

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. 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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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...

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

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

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkOpenGLRenderTimerLog *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenGLRenderTimerLog *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkRenderTimerLog
static vtkRenderTimerLog *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkRenderTimerLog *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenGLRenderTimerLog ()

	~vtkOpenGLRenderTimerLog () override

bool	DoLogging () VTK_FUTURE_CONST

Frame	Convert (const OGLFrame &oglFrame)

Event	Convert (const OGLEvent &oglEvent)

OGLEvent &	NewEvent ()

OGLEvent *	DeepestOpenEvent ()

OGLEvent &	WalkOpenEvents (OGLEvent &event)

vtkOpenGLRenderTimer *	NewTimer ()

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 ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
OGLFrame	CurrentFrame

std::deque< OGLFrame >	PendingFrames

std::queue< Frame >	ReadyFrames

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

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

OpenGL2 override for vtkRenderTimerLog.

Definition at line 19 of file vtkOpenGLRenderTimerLog.h.

Member Typedef Documentation

◆ Superclass

typedef vtkRenderTimerLog vtkOpenGLRenderTimerLog::Superclass

Definition at line 46 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 54 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 84 of file vtkOpenGLRenderTimerLog.h.

◆ PendingFrames

std::deque<OGLFrame> vtkOpenGLRenderTimerLog::PendingFrames

protected

Definition at line 86 of file vtkOpenGLRenderTimerLog.h.

◆ ReadyFrames

std::queue<Frame> vtkOpenGLRenderTimerLog::ReadyFrames

protected

Definition at line 87 of file vtkOpenGLRenderTimerLog.h.

◆ TimerPool

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

protected

Definition at line 89 of file vtkOpenGLRenderTimerLog.h.

◆ MinTimerPoolSize

size_t vtkOpenGLRenderTimerLog::MinTimerPoolSize

protected

Definition at line 91 of file vtkOpenGLRenderTimerLog.h.

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

Rendering/OpenGL2/vtkOpenGLRenderTimerLog.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOpenGLRenderTimerLog()

◆ ~vtkOpenGLRenderTimerLog()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ IsSupported()

◆ GetLoggingEnabled()

◆ MarkFrame()

◆ MarkStartEvent()

◆ MarkEndEvent()

◆ FrameReady()

◆ PopFirstReadyFrame()

◆ ReleaseGraphicsResources()

◆ SetMinTimerPoolSize()

◆ GetMinTimerPoolSize()

◆ DoLogging()

◆ Convert() [1/2]

◆ Convert() [2/2]

◆ NewEvent()

◆ DeepestOpenEvent()

◆ WalkOpenEvents()

◆ NewTimer()

◆ ReleaseTimer()

◆ ReleaseOGLFrame()

◆ ReleaseOGLEvent()

◆ TrimTimerPool()

◆ CheckPendingFrames()

◆ IsFrameReady()

◆ IsEventReady()

◆ ForceCloseFrame()

◆ ForceCloseEvent()

Member Data Documentation

◆ CurrentFrame

◆ PendingFrames

◆ ReadyFrames

◆ TimerPool

◆ MinTimerPoolSize