CommandQueue interface for cl_command_queue. More...

#include <opencl.hpp>

Inheritance diagram for cl::CommandQueue:

Public Member Functions
	CommandQueue (cl_command_queue_properties properties, cl_int *err=NULL)
	Constructs a CommandQueue based on passed properties. Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified. More...

	CommandQueue (QueueProperties properties, cl_int *err=NULL)
	Constructs a CommandQueue based on passed properties. Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified. More...

	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 Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified. More...

	CommandQueue (const Context &context, QueueProperties properties, cl_int *err=NULL)
	Constructs a CommandQueue for an implementation defined device in the given context Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified. More...

	CommandQueue (const Context &context, const Device &device, cl_command_queue_properties properties=0, cl_int *err=NULL)
	Constructs a CommandQueue for a passed device and context Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified. More...

	CommandQueue (const Context &context, const Device &device, QueueProperties properties, cl_int *err=NULL)
	Constructs a CommandQueue for a passed device and context Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified. More...

	CommandQueue (const cl_command_queue &commandQueue, bool retainObject=false)
	Constructor from cl_command_queue - takes ownership. More...

CommandQueue &	operator= (const cl_command_queue &rhs)

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

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

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

CommandQueue &	operator= (CommandQueue &&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_command_queue_info 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_type offset, size_type size, void ptr, const vector< Event > events=NULL, Event *event=NULL) const

cl_int	enqueueWriteBuffer (const Buffer &buffer, cl_bool blocking, size_type offset, size_type size, const void ptr, const vector< Event > events=NULL, Event *event=NULL) const

cl_int	enqueueCopyBuffer (const Buffer &src, const Buffer &dst, size_type src_offset, size_type dst_offset, size_type size, const vector< Event > events=NULL, Event event=NULL) const

cl_int	enqueueReadBufferRect (const Buffer &buffer, cl_bool blocking, const array< size_type, 3 > &buffer_offset, const array< size_type, 3 > &host_offset, const array< size_type, 3 > &region, size_type buffer_row_pitch, size_type buffer_slice_pitch, size_type host_row_pitch, size_type host_slice_pitch, void ptr, const vector< Event > events=NULL, Event *event=NULL) const

cl_int	enqueueWriteBufferRect (const Buffer &buffer, cl_bool blocking, const array< size_type, 3 > &buffer_offset, const array< size_type, 3 > &host_offset, const array< size_type, 3 > &region, size_type buffer_row_pitch, size_type buffer_slice_pitch, size_type host_row_pitch, size_type host_slice_pitch, const void ptr, const vector< Event > events=NULL, Event *event=NULL) const

cl_int	enqueueCopyBufferRect (const Buffer &src, const Buffer &dst, const array< size_type, 3 > &src_origin, const array< size_type, 3 > &dst_origin, const array< size_type, 3 > &region, size_type src_row_pitch, size_type src_slice_pitch, size_type dst_row_pitch, size_type dst_slice_pitch, const vector< Event > events=NULL, Event event=NULL) const

template<typename PatternType >
cl_int	enqueueFillBuffer (const Buffer &buffer, PatternType pattern, size_type offset, size_type size, const vector< Event > events=NULL, Event event=NULL) const

cl_int	enqueueReadImage (const Image &image, cl_bool blocking, const array< size_type, 3 > &origin, const array< size_type, 3 > &region, size_type row_pitch, size_type slice_pitch, void ptr, const vector< Event > events=NULL, Event *event=NULL) const

cl_int	enqueueWriteImage (const Image &image, cl_bool blocking, const array< size_type, 3 > &origin, const array< size_type, 3 > &region, size_type row_pitch, size_type slice_pitch, const void ptr, const vector< Event > events=NULL, Event *event=NULL) const

cl_int	enqueueCopyImage (const Image &src, const Image &dst, const array< size_type, 3 > &src_origin, const array< size_type, 3 > &dst_origin, const array< size_type, 3 > &region, const vector< Event > events=NULL, Event event=NULL) const

cl_int	enqueueFillImage (const Image &image, cl_float4 fillColor, const array< size_type, 3 > &origin, const array< size_type, 3 > &region, const vector< Event > events=NULL, Event event=NULL) const

cl_int	enqueueFillImage (const Image &image, cl_int4 fillColor, const array< size_type, 3 > &origin, const array< size_type, 3 > &region, const vector< Event > events=NULL, Event event=NULL) const

cl_int	enqueueFillImage (const Image &image, cl_uint4 fillColor, const array< size_type, 3 > &origin, const array< size_type, 3 > &region, const vector< Event > events=NULL, Event event=NULL) const

cl_int	enqueueCopyImageToBuffer (const Image &src, const Buffer &dst, const array< size_type, 3 > &src_origin, const array< size_type, 3 > &region, size_type dst_offset, const vector< Event > events=NULL, Event event=NULL) const

cl_int	enqueueCopyBufferToImage (const Buffer &src, const Image &dst, size_type src_offset, const array< size_type, 3 > &dst_origin, const array< size_type, 3 > &region, const vector< Event > events=NULL, Event event=NULL) const

void *	enqueueMapBuffer (const Buffer &buffer, cl_bool blocking, cl_map_flags flags, size_type offset, size_type size, const vector< Event > events=NULL, Event event=NULL, cl_int *err=NULL) const

void *	enqueueMapImage (const Image &buffer, cl_bool blocking, cl_map_flags flags, const array< size_type, 3 > &origin, const array< size_type, 3 > &region, size_type row_pitch, size_type slice_pitch, const vector< Event > events=NULL, Event event=NULL, cl_int *err=NULL) const

template<typename T >
cl_int	enqueueMapSVM (T ptr, cl_bool blocking, cl_map_flags flags, size_type size, const vector< Event > events=NULL, Event *event=NULL) const

template<typename T , class D >
cl_int	enqueueMapSVM (cl::pointer< T, D > &ptr, cl_bool blocking, cl_map_flags flags, size_type size, const vector< Event > events=NULL, Event event=NULL) const

template<typename T , class Alloc >
cl_int	enqueueMapSVM (cl::vector< T, Alloc > &container, cl_bool blocking, cl_map_flags flags, const vector< Event > events=NULL, Event event=NULL) const

cl_int	enqueueUnmapMemObject (const Memory &memory, void mapped_ptr, const vector< Event > events=NULL, Event *event=NULL) const

template<typename T >
cl_int	enqueueUnmapSVM (T ptr, const vector< Event > events=NULL, Event *event=NULL) const

template<typename T , class D >
cl_int	enqueueUnmapSVM (cl::pointer< T, D > &ptr, const vector< Event > events=NULL, Event event=NULL) const

template<typename T , class Alloc >
cl_int	enqueueUnmapSVM (cl::vector< T, Alloc > &container, const vector< Event > events=NULL, Event event=NULL) const

cl_int	enqueueMarkerWithWaitList (const vector< Event > events=0, Event event=0) const

cl_int	enqueueBarrierWithWaitList (const vector< Event > events=0, Event event=0) const

cl_int	enqueueMigrateMemObjects (const vector< Memory > &memObjects, cl_mem_migration_flags flags, const vector< Event > events=NULL, Event event=NULL) const

template<typename T >
cl_int	enqueueMigrateSVM (const cl::vector< T * > &svmRawPointers, const cl::vector< size_type > &sizes, cl_mem_migration_flags flags=0, const vector< Event > events=NULL, Event event=NULL) const

template<typename T >
cl_int	enqueueMigrateSVM (const cl::vector< T * > &svmRawPointers, cl_mem_migration_flags flags=0, const vector< Event > events=NULL, Event event=NULL) const

template<typename T , class D >
cl_int	enqueueMigrateSVM (const cl::vector< cl::pointer< T, D > > &svmPointers, const cl::vector< size_type > &sizes, cl_mem_migration_flags flags=0, const vector< Event > events=NULL, Event event=NULL) const

template<typename T , class D >
cl_int	enqueueMigrateSVM (const cl::vector< cl::pointer< T, D > > &svmPointers, cl_mem_migration_flags flags=0, const vector< Event > events=NULL, Event event=NULL) const

template<typename T , class Alloc >
cl_int	enqueueMigrateSVM (const cl::vector< cl::vector< T, Alloc > > &svmContainers, const cl::vector< size_type > &sizes, cl_mem_migration_flags flags=0, const vector< Event > events=NULL, Event event=NULL) const

template<typename T , class Alloc >
cl_int	enqueueMigrateSVM (const cl::vector< cl::vector< T, Alloc > > &svmContainers, cl_mem_migration_flags flags=0, const vector< 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< Event > events=NULL, Event event=NULL) const

CL_API_PREFIX__VERSION_1_2_DEPRECATED cl_int	enqueueTask (const Kernel &kernel, const vector< Event > events=NULL, Event event=NULL) const CL_API_SUFFIX__VERSION_1_2_DEPRECATED

cl_int	enqueueNativeKernel (void(CL_CALLBACK userFptr)(void ), std::pair< void , size_type > args, const vector< Memory > mem_objects=NULL, const vector< const void * > mem_locs=NULL, const vector< Event > events=NULL, Event *event=NULL) const

CL_API_PREFIX__VERSION_1_1_DEPRECATED cl_int	enqueueMarker (Event *event=NULL) const CL_API_SUFFIX__VERSION_1_1_DEPRECATED

CL_API_PREFIX__VERSION_1_1_DEPRECATED cl_int	enqueueWaitForEvents (const vector< Event > &events) const CL_API_SUFFIX__VERSION_1_1_DEPRECATED

cl_int	enqueueAcquireGLObjects (const vector< Memory > mem_objects=NULL, const vector< Event > events=NULL, Event *event=NULL) const

cl_int	enqueueReleaseGLObjects (const vector< Memory > mem_objects=NULL, const vector< Event > events=NULL, Event *event=NULL) const

CL_API_PREFIX__VERSION_1_1_DEPRECATED cl_int	enqueueBarrier () const CL_API_SUFFIX__VERSION_1_1_DEPRECATED

cl_int	flush () const

cl_int	finish () 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 CommandQueue	getDefault (cl_int *err=NULL)

static CommandQueue	setDefault (const CommandQueue &default_queue)

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 7120 of file opencl.hpp.

Constructor & Destructor Documentation

◆ CommandQueue() [1/10]

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

inline

Constructs a CommandQueue based on passed properties. Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified.

Definition at line 7186 of file opencl.hpp.

◆ CommandQueue() [2/10]

cl::CommandQueue::CommandQueue	(	QueueProperties	properties,
		cl_int *	err = `NULL`
	)

inline

Constructs a CommandQueue based on passed properties. Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified.

Definition at line 7252 of file opencl.hpp.

◆ CommandQueue() [3/10]

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 Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified.

Definition at line 7315 of file opencl.hpp.

◆ CommandQueue() [4/10]

cl::CommandQueue::CommandQueue	(	const Context &	context,
		QueueProperties	properties,
		cl_int *	err = `NULL`
	)

inlineexplicit

Constructs a CommandQueue for an implementation defined device in the given context Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified.

Definition at line 7382 of file opencl.hpp.

◆ CommandQueue() [5/10]

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

inline

Constructs a CommandQueue for a passed device and context Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified.

Definition at line 7444 of file opencl.hpp.

◆ CommandQueue() [6/10]

cl::CommandQueue::CommandQueue	(	const Context &	context,
		const Device &	device,
		QueueProperties	properties,
		cl_int *	err = `NULL`
	)

inline

Constructs a CommandQueue for a passed device and context Will return an CL_INVALID_QUEUE_PROPERTIES error if CL_QUEUE_ON_DEVICE is specified.

Definition at line 7495 of file opencl.hpp.

◆ CommandQueue() [7/10]

cl::CommandQueue::CommandQueue ( )

inline

Definition at line 7570 of file opencl.hpp.

◆ CommandQueue() [8/10]

cl::CommandQueue::CommandQueue	(	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 7579 of file opencl.hpp.

◆ CommandQueue() [9/10]

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

inline

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

Definition at line 7591 of file opencl.hpp.

◆ CommandQueue() [10/10]

cl::CommandQueue::CommandQueue ( CommandQueue && queue )

inline

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

Definition at line 7605 of file opencl.hpp.

Member Function Documentation

◆ enqueueAcquireGLObjects()

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

inline

Definition at line 8705 of file opencl.hpp.

◆ enqueueBarrier()

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

inline

Deprecated APIs for 1.2

Definition at line 8831 of file opencl.hpp.

◆ enqueueBarrierWithWaitList()

cl_int cl::CommandQueue::enqueueBarrierWithWaitList	(	const vector< Event > *	events = `0`,
		Event *	event = `0`
	)		const

inline

A synchronization point that enqueues a barrier operation.

Enqueues a barrier command which waits for either a list of events to complete, or if the list is empty it waits for all commands previously enqueued in command_queue to complete before it completes. This command blocks command execution, that is, any following commands enqueued after it do not execute until it completes. This command returns an event which can be waited on, i.e. this event can be waited on to insure that all events either in the event_wait_list or all previously enqueued commands, queued before this command to command_queue, have completed.

Definition at line 8412 of file opencl.hpp.

◆ enqueueCopyBuffer()

cl_int cl::CommandQueue::enqueueCopyBuffer	(	const Buffer &	src,
		const Buffer &	dst,
		size_type	src_offset,
		size_type	dst_offset,
		size_type	size,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Definition at line 7688 of file opencl.hpp.

◆ enqueueCopyBufferRect()

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

inline

Definition at line 7790 of file opencl.hpp.

◆ enqueueCopyBufferToImage()

cl_int cl::CommandQueue::enqueueCopyBufferToImage	(	const Buffer &	src,
		const Image &	dst,
		size_type	src_offset,
		const array< size_type, 3 > &	dst_origin,
		const array< size_type, 3 > &	region,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Definition at line 8097 of file opencl.hpp.

◆ enqueueCopyImage()

cl_int cl::CommandQueue::enqueueCopyImage	(	const Image &	src,
		const Image &	dst,
		const array< size_type, 3 > &	src_origin,
		const array< size_type, 3 > &	dst_origin,
		const array< size_type, 3 > &	region,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Definition at line 7935 of file opencl.hpp.

◆ enqueueCopyImageToBuffer()

cl_int cl::CommandQueue::enqueueCopyImageToBuffer	(	const Image &	src,
		const Buffer &	dst,
		const array< size_type, 3 > &	src_origin,
		const array< size_type, 3 > &	region,
		size_type	dst_offset,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Definition at line 8068 of file opencl.hpp.

◆ enqueueFillBuffer()

template<typename PatternType >

cl_int cl::CommandQueue::enqueueFillBuffer	(	const Buffer &	buffer,
		PatternType	pattern,
		size_type	offset,
		size_type	size,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueue a command to fill a buffer object with a pattern of a given size. The pattern is specified as a vector type.

Template Parameters

PatternType	The datatype of the pattern field. The pattern type must be an accepted OpenCL data type.
offset	Is the offset in bytes into the buffer at which to start filling. This must be a multiple of the pattern size.
size	Is the size in bytes of the region to fill. This must be a multiple of the pattern size.

Definition at line 7840 of file opencl.hpp.

◆ enqueueFillImage() [1/3]

cl_int cl::CommandQueue::enqueueFillImage	(	const Image &	image,
		cl_float4	fillColor,
		const array< size_type, 3 > &	origin,
		const array< size_type, 3 > &	region,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueue a command to fill an image object with a specified color.

Parameters

fillColor is the color to use to fill the image. This is a four component RGBA floating-point color value if the image channel data type is not an unnormalized signed or unsigned data type.

Definition at line 7972 of file opencl.hpp.

◆ enqueueFillImage() [2/3]

cl_int cl::CommandQueue::enqueueFillImage	(	const Image &	image,
		cl_int4	fillColor,
		const array< size_type, 3 > &	origin,
		const array< size_type, 3 > &	region,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueue a command to fill an image object with a specified color.

Parameters

fillColor is the color to use to fill the image. This is a four component RGBA signed integer color value if the image channel data type is an unnormalized signed integer type.

Definition at line 8006 of file opencl.hpp.

◆ enqueueFillImage() [3/3]

cl_int cl::CommandQueue::enqueueFillImage	(	const Image &	image,
		cl_uint4	fillColor,
		const array< size_type, 3 > &	origin,
		const array< size_type, 3 > &	region,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueue a command to fill an image object with a specified color.

Parameters

fillColor is the color to use to fill the image. This is a four component RGBA unsigned integer color value if the image channel data type is an unnormalized unsigned integer type.

Definition at line 8040 of file opencl.hpp.

◆ enqueueMapBuffer()

void * cl::CommandQueue::enqueueMapBuffer	(	const Buffer &	buffer,
		cl_bool	blocking,
		cl_map_flags	flags,
		size_type	offset,
		size_type	size,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`,
		cl_int *	err = `NULL`
	)		const

inline

Definition at line 8126 of file opencl.hpp.

◆ enqueueMapImage()

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

inline

Definition at line 8155 of file opencl.hpp.

◆ enqueueMapSVM() [1/3]

template<typename T , class D >

cl_int cl::CommandQueue::enqueueMapSVM	(	cl::pointer< T, D > &	ptr,
		cl_bool	blocking,
		cl_map_flags	flags,
		size_type	size,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will allow the host to update a region of a coarse-grained SVM buffer. This variant takes a cl::pointer instance.

Definition at line 8222 of file opencl.hpp.

◆ enqueueMapSVM() [2/3]

template<typename T , class Alloc >

cl_int cl::CommandQueue::enqueueMapSVM	(	cl::vector< T, Alloc > &	container,
		cl_bool	blocking,
		cl_map_flags	flags,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will allow the host to update a region of a coarse-grained SVM buffer. This variant takes a cl::vector instance.

Definition at line 8249 of file opencl.hpp.

◆ enqueueMapSVM() [3/3]

template<typename T >

cl_int cl::CommandQueue::enqueueMapSVM	(	T *	ptr,
		cl_bool	blocking,
		cl_map_flags	flags,
		size_type	size,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will allow the host to update a region of a coarse-grained SVM buffer. This variant takes a raw SVM pointer.

Definition at line 8194 of file opencl.hpp.

◆ enqueueMarker()

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

inline

Deprecated APIs for 1.2

Definition at line 8678 of file opencl.hpp.

◆ enqueueMarkerWithWaitList()

cl_int cl::CommandQueue::enqueueMarkerWithWaitList	(	const vector< Event > *	events = `0`,
		Event *	event = `0`
	)		const

inline

Enqueues a marker command which waits for either a list of events to complete, or all previously enqueued commands to complete.

Enqueues a marker command which waits for either a list of events to complete, or if the list is empty it waits for all commands previously enqueued in command_queue to complete before it completes. This command returns an event which can be waited on, i.e. this event can be waited on to insure that all events either in the event_wait_list or all previously enqueued commands, queued before this command to command_queue, have completed.

Definition at line 8382 of file opencl.hpp.

◆ enqueueMigrateMemObjects()

cl_int cl::CommandQueue::enqueueMigrateMemObjects	(	const vector< Memory > &	memObjects,
		cl_mem_migration_flags	flags,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command to indicate with which device a set of memory objects should be associated.

Definition at line 8435 of file opencl.hpp.

◆ enqueueMigrateSVM() [1/6]

template<typename T , class D >

cl_int cl::CommandQueue::enqueueMigrateSVM	(	const cl::vector< cl::pointer< T, D > > &	svmPointers,
		cl_mem_migration_flags	flags = `0`,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will allow the host associate a set of SVM allocations with a device.

Definition at line 8543 of file opencl.hpp.

◆ enqueueMigrateSVM() [2/6]

template<typename T , class D >

cl_int cl::CommandQueue::enqueueMigrateSVM	(	const cl::vector< cl::pointer< T, D > > &	svmPointers,
		const cl::vector< size_type > &	sizes,
		cl_mem_migration_flags	flags = `0`,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will allow the host associate ranges within a set of SVM allocations with a device.

Parameters

sizes - The length from each pointer to migrate.

Definition at line 8521 of file opencl.hpp.

◆ enqueueMigrateSVM() [3/6]

template<typename T , class Alloc >

cl_int cl::CommandQueue::enqueueMigrateSVM	(	const cl::vector< cl::vector< T, Alloc > > &	svmContainers,
		cl_mem_migration_flags	flags = `0`,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will allow the host associate a set of SVM allocations with a device.

Definition at line 8579 of file opencl.hpp.

◆ enqueueMigrateSVM() [4/6]

template<typename T , class Alloc >

cl_int cl::CommandQueue::enqueueMigrateSVM	(	const cl::vector< cl::vector< T, Alloc > > &	svmContainers,
		const cl::vector< size_type > &	sizes,
		cl_mem_migration_flags	flags = `0`,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will allow the host associate ranges within a set of SVM allocations with a device.

Parameters

sizes - The length from the beginning of each container to migrate.

Definition at line 8558 of file opencl.hpp.

◆ enqueueMigrateSVM() [5/6]

template<typename T >

cl_int cl::CommandQueue::enqueueMigrateSVM	(	const cl::vector< T * > &	svmRawPointers,
		cl_mem_migration_flags	flags = `0`,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will allow the host associate a set of SVM allocations with a device.

Definition at line 8505 of file opencl.hpp.

◆ enqueueMigrateSVM() [6/6]

template<typename T >

cl_int cl::CommandQueue::enqueueMigrateSVM	(	const cl::vector< T * > &	svmRawPointers,
		const cl::vector< size_type > &	sizes,
		cl_mem_migration_flags	flags = `0`,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will allow the host associate ranges within a set of SVM allocations with a device.

Parameters

sizes - The length from each pointer to migrate.

Definition at line 8476 of file opencl.hpp.

◆ enqueueNativeKernel()

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

inline

Definition at line 8638 of file opencl.hpp.

◆ enqueueNDRangeKernel()

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

inline

Definition at line 8590 of file opencl.hpp.

◆ enqueueReadBuffer()

cl_int cl::CommandQueue::enqueueReadBuffer	(	const Buffer &	buffer,
		cl_bool	blocking,
		size_type	offset,
		size_type	size,
		void *	ptr,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Definition at line 7638 of file opencl.hpp.

◆ enqueueReadBufferRect()

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

inline

Definition at line 7712 of file opencl.hpp.

◆ enqueueReadImage()

cl_int cl::CommandQueue::enqueueReadImage	(	const Image &	image,
		cl_bool	blocking,
		const array< size_type, 3 > &	origin,
		const array< size_type, 3 > &	region,
		size_type	row_pitch,
		size_type	slice_pitch,
		void *	ptr,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Definition at line 7869 of file opencl.hpp.

◆ enqueueReleaseGLObjects()

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

inline

Definition at line 8727 of file opencl.hpp.

◆ enqueueTask()

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

inline

Definition at line 8617 of file opencl.hpp.

◆ enqueueUnmapMemObject()

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

inline

Definition at line 8271 of file opencl.hpp.

◆ enqueueUnmapSVM() [1/3]

template<typename T , class D >

cl_int cl::CommandQueue::enqueueUnmapSVM	(	cl::pointer< T, D > &	ptr,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will release a coarse-grained SVM buffer back to the OpenCL runtime. This variant takes a cl::pointer instance.

Definition at line 8324 of file opencl.hpp.

◆ enqueueUnmapSVM() [2/3]

template<typename T , class Alloc >

cl_int cl::CommandQueue::enqueueUnmapSVM	(	cl::vector< T, Alloc > &	container,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will release a coarse-grained SVM buffer back to the OpenCL runtime. This variant takes a cl::vector instance.

Definition at line 8349 of file opencl.hpp.

◆ enqueueUnmapSVM() [3/3]

template<typename T >

cl_int cl::CommandQueue::enqueueUnmapSVM	(	T *	ptr,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Enqueues a command that will release a coarse-grained SVM buffer back to the OpenCL runtime. This variant takes a raw SVM pointer.

Definition at line 8299 of file opencl.hpp.

◆ enqueueWaitForEvents()

CL_API_PREFIX__VERSION_1_1_DEPRECATED cl_int cl::CommandQueue::enqueueWaitForEvents ( const vector< Event > & events ) const

inline

Definition at line 8694 of file opencl.hpp.

◆ enqueueWriteBuffer()

cl_int cl::CommandQueue::enqueueWriteBuffer	(	const Buffer &	buffer,
		cl_bool	blocking,
		size_type	offset,
		size_type	size,
		const void *	ptr,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Definition at line 7663 of file opencl.hpp.

◆ enqueueWriteBufferRect()

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

inline

Definition at line 7751 of file opencl.hpp.

◆ enqueueWriteImage()

cl_int cl::CommandQueue::enqueueWriteImage	(	const Image &	image,
		cl_bool	blocking,
		const array< size_type, 3 > &	origin,
		const array< size_type, 3 > &	region,
		size_type	row_pitch,
		size_type	slice_pitch,
		const void *	ptr,
		const vector< Event > *	events = `NULL`,
		Event *	event = `NULL`
	)		const

inline

Definition at line 7902 of file opencl.hpp.

◆ finish()

cl_int cl::CommandQueue::finish ( ) const

inline

Definition at line 8844 of file opencl.hpp.

◆ flush()

cl_int cl::CommandQueue::flush ( ) const

inline

Definition at line 8839 of file opencl.hpp.

◆ getDefault()

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

inlinestatic

Definition at line 7542 of file opencl.hpp.

◆ getInfo() [1/2]

template<typename T >

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

inline

Definition at line 7617 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::CommandQueue::getInfo ( cl_int * err = NULL ) const

inline

Definition at line 7627 of file opencl.hpp.

◆ operator=() [1/3]

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

inline

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

Definition at line 7610 of file opencl.hpp.

◆ operator=() [2/3]

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

inline

Definition at line 7582 of file opencl.hpp.

◆ operator=() [3/3]

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

inline

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

Definition at line 7596 of file opencl.hpp.

◆ setDefault()

static CommandQueue cl::CommandQueue::setDefault ( const CommandQueue & default_queue )

inlinestatic

Modify the default command queue to be used by subsequent operations. Will only set the default if no default was previously created.

Returns: updated default command queue. Should be compared to the passed value to ensure that it was updated.

Definition at line 7563 of file opencl.hpp.

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

opencl.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CommandQueue() [1/10]

◆ CommandQueue() [2/10]

◆ CommandQueue() [3/10]

◆ CommandQueue() [4/10]

◆ CommandQueue() [5/10]

◆ CommandQueue() [6/10]

◆ CommandQueue() [7/10]

◆ CommandQueue() [8/10]

◆ CommandQueue() [9/10]

◆ CommandQueue() [10/10]

Member Function Documentation

◆ enqueueAcquireGLObjects()

◆ enqueueBarrier()

◆ enqueueBarrierWithWaitList()

◆ enqueueCopyBuffer()

◆ enqueueCopyBufferRect()

◆ enqueueCopyBufferToImage()

◆ enqueueCopyImage()

◆ enqueueCopyImageToBuffer()

◆ enqueueFillBuffer()

◆ enqueueFillImage() [1/3]

◆ enqueueFillImage() [2/3]

◆ enqueueFillImage() [3/3]

◆ enqueueMapBuffer()

◆ enqueueMapImage()

◆ enqueueMapSVM() [1/3]

◆ enqueueMapSVM() [2/3]

◆ enqueueMapSVM() [3/3]

◆ enqueueMarker()

◆ enqueueMarkerWithWaitList()

◆ enqueueMigrateMemObjects()

◆ enqueueMigrateSVM() [1/6]

◆ enqueueMigrateSVM() [2/6]

◆ enqueueMigrateSVM() [3/6]

◆ enqueueMigrateSVM() [4/6]

◆ enqueueMigrateSVM() [5/6]

◆ enqueueMigrateSVM() [6/6]

◆ enqueueNativeKernel()

◆ enqueueNDRangeKernel()

◆ enqueueReadBuffer()

◆ enqueueReadBufferRect()

◆ enqueueReadImage()

◆ enqueueReleaseGLObjects()

◆ enqueueTask()

◆ enqueueUnmapMemObject()

◆ enqueueUnmapSVM() [1/3]

◆ enqueueUnmapSVM() [2/3]

◆ enqueueUnmapSVM() [3/3]

◆ enqueueWaitForEvents()

◆ enqueueWriteBuffer()

◆ enqueueWriteBufferRect()

◆ enqueueWriteImage()

◆ finish()

◆ flush()

◆ getDefault()

◆ getInfo() [1/2]

◆ getInfo() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ setDefault()