mi::neuraylib::IGpu_description Class Reference

This interface describes a GPU. More...

#include <igpu_description.h>

Inheritance diagram for mi::neuraylib::IGpu_description:

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...
virtual bool	get_optimus_flag () const =0
	Returns true if the GPU is part of an Optimus/mixed internal+discrete GPU setup (Windows only), and false otherwise. More...
Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...
virtual Uint32	release () const =0
	Decrements the reference count. More...
virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...
template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...
virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...
template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...
virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x1e2e02ff, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...
using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...
Public Types inherited from mi::base::IInterface
using	IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0x1e2e02ff, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface. More...

Detailed Description

This interface describes a GPU.

See also

mi::neuraylib::IRendering_configuration::get_gpu_description()

Member Function Documentation

get_clock_rate()

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.

get_cuda_compute_capability_major()

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.

get_cuda_compute_capability_minor()

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.

get_cuda_device_id()

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.

get_id()

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

pure virtual

Returns the GPU ID.

get_memory_size()

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

pure virtual

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

get_multi_processor_count()

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.

get_name()

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.

get_optimus_flag()

virtual bool mi::neuraylib::IGpu_description::get_optimus_flag ( ) const

pure virtual

Returns true if the GPU is part of an Optimus/mixed internal+discrete GPU setup (Windows only), and false otherwise.

get_pci_bus_id()

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

pure virtual

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

get_pci_device_id()

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

pure virtual

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

get_tcc_flag()

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.

is_attached_to_display()

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.