SoDevice Class Reference
[Devices]

Abstract device management class More...

#include <Inventor/devices/SoDevice.h>

Inheritance diagram for SoDevice:

Public Member Functions
virtual unsigned long long	getTotalMemory () const =0
virtual unsigned long long	getAvailableMemory () const =0
virtual unsigned int	getLogicalUnits () const =0
virtual SbString	getDriverVersion () const =0
virtual SbString	getDeviceName () const =0
Static Public Member Functions
static SoDevice *	find (SoDeviceFindFunction *findFunction)
static unsigned int	getDevicesCount ()
static SoDevice *	getDevice (int index)

Detailed Description

Abstract device management class

This class provides generic functions to manage and to get data about specific devices.

There are specific implementations of this class for each type of device supported by Open Inventor. These classes may provide additional methods to query information specific to the device type. Currently the supported device types are:

SoCpuDevice: A system CPU, including multiple cores.
SoCudaDevice: A GPU, managed through Nvidia's CUDA API.
SoGLDevice: A GPU, managed through the OpenGL API.
SoOpenCLDevice: A CPU or GPU, managed through the OpenCL API.

A single physical device may be accessible as more than one type of logical device. For example, a GPU (graphics board) may be accessible as an OpenGL device and as a CUDA device. Using the query methods, you can determine the number of each type of device and specific information about each device such as the total memory.

Before using any CUDA or OpenCL devices, the application must initialize the corresponding module using SoCuda::init() or SoOpenCL::init() These methods should only be called after initializing Open Inventor (using SoXt::init() etc).

On most devices other than the CPU, a device "context" is necessary when using the device. Open Inventor provides classes to manage contexts for each type of device. See SoDeviceContext and its derived classes SoCpuContext, SoCudaContext, SoGLContext and SoOpenCLContext.

Open Inventor provides classes to manage data objects (blocks of memory), called buffer objects, on each type of device. See SoBufferObject and its derived classes SoCpuBufferObject, SoCudaBufferObject, SoGLBufferObject and SoOpenCLBufferObject.

On some devices, for example CUDA and OpenCL, Open Inventor provides a wrapper class that allows the application to call functions in the corresponding API using object oriented methods. See SoCudaApi and SoOpenCLApi.

Open Inventor also provides a set of classes that implement commonly used computing algorithms that operate on data buffer objects. See, for example: SoArithmetic, SoConversion, SoConvolution and SoSeismic. Some of these classes have device specific implementations, for example SoCudaConvolution and SoOpenCLConvolution.

Note: The word "device" is also used to refer to input devices such as the mouse and keyboard. These devices are associated with the viewer or render area and are represented by window system dependent classes. See, for example: SoWinDevice, SoQtDevice and SoXtDevice.