ASL 0.1.7
Advanced Simulation Library
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
cl::CommandQueue Class Reference

CommandQueue interface for cl_command_queue. More...

#include <cl.hpp>

Inheritance diagram for cl::CommandQueue:
Inheritance graph
[legend]
Collaboration diagram for cl::CommandQueue:
Collaboration graph
[legend]

Public Member Functions

 CommandQueue (cl_command_queue_properties properties, cl_int *err=NULL)
 
 CommandQueue (const Context &context, cl_command_queue_properties properties=0, cl_int *err=NULL)
 Constructs a CommandQueue for an implementation defined device in the given context.
 
 CommandQueue (const Context &context, const Device &device, cl_command_queue_properties properties=0, cl_int *err=NULL)
 
 CommandQueue (const CommandQueue &queue)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC.
 
CommandQueueoperator= (const CommandQueue &queue)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC.
 
 CommandQueue ()
 
__CL_EXPLICIT_CONSTRUCTORS CommandQueue (const cl_command_queue &commandQueue)
 
CommandQueueoperator= (const cl_command_queue &rhs)
 
template<typename T >
cl_int getInfo (cl_command_queue_info name, T *param) const
 
template<cl_int name>
detail::param_traits< detail::cl_command_queue_info, name >::param_type getInfo (cl_int *err=NULL) const
 
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) const
 
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) const
 
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) const
 
cl_int enqueueReadBufferRect (const Buffer &buffer, cl_bool blocking, const size_t< 3 > &buffer_offset, const size_t< 3 > &host_offset, const size_t< 3 > &region, ::size_t buffer_row_pitch, ::size_t buffer_slice_pitch, ::size_t host_row_pitch, ::size_t host_slice_pitch, void *ptr, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL) const
 
cl_int enqueueWriteBufferRect (const Buffer &buffer, cl_bool blocking, const size_t< 3 > &buffer_offset, const size_t< 3 > &host_offset, const size_t< 3 > &region, ::size_t buffer_row_pitch, ::size_t buffer_slice_pitch, ::size_t host_row_pitch, ::size_t host_slice_pitch, void *ptr, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL) const
 
cl_int enqueueCopyBufferRect (const Buffer &src, const Buffer &dst, const size_t< 3 > &src_origin, const size_t< 3 > &dst_origin, const size_t< 3 > &region, ::size_t src_row_pitch, ::size_t src_slice_pitch, ::size_t dst_row_pitch, ::size_t dst_slice_pitch, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL) const
 
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) const
 
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) const
 
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) const
 
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) const
 
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) const
 
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) const
 
void * enqueueMapImage (const Image &buffer, cl_bool blocking, cl_map_flags flags, const size_t< 3 > &origin, const size_t< 3 > &region, ::size_t *row_pitch, ::size_t *slice_pitch, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL, cl_int *err=NULL) const
 
cl_int enqueueUnmapMemObject (const Memory &memory, void *mapped_ptr, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL) const
 
cl_int enqueueNDRangeKernel (const Kernel &kernel, const NDRange &offset, const NDRange &global, const NDRange &local=NullRange, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL) const
 
cl_int enqueueTask (const Kernel &kernel, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL) const
 
cl_int enqueueNativeKernel (void(CL_CALLBACK *userFptr)(void *), std::pair< void *, ::size_t > args, const VECTOR_CLASS< Memory > *mem_objects=NULL, const VECTOR_CLASS< const void * > *mem_locs=NULL, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL) const
 
cl_int enqueueAcquireGLObjects (const VECTOR_CLASS< Memory > *mem_objects=NULL, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL) const
 
cl_int enqueueReleaseGLObjects (const VECTOR_CLASS< Memory > *mem_objects=NULL, const VECTOR_CLASS< Event > *events=NULL, Event *event=NULL) const
 
cl_int flush () const
 
cl_int finish () const
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_command_queue >
 Wrapper ()
 
 Wrapper (const cl_type &obj)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 ~Wrapper ()
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (const cl_type &rhs)
 
cl_type operator() () const
 
cl_typeoperator() ()
 

Static Public Member Functions

static CommandQueue getDefault (cl_int *err=NULL)
 

Additional Inherited Members

- Public Types inherited from cl::detail::Wrapper< cl_command_queue >
typedef cl_command_queue cl_type
 
- Protected Member Functions inherited from cl::detail::Wrapper< cl_command_queue >
cl_int retain () const
 
cl_int release () const
 
- Protected Attributes inherited from cl::detail::Wrapper< cl_command_queue >
cl_type object_
 

Detailed Description

CommandQueue interface for cl_command_queue.

Definition at line 5354 of file cl.hpp.

Constructor & Destructor Documentation

◆ CommandQueue() [1/6]

cl::CommandQueue::CommandQueue ( cl_command_queue_properties  properties,
cl_int *  err = NULL 
)
inline

Definition at line 5365 of file cl.hpp.

◆ CommandQueue() [2/6]

cl::CommandQueue::CommandQueue ( const Context context,
cl_command_queue_properties  properties = 0,
cl_int *  err = NULL 
)
inlineexplicit

Constructs a CommandQueue for an implementation defined device in the given context.

Definition at line 5394 of file cl.hpp.

◆ CommandQueue() [3/6]

cl::CommandQueue::CommandQueue ( const Context context,
const Device device,
cl_command_queue_properties  properties = 0,
cl_int *  err = NULL 
)
inline

Definition at line 5423 of file cl.hpp.

◆ CommandQueue() [4/6]

cl::CommandQueue::CommandQueue ( const CommandQueue queue)
inline

Copy constructor to forward copy to the superclass correctly. Required for MSVC.

Definition at line 5442 of file cl.hpp.

◆ CommandQueue() [5/6]

cl::CommandQueue::CommandQueue ( )
inline

Definition at line 5530 of file cl.hpp.

◆ CommandQueue() [6/6]

__CL_EXPLICIT_CONSTRUCTORS cl::CommandQueue::CommandQueue ( const cl_command_queue &  commandQueue)
inline

Definition at line 5532 of file cl.hpp.

Member Function Documentation

◆ enqueueAcquireGLObjects()

cl_int cl::CommandQueue::enqueueAcquireGLObjects ( const VECTOR_CLASS< Memory > *  mem_objects = NULL,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
) const
inline

Deprecated APIs for 1.2

Definition at line 6315 of file cl.hpp.

◆ enqueueCopyBuffer()

cl_int cl::CommandQueue::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 
) const
inline

Definition at line 5612 of file cl.hpp.

◆ enqueueCopyBufferRect()

cl_int cl::CommandQueue::enqueueCopyBufferRect ( const Buffer src,
const Buffer dst,
const size_t< 3 > &  src_origin,
const size_t< 3 > &  dst_origin,
const size_t< 3 > &  region,
::size_t  src_row_pitch,
::size_t  src_slice_pitch,
::size_t  dst_row_pitch,
::size_t  dst_slice_pitch,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
) const
inline

Definition at line 5714 of file cl.hpp.

◆ enqueueCopyBufferToImage()

cl_int cl::CommandQueue::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 
) const
inline

Definition at line 5996 of file cl.hpp.

◆ enqueueCopyImage()

cl_int cl::CommandQueue::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 
) const
inline

Definition at line 5842 of file cl.hpp.

◆ enqueueCopyImageToBuffer()

cl_int cl::CommandQueue::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 
) const
inline

Definition at line 5971 of file cl.hpp.

◆ enqueueMapBuffer()

void * cl::CommandQueue::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 
) const
inline

Definition at line 6021 of file cl.hpp.

◆ enqueueMapImage()

void * cl::CommandQueue::enqueueMapImage ( const Image buffer,
cl_bool  blocking,
cl_map_flags  flags,
const size_t< 3 > &  origin,
const size_t< 3 > &  region,
::size_t *  row_pitch,
::size_t *  slice_pitch,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL,
cl_int *  err = NULL 
) const
inline

Definition at line 6050 of file cl.hpp.

◆ enqueueNativeKernel()

cl_int cl::CommandQueue::enqueueNativeKernel ( void(CL_CALLBACK *userFptr)(void *)  ,
std::pair< void *, ::size_t >  args,
const VECTOR_CLASS< Memory > *  mem_objects = NULL,
const VECTOR_CLASS< const void * > *  mem_locs = NULL,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
) const
inline

Definition at line 6247 of file cl.hpp.

◆ enqueueNDRangeKernel()

cl_int cl::CommandQueue::enqueueNDRangeKernel ( const Kernel kernel,
const NDRange offset,
const NDRange global,
const NDRange local = NullRange,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
) const
inline

Definition at line 6201 of file cl.hpp.

◆ enqueueReadBuffer()

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

Definition at line 5562 of file cl.hpp.

◆ enqueueReadBufferRect()

cl_int cl::CommandQueue::enqueueReadBufferRect ( const Buffer buffer,
cl_bool  blocking,
const size_t< 3 > &  buffer_offset,
const size_t< 3 > &  host_offset,
const size_t< 3 > &  region,
::size_t  buffer_row_pitch,
::size_t  buffer_slice_pitch,
::size_t  host_row_pitch,
::size_t  host_slice_pitch,
void *  ptr,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
) const
inline

Definition at line 5636 of file cl.hpp.

◆ enqueueReadImage()

cl_int cl::CommandQueue::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 
) const
inline

Definition at line 5788 of file cl.hpp.

◆ enqueueReleaseGLObjects()

cl_int cl::CommandQueue::enqueueReleaseGLObjects ( const VECTOR_CLASS< Memory > *  mem_objects = NULL,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
) const
inline

Definition at line 6337 of file cl.hpp.

◆ enqueueTask()

cl_int cl::CommandQueue::enqueueTask ( const Kernel kernel,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
) const
inline

Definition at line 6227 of file cl.hpp.

◆ enqueueUnmapMemObject()

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

Definition at line 6082 of file cl.hpp.

◆ enqueueWriteBuffer()

cl_int cl::CommandQueue::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 
) const
inline

Definition at line 5587 of file cl.hpp.

◆ enqueueWriteBufferRect()

cl_int cl::CommandQueue::enqueueWriteBufferRect ( const Buffer buffer,
cl_bool  blocking,
const size_t< 3 > &  buffer_offset,
const size_t< 3 > &  host_offset,
const size_t< 3 > &  region,
::size_t  buffer_row_pitch,
::size_t  buffer_slice_pitch,
::size_t  host_row_pitch,
::size_t  host_slice_pitch,
void *  ptr,
const VECTOR_CLASS< Event > *  events = NULL,
Event event = NULL 
) const
inline

Definition at line 5675 of file cl.hpp.

◆ enqueueWriteImage()

cl_int cl::CommandQueue::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 
) const
inline

Definition at line 5815 of file cl.hpp.

◆ finish()

cl_int cl::CommandQueue::finish ( ) const
inline

Definition at line 6454 of file cl.hpp.

◆ flush()

cl_int cl::CommandQueue::flush ( ) const
inline

Deprecated APIs for 1.2

Definition at line 6449 of file cl.hpp.

◆ getDefault()

static CommandQueue cl::CommandQueue::getDefault ( cl_int *  err = NULL)
inlinestatic

Definition at line 5469 of file cl.hpp.

◆ getInfo() [1/2]

template<typename T >
cl_int cl::CommandQueue::getInfo ( cl_command_queue_info  name,
T *  param 
) const
inline

Definition at line 5541 of file cl.hpp.

◆ getInfo() [2/2]

template<cl_int name>
detail::param_traits< detail::cl_command_queue_info, name >::param_type cl::CommandQueue::getInfo ( cl_int *  err = NULL) const
inline

Definition at line 5551 of file cl.hpp.

◆ operator=() [1/2]

CommandQueue & cl::CommandQueue::operator= ( const cl_command_queue &  rhs)
inline

Definition at line 5534 of file cl.hpp.

◆ operator=() [2/2]

CommandQueue & cl::CommandQueue::operator= ( const CommandQueue queue)
inline

Copy assignment to forward copy to the superclass correctly. Required for MSVC.

Definition at line 5447 of file cl.hpp.


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