Stores GPU VRAM information. More...

#include <vtkGPUInfo.h>

Inheritance diagram for vtkGPUInfo:

Collaboration diagram for vtkGPUInfo:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkGPUInfo *	NewInstance () const

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


virtual void	SetDedicatedVideoMemory (vtkTypeUInt64)
	Set/Get dedicated video memory in bytes. More...

virtual vtkTypeUInt64	GetDedicatedVideoMemory ()
	Set/Get dedicated video memory in bytes. More...


virtual void	SetDedicatedSystemMemory (vtkTypeUInt64)
	Set/Get dedicated system memory in bytes. More...

virtual vtkTypeUInt64	GetDedicatedSystemMemory ()
	Set/Get dedicated system memory in bytes. More...


virtual void	SetSharedSystemMemory (vtkTypeUInt64)
	Set/Get shared system memory in bytes. More...

virtual vtkTypeUInt64	GetSharedSystemMemory ()
	Set/Get shared system memory in bytes. 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 ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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

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

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)
	This method invokes an event and return whether the event was aborted or not. More...

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

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

Static Public Member Functions
static vtkGPUInfo *	New ()

static int	IsTypeOf (const char *type)

static vtkGPUInfo *	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 (int 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 int	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkGPUInfo ()

	~vtkGPUInfo ()

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=NULL)
	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	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTypeUInt64	DedicatedVideoMemory

vtkTypeUInt64	DedicatedSystemMemory

vtkTypeUInt64	SharedSystemMemory

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Stores GPU VRAM information.

vtkGPUInfo stores information about GPU Video RAM. An host can have several GPUs. The values are set by vtkGPUInfoList.

See also: vtkGPUInfoList vtkDirectXGPUInfoList vtkCoreGraphicsGPUInfoList

Tests:: vtkGPUInfo (Tests)

Definition at line 35 of file vtkGPUInfo.h.

Member Typedef Documentation

typedef vtkObject vtkGPUInfo::Superclass

Definition at line 39 of file vtkGPUInfo.h.

Constructor & Destructor Documentation

vtkGPUInfo::vtkGPUInfo ( )

protected

vtkGPUInfo::~vtkGPUInfo ( )

protected

Member Function Documentation

static vtkGPUInfo* vtkGPUInfo::New ( )

static

static int vtkGPUInfo::IsTypeOf ( const char * type )

static

virtual int vtkGPUInfo::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 vtkObjectBase.

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

static

virtual vtkObjectBase* vtkGPUInfo::NewInstanceInternal ( ) const

protectedvirtual

vtkGPUInfo* vtkGPUInfo::NewInstance ( ) const

void vtkGPUInfo::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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

virtual void vtkGPUInfo::SetDedicatedVideoMemory ( vtkTypeUInt64 )

virtual

Set/Get dedicated video memory in bytes.

Initial value is 0. Usually the fastest one. If it is not 0, it should be taken into account first and DedicatedSystemMemory or SharedSystemMemory should be ignored.

virtual vtkTypeUInt64 vtkGPUInfo::GetDedicatedVideoMemory ( )

virtual

Set/Get dedicated video memory in bytes.

Initial value is 0. Usually the fastest one. If it is not 0, it should be taken into account first and DedicatedSystemMemory or SharedSystemMemory should be ignored.

virtual void vtkGPUInfo::SetDedicatedSystemMemory ( vtkTypeUInt64 )

virtual

Set/Get dedicated system memory in bytes.

Initial value is 0. This is slow memory. If it is not 0, this value should be taken into account only if there is no DedicatedVideoMemory and SharedSystemMemory should be ignored.

virtual vtkTypeUInt64 vtkGPUInfo::GetDedicatedSystemMemory ( )

virtual

Set/Get dedicated system memory in bytes.

Initial value is 0. This is slow memory. If it is not 0, this value should be taken into account only if there is no DedicatedVideoMemory and SharedSystemMemory should be ignored.

virtual void vtkGPUInfo::SetSharedSystemMemory ( vtkTypeUInt64 )

virtual

Set/Get shared system memory in bytes.

Initial value is 0. Slowest memory. This value should be taken into account only if there is neither DedicatedVideoMemory nor DedicatedSystemMemory.

virtual vtkTypeUInt64 vtkGPUInfo::GetSharedSystemMemory ( )

virtual

Set/Get shared system memory in bytes.

Initial value is 0. Slowest memory. This value should be taken into account only if there is neither DedicatedVideoMemory nor DedicatedSystemMemory.

Member Data Documentation

vtkTypeUInt64 vtkGPUInfo::DedicatedVideoMemory

protected

Definition at line 78 of file vtkGPUInfo.h.

vtkTypeUInt64 vtkGPUInfo::DedicatedSystemMemory

protected

Definition at line 79 of file vtkGPUInfo.h.

vtkTypeUInt64 vtkGPUInfo::SharedSystemMemory

protected

Definition at line 80 of file vtkGPUInfo.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/Core/vtkGPUInfo.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation