OpenCL C++ Bindings
Loading...
Searching...
No Matches
cl::DeviceCommandQueue Class Reference

DeviceCommandQueue interface for device cl_command_queues. More...

#include <opencl.hpp>

Inheritance diagram for cl::DeviceCommandQueue:
cl::detail::Wrapper< cl_command_queue >

Public Member Functions

 DeviceCommandQueue ()
 
 DeviceCommandQueue (DeviceQueueProperties properties, cl_int *err=NULL)
 
 DeviceCommandQueue (const Context &context, const Device &device, DeviceQueueProperties properties=DeviceQueueProperties::None, cl_int *err=NULL)
 
 DeviceCommandQueue (const Context &context, const Device &device, cl_uint queueSize, DeviceQueueProperties properties=DeviceQueueProperties::None, cl_int *err=NULL)
 
 DeviceCommandQueue (const cl_command_queue &commandQueue, bool retainObject=false)
 Constructor from cl_command_queue - takes ownership.
 
DeviceCommandQueueoperator= (const cl_command_queue &rhs)
 
 DeviceCommandQueue (const DeviceCommandQueue &queue)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC.
 
DeviceCommandQueueoperator= (const DeviceCommandQueue &queue)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC.
 
 DeviceCommandQueue (DeviceCommandQueue &&queue) CL_HPP_NOEXCEPT_
 Move constructor to forward move to the superclass correctly. Required for MSVC.
 
DeviceCommandQueueoperator= (DeviceCommandQueue &&queue)
 Move assignment to forward move to the superclass correctly. Required for MSVC.
 
template<typename T >
cl_int getInfo (cl_command_queue_info name, T *param) const
 
template<cl_command_queue_info name>
detail::param_traits< detail::cl_command_queue_info, name >::param_type getInfo (cl_int *err=NULL) const
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_command_queue >
 Wrapper (const cl_type &obj, bool retainObject)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 Wrapper (Wrapper< cl_type > &&rhs) CL_HPP_NOEXCEPT_
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (Wrapper< cl_type > &&rhs)
 
Wrapper< cl_type > & operator= (const cl_type &rhs)
 
const cl_type & operator() () const
 
cl_type & operator() ()
 
cl_type get () const
 

Static Public Member Functions

static DeviceCommandQueue makeDefault (cl_int *err=nullptr)
 
static DeviceCommandQueue makeDefault (const Context &context, const Device &device, cl_int *err=nullptr)
 
static DeviceCommandQueue makeDefault (const Context &context, const Device &device, cl_uint queueSize, cl_int *err=nullptr)
 
static DeviceCommandQueue updateDefault (const Context &context, const Device &device, const DeviceCommandQueue &default_queue, cl_int *err=nullptr)
 
static DeviceCommandQueue getDefault (const CommandQueue &queue, 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

DeviceCommandQueue interface for device cl_command_queues.

Definition at line 8841 of file opencl.hpp.

Constructor & Destructor Documentation

◆ DeviceCommandQueue() [1/7]

cl::DeviceCommandQueue::DeviceCommandQueue ( )
inline

Trivial empty constructor to create a null queue.

Definition at line 8848 of file opencl.hpp.

◆ DeviceCommandQueue() [2/7]

cl::DeviceCommandQueue::DeviceCommandQueue ( DeviceQueueProperties  properties,
cl_int *  err = NULL 
)
inline

Default construct device command queue on default context and device

Definition at line 8853 of file opencl.hpp.

◆ DeviceCommandQueue() [3/7]

cl::DeviceCommandQueue::DeviceCommandQueue ( const Context context,
const Device device,
DeviceQueueProperties  properties = DeviceQueueProperties::None,
cl_int *  err = NULL 
)
inline

Create a device command queue for a specified device in the passed context.

Definition at line 8876 of file opencl.hpp.

◆ DeviceCommandQueue() [4/7]

cl::DeviceCommandQueue::DeviceCommandQueue ( const Context context,
const Device device,
cl_uint  queueSize,
DeviceQueueProperties  properties = DeviceQueueProperties::None,
cl_int *  err = NULL 
)
inline

Create a device command queue for a specified device in the passed context.

Definition at line 8900 of file opencl.hpp.

◆ DeviceCommandQueue() [5/7]

cl::DeviceCommandQueue::DeviceCommandQueue ( const cl_command_queue &  commandQueue,
bool  retainObject = false 
)
inlineexplicit

Constructor from cl_command_queue - takes ownership.

Parameters
retainObjectwill cause the constructor to retain its cl object. Defaults to false to maintain compatibility with earlier versions.

Definition at line 8930 of file opencl.hpp.

◆ DeviceCommandQueue() [6/7]

cl::DeviceCommandQueue::DeviceCommandQueue ( const DeviceCommandQueue queue)
inline

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

Definition at line 8942 of file opencl.hpp.

◆ DeviceCommandQueue() [7/7]

cl::DeviceCommandQueue::DeviceCommandQueue ( DeviceCommandQueue &&  queue)
inline

Move constructor to forward move to the superclass correctly. Required for MSVC.

Definition at line 8956 of file opencl.hpp.

Member Function Documentation

◆ getDefault()

static DeviceCommandQueue cl::DeviceCommandQueue::getDefault ( const CommandQueue queue,
cl_int *  err = NULL 
)
inlinestatic

Return the current default command queue for the specified command queue

Definition at line 9100 of file opencl.hpp.

◆ getInfo() [1/2]

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

Definition at line 8968 of file opencl.hpp.

◆ getInfo() [2/2]

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

Definition at line 8978 of file opencl.hpp.

◆ makeDefault() [1/3]

static DeviceCommandQueue cl::DeviceCommandQueue::makeDefault ( cl_int *  err = nullptr)
inlinestatic

Create a new default device command queue for the default device, in the default context and of the default size. If there is already a default queue for the specified device this function will return the pre-existing queue.

Definition at line 8995 of file opencl.hpp.

◆ makeDefault() [2/3]

static DeviceCommandQueue cl::DeviceCommandQueue::makeDefault ( const Context context,
const Device device,
cl_int *  err = nullptr 
)
inlinestatic

Create a new default device command queue for the specified device and of the default size. If there is already a default queue for the specified device this function will return the pre-existing queue.

Definition at line 9025 of file opencl.hpp.

◆ makeDefault() [3/3]

static DeviceCommandQueue cl::DeviceCommandQueue::makeDefault ( const Context context,
const Device device,
cl_uint  queueSize,
cl_int *  err = nullptr 
)
inlinestatic

Create a new default device command queue for the specified device and of the requested size in bytes. If there is already a default queue for the specified device this function will return the pre-existing queue.

Definition at line 9053 of file opencl.hpp.

◆ operator=() [1/3]

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

Definition at line 8933 of file opencl.hpp.

◆ operator=() [2/3]

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

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

Definition at line 8947 of file opencl.hpp.

◆ operator=() [3/3]

DeviceCommandQueue & cl::DeviceCommandQueue::operator= ( DeviceCommandQueue &&  queue)
inline

Move assignment to forward move to the superclass correctly. Required for MSVC.

Definition at line 8961 of file opencl.hpp.

◆ updateDefault()

static DeviceCommandQueue cl::DeviceCommandQueue::updateDefault ( const Context context,
const Device device,
const DeviceCommandQueue default_queue,
cl_int *  err = nullptr 
)
inlinestatic

Modify the default device command queue to be used for subsequent kernels. This can update the default command queue for a device repeatedly to account for kernels that rely on the default.

Returns
updated default device command queue.

Definition at line 9085 of file opencl.hpp.


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