mesa  18.2.8
About: Mesa is an open-source implementation of the OpenGL specification - a system for rendering interactive 3D graphics (main library code).
  Fossies Dox: mesa-18.2.8.tar.xz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

cl::CommandQueue Class Reference

CommandQueue interface for cl_command_queue. More...

#include <cl.hpp>

Inheritance diagram for cl::CommandQueue:
Collaboration diagram for cl::CommandQueue:

Public Member Functions

 CommandQueue (const Context &context, const Device &device, cl_command_queue_properties properties=0, cl_int *err=NULL)
 
 CommandQueue ()
 
 CommandQueue (const CommandQueue &commandQueue)
 
CommandQueueoperator= (const CommandQueue &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 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
 
voidenqueueMapBuffer (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
 
voidenqueueMapImage (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, 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(*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 enqueueMarker (Event *event=NULL) const
 
cl_int enqueueWaitForEvents (const VECTOR_CLASS< Event > &events) 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 enqueueBarrier () const
 
cl_int flush () const
 
cl_int finish () const
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_command_queue >
 Wrapper ()
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 ~Wrapper ()
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
cl_type operator() () const
 
cl_typeoperator() ()
 

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

Constructor & Destructor Documentation

◆ CommandQueue() [1/3]

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

◆ CommandQueue() [2/3]

cl::CommandQueue::CommandQueue ( )
inline

Definition at line 2578 of file cl.hpp.

◆ CommandQueue() [3/3]

cl::CommandQueue::CommandQueue ( const CommandQueue commandQueue)
inline

Definition at line 2580 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

◆ enqueueBarrier()

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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ enqueueMarker()

cl_int cl::CommandQueue::enqueueMarker ( Event event = NULL) const
inline

◆ enqueueNativeKernel()

cl_int cl::CommandQueue::enqueueNativeKernel ( void(*)(void *)  userFptr,
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

◆ enqueueNDRangeKernel()

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

◆ 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

◆ 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

◆ enqueueReleaseGLObjects()

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

◆ enqueueTask()

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

◆ enqueueUnmapMemObject()

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

◆ enqueueWaitForEvents()

cl_int cl::CommandQueue::enqueueWaitForEvents ( const VECTOR_CLASS< Event > &  events) const
inline

◆ 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

◆ 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

◆ finish()

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

◆ flush()

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

◆ getInfo() [1/2]

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

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

References getInfo(), and NULL.

◆ operator=()

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

Definition at line 2582 of file cl.hpp.

References cl::detail::Wrapper< T >::operator=().


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