'\" t
.\"     Title: clEnqueueTask
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 02/03/2019
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLENQUEUETASK" "3clc" "02/03/2019" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
clEnqueueTask \- Enqueues a command to execute a kernel on a device\&.
.SH ""
.HP \w'cl_int\ clEnqueueTask('u
.BI "cl_int clEnqueueTask(cl_command_queue\ " "command_queue" ", cl_kernel\ " "kernel" ", cl_uint\ " "num_events_in_wait_list" ", const\ cl_event\ *" "event_wait_list" ", cl_event\ *" "event" ");"
.SH "PARAMETERS"
.PP
\fI command_queue \fR
.RS 4
A valid command\-queue\&. The kernel will be queued for execution on the device associated with
\fIcommand_queue\fR\&.
.RE
.PP
\fI kernel \fR
.RS 4
A valid kernel object\&. The OpenCL context associated with
\fIkernel\fR
and
\fIcommand_queue\fR
must be the same\&.
.RE
.PP
\fI \fR\fI\fR\fI num_events_in_wait_list \fR, \fI event_wait_list \fR
.RS 4
Sspecify events that need to complete before this particular command can be executed\&. If
\fIevent_wait_list\fR
is NULL, then this particular command does not wait on any event to complete\&. If
\fIevent_wait_list\fR
is NULL,
\fInum_events_in_wait_list\fR
must be 0\&. If
\fIevent_wait_list\fR
is not NULL, the list of events pointed to by
\fIevent_wait_list\fR
must be valid and
\fInum_events_in_wait_list\fR
must be greater than 0\&. The events specified in
\fIevent_wait_list\fR
act as synchronization points\&. The context associated with events in
\fIevent_wait_list\fR
and
\fIcommand_queue\fR
must be the same\&. The memory associated with
\fIevent_wait_list\fR
can be reused or freed after the function returns\&.
.RE
.PP
\fI event \fR
.RS 4
Returns an event object that identifies this particular kernel execution instance\&. Event objects are unique and can be used to identify a particular kernel execution instance later on\&. If
\fIevent\fR
is NULL, no event will be created for this kernel execution instance and therefore it will not be possible for the application to query or queue a wait for this particular kernel execution instance\&.
.RE
.SH "NOTES"
.PP
The kernel is executed using a single work\-item\&.
.PP
\fBclEnqueueTask\fR
is equivalent to calling
\fBclEnqueueNDRangeKernel\fR(3clc)
with
\fIwork_dim\fR
= 1,
\fIglobal_work_offset\fR
= NULL,
\fIglobal_work_size\fR[0] set to 1, and
\fIlocal_work_size\fR[0] set to 1\&.
.SH "ERRORS"
.PP
Returns
CL_SUCCESS
if the kernel execution was successfully queued, or one of the errors below:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_PROGRAM_EXECUTABLE if there is no
successfully built program executable available for device associated with
\fIcommand_queue\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_COMMAND_QUEUE if \fIcommand_queue\fR
is not a valid command\-queue\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_KERNEL if \fIkernel\fR is not a
valid kernel object\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_CONTEXT if context associated with
\fIcommand_queue\fR and \fIkernel\fR is not the same
or if the context associated with \fIcommand_queue\fR and events in
\fIevent_wait_list\fR are not the same\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_KERNEL_ARGS if the kernel argument values have
not been specified\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_WORK_GROUP_SIZE if a work\-group size is
specified for \fIkernel\fR using the \fB\fBfunctionQualifiers\fR(3clc)\fR\fB
((reqd_work_group_size(X, Y, Z)))\fR qualifier in program source and is
not (\fB1\fR, \fB1\fR, \fB1\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_MISALIGNED_SUB_BUFFER_OFFSET if a sub\-buffer object
is specified as the value for an argument that is a buffer object and the
\fIoffset\fR specified when the sub\-buffer object is created is not
aligned to \fBCL_DEVICE_MEM_BASE_ADDR_ALIGN\fR value for device
associated with \fIqueue\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_IMAGE_SIZE if an image object is specified
as an argument value and the image dimensions (image width, height, specified
or compute row and/or slice pitch) are not supported by device associated with
\fIqueue\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_IMAGE_FORMAT if an image object is specified
as an argument value and the image format (image channel order and data type)
is not supported by device associated with \fIqueue\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_RESOURCES if there is a failure to queue the
execution instance of \fIkernel\fR on the command\-queue because of
insufficient resources needed to execute the kernel\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_MEM_OBJECT_ALLOCATION_FAILURE if there is a failure to
allocate memory for data store associated with image or buffer objects specified
as arguments to \fIkernel\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_EVENT_WAIT_LIST
if \fIevent_wait_list\fR is NULL and
\fInum_events_in_wait_list\fR > 0,
or \fIevent_wait_list\fR is not NULL and
\fInum_events_in_wait_list\fR is 0, or if event objects in
\fIevent_wait_list\fR are not valid events\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_RESOURCES if there is a failure to allocate
resources required by the OpenCL implementation on the device\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate
resources required by the OpenCL implementation on the host\&.
.RE
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBclEnqueueNDRangeKernel\fR(3clc),
\fBclEnqueueNativeKernel\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 172, section 5.8 - Executing Kernels (updated for 1.2 rev 14)
.RE