Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
4 | <refentry id="glFenceSync">\r | |
5 | <refmeta>\r | |
6 | <refmetainfo>\r | |
7 | <copyright>\r | |
8 | <year>2010</year>\r | |
9 | <holder>Khronos Group</holder>\r | |
10 | </copyright>\r | |
11 | </refmetainfo>\r | |
12 | <refentrytitle>glFenceSync</refentrytitle>\r | |
13 | <manvolnum>3G</manvolnum>\r | |
14 | </refmeta>\r | |
15 | <refnamediv>\r | |
16 | <refname>glFenceSync</refname>\r | |
17 | <refpurpose>create a new sync object and insert it into the GL command stream</refpurpose>\r | |
18 | </refnamediv>\r | |
19 | <refsynopsisdiv><title>C Specification</title>\r | |
20 | <funcsynopsis>\r | |
21 | <funcprototype>\r | |
22 | <funcdef>GLsync <function>glFenceSync</function></funcdef>\r | |
23 | <paramdef>GLenum <parameter>condition</parameter></paramdef>\r | |
24 | <paramdef>GLbitfield <parameter>flags</parameter></paramdef>\r | |
25 | </funcprototype>\r | |
26 | </funcsynopsis>\r | |
27 | </refsynopsisdiv>\r | |
28 | <!-- eqn: ignoring delim $$ -->\r | |
29 | <refsect1 id="parameters"><title>Parameters</title>\r | |
30 | <variablelist>\r | |
31 | <varlistentry>\r | |
32 | <term><parameter>condition</parameter></term>\r | |
33 | <listitem>\r | |
34 | <para>\r | |
35 | Specifies the condition that must be met to set the sync object's state to signaled. <parameter>condition</parameter>\r | |
36 | must be <constant>GL_SYNC_GPU_COMMANDS_COMPLETE</constant>.\r | |
37 | </para>\r | |
38 | </listitem>\r | |
39 | </varlistentry>\r | |
40 | <varlistentry>\r | |
41 | <term><parameter>flags</parameter></term>\r | |
42 | <listitem>\r | |
43 | <para>\r | |
44 | Specifies a bitwise combination of flags controlling the behavior of the sync object. No flags are presently defined\r | |
45 | for this operation and <parameter>flags</parameter> must be zero.<footnote><para>\r | |
46 | <parameter>flags</parameter> is a placeholder for anticipated future extensions of fence sync object capabilities.\r | |
47 | </para>\r | |
48 | </footnote>\r | |
49 | </para>\r | |
50 | </listitem>\r | |
51 | </varlistentry>\r | |
52 | </variablelist>\r | |
53 | </refsect1>\r | |
54 | <refsect1 id="description"><title>Description</title>\r | |
55 | <para>\r | |
56 | <function>glFenceSync</function> creates a new fence sync object, inserts a fence command into the GL command stream and\r | |
57 | associates it with that sync object, and returns a non-zero name corresponding to the sync object.\r | |
58 | </para>\r | |
59 | <para>\r | |
60 | When the specified <parameter>condition</parameter> of the sync object is satisfied by the fence command, the sync object\r | |
61 | is signaled by the GL, causing any <citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry>,\r | |
62 | <citerefentry><refentrytitle>glClientWaitSync</refentrytitle></citerefentry> commands blocking in <parameter>sync</parameter>\r | |
63 | to <emphasis>unblock</emphasis>. No other state is affected by <function>glFenceSync</function> or by the execution\r | |
64 | of the associated fence command.\r | |
65 | </para>\r | |
66 | <para>\r | |
67 | <parameter>condition</parameter> must be <constant>GL_SYNC_GPU_COMMANDS_COMPLETE</constant>. This condition is satisfied by \r | |
68 | completion of the fence command corresponding to the sync object and all preceding commands in the same command stream.\r | |
69 | The sync object will not be signaled until all effects from these commands on GL client and server state and the\r | |
70 | framebuffer are fully realized. Note that completion of the fence command occurs once the state of the corresponding sync\r | |
71 | object has been changed, but commands waiting on that sync object may not be unblocked until after the fence command completes.\r | |
72 | </para>\r | |
73 | </refsect1>\r | |
74 | <refsect1 id="notes"><title>Notes</title>\r | |
75 | <function>glFenceSync</function> is only supported if the GL version is 3.2 or greater, or if\r | |
76 | the <code>ARB_sync</code> extension is supported.\r | |
77 | </refsect1>\r | |
78 | <refsect1 id="errors"><title>Errors</title>\r | |
79 | <para>\r | |
80 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>condition</parameter> is not\r | |
81 | <constant>GL_SYNC_GPU_COMMANDS_COMPLETE</constant>.\r | |
82 | </para>\r | |
83 | <para>\r | |
84 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>flags</parameter> is not zero.\r | |
85 | </para>\r | |
86 | <para>\r | |
87 | Additionally, if <function>glFenceSync</function> fails, it will return zero.\r | |
88 | </para>\r | |
89 | </refsect1>\r | |
90 | <refsect1 id="seealso"><title>See Also</title>\r | |
91 | <para>\r | |
92 | <citerefentry><refentrytitle>glDeleteSync</refentrytitle></citerefentry>,\r | |
93 | <citerefentry><refentrytitle>glGetSync</refentrytitle></citerefentry>,\r | |
94 | <citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry>,\r | |
95 | <citerefentry><refentrytitle>glClientWaitSync</refentrytitle></citerefentry>\r | |
96 | </para>\r | |
97 | </refsect1>\r | |
98 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
99 | <para>\r | |
100 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r | |
101 | This material may be distributed subject to the terms and conditions set forth in \r | |
102 | the Open Publication License, v 1.0, 8 June 1999.\r | |
103 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
104 | </para>\r | |
105 | </refsect1>\r | |
106 | </refentry>\r |