hpx::opencl::program Class Reference

An OpenCL program consisting of one or multiple kernels. More...

#include <program.hpp>

List of all members.

Public Member Functions
	program (hpx::shared_future< hpx::naming::id_type > const &gid, hpx::naming::id_type device_gid_)
hpx::lcos::future< void >	build_async () const
	Builds the program, non-blocking.
hpx::lcos::future< void >	build_async (std::string build_options) const
	Builds the program, non-blocking.
void	build () const
	Builds the program, blocking.
void	build (std::string build_options) const
	Builds the program, blocking.
hpx::lcos::future < hpx::serialization::serialize_buffer < char > >	get_binary () const
	Retrieves the binary of a built program. It can be used to create programs with device::create_program_with_binary().
hpx::opencl::kernel	create_kernel (std::string kernel_name) const
	Creates a kernel.
Friends
class	hpx::serialization::access

---

Detailed Description

An OpenCL program consisting of one or multiple kernels.

Every program belongs to one device.

Examples:

hello_world.cpp.

---

Member Function Documentation

void hpx::opencl::program::build

(

)

const

Builds the program, blocking.

Returns:

A future that will trigger upon build completion.

Examples:

hello_world.cpp.

void hpx::opencl::program::build

(

std::string

build_options

)

const

Builds the program, blocking.

Parameters:

build_options

A string with specific build options. Look at the official OpenCL Reference for further information.

Returns:

A future that will trigger upon build completion.

hpx::lcos::future<void> hpx::opencl::program::build_async

(

)

const

Builds the program, non-blocking.

Returns:

A future that will trigger upon build completion.

hpx::lcos::future<void> hpx::opencl::program::build_async

(

std::string

build_options

)

const

Builds the program, non-blocking.

Parameters:

build_options

A string with specific build options. Look at the official OpenCL Reference for further information.

Returns:

A future that will trigger upon build completion.

hpx::opencl::kernel hpx::opencl::program::create_kernel

(

std::string

kernel_name

)

const

Creates a kernel.

The kernel with the name kernel_name has to be defined and implemented in the program source code.

Parameters:

kernel_name

The name of the kernel to be created

Returns:

A kernel object.

Examples:

hello_world.cpp.

hpx::lcos::future<hpx::serialization::serialize_buffer<char> > hpx::opencl::program::get_binary

(

)

const

Retrieves the binary of a built program. It can be used to create programs with device::create_program_with_binary().

Returns:

A future to the binary code

---

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

• /home/diehl/git/hpxcl/opencl/program.hpp