Inventor/devices/SoOpenCLDevice.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#if !defined SoOpenCLDEVICE_H
#define SoOpenCLDEVICE_H

#include <Inventor/SoDB.h>

#include <Inventor/devices/SoDevice.h>

#include <Inventor/threads/SbThreadMutex.h>

#include <Inventor/OpenCL/SoOpenCLDefs.h>

#include <Inventor/STL/vector>
#include <Inventor/STL/string>

#include <Inventor/sys/SoCL.h>

#ifdef _WIN32
#pragma warning( push )
#pragma warning(disable:4251)
#endif

class INVENTOROPENCL_API SoOpenCLDevice : public SoDevice
{
  friend class SoDevice;

  // ----------------------- Public usage --------------------------------------

public:


  enum OpenCLDeviceType
  {
    DEVICE_CPU = 1,
    DEVICE_GPU = 2,
    DEVICE_ACCELERATOR = 4,
    DEVICE_DEFAULT = 8
  };

  static void init();

  static bool isInitialized();

  static void finish();

  static SoOpenCLDevice* findFirstAvailableDevice();

  static SoOpenCLDevice* getDevice( int index );

  static unsigned int getDevicesCount();

  OpenCLDeviceType getDeviceType() const;

  SbString getDeviceTypeString() const;

  float getComputingVersion() const;

  virtual unsigned long long getTotalMemory() const;

  virtual unsigned long long getAvailableMemory() const;

  virtual unsigned int getLogicalUnits() const;

  virtual SbString getDriverVersion() const;

  virtual SbString getDeviceName() const;

  cl_device_id getOpenCLDeviceId() const;

  void getMaxWorkItemSizes( int& x, int& y, int& z ) const;

  unsigned long getMaxWorkGroupSize() const;

  unsigned long getMaxMemoryAllocationSize() const;

  friend std::ostream& operator << ( std::ostream& os, const SoOpenCLDevice& dev )
  {
    return os << "[Device name]: " << dev.m_name.toLatin1() << "\n" <<
                 "[Device type ]: " << dev.getDeviceTypeString() << "\n" <<
                 "[Driver ver]: " << dev.m_drvVer << "\n" <<
                 "[Computing ver]: " << dev.m_computingVersion << "\n" << \
                 "[Vram size]: " << (dev.m_totalMemory)/(1024*1024) << "MB" << "\n" << // memory size returned in Mbytes.
                 "[Available Vram size]: " << (dev.m_totalMemory)/(1024*1024) << "MB" << "\n" << // memory size returned in Mbytes.
                 "[Compute units]: " << dev.getLogicalUnits() << "\n" <<
                 "[Max memory allocation size]: " << dev.m_maxMemAllocSize/(1024*1024) << "MB\n" <<
                 "[Max work group size]: " << dev.m_maxWorkGroupSize << "\n" <<
                 "[Max work items sizes]: " << dev.m_maxWorkItemSizes[0] << " / " <<
                 dev.m_maxWorkItemSizes[1] << " / " <<
                 dev.m_maxWorkItemSizes[2] << "\n";
  }

  // ----------------------- Protected usage --------------------------------------

private:

  SoOpenCLDevice();


  virtual ~SoOpenCLDevice();

  // ----------------------- Private usage --------------------------------------

private:

  static bool findFirstDeviceFunc( SoDevice* device );


  // ----------------------- Private usage --------------------------------------

private:

  cl_ulong m_totalMemory;

  float m_computingVersion;

  // Driver version 
  SbString m_drvVer;

  cl_device_id m_devicePtr;

  OpenCLDeviceType m_deviceType;

  SbString m_name;

  int m_maxWorkItemSizes[ 3 ];

  int m_maxWorkGroupSize;

  unsigned long m_maxMemAllocSize;

  unsigned int m_maxComputeUnits;

  static std::vector< SoOpenCLDevice * > s_openCLDevices;

  // We keep the number of references to this module, so we really free the data when nobody uses it..
  static SbThreadMutex s_initThreadMutex;

  // The refs counter
  static int s_initRefCount;
};

#ifdef _WIN32
#pragma warning( pop )
#endif

#endif // SoOpenCLDEVICE_H

---

Open Inventor Toolkit reference manual, generated on 22 Jul 2025
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/