Inventor/OpenCL/SoOpenCL.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 SoOpenCL_H
#define SoOpenCL_H

#include <Inventor/SbString.h>
#include <Inventor/STL/vector>
#include <Inventor/threads/SbThreadMutex.h>

#include <Inventor/OpenCL/SoOpenCLDefs.h>

#include <Inventor/SoModule.h>
SO_MODULE_HEADER(SoOpenCL,__INVOPENCLDLL)

class SoOpenCLHandle;

class INVENTOROPENCL_API  SoOpenCL
{
public:

  enum SoOpenCLError
  {
    SO_OPENCL_SUCCESS,

    SO_OPENCL_MODULE_LOAD_ERROR,

    SO_OPENCL_MODULE_FUNCTION_ERROR,

    SO_OPENCL_INVALID_PARAMETER,

    SO_OPENCL_INVALID_CONTEXT
  };


  static void init();

  static void finish();

  static bool isInitialized();

  static SbBool isAvailable();

  static SoOpenCLError loadSourceModule( const SbString& filename, const SbString& moduleName );

  static SoOpenCLHandle* findFunction( const SbString& moduleName, const SbString& functionName );


   static SoOpenCLError findFunction( SoOpenCLHandle* handle, const SbString& moduleName,
                                    const SbString& functionName );

private:

 struct SoOpenCLModule
  {
    SbString name;

    std::vector< SbString > functions;

    void* data;

    bool allocated;
  };

  static void registerModule( SoOpenCLModule* module );

  static void extractFunctionNames( SoOpenCLModule* module, const char* buffer );
  static void declareModule(const SbString& moduleName, const char* codeStr, bool isAllocated );

  static void removeModule( const SbString& moduleName );

  static void initGLInterop();

  static void throwCLError( const char* str, const char* function, int errorCode );

private:

  static SbThreadMutex s_initThreadMutex;

  static int s_initRefCount;

  static bool s_glOpInitialized;
};

#endif //SoOpenCL_H

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/