1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
8
<keyword>clEnqueueMarkerWithWaitList</keyword>
14
clEnqueueMarkerWithWaitList
19
<year>2007-2011</year>
20
<holder>The Khronos Group Inc.
21
Permission is hereby granted, free of charge, to any person obtaining a
22
copy of this software and/or associated documentation files (the
23
"Materials"), to deal in the Materials without restriction, including
24
without limitation the rights to use, copy, modify, merge, publish,
25
distribute, sublicense, and/or sell copies of the Materials, and to
26
permit persons to whom the Materials are furnished to do so, subject to
27
the condition that this copyright notice and permission notice shall be included
28
in all copies or substantial portions of the Materials.</holder>
31
<manvolnum>3</manvolnum>
34
<!-- ================================ SYNOPSIS -->
36
<refnamediv id="clEnqueueMarkerWithWaitList">
38
clEnqueueMarkerWithWaitList
42
Enqueues a marker command which waits for either a list of events to complete,
43
or all previously enqueued commands to complete.
47
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
51
<link xlink:href="scalarDataTypes.html">cl_int</link>
52
<function>clEnqueueMarkerWithWaitList</function>
55
<link xlink:href="abstractDataTypes.html">cl_command_queue</link>
56
<parameter>command_queue</parameter>
59
<link xlink:href="abstractDataTypes.html">cl_uint</link>
60
<parameter>num_events_in_wait_list</parameter>
63
<link xlink:href="abstractDataTypes.html">cl_event</link>
64
<parameter>*event_wait_list</parameter>
67
<link xlink:href="abstractDataTypes.html">cl_event</link>
68
<parameter>*event</parameter>
75
<!-- ================================ PARAMETERS -->
76
<!-- For each <varlistentry />, place the parameter name in <term /><varname />, then the definition in
77
<listitem /><para />. When refering to anything
78
that has a page in this system, use <citerefentry /><refentrytitle /> to make it a link.-->
80
<refsect1 id="parameters">
81
<title>Parameters</title>
84
<term> <varname> command_queue </varname> </term>
87
A valid command-queue.
98
num_events_in_wait_list
103
These functions specify events that need to complete before this particular
104
command can be executed.
108
If <varname>event_wait_list</varname> is NULL,
109
<varname>num_events_in_wait_list</varname> must be 0. If
110
<varname>event_wait_list</varname> is not NULL, the list of events
111
pointed to by <varname>event_wait_list</varname> must be valid
112
and <varname>num_events_in_wait_list</varname> must be greater
113
than 0. The events specified in <varname>event_wait_list</varname>
114
act as synchronization points. The context associated with events in
115
<varname>event_wait_list</varname> and <varname>command_queue</varname> must
116
be the same. The memory associated with <varname>event_wait_list</varname>
117
can be reused or freed after the function returns.
121
If <varname>event_wait_list</varname> is NULL, then this
122
particular command waits until all previous enqueued commands to
123
<varname>command_queue</varname> have completed.
129
<term> <varname> event </varname> </term>
132
Returns an event object that identifies this particular command.
133
Event objects are unique and can be used to identify this marker
134
command later on. <varname>event</varname> can be NULL in which case
135
it will not be possible for the application to query the status of
136
this command or queue a wait for this command to complete. If the
137
<varname>event_wait_list</varname> and the <varname>event</varname>
138
arguments are not NULL, the <varname>event</varname> argument should not
139
refer to an element of the <varname>event_wait_list</varname> array.
146
<!-- ================================ DESCRIPTION -->
148
<refsect1 id="description"><title>Description</title>
150
Enqueues a marker command which waits for either a list of events to complete,
151
or if the list is empty it waits for all commands previously enqueued in
152
<varname>command_queue</varname> to complete before it completes. This command returns
153
an event which can be waited on, i.e. this event can be waited on to insure that all
154
events either in the <varname>event_wait_list</varname> or all previously enqueued
155
commands, queued before this command to <varname>command_queue</varname>, have completed.
159
<!-- ================================ ERRORS -->
161
<refsect1 id="errors"><title>Errors</title>
163
Returns <errorname>CL_SUCCESS</errorname> if the function executed successfully,
164
or one of the errors below:
167
<itemizedlist mark="disc">
169
<errorname>CL_INVALID_COMMAND_QUEUE</errorname> if <varname>command_queue</varname>
170
is not a valid command-queue.
174
<errorname>CL_INVALID_EVENT_WAIT_LIST</errorname>
175
if <varname>event_wait_list</varname> is NULL and
176
<varname>num_events_in_wait_list</varname> > 0, or <varname>event_wait_list</varname>
177
is not NULL and <varname>num_events_in_wait_list</varname> is 0, or if event
178
objects in <varname>event_wait_list</varname> are not valid events.
182
<errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
183
resources required by the OpenCL implementation on the device.
187
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
188
resources required by the OpenCL implementation on the host.
194
<!-- ================================ EXAMPLE -->
195
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
197
<refsect2 id="example1">
202
<informaltable frame="none">
203
<tgroup cols="1" align="left" colsep="0" rowsep="0">
204
<colspec colname="col1" colnum="1" />
208
Example goes here - it will be set in "code" type with white space preserved.
217
<!-- ================================ SPECIFICATION -->
218
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
220
<refsect1 id="specification"><title>Specification</title>
223
<imagedata fileref="pdficon_small1.gif" format="gif" />
227
<olink uri="clEnqueueMarkerWithWaitList">OpenCL Specification</olink>
231
<!-- ================================ ALSO SEE -->
233
<refsect1 id="seealso"><title>Also see</title>
235
<citerefentry><refentrytitle>clWaitForEvents</refentrytitle></citerefentry>,
236
<citerefentry><refentrytitle>clEnqueueBarrierWithWaitList</refentrytitle></citerefentry>
240
<!-- ================================ COPYRIGHT -->
241
<!-- Content included from copyright.inc.xsl -->
243
<refsect3 id="Copyright"><title></title>
245
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
added
removed
clEnqueueMarkerWithWaitList.xml
