DeviceCommandQueue interface for device cl_command_queues. More...

#include <cl2.hpp>

Inheritance diagram for cl::DeviceCommandQueue:

Collaboration diagram for cl::DeviceCommandQueue:

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. More...

DeviceCommandQueue &	operator= (const cl_command_queue &rhs)

	DeviceCommandQueue (const DeviceCommandQueue &queue)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...

DeviceCommandQueue &	operator= (const DeviceCommandQueue &queue)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...

	DeviceCommandQueue (DeviceCommandQueue &&queue) CL_HPP_NOEXCEPT_
	Move constructor to forward move to the superclass correctly. Required for MSVC. More...

DeviceCommandQueue &	operator= (DeviceCommandQueue &&queue)
	Move assignment to forward move to the superclass correctly. Required for MSVC. More...

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

Public Member Functions inherited from cl::detail::Wrapper< cl_command_queue >
	Wrapper ()

	Wrapper (const cl_type &obj, bool retainObject)

	Wrapper (const Wrapper< cl_type > &rhs)

	Wrapper (Wrapper< cl_type > &&rhs) CL_HPP_NOEXCEPT_

	~Wrapper ()

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() ()

const cl_type	get () const

cl_type	get ()

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)

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 8091 of file cl2.hpp.

Constructor & Destructor Documentation

cl::DeviceCommandQueue::DeviceCommandQueue ( )

inline

Trivial empty constructor to create a null queue.

Definition at line 8098 of file cl2.hpp.

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

inline

Default construct device command queue on default context and device

Definition at line 8103 of file cl2.hpp.

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 8126 of file cl2.hpp.

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 8150 of file cl2.hpp.

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

inlineexplicit

Constructor from cl_command_queue - takes ownership.

Parameters

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

Definition at line 8180 of file cl2.hpp.

cl::DeviceCommandQueue::DeviceCommandQueue ( const DeviceCommandQueue & queue )

inline

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

Definition at line 8192 of file cl2.hpp.

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

inline

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

Definition at line 8206 of file cl2.hpp.

Member Function Documentation

template<typename T >

cl_int cl::DeviceCommandQueue::getInfo	(	cl_command_queue_info	name,
		T *	param
	)		const

inline

Definition at line 8218 of file cl2.hpp.

template<cl_int name>

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

inline

Definition at line 8228 of file cl2.hpp.

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 8245 of file cl2.hpp.

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 8275 of file cl2.hpp.

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 8303 of file cl2.hpp.

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

inline

Definition at line 8183 of file cl2.hpp.

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

inline

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

Definition at line 8197 of file cl2.hpp.

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

inline

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

Definition at line 8211 of file cl2.hpp.

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

cl2.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation