blob: de77ca6a2059dd2271ead11d8e6908a3150e1361 [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="clCreateFromGLBuffer">
Creates an event object linked to an OpenGL sync object.
<refsynopsisdiv xmlns:xlink=""><title></title>
<link xlink:href="abstractDataTypes.html">cl_event</link>
<paramdef><link xlink:href="abstractDataTypes.html">cl_context</link><parameter>context</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">cl_int</link><parameter>*errcode_ret</parameter></paramdef>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters">
<term> <varname> context </varname> </term>
<!-- parameter description --> A valid OpenCL context
created from an OpenGL context or share group, using the
<term> <varname> sync </varname> </term>
<para> <!-- parameter description -->
The name of a sync object in the GL share group associated with <varname>context</varname>.
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
An event object may be created by linking to an OpenGL sync object. Completion of such an event
object is equivalent to waiting for completion of the fence command associated with the linked
GL sync object.
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
The parameters of an event object linked to a GL sync
object will return the following values when queried with
<itemizedlist mark="disc">
The <constant>CL_EVENT_COMMAND_QUEUE</constant> of a linked event is NULL,
because the event is not associated with any OpenCL command queue.
The <constant>CL_EVENT_COMMAND_TYPE</constant> of a linked event is
<constant>CL_COMMAND_GL_FENCE_SYNC_OBJECT_KHR</constant>, indicating that the
event is associated with a GL sync object, rather than an OpenCL command.
The <constant>CL_EVENT_COMMAND_EXECUTION_STATUS</constant> of a linked
event is either <constant>CL_SUBMITTED</constant>, indicating that the
fence command associated with the sync object has not yet completed, or
<constant>CL_COMPLETE</constant>, indicating that the fence command has completed.
<function>clCreateEventFromGLsyncKHR</function> performs an implicit
<citerefentry><refentrytitle>clRetainEvent</refentrytitle></citerefentry> on the
returned event object. Creating a linked event object also places a reference on
the linked GL sync object. When the event object is deleted, the reference will be
removed from the GL sync object.
Events returned from <function>clCreateEventFromGLsyncKHR</function> may only be consumed
by <citerefentry><refentrytitle>clEnqueueAcquireGLObjects</refentrytitle></citerefentry>.
Passing such events to any other CL API will generate a
<constant>CL_INVALID_EVENT</constant> error.
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
Returns a valid OpenCL event object and <varname>errcode_ret</varname> is set to
<errorname>CL_SUCCESS</errorname> if the event object is created successfully.
Otherwise, it returns a NULL value with one of the following error values returned
in <varname>errcode_ret</varname>:
<itemizedlist mark="disc">
<errorname>CL_INVALID_CONTEXT</errorname> if <varname>context</varname> is not
a valid context or was not created from a GL context.
<errorname>CL_INVALID_GL_OBJECT</errorname> if <varname>sync</varname>
is not the name of a sync object in the GL share group associated with
<!-- ================================ 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="clCreateEventFromGLsyncKHR">OpenCL Specification</olink>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<!-- ============================== COPYRIGHT -->
<!-- Content included from -->
<refsect3 id="Copyright"><title></title>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
<para />
<!-- 24-Oct-2011 -->