| <?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" |
| "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> |
| <refentry> |
| <refentryinfo>clSetUserEventStatus |
| <keywordset> |
| <keyword>clSetUserEventStatus</keyword> |
| </keywordset> |
| </refentryinfo> |
| |
| <refmeta> |
| <refentrytitle> |
| clSetUserEventStatus |
| </refentrytitle> |
| |
| <refmiscinfo> |
| <copyright> |
| <year>2007-2010</year> |
| <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> |
| </copyright> |
| </refmiscinfo> |
| <manvolnum>3</manvolnum> |
| |
| </refmeta> |
| |
| |
| <!-- ================================ SYNOPSIS --> |
| |
| <refnamediv id="clCreateBuffer"> |
| <refname> |
| clSetUserEventStatus |
| </refname> |
| |
| <refpurpose> |
| Sets the execution status of a user event object. |
| </refpurpose> |
| </refnamediv> |
| |
| <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title> |
| <funcsynopsis> |
| <funcprototype> |
| <funcdef> |
| <link xlink:href="abstractDataTypes.html">cl_mem</link> <function>clSetUserEventStatus</function> |
| </funcdef> |
| |
| <paramdef><link xlink:href="abstractDataTypes.html">cl_event</link><parameter>event</parameter></paramdef> |
| <paramdef><link xlink:href="scalarDataTypes.html">cl_int</link><parameter>execution_status</parameter></paramdef> |
| |
| </funcprototype> |
| </funcsynopsis> |
| </refsynopsisdiv> |
| |
| |
| <!-- ================================ PARAMETERS --> |
| |
| <refsect1 id="parameters"> |
| <title>Parameters</title> |
| <variablelist> |
| |
| <varlistentry> |
| <term><varname>event</varname></term> |
| <listitem> |
| <para>A user event object created using |
| <citerefentry><refentrytitle>clCreateUserEvent</refentrytitle></citerefentry>. |
| </para> |
| </listitem> |
| </varlistentry> |
| |
| <varlistentry> |
| <term><varname>execution_status</varname></term> |
| <listitem> |
| <para> <!-- parameter description --> |
| Specifies the new execution status to be set and can be CL_COMPLETE or a negative integer value |
| to indicate an error. A negative integer value causes all enqueued commands that wait on this user event |
| to be terminated. <function>clSetUserEventStatus</function> can only be called once to change the execution |
| status of <varname>event</varname>. |
| </para> |
| </listitem> |
| </varlistentry> |
| </variablelist> |
| </refsect1> |
| |
| |
| <!-- ================================ NOTES --> |
| <refsect1 id="notes"><title>Notes</title> |
| <para> |
| Enqueued commands that specify user events in the <varname>event_wait_list</varname> argument of |
| <function>clEnqueue***</function> commands must ensure that the status of these user events being waited on are |
| set using <function>clSetUserEventStatus</function> before any OpenCL APIs that release OpenCL objects except for |
| event objects are called; otherwise the behavior is undefined. |
| </para> |
| </refsect1> |
| |
| |
| <!-- ================================ ERRORS --> |
| |
| <refsect1 id="errors"><title>Errors</title> |
| <para> |
| Returns <errorname>CL_SUCCESS</errorname> if the function was executed successfully. Otherwise, it |
| returns one of the following errors |
| </para> |
| |
| <itemizedlist mark="disc"> |
| <listitem> |
| <errorname>CL_INVALID_EVENT</errorname> if <varname>event</varname> is not a valid user event. |
| </listitem> |
| <listitem> |
| <errorname>CL_INVALID_VALUE</errorname> if the <varname>execution_status</varname> is not CL_COMPLETE |
| or a negative integer value. |
| </listitem> |
| <listitem> |
| <errorname>CL_INVALID_OPERATION</errorname> if the <varname>execution_status</varname> for |
| <varname>event</varname> has already been changed by a previous call to |
| <function>clSetUserEventStatus</function>. |
| </listitem> |
| <listitem> |
| <errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate resources required |
| by the OpenCL implementation on the device. |
| </listitem> |
| <listitem> |
| <errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate resources |
| required by the OpenCL implementation on the host. |
| </listitem> |
| </itemizedlist> |
| </refsect1> |
| |
| |
| <!-- ================================ EXAMPLE --> |
| <!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE --> |
| <!-- --> |
| <refsect2 id="example1"> |
| <title> |
| Example |
| </title> |
| <para> |
| For example, the following code sequence will result in undefined behavior |
| of <citerefentry><refentrytitle>clReleaseMemObject</refentrytitle></citerefentry>. |
| </para> |
| <informaltable frame="none"> |
| <tgroup cols="1" align="left" colsep="0" rowsep="0"> |
| <colspec colname="col1" colnum="1" /> |
| <tbody> |
| <row> |
| <entry> |
| ev1 = clCreateUserEvent(ctx, NULL); |
| clEnqueueWriteBuffer(cq, buf1, CL_FALSE, ..., 1, &ev1, NULL; |
| clEnqueueWriteBuffer(cq, buf2, CL_FALSE,...); |
| clReleaseMemObject(buf2); |
| clSetUserEventStatus(ev1, CL_COMPLETE); |
| </entry> |
| </row> |
| </tbody> |
| </tgroup> |
| </informaltable> |
| |
| <para> |
| The following code sequence, however, works correctly. |
| </para> |
| <informaltable frame="none"> |
| <tgroup cols="1" align="left" colsep="0" rowsep="0"> |
| <colspec colname="col1" colnum="1" /> |
| <tbody> |
| <row> |
| <entry> |
| ev1 = clCreateUserEvent(ctx, NULL); |
| clEnqueueWriteBuffer(cq, buf1, CL_FALSE, ..., 1, &ev1, NULL; |
| clEnqueueWriteBuffer(cq, buf2, CL_FALSE,...); |
| clSetUserEventStatus(ev1, CL_COMPLETE); |
| clReleaseMemObject(buf2); |
| </entry> |
| </row> |
| </tbody> |
| </tgroup> |
| </informaltable> |
| |
| |
| </refsect2> |
| |
| |
| |
| <!-- ================================ SPECIFICATION --> |
| <!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page |
| --> |
| <refsect1 id="specification"><title>Specification</title> |
| <para> |
| <imageobject> |
| <imagedata fileref="pdficon_small1.gif" format="gif" /> |
| </imageobject> |
| |
| |
| <olink uri="clSetUserEventStatus">OpenCL Specification</olink> |
| </para> |
| </refsect1> |
| |
| |
| <!-- ================================ ALSO SEE --> |
| |
| |
| <refsect1 id="seealso"><title>Also see</title> |
| <para> |
| <citerefentry><refentrytitle>clCreateUserEvent</refentrytitle></citerefentry> |
| </para> |
| </refsect1> |
| |
| <!-- ================================ COPYRIGHT --> |
| <!-- Content included from copyright.inc.xsl --> |
| |
| <refsect3 id="Copyright"><title></title> |
| <imageobject> |
| <imagedata fileref="KhronosLogo.jpg" format="jpg" /> |
| </imageobject> |
| <para /> |
| </refsect3> |
| |
| </refentry> |
| |