File: textureQueryLevels.xml

package info (click to toggle)
khronos-opengl-man4 1.0~svn31251-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 6,368 kB
  • ctags: 267
  • sloc: xml: 93,382; makefile: 730; python: 627; sh: 50; php: 4
file content (140 lines) | stat: -rw-r--r-- 7,320 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="textureQueryLevels">
    <info>
        <copyright>
            <year>2012-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>textureQueryLevels</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>textureQueryLevels</refname>
        <refpurpose>compute the number of accessible mipmap levels of a texture</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>Declaration</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsamplerCube <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsampler2DDArray <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsamplerCubeArray <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsampler1DShadow <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsampler2DShadow <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsamplerCubeShadow <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsampler1DArrayShadow <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsampler2DArrayShadow <parameter>sampler</parameter></paramdef>
            </funcprototype>
            <funcprototype>
                <funcdef>int <function>textureQueryLevels</function></funcdef>
                <paramdef>gsamplerCubeArrayShadow <parameter>sampler</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>sampler</parameter></term>
            <listitem>
                <para>
                    Specifies the sampler to which the texture whose mipmap level count will be queried is bound.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            <function>textureQueryLevels</function> returns the number of accessible mipmap levels
            in the texture associated with <parameter>sampler</parameter>.
        </para>
        <para>
            If called on an incomplete texture, or if no texture is associated with <parameter>sampler</parameter>, zero is returned.
        </para>
    </refsect1>
    <refsect1 xml:id="versions"><title>Version Support</title>
        <informaltable>
            <tgroup cols="13" align="left">
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="funchead.xml" xpointer="xpointer(/*/*)"/>
                <tbody>
                    <row>
                        <entry>textureQueryLevels</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='43']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>texelFetchOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 2012-2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
        </para>
    </refsect1>
</refentry>