blob: 1f84691cfa10d17995f5698122a04d5e6b1fa094 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
<holder>The Khronos Group Inc.
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.</holder>
<!-- ================================ SYNOPSIS -->
<refnamediv id="wait_group_events">
Wait for events that identify the <function>async_work_group_copy</function> operations to complete.
<refsynopsisdiv xmlns:xlink=""><title></title>
<link xlink:href="scalarDataTypes.html">void</link>
<paramdef><link xlink:href="scalarDataTypes.html">int</link><parameter>num_events</parameter></paramdef>
<paramdef><link xlink:href="otherDataTypes.html">event_t</link><parameter>*event_list</parameter></paramdef>
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
<function>wait_group_events</function> waits for events that identify the
operations to complete. The event objects specified in <varname>event_list</varname>
will be released after the wait is performed.
This function must be encountered by all work-items in a work-group executing the
kernel with the same <varname>num_events</varname> and event objects specified in
<varname>event_list</varname>; otherwise the results are undefined.
This rule applies to ND-ranges implemented with uniform
and non-uniform work-groups.
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
The kernel must wait for the completion of all async copies using the
<function>wait_group_events</function> built-in function before exiting; otherwise the
behavior is undefined.
<!-- ================================ EXAMPLE -->
<refsect2 id="example1">
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
Example goes here - it will be set in "code" type with white space preserved.
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
<refsect1 id="specification"><title>Specification</title>
<imagedata fileref="pdficon_small1.gif" format="gif" />
<olink uri="asyncCopyFunctions">OpenCL Specification</olink>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<citerefentry href="asyncCopyFunctions"><refentrytitle>Async Copy and Prefetch Functions</refentrytitle></citerefentry>
<!-- ============================== COPYRIGHT -->
<!-- Content included from -->
<refsect3 id="Copyright"><title></title>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
<para />
<!-- 9-Nov-2015, API ver 2.1 rev 19; Ext ver 2.1 rev 10; C lang ver 2.0 rev 30 -->