VTK
Public Types | Public Member Functions | Static Public Member Functions | List of all members
vtkDirectXGPUInfoList Class Reference

Get GPUs VRAM information using DirectX. More...

#include <vtkDirectXGPUInfoList.h>

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

Public Types

typedef vtkGPUInfoList Superclass
- Public Types inherited from vtkGPUInfoList
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Probe ()
- Public Member Functions inherited from vtkGPUInfoList
virtual bool IsProbed ()
virtual int GetNumberOfGPUs ()
virtual vtkGPUInfoGetGPUInfo (int i)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
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)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkDirectXGPUInfoListNew ()
static int IsTypeOf (const char *type)
static vtkDirectXGPUInfoListSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkDirectXGPUInfoList ()
virtual ~vtkDirectXGPUInfoList ()
bool ProbeInfoWithDXGI (HMONITOR m, vtkGPUInfo *info)
void ProbeInfoWithWMI (HMONITOR m, vtkGPUInfo *info)
bool GetDeviceIDFromHMonitor (HMONITOR hm, WCHAR *strDeviceID, int cchDeviceID)
- Protected Member Functions inherited from vtkGPUInfoList
 vtkGPUInfoList ()
virtual ~vtkGPUInfoList ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

- Protected Attributes inherited from vtkGPUInfoList
bool Probed
vtkGPUInfoListArrayArray
- Friends inherited from vtkObject

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 35 of file vtkDirectXGPUInfoList.h.

Member Typedef Documentation

Definition at line 39 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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkGPUInfoList.

virtual const char* vtkDirectXGPUInfoList::GetClassName ( )
virtual

Reimplemented from vtkGPUInfoList.

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

Return 1 if this class type 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.

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 ( vtkObject o)
static

Reimplemented from vtkGPUInfoList.

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: