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

« back to all changes in this revision

Viewing changes to get_image_array_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:
 
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
<refentry>
 
5
    <refentryinfo>
 
6
        <keywordset>
 
7
            <keyword>get_image_array_size</keyword>
 
8
        </keywordset>
 
9
    </refentryinfo>
 
10
 
 
11
    <refmeta>                                    
 
12
        <refentrytitle>get_image_array_size</refentrytitle>
 
13
 
 
14
        <refmiscinfo>
 
15
            <copyright>
 
16
                <year>2007-2011</year>
 
17
                <holder>The Khronos Group Inc. 
 
18
 Permission is hereby granted, free of charge, to any person obtaining a
 
19
copy of this software and/or associated documentation files (the
 
20
"Materials"), to deal in the Materials without restriction, including
 
21
without limitation the rights to use, copy, modify, merge, publish,
 
22
distribute, sublicense, and/or sell copies of the Materials, and to
 
23
permit persons to whom the Materials are furnished to do so, subject to
 
24
the condition that this copyright notice and permission notice shall be included
 
25
in all copies or substantial portions of the Materials.</holder>
 
26
            </copyright>
 
27
        </refmiscinfo>
 
28
        <manvolnum>3</manvolnum>
 
29
    </refmeta>
 
30
 
 
31
<!-- ================================ SYNOPSIS -->
 
32
 
 
33
    <refnamediv id="get_image_dim">             
 
34
        <refname>get_image_array_size</refname>
 
35
 
 
36
        <refpurpose> 
 
37
            Return the number of images in an image array. 
 
38
        </refpurpose>
 
39
    </refnamediv>
 
40
 
 
41
    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
 
42
        
 
43
        <funcsynopsis>
 
44
            <funcprototype>
 
45
                <funcdef>
 
46
                    <link xlink:href="scalarDataTypes.html">size_t</link>
 
47
                    <function>                   
 
48
                        get_image_array_size
 
49
                    </function>
 
50
                </funcdef>
 
51
                <paramdef>
 
52
                    <link xlink:href="otherDataTypes.html">image2d_array_t</link>
 
53
                    <parameter>image</parameter>
 
54
               </paramdef>    
 
55
            </funcprototype>
 
56
        </funcsynopsis>     
 
57
        <funcsynopsis>
 
58
            <funcprototype>
 
59
                <funcdef>
 
60
                    <link xlink:href="scalarDataTypes.html">size_t</link>
 
61
                    <function>                   
 
62
                        get_image_array_size
 
63
                    </function>
 
64
                </funcdef>
 
65
                <paramdef>
 
66
                    <link xlink:href="otherDataTypes.html">image1d_array_t</link>
 
67
                    <parameter>image</parameter>
 
68
               </paramdef>    
 
69
            </funcprototype>
 
70
        </funcsynopsis>    
 
71
    </refsynopsisdiv>       
 
72
 
 
73
<!-- ================================ DESCRIPTION  -->
 
74
 
 
75
    <refsect1 id="description"><title>Description</title>
 
76
        <para>
 
77
            <function>get_image_array_size</function> with 
 
78
            <citerefentry href="otherDataTypes"><refentrytitle>image2d_t</refentrytitle></citerefentry> 
 
79
            returns the number of images in a 2D image array.
 
80
        </para>
 
81
        <para>
 
82
        <function>get_image_array_size</function> with 
 
83
            <citerefentry href="otherDataTypes"><refentrytitle>image1d_t</refentrytitle></citerefentry> 
 
84
            returns the number of images in a 1D image array.
 
85
        </para>
 
86
    </refsect1>
 
87
 
 
88
 
 
89
 
 
90
 
 
91
<!-- ================================ SPECIFICATION  -->
 
92
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
93
-->
 
94
    <refsect1 id="specification"><title>Specification</title>
 
95
        <para>
 
96
            <imageobject>
 
97
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
98
            </imageobject>
 
99
                                                 
 
100
            <olink uri="imageFunctions">OpenCL Specification</olink>
 
101
        </para>
 
102
    </refsect1>
 
103
 
 
104
 
 
105
<!-- ================================ ALSO SEE  -->
 
106
 
 
107
    <refsect1 id="seealso"><title>Also see</title>
 
108
        <para>
 
109
            <citerefentry href="imageFunctions"><refentrytitle>Image Functions</refentrytitle></citerefentry> 
 
110
        </para>
 
111
    </refsect1>
 
112
 
 
113
 
 
114
 
 
115
<!-- ============================== COPYRIGHT -->
 
116
<!-- Content included from copyright.inc.xsl -->
 
117
 
 
118
    <refsect3 id="Copyright"><title></title>
 
119
        <imageobject>
 
120
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
121
        </imageobject>
 
122
        <para />
 
123
    </refsect3>
 
124
<!-- 14-Oct-11 -->
 
125
</refentry>
 
126