Public Member Functions | Static Public Member Functions | Static Private Attributes | 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]

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. More...
 
 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. More...
 
 CommandQueue ()
 
__CL_EXPLICIT_CONSTRUCTORS CommandQueue (const cl_command_queue &commandQueue)
 
cl_int enqueueAcquireGLObjects (const VECTOR_CLASS< Memory > *mem_objects=NULL, 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 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 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
 
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
 
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 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 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 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 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 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 enqueueReleaseGLObjects (const VECTOR_CLASS< Memory > *mem_objects=NULL, 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 enqueueUnmapMemObject (const Memory &memory, void *mapped_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 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 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 finish () const
 
cl_int flush () const
 
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
 
CommandQueue & operator= (const CommandQueue &queue)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
CommandQueue & operator= (const cl_command_queue &rhs)
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_command_queue >
cl_type operator() () const
 
cl_type & operator() ()
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (const cl_type &rhs)
 
 Wrapper ()
 
 Wrapper (const cl_type &obj)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 ~Wrapper ()
 

Static Public Member Functions

static CommandQueue getDefault (cl_int *err=NULL)
 

Static Private Attributes

static CommandQueue default_
 
static volatile cl_int default_error_
 
static volatile int default_initialized_
 

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 release () const
 
cl_int retain () 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 5477 of file cl.hpp.

Constructor & Destructor Documentation

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

Definition at line 5488 of file cl.hpp.

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 5517 of file cl.hpp.

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

Definition at line 5546 of file cl.hpp.

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

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

Definition at line 5565 of file cl.hpp.

cl::CommandQueue::CommandQueue ( )
inline

Definition at line 5653 of file cl.hpp.

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

Definition at line 5655 of file cl.hpp.

Member Function Documentation

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 6438 of file cl.hpp.

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 5735 of file cl.hpp.

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 5837 of file cl.hpp.

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 6119 of file cl.hpp.

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 5965 of file cl.hpp.

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 6094 of file cl.hpp.

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 6144 of file cl.hpp.

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 6173 of file cl.hpp.

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 6370 of file cl.hpp.

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 6324 of file cl.hpp.

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 5685 of file cl.hpp.

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 5759 of file cl.hpp.

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 5911 of file cl.hpp.

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 6460 of file cl.hpp.

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

Definition at line 6350 of file cl.hpp.

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 6205 of file cl.hpp.

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 5710 of file cl.hpp.

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 5798 of file cl.hpp.

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 5938 of file cl.hpp.

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

Definition at line 6577 of file cl.hpp.

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

Deprecated APIs for 1.2

Definition at line 6572 of file cl.hpp.

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

Definition at line 5592 of file cl.hpp.

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

Definition at line 5664 of file cl.hpp.

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 5674 of file cl.hpp.

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

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

Definition at line 5570 of file cl.hpp.

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

Definition at line 5657 of file cl.hpp.

Member Data Documentation

CommandQueue cl::CommandQueue::default_
staticprivate

Definition at line 5485 of file cl.hpp.

volatile cl_int cl::CommandQueue::default_error_
staticprivate

Definition at line 5486 of file cl.hpp.

volatile int cl::CommandQueue::default_initialized_
staticprivate

Definition at line 5483 of file cl.hpp.

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

kinect2_registration
Author(s):
autogenerated on Wed Jan 3 2018 03:48:04