VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected 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 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...
 
vtkDirectXGPUInfoListNewInstance () 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
vtkGPUInfoListNewInstance () const
 
virtual bool IsProbed ()
 Tells if the operating system has been probed. More...
 
virtual int GetNumberOfGPUs ()
 Return the number of GPUs. More...
 
virtual vtkGPUInfoGetGPUInfo (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...
 
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 *)
 
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)
 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 vtkDirectXGPUInfoListNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDirectXGPUInfoListSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGPUInfoList
static vtkGPUInfoListNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGPUInfoListSafeDownCast (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
 
 vtkDirectXGPUInfoList ()
 Default constructor. More...
 
virtual ~vtkDirectXGPUInfoList ()
 
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...
 
- Protected Member Functions inherited from vtkGPUInfoList
 vtkGPUInfoList ()
 Default constructor. More...
 
virtual ~vtkGPUInfoList ()
 
- 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 ()
 
- 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
 
vtkGPUInfoListArrayArray
 
- 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

◆ Superclass

Definition at line 41 of file vtkDirectXGPUInfoList.h.

Constructor & Destructor Documentation

◆ vtkDirectXGPUInfoList()

vtkDirectXGPUInfoList::vtkDirectXGPUInfoList ( )
protected

Default constructor.

◆ ~vtkDirectXGPUInfoList()

virtual vtkDirectXGPUInfoList::~vtkDirectXGPUInfoList ( )
protectedvirtual

Member Function Documentation

◆ New()

static vtkDirectXGPUInfoList* vtkDirectXGPUInfoList::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDirectXGPUInfoList::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGPUInfoList.

◆ NewInstance()

vtkDirectXGPUInfoList* vtkDirectXGPUInfoList::NewInstance ( ) const

◆ PrintSelf()

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.

◆ Probe()

virtual void vtkDirectXGPUInfoList::Probe ( )
virtual

Build the list of vtkInfoGPU if not done yet.

Postcondition
probed: IsProbed()

Implements vtkGPUInfoList.

◆ ProbeInfoWithDXGI()

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

◆ ProbeInfoWithWMI()

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

◆ GetDeviceIDFromHMonitor()

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: