← Back to branch summary

~ubuntu-branches/ubuntu/trusty/khronos-opencl-man/trusty

« back to all changes in this revision

Viewing changes to atomic_dec.xml

  • Committer: Package Import Robot
  • Author(s): Mathieu Malaterre
  • Date: 2013-05-21 18:06:15 UTC
  • Revision ID: package-import@ubuntu.com-20130521180615-6e0s2n3pai95ip2f
Tags: upstream-1.0~svn21772
Import upstream version 1.0~svn21772

Show diffs side-by-side

added added

removed removed

Lines of Context:
atomic_dec.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
 
3
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd" >
 
4
 
 
5
<refentry>
 
6
    <refentryinfo>
 
7
        <keywordset>
 
8
            <keyword>atomic_dec</keyword>
 
9
        </keywordset>
 
10
    </refentryinfo>
 
11
 
 
12
    <refmeta>
 
13
        <refentrytitle>atomic_dec</refentrytitle>
 
14
 
 
15
        <refmiscinfo>
 
16
            <copyright>
 
17
                <year>2007-2011</year>
 
18
                <holder>The Khronos Group Inc.
 
19
 Permission is hereby granted, free of charge, to any person obtaining a
 
20
copy of this software and/or associated documentation files (the
 
21
"Materials"), to deal in the Materials without restriction, including
 
22
without limitation the rights to use, copy, modify, merge, publish,
 
23
distribute, sublicense, and/or sell copies of the Materials, and to
 
24
permit persons to whom the Materials are furnished to do so, subject to
 
25
the condition that this copyright notice and permission notice shall be included
 
26
in all copies or substantial portions of the Materials.</holder>
 
27
            </copyright>
 
28
        </refmiscinfo>
 
29
        <manvolnum>3</manvolnum>
 
30
    </refmeta>
 
31
 
 
32
<!-- ================================ SYNOPSIS -->
 
33
 
 
34
    <refnamediv id="atomic_dec">
 
35
        <refname>atomic_dec</refname>
 
36
 
 
37
        <refpurpose>
 
38
            atomic_dec functions.
 
39
        </refpurpose>
 
40
    </refnamediv>
 
41
 
 
42
    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
 
43
        <funcsynopsis>
 
44
            <funcprototype>
 
45
                <funcdef>
 
46
                    <link xlink:href="scalarDataTypes.html">int</link>
 
47
                    <function>
 
48
                        atomic_dec
 
49
                    </function>
 
50
                </funcdef>
 
51
                <paramdef>
 
52
                    volatile <citerefentry href="global"><refentrytitle>__global</refentrytitle></citerefentry>
 
53
                    <link xlink:href="scalarDataTypes.html">int</link><parameter>*p</parameter>
 
54
                </paramdef>
 
55
            </funcprototype>
 
56
        </funcsynopsis>
 
57
 
 
58
        <funcsynopsis>
 
59
            <funcprototype>
 
60
                <funcdef>
 
61
                    <link xlink:href="scalarDataTypes.html">unsigned int</link>
 
62
                    <function>
 
63
                        atomic_dec
 
64
                    </function>
 
65
                </funcdef>
 
66
                <paramdef>
 
67
                    volatile <citerefentry href="global"><refentrytitle>__global</refentrytitle></citerefentry>
 
68
                    <link xlink:href="scalarDataTypes.html">unsigned int</link><parameter>*p</parameter>
 
69
                </paramdef>
 
70
            </funcprototype>
 
71
        </funcsynopsis>
 
72
 
 
73
        <funcsynopsis>
 
74
            <funcprototype>
 
75
                <funcdef>
 
76
                    <link xlink:href="scalarDataTypes.html">int</link>
 
77
                    <function>
 
78
                        atomic_dec
 
79
                    </function>
 
80
                </funcdef>
 
81
                <paramdef>
 
82
                    volatile <citerefentry href="local"><refentrytitle>__local</refentrytitle></citerefentry>
 
83
                    <link xlink:href="scalarDataTypes.html">int</link><parameter>*p</parameter>
 
84
                </paramdef>
 
85
            </funcprototype>
 
86
        </funcsynopsis>
 
87
 
 
88
        <funcsynopsis>
 
89
            <funcprototype>
 
90
                <funcdef>
 
91
                    <link xlink:href="scalarDataTypes.html">unsigned int</link>
 
92
                    <function>
 
93
                        atomic_dec
 
94
                    </function>
 
95
                </funcdef>
 
96
                <paramdef>
 
97
                    volatile <citerefentry href="local"><refentrytitle>__local</refentrytitle></citerefentry>
 
98
                    <link xlink:href="scalarDataTypes.html">unsigned int</link><parameter>*p</parameter>
 
99
                </paramdef>
 
100
            </funcprototype>
 
101
        </funcsynopsis>
 
102
    </refsynopsisdiv>
 
103
 
 
104
<!-- ================================ DESCRIPTION  -->
 
105
 
 
106
    <refsect1 id="description"><title>Description</title>
 
107
        <para>
 
108
          Read the 32-bit value (referred to as <varname>old</varname>) stored at location
 
109
          pointed by <varname>p</varname>. Compute (<varname>old</varname> - 1) and store result
 
110
          at location pointed by <varname>p</varname>. The function returns <varname>old</varname>.
 
111
        </para>
 
112
 
 
113
        <para>
 
114
          A 64-bit version of this function,
 
115
          <citerefentry><refentrytitle>atom_dec</refentrytitle></citerefentry>, is enabled by
 
116
          <citerefentry><refentrytitle>cl_khr_int64_base_atomics</refentrytitle></citerefentry>.
 
117
        </para>
 
118
    </refsect1>
 
119
 
 
120
<!-- ================================ NOTES
 
121
 
 
122
    <refsect1 id="notes"><title>Notes</title>
 
123
 
 
124
    </refsect1>-->
 
125
 
 
126
<!-- ================================ EXAMPLE  -->
 
127
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
128
<!--
 
129
    <refsect2 id="example1">
 
130
        <title>
 
131
            Example
 
132
        </title>
 
133
 
 
134
        <informaltable frame="none">
 
135
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
136
                <colspec colname="col1" colnum="1" />
 
137
                <tbody>
 
138
                    <row>
 
139
                        <entry>
 
140
                            Example goes here - it will be set in "code" type with white space preserved.
 
141
                        </entry>
 
142
                    </row>
 
143
                </tbody>
 
144
            </tgroup>
 
145
        </informaltable>
 
146
    </refsect2>
 
147
-->
 
148
 
 
149
<!-- ================================ SPECIFICATION  -->
 
150
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
151
-->
 
152
    <refsect1 id="specification"><title>Specification</title>
 
153
        <para>
 
154
            <imageobject>
 
155
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
156
            </imageobject>
 
157
 
 
158
            <olink uri="atomicFunctions">OpenCL Specification</olink>
 
159
        </para>
 
160
    </refsect1>
 
161
 
 
162
<!-- ================================ ALSO SEE  -->
 
163
 
 
164
    <refsect1 id="seealso"><title>Also see</title>
 
165
        <para>
 
166
            <citerefentry href="atomicFunctions"><refentrytitle>Atomic Functions</refentrytitle></citerefentry>,
 
167
            <citerefentry><refentrytitle>atom_dec</refentrytitle></citerefentry>
 
168
        </para>
 
169
    </refsect1>
 
170
 
 
171
<!-- ============================== COPYRIGHT -->
 
172
<!-- Content included from copyright.inc.xsl -->
 
173
 
 
174
    <refsect3 id="Copyright"><title></title>
 
175
        <imageobject>
 
176
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
177
        </imageobject>
 
178
        <para />
 
179
    </refsect3>
 
180
 
 
181
<!-- 23-Oct-2011 -->
 
182
</refentry>
 
183