SoOpenCLApi Class Reference
[OpenCL device]

OpenCL access API More...

#include <Inventor/OpenCL/SoOpenCLApi.h>

List of all members.

Static Public Member Functions
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)

---

Detailed Description

OpenCL access API

The SoOpenCLApi class provides functions to perform specific OpenCL operations.

NOTE: The classes in this module do not exist in Open Inventor 10.0 and later.

Most of the functions setup SoOpenCLHandle parameters, like the function arguments, block size, etc. Those parameters are used when the OpenCL function is called.

USAGE

You can call the provided functions with a valid handle created by the SoOpenCL class.

EXAMPLE

  SoOpenCL::init();
  SoOpenCLDevice*  mainDevice = SoOpenCLDevice::findFirstAvailableDevice();
  SoOpenCLContext* context    = new SoOpenCLContext( mainDevice );
  context->bind();
  SoOpenCLHandle* handle = SoOpenCL::findFunction( "ModuleName", "FunctionName" );
  if ( handle ) {
    SoOpenCLApi::resetParameters( handle );
    SoOpenCLApi::setParameter( handle, (unsigned int)input );
    SoOpenCLApi::setParameter( handle, (unsigned int)output );
    SoOpenCLApi::setParameter( handle, (size_t)inputSize );

    SoOpenCLApi::launch( handle, inputSize / 64, 1 );
    SoOpenCLApi::freeHandle( handle );
  }
  context->unbind();
  SoOpenCL::finish();

SEE ALSO

SoOpenCL, SoOpenCLContext, SoOpenCLDevice, SoOpenCLBufferObject,

See related examples:

HelloOpenCL, SimpleOpenCLKernel, TextureConvolution

---

Member Function Documentation

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

Launch the specified kernel function.

Parameters:

	handle	The handle of the function to launch.
	globalWorkSize	The group work size.
	localWorkSize	The group item work size.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::resetParameters

(

SoOpenCLHandle *

handle

)

[static]

This function resets the internal list of parameters for the specific list.

This function should be called before each launch in order to reset the parameters, then the setParameter* function can be called to update the parameters.

Parameters:

handle

The function OPENCL handle.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		double	value
	)			[static]

This function adds a double parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	value	The value to add to the parameters stack.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		float	value
	)			[static]

This function adds a float parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	value	The value to add to the parameters stack.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		unsigned int	value
	)			[static]

This function adds an unsigned integer parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	value	The value to add to the parameters stack.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		int	value
	)			[static]

This function adds an integer parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	value	The value to add to the parameters stack.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		unsigned long	value
	)			[static]

This function adds an unsigned integer parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	value	The value to add to the parameters stack.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		long	value
	)			[static]

This function adds a long parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	value	The value to add to the parameters stack.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		unsigned short	value
	)			[static]

This function adds an unsigned short parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	value	The value to add to the parameters stack.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		short	value
	)			[static]

This function adds a short parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	value	The value to add to the parameters stack.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		unsigned char	value
	)			[static]

This function adds an unsigned char parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	value	The value to add to the parameters stack.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		char	value
	)			[static]

This function adds a char parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	value	The value to add to the parameters stack.

Returns:

Operation result error code.

static SoOpenCL::SoOpenCLError SoOpenCLApi::setParameter	(	SoOpenCLHandle *	handle,
		const void *	pointer
	)			[static]

This function adds a pointer parameter to the list of parameters sent to the kernel by launch function.

Parameters:

	handle	The function OPENCL handle.
	pointer	The pointer to add to the parameters stack.

Returns:

Operation result error code.

---

The documentation for this class was generated from the following file:

• Inventor/OpenCL/SoOpenCLApi.h