← Back to branch summary

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

« back to all changes in this revision

Viewing changes to vstoren.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:
vstoren.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
<!ENTITY vectorFunctionsInc SYSTEM "vectorFunctionsInc.xml">
 
5
<!ENTITY vectorHalfFunctionsInc SYSTEM "vectorHalfFunctionsInc.xml">
 
6
]>
 
7
 
 
8
<refentry>
 
9
    <refentryinfo>
 
10
        <keywordset>
 
11
            <keyword>vstoren</keyword>
 
12
        </keywordset>
 
13
    </refentryinfo>
 
14
 
 
15
    <refmeta>
 
16
        <refentrytitle>vstoren</refentrytitle>
 
17
 
 
18
        <refmiscinfo>
 
19
            <copyright>
 
20
                <year>2007-2011</year>
 
21
                <holder>The Khronos Group Inc.
 
22
 Permission is hereby granted, free of charge, to any person obtaining a
 
23
copy of this software and/or associated documentation files (the
 
24
"Materials"), to deal in the Materials without restriction, including
 
25
without limitation the rights to use, copy, modify, merge, publish,
 
26
distribute, sublicense, and/or sell copies of the Materials, and to
 
27
permit persons to whom the Materials are furnished to do so, subject to
 
28
the condition that this copyright notice and permission notice shall be included
 
29
in all copies or substantial portions of the Materials.</holder>
 
30
            </copyright>
 
31
        </refmiscinfo>
 
32
        <manvolnum>3</manvolnum>
 
33
    </refmeta>
 
34
 
 
35
<!-- ================================ SYNOPSIS -->
 
36
 
 
37
    <refnamediv id="vstoren">
 
38
        <refname>vstore<emphasis>n</emphasis></refname>
 
39
 
 
40
        <refpurpose>
 
41
            Write sizeof bytes (<type>gentype<replaceable>n</replaceable></type>) to memory.
 
42
        </refpurpose>
 
43
    </refnamediv>
 
44
 
 
45
    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
 
46
        <funcsynopsis>
 
47
            <funcprototype>
 
48
                <funcdef>
 
49
                    <link xlink:href="scalarDataTypes.html">void</link>
 
50
                    <function>
 
51
                        vstore<replaceable>n</replaceable>
 
52
                    </function>
 
53
                </funcdef>
 
54
 
 
55
                <paramdef>
 
56
                    gentype<replaceable>n</replaceable><parameter>data</parameter>
 
57
                </paramdef>
 
58
 
 
59
                <paramdef>
 
60
                    <link xlink:href="scalarDataTypes.html">size_t</link><parameter>offset</parameter>
 
61
                </paramdef>
 
62
 
 
63
                <paramdef>
 
64
                    <link xlink:href="global.html">__global</link> gentype<parameter>*p</parameter>
 
65
                </paramdef>
 
66
            </funcprototype>
 
67
        </funcsynopsis>
 
68
 
 
69
        <funcsynopsis>
 
70
            <funcprototype>
 
71
                <funcdef>
 
72
                    <link xlink:href="scalarDataTypes.html">void</link>
 
73
                    <function>
 
74
                        vstore<replaceable>n</replaceable>
 
75
                    </function>
 
76
                </funcdef>
 
77
                <paramdef>gentype<replaceable>n</replaceable><parameter>data</parameter></paramdef>
 
78
                <paramdef><link xlink:href="scalarDataTypes.html">size_t</link><parameter>offset</parameter></paramdef>
 
79
                <paramdef><link xlink:href="local.html">__local</link> gentype<parameter>*p</parameter></paramdef>
 
80
            </funcprototype>
 
81
        </funcsynopsis>
 
82
 
 
83
        <funcsynopsis>
 
84
            <funcprototype>
 
85
                <funcdef>
 
86
                    <link xlink:href="scalarDataTypes.html">void</link>
 
87
                    <function>
 
88
                        vstore<replaceable>n</replaceable>
 
89
                    </function>
 
90
                </funcdef>
 
91
                <paramdef>gentype<replaceable>n</replaceable><parameter>data</parameter></paramdef>
 
92
                <paramdef><link xlink:href="scalarDataTypes.html">size_t</link><parameter>offset</parameter></paramdef>
 
93
                <paramdef><link xlink:href="private.html">__private</link> gentype<parameter>*p</parameter></paramdef>
 
94
            </funcprototype>
 
95
        </funcsynopsis>
 
96
    </refsynopsisdiv>
 
97
 
 
98
<!-- ================================ DESCRIPTION  -->
 
99
 
 
100
    <refsect1 id="description"><title>Description</title>
 
101
      <para>
 
102
        Write <constant>sizeof(<type>gentype<replaceable>n</replaceable></type>)</constant>
 
103
        bytes given by <varname>data</varname> to address (<varname>p</varname> +
 
104
        (<varname>offset</varname> * <varname>n</varname>)).  The address computed as
 
105
        (<varname>p</varname> + (<varname>offset</varname> * <varname>n</varname>)) must be
 
106
        8-bit aligned if <type>gentype</type> is <type>char</type> or <type>uchar</type>;
 
107
        16-bit aligned if <type>gentype</type> is <type>short</type>, <type>ushort</type>,
 
108
        or <type>half</type>; 32-bit aligned if <type>gentype</type> is <type>int</type>,
 
109
        <type>uint</type>, or <type>float</type>; 64-bit aligned if <type>gentype</type> is
 
110
        <type>long</type> or  <type>ulong</type>.
 
111
      </para>
 
112
    </refsect1>
 
113
 
 
114
<!-- ================================ NOTES  -->
 
115
 
 
116
     <refsect1 id="notes"><title>Notes</title>
 
117
 
 
118
        &vectorFunctionsInc;
 
119
 
 
120
        &vectorHalfFunctionsInc;
 
121
 
 
122
        <para>
 
123
          <function>vstore3</function>, and <function>vstore_half3</function> write
 
124
          <varname>x</varname>, <varname>y</varname>, <varname>z</varname> components from a
 
125
          3-component vector to address (<varname>p</varname> + (<varname>offset</varname> * 3)).
 
126
        </para>
 
127
    </refsect1>
 
128
 
 
129
<!-- ================================ EXAMPLE  -->
 
130
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
131
<!--
 
132
    <refsect2 id="example1">
 
133
        <title>
 
134
            Example
 
135
        </title>
 
136
 
 
137
        <informaltable frame="none">
 
138
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
139
                <colspec colname="col1" colnum="1" />
 
140
                <tbody>
 
141
                    <row>
 
142
                        <entry>
 
143
                            Example goes here - it will be set in "code" type with white space preserved.
 
144
                        </entry>
 
145
                    </row>
 
146
                </tbody>
 
147
            </tgroup>
 
148
        </informaltable>
 
149
    </refsect2>
 
150
-->
 
151
 
 
152
<!-- ================================ SPECIFICATION  -->
 
153
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
154
-->
 
155
    <refsect1 id="specification"><title>Specification</title>
 
156
        <para>
 
157
            <imageobject>
 
158
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
159
            </imageobject>
 
160
 
 
161
            <olink uri="vectorDataLoadandStoreFunctions">OpenCL Specification</olink>
 
162
        </para>
 
163
    </refsect1>
 
164
 
 
165
<!-- ================================ ALSO SEE  -->
 
166
 
 
167
    <refsect1 id="seealso"><title>Also see</title>
 
168
        <para>
 
169
            <citerefentry href="vectorDataLoadandStoreFunctions"><refentrytitle>Vector Data Load and Store Functions</refentrytitle></citerefentry>
 
170
        </para>
 
171
    </refsect1>
 
172
 
 
173
<!-- ============================== COPYRIGHT -->
 
174
<!-- Content included from copyright.inc.xsl -->
 
175
 
 
176
    <refsect3 id="Copyright"><title></title>
 
177
        <imageobject>
 
178
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
179
        </imageobject>
 
180
        <para />
 
181
    </refsect3>
 
182
 
 
183
<!-- 12-Oct-2011 -->
 
184
</refentry>
 
185