NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::IGpu_description Class Referenceabstract

This interface describes a GPU. More...

Inheritance diagram for mi::neuraylib::IGpu_description:
Inheritance graph
[legend]

Public Member Functions

virtual Uint32  get_id () const =0
  Returns the GPU ID. More...
 
virtual const char *  get_name () const =0
  Returns the GPU name. More...
 
virtual Sint64  get_memory_size () const =0
  Returns the GPU memory in bytes (or -1 in case of failures). More...
 
virtual bool  get_tcc_flag () const =0
  Indicates whether the GPU is in TCC mode. More...
 
virtual Sint32  get_cuda_device_id () const =0
  Returns the CUDA device ID, or -1 if the GPU is not a CUDA device. More...
 
virtual Sint32  get_cuda_compute_capability_major () const =0
  Returns the CUDA compute capability (major), or -1 if the GPU is not a CUDA device. More...
 
virtual Sint32  get_cuda_compute_capability_minor () const =0
  Returns the CUDA compute capability (minor), or -1 if the GPU is not a CUDA device. More...
 
virtual Sint32  get_clock_rate () const =0
  Returns the clock rate in kilohertz, or -1 if the GPU is not a CUDA device. More...
 
virtual Sint32  get_multi_processor_count () const =0
  Returns the number of multiprocessors, or -1 if the GPU is not a CUDA device. More...
 
virtual Sint32  get_pci_bus_id () const =0
  Returns the PCI bus ID (or -1 in case of failure). More...
 
virtual Sint32  get_pci_device_id () const =0
  Returns the PCI device ID (or -1 in case of failure). More...
 
virtual bool  is_attached_to_display () const =0
  Indicates whether the GPU is attached to a display. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x1e2e02ff, 0xf083, 0x4a12, 0xb7, 0xda, 0x02, 0x58, 0xb6, 0xd0, 0x04, 0x75 >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
Self
  Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
  Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x1e2e02ff, 0xf083, 0x4a12, 0xb7, 0xda, 0x02, 0x58, 0xb6, 0xd0, 0x04, 0x75 >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

This interface describes a GPU.

See Also
mi::neuraylib::IRendering_configuration::get_gpu_description()

Member Function Documentation

virtual Sint32 mi::neuraylib::IGpu_description::get_clock_rate ( ) const
pure virtual

Returns the clock rate in kilohertz, or -1 if the GPU is not a CUDA device.

virtual Sint32 mi::neuraylib::IGpu_description::get_cuda_compute_capability_major ( ) const
pure virtual

Returns the CUDA compute capability (major), or -1 if the GPU is not a CUDA device.

virtual Sint32 mi::neuraylib::IGpu_description::get_cuda_compute_capability_minor ( ) const
pure virtual

Returns the CUDA compute capability (minor), or -1 if the GPU is not a CUDA device.

virtual Sint32 mi::neuraylib::IGpu_description::get_cuda_device_id ( ) const
pure virtual

Returns the CUDA device ID, or -1 if the GPU is not a CUDA device.

virtual Uint32 mi::neuraylib::IGpu_description::get_id ( ) const
pure virtual

Returns the GPU ID.

virtual Sint64 mi::neuraylib::IGpu_description::get_memory_size ( ) const
pure virtual

Returns the GPU memory in bytes (or -1 in case of failures).

virtual Sint32 mi::neuraylib::IGpu_description::get_multi_processor_count ( ) const
pure virtual

Returns the number of multiprocessors, or -1 if the GPU is not a CUDA device.

virtual const char* mi::neuraylib::IGpu_description::get_name ( ) const
pure virtual

Returns the GPU name.

The name is human-readable string, typically involving the GPU model.

virtual Sint32 mi::neuraylib::IGpu_description::get_pci_bus_id ( ) const
pure virtual

Returns the PCI bus ID (or -1 in case of failure).

virtual Sint32 mi::neuraylib::IGpu_description::get_pci_device_id ( ) const
pure virtual

Returns the PCI device ID (or -1 in case of failure).

virtual bool mi::neuraylib::IGpu_description::get_tcc_flag ( ) const
pure virtual

Indicates whether the GPU is in TCC mode.

Returns true if the GPU is in TCC mode (Windows only), and false otherwise.

virtual bool mi::neuraylib::IGpu_description::is_attached_to_display ( ) const
pure virtual

Indicates whether the GPU is attached to a display.

Returns true if the GPU is attached to a display (Windows only), and false otherwise.