Inventor/devices/SoGLDevice.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-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Tristan MEHAMLI (Aug 2009)
**=======================================================================*/

#ifndef SO_GL_DEVICE
#define SO_GL_DEVICE

//
//  Class: SoGLDevice
//
// Provides methods to retrieve the properties of a GPU.
// 
//

#include <Inventor/devices/SoDevice.h>
#include <Inventor/devices/SoGLScreenDevice.h>
#include <Inventor/STL/vector>
#include <Inventor/devices/SoGLDeviceSettings.h>

class  SoGLDevice : public SoDevice
{
  // ----------------------- Public usage --------------------------------------
public:

  virtual unsigned long long getTotalMemory() const;

  virtual unsigned long long getAvailableMemory() const;

  virtual unsigned int getLogicalUnits() const;

  virtual SbString getDriverVersion() const;

  virtual SoGLDeviceSettings* getDeviceSettings() const;

  virtual SbString getDeviceName() const;

  static SoGLDevice* findFirstAvailableDevice();

  static unsigned int getDevicesCount();

  static SoGLDevice* getDevice( int index );

  SoGLScreenDevice* getMainScreenDevice();

  unsigned int getScreenDevicesCount();

  SoGLScreenDevice* getScreenDevice( int index );

  static void initClass();

  static void exitClass();

  friend std::ostream& operator << ( std::ostream& os, const SoGLDevice& dev )
  {
    unsigned long long allocatedMemory, availableMemory;
    dev.getMemoryInfo( allocatedMemory, availableMemory );

    return os << "[GPU name]: " << dev.m_name.toLatin1() << "\n" << \
                 "[Driver ver]: " << dev.m_drvVer.toLatin1() << "\n" << \
                 "[Vram size]: " << (dev.m_totalMemory)/(1024*1024) << "MB" << "\n" <<  // memory size returned in Mbytes.
                 "[Available Vram size]: " << availableMemory/(1024*1024) << "MB" << "\n" <<  // memory size returned in Mbytes.
                 "[LogicalUnits]: " << dev.m_logicalUnitsCount;
  }

  // ----------------------- Protected usage --------------------------------------
private:

  SoGLDevice();

  virtual ~SoGLDevice();

  static bool findFirstDeviceFunc( SoDevice* device );

  // ----------------------- Private usage --------------------------------------
private:

  // Only used under Linux
  enum VideoCardType
  {
    VC_ATI,
    VC_NVIDIA,
    VC_VIRTUALBOX,
    VC_MESA,
    VC_UNKNOWN
  };

  void getMemoryInfo( unsigned long long& allocatedMemory, unsigned long long& availableMemory ) const;

  // Initializes the device with default parameters
  static void defaultDeviceInit();

  // Memory
  unsigned long long m_totalMemory;

  // Logical units
  unsigned int m_logicalUnitsCount;

  // GPU name
  SbString m_name;

  // Driver version
  SbString m_drvVer;

  VideoCardType m_vcType;

  // List of GPU devices removed when this module is unlocked
  static std::vector<SoGLDevice*> s_glDevices;

  // List of screen devices attached to the GL device
  std::vector<SoGLScreenDevice*> m_screenDevices;

  // Thread mutex for initClass and exitClass
  static SbThreadMutex s_initThreadMutex;

  // Refs counter
  static int s_initRefCount;
};

// ----------------------- Inline functions --------------------------------------
inline unsigned long long
SoGLDevice::getTotalMemory() const
{
  return m_totalMemory;
}

inline unsigned int 
SoGLDevice::getLogicalUnits() const
{
  return m_logicalUnitsCount;
}

inline SbString 
SoGLDevice::getDeviceName() const
{
  return m_name;
}

#endif // SO_GL_DEVICE

---

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/