neuray API Programmer's Manual

mi::neuraylib::IGpu_description Class Reference

[Configuration Interfaces]

Description

This interface describes a GPU.

See also:

mi::neuraylib::IDice_configuration::get_gpu_description()

mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

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

Member Functions

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.