sp::video::OpenCLProgram Class Reference [GPGPU]

#include <spOpenCLProgram.hpp>

List of all members.

Public Member Functions
	OpenCLProgram (const io::stringc &SourceString, const io::stringc &CompilationOptions="")
	~OpenCLProgram ()
bool	compile (const io::stringc &SourceString, const io::stringc &CompilationOptions="")
bool	addKernel (const io::stringc &EntryPoint)
bool	run (const io::stringc &EntryPoint, s32 Dimensions, const size_t *GlobalWorkSizes, const size_t *LocalWorkSizes)
bool	setParameter (const io::stringc &EntryPoint, u32 Index, const void *Buffer, u32 Size)
bool	setParameter (const io::stringc &EntryPoint, u32 Index, OpenCLBuffer *Buffer)
bool	run (const io::stringc &KernelEntryPoint, size_t GlobalWorkSize, size_t LocalWorkSize)
template<typename T >
bool	setParameter (const io::stringc &EntryPoint, u32 Index, const T &Value)
bool	valid () const
	Returns true if this OpenCL program was build successfully.

---

Detailed Description

Since:

Version 3.2

---

Constructor & Destructor Documentation

sp::video::OpenCLProgram::OpenCLProgram	(	const io::stringc &	SourceString,
		const io::stringc &	CompilationOptions = ""
	)

sp::video::OpenCLProgram::~OpenCLProgram

(

)

---

Member Function Documentation

bool sp::video::OpenCLProgram::addKernel

(

const io::stringc &

EntryPoint

)

bool sp::video::OpenCLProgram::compile	(	const io::stringc &	SourceString,
		const io::stringc &	CompilationOptions = ""
	)

bool sp::video::OpenCLProgram::run	(	const io::stringc &	EntryPoint,
		s32	Dimensions,
		const size_t *	GlobalWorkSizes,
		const size_t *	LocalWorkSizes
	)

Runs respectively executes the specified OpenCL kernel.

Parameters:

	EntryPoint,:	Specifies the kernel entry point, i.e. the main-function's name.
	Dimensions,:	Specifies the count of dimensions for the working groups. Must be 1, 2 or 3.
	GlobalWorkSizes,:	Specifies a pointer to an array of 'Dimensions' elements describing the global work sizes.
	LocalWorkSizes,:	Specifies a pointer to an array of 'Dimensions' elements describing the local work sizes.

Returns:

True on success otherwise false.

bool sp::video::OpenCLProgram::run	(	const io::stringc &	KernelEntryPoint,
		size_t	GlobalWorkSize,
		size_t	LocalWorkSize
	)			[inline]

bool sp::video::OpenCLProgram::setParameter	(	const io::stringc &	EntryPoint,
		u32	Index,
		OpenCLBuffer *	Buffer
	)

bool sp::video::OpenCLProgram::setParameter	(	const io::stringc &	EntryPoint,
		u32	Index,
		const void *	Buffer,
		u32	Size
	)

template<typename T >

bool sp::video::OpenCLProgram::setParameter	(	const io::stringc &	EntryPoint,
		u32	Index,
		const T &	Value
	)			[inline]

bool sp::video::OpenCLProgram::valid

(

)

const [inline]

Returns true if this OpenCL program was build successfully.

---

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

• D:/SoftwareEntwicklung/C++/HLC/Tools/SoftPixelEngine/repository/sources/Framework/OpenCL/spOpenCLProgram.hpp