← Back to branch summary

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

« back to all changes in this revision

Viewing changes to get_global_size.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:
get_global_size.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>get_global_size</keyword>
 
9
        </keywordset>
 
10
    </refentryinfo>
 
11
 
 
12
    <refmeta>
 
13
        <refentrytitle>get_global_size</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="get_global_size">
 
35
        <refname>get_global_size</refname>
 
36
 
 
37
        <refpurpose>
 
38
            Returns the number of global work-items specified for dimension identified by <varname>dimindx</varname>.
 
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">size_t</link>
 
47
                    <function>
 
48
                        get_global_size
 
49
                    </function>
 
50
                </funcdef>
 
51
                <paramdef><link xlink:href="scalarDataTypes.html">uint</link><parameter>dimindx</parameter></paramdef>
 
52
            </funcprototype>
 
53
        </funcsynopsis>
 
54
    </refsynopsisdiv>
 
55
 
 
56
<!-- ================================ DESCRIPTION  -->
 
57
 
 
58
    <refsect1 id="description"><title>Description</title>
 
59
        <para>
 
60
          This value is given by the <varname>global_work_size</varname> argument to
 
61
          <citerefentry><refentrytitle>clEnqueueNDRangeKernel</refentrytitle></citerefentry>. Valid
 
62
          values of <varname>dimindx</varname> are 0 to
 
63
          <citerefentry><refentrytitle>get_work_dim</refentrytitle></citerefentry>() - 1. For
 
64
          other values of <varname>dimindx</varname>, <function>get_global_size</function>()
 
65
          returns 1.
 
66
        </para>
 
67
 
 
68
        <para>
 
69
          For <citerefentry><refentrytitle>clEnqueueTask</refentrytitle></citerefentry>, this
 
70
          always returns 1.
 
71
        </para>
 
72
    </refsect1>
 
73
 
 
74
<!-- ================================ EXAMPLE  -->
 
75
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
76
<!--
 
77
    <refsect2 id="example1">
 
78
        <title>
 
79
            Example
 
80
        </title>
 
81
 
 
82
        <informaltable frame="none">
 
83
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
84
                <colspec colname="col1" colnum="1" />
 
85
                <tbody>
 
86
                    <row>
 
87
                        <entry>
 
88
                            Example goes here - it will be set in "code" type with white space preserved.
 
89
                        </entry>
 
90
                    </row>
 
91
                </tbody>
 
92
            </tgroup>
 
93
        </informaltable>
 
94
    </refsect2>
 
95
-->
 
96
 
 
97
<!-- ================================ SPECIFICATION  -->
 
98
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
99
-->
 
100
    <refsect1 id="specification"><title>Specification</title>
 
101
        <para>
 
102
            <imageobject>
 
103
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
104
            </imageobject>
 
105
 
 
106
            <olink uri="workItemFunctions">OpenCL Specification</olink>
 
107
        </para>
 
108
    </refsect1>
 
109
 
 
110
<!-- ================================ ALSO SEE  -->
 
111
 
 
112
    <refsect1 id="seealso"><title>Also see</title>
 
113
        <para>
 
114
            <citerefentry href="workItemFunctions"><refentrytitle>Work-Item Functions</refentrytitle></citerefentry>,
 
115
            <citerefentry><refentrytitle>clEnqueueNDRangeKernel</refentrytitle></citerefentry>,
 
116
            <citerefentry><refentrytitle>clEnqueueTask</refentrytitle></citerefentry>
 
117
        </para>
 
118
    </refsect1>
 
119
 
 
120
<!-- ============================== COPYRIGHT -->
 
121
<!-- Content included from copyright.inc.xsl -->
 
122
 
 
123
    <refsect3 id="Copyright"><title></title>
 
124
        <imageobject>
 
125
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
126
        </imageobject>
 
127
        <para />
 
128
    </refsect3>
 
129
 
 
130
<!-- 17-Oct-2011 -->
 
131
</refentry>
 
132