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>clEnqueueBarrierWithWaitList</keyword>
14
clEnqueueBarrierWithWaitList
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="clEnqueueBarrierWithWaitList">
38
clEnqueueBarrierWithWaitList
42
A synchronization point that enqueues a barrier operation.
46
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
50
<link xlink:href="scalarDataTypes.html">cl_int</link>
51
<function>clEnqueueBarrierWithWaitList</function>
54
<link xlink:href="abstractDataTypes.html">cl_command_queue</link>
55
<parameter>command_queue</parameter>
58
<link xlink:href="abstractDataTypes.html">cl_uint</link>
59
<parameter>num_events_in_wait_list</parameter>
62
<link xlink:href="abstractDataTypes.html">cl_event</link>
63
<parameter>*event_wait_list</parameter>
66
<link xlink:href="abstractDataTypes.html">cl_event</link>
67
<parameter>*event</parameter>
73
<!-- ================================ PARAMETERS -->
76
<refsect1 id="parameters">
77
<title>Parameters</title>
81
<term> <varname> command_queue </varname> </term>
84
A valid command queue.
95
num_events_in_wait_list
100
Specify events that need to complete before this particular command can be executed.
104
If <varname>event_wait_list</varname> is NULL,
105
<varname>num_events_in_wait_list</varname> must be 0. If
106
<varname>event_wait_list</varname> is not NULL, the list of events
107
pointed to by <varname>event_wait_list</varname> must be valid
108
and <varname>num_events_in_wait_list</varname> must be greater
109
than 0. The events specified in <varname>event_wait_list</varname>
110
act as synchronization points. The context associated with events in
111
<varname>event_wait_list</varname> and <varname>command_queue</varname> must
112
be the same. The memory associated with <varname>event_wait_list</varname>
113
can be reused or freed after the function returns.
117
If <varname>event_wait_list</varname> is NULL, then this particular command
118
waits until all previous enqueued commands to command_queue have completed.
124
<term> <varname> event </varname> </term>
127
Returns an event object that identifies this particular command. Event
128
objects are unique and can be used to identify this barrier command
129
later on. <varname>event</varname> can be NULL in which case it
130
will not be possible for the application to query the status of
131
this command or queue a wait for this command to complete. If the
132
<varname>event_wait_list</varname> and the <varname>event</varname>
133
arguments are not NULL, the <varname>event</varname> argument should not
134
refer to an element of the <varname>event_wait_list</varname> array.
141
<!-- ================================ NOTES -->
143
<refsect1 id="notes"><title>Notes</title>
145
Enqueues a barrier command which waits for either a list of events to complete,
146
or if the list is empty it waits for all commands previously enqueued in
147
<varname>command_queue</varname> to complete before it completes. This command blocks
148
command execution, that is, any following commands enqueued after it do not execute
149
until it completes. This command returns an <varname>event</varname> which can be
150
waited on, i.e. this event can be waited on to insure that all events either in the
151
<varname>event_wait_list</varname> or all previously enqueued commands, queued before
152
this command to <varname>command_queue</varname>, have completed.
156
<!-- ================================ ERRORS -->
158
<refsect1 id="errors"><title>Errors</title>
160
Returns <errorname>CL_SUCCESS</errorname> if the function was successfully executed.
161
Otherwise, it returns one of the following errors:
164
<itemizedlist mark="disc">
166
<errorname>CL_INVALID_COMMAND_QUEUE</errorname> if <varname>command_queue</varname>
167
is not a valid command-queue.
171
<errorname>CL_INVALID_EVENT_WAIT_LIST</errorname>
172
if <varname>event_wait_list</varname> is NULL and
173
<varname>num_events_in_wait_list</varname> > 0,
174
or <varname>event_wait_list</varname> is not NULL and
175
<varname>num_events_in_wait_list</varname> is 0, or if event objects in
176
<varname>event_wait_list</varname> are not valid events.
180
<errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
181
resources required by the OpenCL implementation on the device.
185
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
186
resources required by the OpenCL implementation on the host.
192
<!-- ================================ EXAMPLE -->
193
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
195
<refsect2 id="example1">
200
<informaltable frame="none">
201
<tgroup cols="1" align="left" colsep="0" rowsep="0">
202
<colspec colname="col1" colnum="1" />
206
Example goes here - it will be set in "code" type with white space preserved.
215
<!-- ================================ SPECIFICATION -->
216
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
218
<refsect1 id="specification"><title>Specification</title>
221
<imagedata fileref="pdficon_small1.gif" format="gif" />
223
<olink uri="clEnqueueBarrierWithWaitList">OpenCL Specification</olink>
227
<!-- ================================ ALSO SEE -->
229
<refsect1 id="seealso"><title>Also see</title>
231
<citerefentry><refentrytitle>clEnqueueFillBuffer</refentrytitle></citerefentry>,
232
<citerefentry><refentrytitle>clEnqueueCopyBuffer</refentrytitle></citerefentry>,
233
<citerefentry><refentrytitle>clEnqueueCopyBufferRect</refentrytitle></citerefentry>,
234
<citerefentry><refentrytitle>clEnqueueFillImage</refentrytitle></citerefentry>,
235
<citerefentry><refentrytitle>clEnqueueCopyImage</refentrytitle></citerefentry>,
236
<citerefentry><refentrytitle>clEnqueueCopyImageToBuffer</refentrytitle></citerefentry>,
237
<citerefentry><refentrytitle>clEnqueueCopyBufferToImage</refentrytitle></citerefentry>,
238
<citerefentry><refentrytitle>clEnqueueUnmapMemObject</refentrytitle></citerefentry>
242
<!-- ================================ COPYRIGHT -->
243
<!-- Content included from copyright.inc.xsl -->
245
<refsect3 id="Copyright"><title></title>
247
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
added
removed
clEnqueueBarrierWithWaitList.xml
