Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
4 | <refentry id="imageSize">\r | |
5 | <refmeta>\r | |
6 | <refmetainfo>\r | |
7 | <copyright>\r | |
8 | <year>2012</year>\r | |
9 | <holder>Khronos Group</holder>\r | |
10 | </copyright>\r | |
11 | </refmetainfo>\r | |
12 | <refentrytitle>imageSize</refentrytitle>\r | |
13 | <manvolnum>3G</manvolnum>\r | |
14 | </refmeta>\r | |
15 | <refnamediv>\r | |
16 | <refname>imageSize</refname>\r | |
17 | <refpurpose>retrieve the dimensions of an image</refpurpose>\r | |
18 | </refnamediv>\r | |
19 | <refsynopsisdiv><title>Declaration</title>\r | |
20 | <funcsynopsis>\r | |
21 | <funcprototype>\r | |
22 | <funcdef>int <function>imageSize</function></funcdef>\r | |
23 | <paramdef>gimage1D <parameter>image</parameter></paramdef>\r | |
24 | </funcprototype>\r | |
25 | <funcprototype>\r | |
26 | <funcdef>ivec2 <function>imageSize</function></funcdef>\r | |
27 | <paramdef>gimage2D <parameter>image</parameter></paramdef>\r | |
28 | </funcprototype>\r | |
29 | <funcprototype>\r | |
30 | <funcdef>ivec3 <function>imageSize</function></funcdef>\r | |
31 | <paramdef>gimage3D <parameter>image</parameter></paramdef>\r | |
32 | </funcprototype>\r | |
33 | <funcprototype>\r | |
34 | <funcdef>ivec2 <function>imageSize</function></funcdef>\r | |
35 | <paramdef>gimageCube <parameter>image</parameter></paramdef>\r | |
36 | </funcprototype>\r | |
37 | <funcprototype>\r | |
38 | <funcdef>ivec3 <function>imageSize</function></funcdef>\r | |
39 | <paramdef>gimageCubeArray <parameter>image</parameter></paramdef>\r | |
40 | </funcprototype>\r | |
41 | <funcprototype>\r | |
42 | <funcdef>ivec2 <function>imageSize</function></funcdef>\r | |
43 | <paramdef>gimageRect <parameter>image</parameter></paramdef>\r | |
44 | </funcprototype>\r | |
45 | <funcprototype>\r | |
46 | <funcdef>ivec2 <function>imageSize</function></funcdef>\r | |
47 | <paramdef>gimage1DArray <parameter>image</parameter></paramdef>\r | |
48 | </funcprototype>\r | |
49 | <funcprototype>\r | |
50 | <funcdef>ivec3 <function>imageSize</function></funcdef>\r | |
51 | <paramdef>gimage2DArray <parameter>image</parameter></paramdef>\r | |
52 | </funcprototype>\r | |
53 | <funcprototype>\r | |
54 | <funcdef>int <function>imageSize</function></funcdef>\r | |
55 | <paramdef>gimageBuffer <parameter>image</parameter></paramdef>\r | |
56 | </funcprototype>\r | |
57 | <funcprototype>\r | |
58 | <funcdef>ivec2 <function>imageSize</function></funcdef>\r | |
59 | <paramdef>gimage2DMS <parameter>image</parameter></paramdef>\r | |
60 | </funcprototype>\r | |
61 | <funcprototype>\r | |
62 | <funcdef>ivec3 <function>imageSize</function></funcdef>\r | |
63 | <paramdef>gimage2DMSArray <parameter>image</parameter></paramdef>\r | |
64 | </funcprototype>\r | |
65 | </funcsynopsis>\r | |
66 | </refsynopsisdiv>\r | |
67 | <refsect1 id="parameters"><title>Parameters</title>\r | |
68 | <variablelist>\r | |
69 | <varlistentry>\r | |
70 | <term><parameter>image</parameter></term>\r | |
71 | <listitem>\r | |
72 | <para>\r | |
73 | Specifies the image to which the texture whose dimensions to retrieve is bound.\r | |
74 | </para>\r | |
75 | </listitem>\r | |
76 | </varlistentry>\r | |
77 | </variablelist>\r | |
78 | </refsect1>\r | |
79 | <refsect1 id="description"><title>Description</title>\r | |
80 | <para>\r | |
81 | <function>imageSize</function> returns the dimensions of the image bound to <parameter>image</parameter>.\r | |
82 | The components in the return value are filled in,\r | |
83 | in order, with the width, height and depth of the image. For the array forms, the last component of the\r | |
84 | return value is the number of layers in the texture array.\r | |
85 | </para>\r | |
86 | </refsect1>\r | |
87 | <refsect1 id="versions"><title>Version Support</title>\r | |
88 | <informaltable frame="topbot">\r | |
89 | #VARTABLECOLS#\r | |
90 | <thead>\r | |
91 | #FUNCTABLEHEADER#\r | |
92 | <row>\r | |
93 | <entry>imageSize</entry>#newin43#\r | |
94 | </row>\r | |
95 | </thead>\r | |
96 | </tgroup>\r | |
97 | </informaltable>\r | |
98 | </refsect1>\r | |
99 | <refsect1 id="seealso"><title>See Also</title>\r | |
100 | <para>\r | |
101 | <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>,\r | |
102 | <citerefentry><refentrytitle>imageLoad</refentrytitle></citerefentry>,\r | |
103 | <citerefentry><refentrytitle>imageStore</refentrytitle></citerefentry>\r | |
104 | </para>\r | |
105 | </refsect1>\r | |
106 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
107 | <para>\r | |
108 | Copyright <trademark class="copyright"></trademark> 2011-2012 Khronos Group.\r | |
109 | This material may be distributed subject to the terms and conditions set forth in\r | |
110 | the Open Publication License, v 1.0, 8 June 1999.\r | |
111 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
112 | </para>\r | |
113 | </refsect1>\r | |
114 | </refentry>\r |