Inventor/OpenCL/SoOpenCLApi.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 _SO_OPENCL_API_H_
#define _SO_OPENCL_API_H_

#include <Inventor/SbBasic.h>
#include <Inventor/SbVec.h>
#include <Inventor/OpenCL/SoOpenCL.h>

class SoOpenCLHandle;

class INVENTOROPENCL_API SoOpenCLApi
{

public:

  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, const void* pointer );

  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, char value );


  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, unsigned char value );

  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, short value );

  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, unsigned short value );

  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, long value );

  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, unsigned long value );

  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, int value );

  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, unsigned int value );

  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, float value );

  static SoOpenCL::SoOpenCLError setParameter( SoOpenCLHandle* handle, double value );

  static SoOpenCL::SoOpenCLError resetParameters( SoOpenCLHandle* handle );

  static SoOpenCL::SoOpenCLError launch( 
    SoOpenCLHandle* handle, 
    const SbVec3i32& globalWorkSize, 
    const SbVec3i32& localWorkSize
    );


private:


  static SoOpenCLHandle* createHandle();

  static void freeHandle( SoOpenCLHandle* handle );


  static SoOpenCL::SoOpenCLError loadFunction( SoOpenCLHandle* handle, const SbString& filename, const SbString& functionName );

  static SoOpenCL::SoOpenCLError findFunction( SoOpenCLHandle* handle, const void* moduleData, const SbString& functionName );

private:
  template<typename T> static SoOpenCL::SoOpenCLError setOpenCLParameter( SoOpenCLHandle* handle, T value );
};

#endif // _SO_OPENCL_API_H_

---

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