upstream-man-pages/manglsl/textureSize.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="textureSize">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>textureSize</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>textureSize</refname>
  17         <refpurpose>retrieve the dimensions of a level of a texture</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>int <function>textureSize</function></funcdef>
  23                 <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>
  24                 <paramdef>int <parameter>lod</parameter></paramdef>
  25             </funcprototype>
  26             <funcprototype>
  27                 <funcdef>ivec2 <function>textureSize</function></funcdef>
  28                 <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>
  29                 <paramdef>int <parameter>lod</parameter></paramdef>
  30             </funcprototype>
  31             <funcprototype>
  32                 <funcdef>ivec3 <function>textureSize</function></funcdef>
  33                 <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>
  34                 <paramdef>int <parameter>lod</parameter></paramdef>
  35             </funcprototype>
  36             <funcprototype>
  37                 <funcdef>ivec2 <function>textureSize</function></funcdef>
  38                 <paramdef>gsamplerCube <parameter>sampler</parameter></paramdef>
  39                 <paramdef>int <parameter>lod</parameter></paramdef>
  40             </funcprototype>
  41             <funcprototype>
  42                 <funcdef>int <function>textureSize</function></funcdef>
  43                 <paramdef>sampler1DShadow <parameter>sampler</parameter></paramdef>
  44                 <paramdef>int <parameter>lod</parameter></paramdef>
  45             </funcprototype>
  46             <funcprototype>
  47                 <funcdef>ivec2 <function>textureSize</function></funcdef>
  48                 <paramdef>sampler2DShadow <parameter>sampler</parameter></paramdef>
  49                 <paramdef>int <parameter>lod</parameter></paramdef>
  50             </funcprototype>
  51             <funcprototype>
  52                 <funcdef>ivec2 <function>textureSize</function></funcdef>
  53                 <paramdef>samplerCubeShadow <parameter>sampler</parameter></paramdef>
  54                 <paramdef>int <parameter>lod</parameter></paramdef>
  55             </funcprototype>
  56             <funcprototype>
  57                 <funcdef>ivec3 <function>textureSize</function></funcdef>
  58                 <paramdef>samplerCubeArray <parameter>sampler</parameter></paramdef>
  59                 <paramdef>int <parameter>lod</parameter></paramdef>
  60             </funcprototype>
  61             <funcprototype>
  62                 <funcdef>ivec3 <function>textureSize</function></funcdef>
  63                 <paramdef>samplerCubeArrayShadow <parameter>sampler</parameter></paramdef>
  64                 <paramdef>int <parameter>lod</parameter></paramdef>
  65             </funcprototype>
  66             <funcprototype>
  67                 <funcdef>ivec2 <function>textureSize</function></funcdef>
  68                 <paramdef>gsamplerRect <parameter>sampler</parameter></paramdef>
  69             </funcprototype>
  70             <funcprototype>
  71                 <funcdef>ivec2 <function>textureSize</function></funcdef>
  72                 <paramdef>gsamplerRectShadow <parameter>sampler</parameter></paramdef>
  73             </funcprototype>
  74             <funcprototype>
  75                 <funcdef>ivec2 <function>textureSize</function></funcdef>
  76                 <paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>
  77                 <paramdef>int <parameter>lod</parameter></paramdef>
  78             </funcprototype>
  79             <funcprototype>
  80                 <funcdef>ivec3 <function>textureSize</function></funcdef>
  81                 <paramdef>gsampler2DArray <parameter>sampler</parameter></paramdef>
  82                 <paramdef>int <parameter>lod</parameter></paramdef>
  83             </funcprototype>            <funcprototype>
  84                 <funcdef>ivec2 <function>textureSize</function></funcdef>
  85                 <paramdef>sampler1DArrayShadow <parameter>sampler</parameter></paramdef>
  86                 <paramdef>int <parameter>lod</parameter></paramdef>
  87             </funcprototype>
  88             <funcprototype>
  89                 <funcdef>ivec3 <function>textureSize</function></funcdef>
  90                 <paramdef>sampler2DArrayShadow <parameter>sampler</parameter></paramdef>
  91                 <paramdef>int <parameter>lod</parameter></paramdef>
  92             </funcprototype>
  93             <funcprototype>
  94                 <funcdef>int <function>textureSize</function></funcdef>
  95                 <paramdef>gsamplerBuffer <parameter>sampler</parameter></paramdef>
  96             </funcprototype>
  97             <funcprototype>
  98                 <funcdef>ivec2 <function>textureSize</function></funcdef>
  99                 <paramdef>gsampler2DMS <parameter>sampler</parameter></paramdef>
 100             </funcprototype>
 101             <funcprototype>
 102                 <funcdef>ivec3 <function>textureSize</function></funcdef>
 103                 <paramdef>gsampler2DMSArray <parameter>sampler</parameter></paramdef>
 104             </funcprototype>
 105         </funcsynopsis>
 106     </refsynopsisdiv>
 107     <refsect1 id="parameters"><title>Parameters</title>
 108         <variablelist>
 109         <varlistentry>
 110             <term><parameter>sampler</parameter></term>
 111             <listitem>
 112                 <para>
 113                     Specifies the sampler to which the texture whose dimensions to retrieve is bound.
 114                 </para>
 115             </listitem>
 116         </varlistentry>
 117         <varlistentry>
 118             <term><parameter>lod</parameter></term>
 119             <listitem>
 120                 <para>
 121                     Specifies the level of the texture for which to retrieve the dimensions.
 122                 </para>
 123             </listitem>
 124         </varlistentry>
 125         </variablelist>
 126     </refsect1>
 127     <refsect1 id="description"><title>Description</title>
 128         <para>
 129             <function>textureSize</function> returns the dimensions of level <parameter>lod</parameter> (if present)
 130             of the texture bound to <parameter>sampler</parameter>. The components in the return value are filled in,
 131             in order, with the width, height and depth of the texture. For the array forms, the last component of the
 132             return value is the number of layers in the texture array.
 133         </para>
 134     </refsect1>
 135     <refsect1 id="versions"><title>Version Support</title>
 136         <informaltable frame="topbot">
 137             #VARTABLECOLS#
 138                 <thead>
 139                     #FUNCTABLEHEADER#
 140                     <row>
 141                         <entry>textureSize</entry>#newin13#
 142                     </row>
 143                     <row>
 144                         <entry>textureSize (samplerBuffer, samplerRect{Shadow})</entry>#newin14#
 145                     </row>
 146                     <row>
 147                         <entry>textureSize (samplerCube{Shadow})</entry>#newin40#
 148                     </row>
 149                 </thead>
 150             </tgroup>
 151         </informaltable>
 152     </refsect1>
 153     <refsect1 id="seealso"><title>See Also</title>
 154         <para>
 155             <citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,
 156             <citerefentry><refentrytitle>texelFetchOffset</refentrytitle></citerefentry>,
 157             <citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,
 158             <citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,
 159             <citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,
 160             <citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,
 161             <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,
 162             <citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,
 163             <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,
 164             <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,
 165             <citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,
 166             <citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,
 167             <citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,
 168             <citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,
 169             <citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,
 170             <citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,
 171             <citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,
 172             <citerefentry><refentrytitle>textureQueryLod</refentrytitle></citerefentry>
 173         </para>
 174     </refsect1>
 175     <refsect1 id="Copyright"><title>Copyright</title>
 176         <para>
 177             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 178             This material may be distributed subject to the terms and conditions set forth in
 179             the Open Publication License, v 1.0, 8 June 1999.
 180             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 181         </para>
 182     </refsect1>
 183 </refentry>