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