File: memoryBarrier.xml

package info (click to toggle)
khronos-opengl-man4 1.0~svn31251-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 6,368 kB
  • ctags: 267
  • sloc: xml: 93,382; makefile: 730; python: 627; sh: 50; php: 4
file content (79 lines) | stat: -rw-r--r-- 4,394 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="memoryBarrier">
    <info>
        <copyright>
            <year>2011-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
            <refentrytitle>memoryBarrier</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>memoryBarrier</refname>
        <refpurpose>controls the ordering of memory transactions issued by a single shader invocation</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>Declaration</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>uint <function>memoryBarrier</function></funcdef>
                <paramdef>void</paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            <function>memoryBarrier</function> waits on the completion of all memory accesses resulting from the use of
            image variables or atomic counters and then returns with no other effect.  When this function returns, the
            results of any memory stores performed using coherent variables performed prior to the call will be visible
            to any future coherent memory access to the same addresses from other shader invocations.  In particular,
            the values written this way in one shader stage are guaranteed to be visible to coherent memory accesses
            performed by shader invocations in subsequent stages when those invocations were triggered by the
            execution of the original shader invocation (e.g., fragment shader invocations for a primitive resulting
            from a particular geometry shader invocation).
        </para>
    </refsect1>
    <refsect1 xml:id="versions"><title>Version Support</title>
        <informaltable>
            <tgroup cols="13" align="left">
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="funchead.xml" xpointer="xpointer(/*/*)"/>
                <tbody>
                    <row>
                        <entry>memoryBarrier</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='40']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>imageLoad</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>imageStore</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>imageAtomicAdd</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>imageAtomicMin</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>imageAtomicMax</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>imageAtomicXor</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>imageAtomicOr</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>imageAtomicAnd</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>imageAtomicExchange</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>imageAtomicCompSwap</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>groupMemoryBarrier</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>memoryBarrierImage</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>memoryBarrierBuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>memoryBarrierShared</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 2011-2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
        </para>
    </refsect1>
</refentry>