rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / textureQueryLevels.xml
CommitLineData
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="textureQueryLevels">\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>textureQueryLevels</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>textureQueryLevels</refname>\r
17 <refpurpose>compute the number of accessible mipmap levels of a texture</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>Declaration</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
23 <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
24 </funcprototype>\r
25 <funcprototype>\r
26 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
27 <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
28 </funcprototype>\r
29 <funcprototype>\r
30 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
31 <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>\r
32 </funcprototype>\r
33 <funcprototype>\r
34 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
35 <paramdef>gsamplerCube <parameter>sampler</parameter></paramdef>\r
36 </funcprototype>\r
37 <funcprototype>\r
38 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
39 <paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>\r
40 </funcprototype>\r
41 <funcprototype>\r
42 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
43 <paramdef>gsampler2DDArray <parameter>sampler</parameter></paramdef>\r
44 </funcprototype>\r
45 <funcprototype>\r
46 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
47 <paramdef>gsamplerCubeArray <parameter>sampler</parameter></paramdef>\r
48 </funcprototype>\r
49 <funcprototype>\r
50 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
51 <paramdef>gsampler1DShadow <parameter>sampler</parameter></paramdef>\r
52 </funcprototype>\r
53 <funcprototype>\r
54 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
55 <paramdef>gsampler2DShadow <parameter>sampler</parameter></paramdef>\r
56 </funcprototype>\r
57 <funcprototype>\r
58 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
59 <paramdef>gsamplerCubeShadow <parameter>sampler</parameter></paramdef>\r
60 </funcprototype>\r
61 <funcprototype>\r
62 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
63 <paramdef>gsampler1DArrayShadow <parameter>sampler</parameter></paramdef>\r
64 </funcprototype>\r
65 <funcprototype>\r
66 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
67 <paramdef>gsampler2DArrayShadow <parameter>sampler</parameter></paramdef>\r
68 </funcprototype>\r
69 <funcprototype>\r
70 <funcdef>vec2 <function>textureQueryLevels</function></funcdef>\r
71 <paramdef>gsamplerCubeArrayShadow <parameter>sampler</parameter></paramdef>\r
72 </funcprototype>\r
73 </funcsynopsis>\r
74 </refsynopsisdiv>\r
75 <refsect1 id="parameters"><title>Parameters</title>\r
76 <variablelist>\r
77 <varlistentry>\r
78 <term><parameter>sampler</parameter></term>\r
79 <listitem>\r
80 <para>\r
81 Specifies the sampler to which the texture whose mipmap level count will be queried is bound.\r
82 </para>\r
83 </listitem>\r
84 </varlistentry>\r
85 </variablelist>\r
86 </refsect1>\r
87 <refsect1 id="description"><title>Description</title>\r
88 <para>\r
89 <function>textureQueryLevels</function> returns the number of accessible mipmap levels\r
90 are in the texture associated with <parameter>sampler</parameter>.\r
91 </para>\r
92 <para>\r
93 If called on an incomplete texture, or if no texture is associated with <parameter>sampler</parameter>, zero is returned.\r
94 </para>\r
95 </refsect1>\r
96 <refsect1 id="versions"><title>Version Support</title>\r
97 <informaltable frame="topbot">\r
98 #VARTABLECOLS#\r
99 <thead>\r
100 #FUNCTABLEHEADER#\r
101 <row>\r
102 <entry>textureQueryLevels</entry>#newin43#\r
103 </row>\r
104 </thead>\r
105 </tgroup>\r
106 </informaltable>\r
107 </refsect1>\r
108 <refsect1 id="seealso"><title>See Also</title>\r
109 <para>\r
110 <citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,\r
111 <citerefentry><refentrytitle>texelFetchOffset</refentrytitle></citerefentry>,\r
112 <citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,\r
113 <citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,\r
114 <citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,\r
115 <citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,\r
116 <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,\r
117 <citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,\r
118 <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,\r
119 <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,\r
120 <citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,\r
121 <citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,\r
122 <citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,\r
123 <citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,\r
124 <citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,\r
125 <citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,\r
126 <citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,\r
127 <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>\r
128 </para>\r
129 </refsect1>\r
130 <refsect1 id="Copyright"><title>Copyright</title>\r
131 <para>\r
132 Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r
133 This material may be distributed subject to the terms and conditions set forth in \r
134 the Open Publication License, v 1.0, 8 June 1999.\r
135 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
136 </para>\r
137 </refsect1>\r
138</refentry>\r