Get GPUs VRAM information using DirectX. More...

#include <vtkDirectXGPUInfoList.h>

Inheritance diagram for vtkDirectXGPUInfoList:

Collaboration diagram for vtkDirectXGPUInfoList:

Public Types
typedef vtkGPUInfoList	Superclass

Public Types inherited from vtkGPUInfoList
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...

vtkDirectXGPUInfoList *	NewInstance () const

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

virtual void	Probe ()
	Build the list of vtkInfoGPU if not done yet. More...

Public Member Functions inherited from vtkGPUInfoList
vtkGPUInfoList *	NewInstance () const

virtual bool	IsProbed ()
	Tells if the operating system has been probed. More...

virtual int	GetNumberOfGPUs ()
	Return the number of GPUs. More...

virtual vtkGPUInfo *	GetGPUInfo (int i)
	Return information about GPU i. 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 vtkDirectXGPUInfoList *	New ()

static int	IsTypeOf (const char *type)

static vtkDirectXGPUInfoList *	SafeDownCast (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkGPUInfoList *	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

bool	ProbeInfoWithDXGI (HMONITOR m, vtkGPUInfo *info)
	Probe the GPUs with the DXGI api (Windows Vista or later). More...

void	ProbeInfoWithWMI (HMONITOR m, vtkGPUInfo *info)
	Probe the GPUs with the WMI api (Windows XP or later). More...

bool	GetDeviceIDFromHMonitor (HMONITOR hm, WCHAR *strDeviceID, int cchDeviceID)
	Used by ProbeInfoWithWMI(). More...


	vtkDirectXGPUInfoList ()
	Default constructor. More...

virtual	~vtkDirectXGPUInfoList ()
	Default constructor. More...

Protected Member Functions inherited from vtkGPUInfoList
	vtkGPUInfoList ()
	Default constructor. More...

virtual	~vtkGPUInfoList ()
	Default constructor. More...

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 &)

Additional Inherited Members
Protected Attributes inherited from vtkGPUInfoList
bool	Probed

vtkGPUInfoListArray *	Array

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Get GPUs VRAM information using DirectX.

vtkDirectXGPUInfoList implements Probe() method of vtkGPUInfoList through the DirectX API. As recommended by Microsoft, the WMI interface is used for Windows XP and the DXGI interface is used for Windows Vista and later. (see documentation of VideoMemory sample of the DirectX SDK) ref: http://msdn.microsoft.com/en-us/library/ee419018(v=VS.85)

See also: vtkGPUInfo vtkGPUInfoList

Definition at line 37 of file vtkDirectXGPUInfoList.h.

Member Typedef Documentation

typedef vtkGPUInfoList vtkDirectXGPUInfoList::Superclass

Definition at line 41 of file vtkDirectXGPUInfoList.h.

Constructor & Destructor Documentation

vtkDirectXGPUInfoList::vtkDirectXGPUInfoList ( )

protected

Default constructor.

virtual vtkDirectXGPUInfoList::~vtkDirectXGPUInfoList ( )

protectedvirtual

Default constructor.

Member Function Documentation

static vtkDirectXGPUInfoList* vtkDirectXGPUInfoList::New ( )

static

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

static

virtual int vtkDirectXGPUInfoList::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 vtkGPUInfoList.

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

static

virtual vtkObjectBase* vtkDirectXGPUInfoList::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGPUInfoList.

vtkDirectXGPUInfoList* vtkDirectXGPUInfoList::NewInstance ( ) const

void vtkDirectXGPUInfoList::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 vtkGPUInfoList.

virtual void vtkDirectXGPUInfoList::Probe ( )

virtual

Build the list of vtkInfoGPU if not done yet.

Postcondition: probed: IsProbed()

Implements vtkGPUInfoList.

bool vtkDirectXGPUInfoList::ProbeInfoWithDXGI	(	HMONITOR	m,
		vtkGPUInfo *	info
	)

protected

Probe the GPUs with the DXGI api (Windows Vista or later).

It returns true if it succeeded (DXGI API is supported and probing succeeded)

Precondition: m_exists: m!=0; info_exist: info!=0

void vtkDirectXGPUInfoList::ProbeInfoWithWMI	(	HMONITOR	m,
		vtkGPUInfo *	info
	)

protected

Probe the GPUs with the WMI api (Windows XP or later).

Precondition: m_exists: m!=0; info_exist: info!=0

bool vtkDirectXGPUInfoList::GetDeviceIDFromHMonitor	(	HMONITOR	hm,
		WCHAR *	strDeviceID,
		int	cchDeviceID
	)

protected

Used by ProbeInfoWithWMI().

Precondition: pre hm_exists: hm!=0; strDeviceID_exists: strDeviceID!=0; cchDeviceID_is_positive: cchDeviceID>0

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkDirectXGPUInfoList.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation