ASL  0.1.7
Advanced Simulation Library
Namespaces | Classes | Typedefs | Functions
cl Namespace Reference

The OpenCL C++ bindings are defined within this namespace. More...

Namespaces

 detail
 

Classes

class  Buffer
 Class interface for Buffer Memory Objects. More...
 
class  BufferGL
 Class interface for GL Buffer Memory Objects. More...
 
class  BufferRenderGL
 Class interface for GL Render Buffer Memory Objects. More...
 
class  CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED
 Class interface for GL 2D Image Memory objects. More...
 
class  CommandQueue
 CommandQueue interface for cl_command_queue. More...
 
class  Context
 Class interface for cl_context. More...
 
class  Device
 Class interface for cl_device_id. More...
 
struct  EnqueueArgs
 
class  Event
 Class interface for cl_event. More...
 
class  Image
 C++ base class for Image Memory objects. More...
 
class  Image2D
 Class interface for 2D Image Memory objects. More...
 
class  Image3D
 Class interface for 3D Image Memory objects. More...
 
class  Image3DGL
 Class interface for GL 3D Image Memory objects. More...
 
struct  ImageFormat
 Adds constructors and member functions for cl_image_format. More...
 
class  Kernel
 Class interface for cl_kernel. More...
 
struct  LocalSpaceArg
 Local address wrapper for use with Kernel::setArg. More...
 
struct  make_kernel
 
class  Memory
 Class interface for cl_mem. More...
 
class  NDRange
 Class interface for specifying NDRange values. More...
 
class  Platform
 Class interface for cl_platform_id. More...
 
class  Program
 Program interface that implements cl_program. More...
 
class  Sampler
 Class interface for cl_sampler. More...
 
class  size_t
 class used to interface between C++ and OpenCL C calls that require arrays of size_t values, whose size is known statically. More...
 

Typedefs

typedef std::string STRING_CLASS
 

Functions

template<typename IteratorType >
cl_int copy (IteratorType startIterator, IteratorType endIterator, cl::Buffer &buffer)
 
template<typename IteratorType >
cl_int copy (const cl::Buffer &buffer, IteratorType startIterator, IteratorType endIterator)
 
template<typename IteratorType >
cl_int copy (const CommandQueue &queue, IteratorType startIterator, IteratorType endIterator, cl::Buffer &buffer)
 
template<typename IteratorType >
cl_int copy (const CommandQueue &queue, const cl::Buffer &buffer, IteratorType startIterator, IteratorType endIterator)
 
CL_EXT_PREFIX__VERSION_1_1_DEPRECATED LocalSpaceArg __local (::size_t size) CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED
 Helper function for generating LocalSpaceArg objects. Deprecated. Replaced with Local. More...
 
LocalSpaceArg Local (::size_t size)
 Helper function for generating LocalSpaceArg objects. More...
 
cl_int enqueueReadBuffer (const Buffer &buffer, cl_bool blocking, ::size_t offset, ::size_t size, void *ptr, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL)
 
cl_int enqueueWriteBuffer (const Buffer &buffer, cl_bool blocking, ::size_t offset, ::size_t size, const void *ptr, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL)
 
void * enqueueMapBuffer (const Buffer &buffer, cl_bool blocking, cl_map_flags flags, ::size_t offset, ::size_t size, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL, cl_int *err=NULL)
 
cl_int enqueueUnmapMemObject (const Memory &memory, void *mapped_ptr, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL)
 
cl_int enqueueCopyBuffer (const Buffer &src, const Buffer &dst, ::size_t src_offset, ::size_t dst_offset, ::size_t size, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL)
 
cl_int enqueueReadImage (const Image &image, cl_bool blocking, const size_t< 3 > &origin, const size_t< 3 > &region, ::size_t row_pitch, ::size_t slice_pitch, void *ptr, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL)
 
cl_int enqueueWriteImage (const Image &image, cl_bool blocking, const size_t< 3 > &origin, const size_t< 3 > &region, ::size_t row_pitch, ::size_t slice_pitch, void *ptr, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL)
 
cl_int enqueueCopyImage (const Image &src, const Image &dst, const size_t< 3 > &src_origin, const size_t< 3 > &dst_origin, const size_t< 3 > &region, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL)
 
cl_int enqueueCopyImageToBuffer (const Image &src, const Buffer &dst, const size_t< 3 > &src_origin, const size_t< 3 > &region, ::size_t dst_offset, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL)
 
cl_int enqueueCopyBufferToImage (const Buffer &src, const Image &dst, ::size_t src_offset, const size_t< 3 > &dst_origin, const size_t< 3 > &region, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL)
 
cl_int flush (void)
 
cl_int finish (void)
 

Detailed Description

The OpenCL C++ bindings are defined within this namespace.

Typedef Documentation

◆ STRING_CLASS

typedef std::string cl::STRING_CLASS

CL 1.2 marker and barrier commands

Definition at line 378 of file cl.hpp.

Function Documentation

◆ __local()

LocalSpaceArg cl::__local ( ::size_t  size)
inline

Helper function for generating LocalSpaceArg objects. Deprecated. Replaced with Local.

__local

Definition at line 4695 of file cl.hpp.

◆ copy() [1/4]

template<typename IteratorType >
cl_int cl::copy ( IteratorType  startIterator,
IteratorType  endIterator,
cl::Buffer buffer 
)
inline

Blocking copy operation between iterators and a buffer. Host to Device. Uses default command queue.

Definition at line 6699 of file cl.hpp.

◆ copy() [2/4]

template<typename IteratorType >
cl_int cl::copy ( const cl::Buffer buffer,
IteratorType  startIterator,
IteratorType  endIterator 
)
inline

Blocking copy operation between iterators and a buffer. Device to Host. Uses default command queue.

Definition at line 6715 of file cl.hpp.

◆ copy() [3/4]

template<typename IteratorType >
cl_int cl::copy ( const CommandQueue queue,
IteratorType  startIterator,
IteratorType  endIterator,
cl::Buffer buffer 
)
inline

Blocking copy operation between iterators and a buffer. Host to Device. Uses specified queue.

Definition at line 6731 of file cl.hpp.

◆ copy() [4/4]

template<typename IteratorType >
cl_int cl::copy ( const CommandQueue queue,
const cl::Buffer buffer,
IteratorType  startIterator,
IteratorType  endIterator 
)
inline

Blocking copy operation between iterators and a buffer. Device to Host. Uses specified queue.

Definition at line 6770 of file cl.hpp.

◆ enqueueCopyBuffer()

cl_int cl::enqueueCopyBuffer ( const Buffer src,
const Buffer dst,
::size_t  src_offset,
::size_t  dst_offset,
::size_t  size,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
)
inline

Definition at line 6674 of file cl.hpp.

◆ enqueueCopyBufferToImage()

cl_int cl::enqueueCopyBufferToImage ( const Buffer src,
const Image dst,
::size_t  src_offset,
const size_t< 3 > &  dst_origin,
const size_t< 3 > &  region,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
)
inline

Definition at line 7015 of file cl.hpp.

◆ enqueueCopyImage()

cl_int cl::enqueueCopyImage ( const Image src,
const Image dst,
const size_t< 3 > &  src_origin,
const size_t< 3 > &  dst_origin,
const size_t< 3 > &  region,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
)
inline

Definition at line 6963 of file cl.hpp.

◆ enqueueCopyImageToBuffer()

cl_int cl::enqueueCopyImageToBuffer ( const Image src,
const Buffer dst,
const size_t< 3 > &  src_origin,
const size_t< 3 > &  region,
::size_t  dst_offset,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
)
inline

Definition at line 6989 of file cl.hpp.

◆ enqueueMapBuffer()

void* cl::enqueueMapBuffer ( const Buffer buffer,
cl_bool  blocking,
cl_map_flags  flags,
::size_t  offset,
::size_t  size,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL,
cl_int *  err = NULL 
)
inline

Definition at line 6615 of file cl.hpp.

◆ enqueueReadBuffer()

cl_int cl::enqueueReadBuffer ( const Buffer buffer,
cl_bool  blocking,
::size_t  offset,
::size_t  size,
void *  ptr,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
)
inline

Definition at line 6577 of file cl.hpp.

◆ enqueueReadImage()

cl_int cl::enqueueReadImage ( const Image image,
cl_bool  blocking,
const size_t< 3 > &  origin,
const size_t< 3 > &  region,
::size_t  row_pitch,
::size_t  slice_pitch,
void *  ptr,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
)
inline

Definition at line 6903 of file cl.hpp.

◆ enqueueUnmapMemObject()

cl_int cl::enqueueUnmapMemObject ( const Memory memory,
void *  mapped_ptr,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
)
inline

Definition at line 6646 of file cl.hpp.

◆ enqueueWriteBuffer()

cl_int cl::enqueueWriteBuffer ( const Buffer buffer,
cl_bool  blocking,
::size_t  offset,
::size_t  size,
const void *  ptr,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
)
inline

Definition at line 6596 of file cl.hpp.

◆ enqueueWriteImage()

cl_int cl::enqueueWriteImage ( const Image image,
cl_bool  blocking,
const size_t< 3 > &  origin,
const size_t< 3 > &  region,
::size_t  row_pitch,
::size_t  slice_pitch,
void *  ptr,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
)
inline

Definition at line 6933 of file cl.hpp.

◆ finish()

cl_int cl::finish ( void  )
inline

Definition at line 7054 of file cl.hpp.

◆ flush()

cl_int cl::flush ( void  )
inline

◆ Local()

LocalSpaceArg cl::Local ( ::size_t  size)
inline

Helper function for generating LocalSpaceArg objects.

Local

Definition at line 4705 of file cl.hpp.