f273b5e1c7246058da19958ff3303662b17beef9
[clinton/guile-figl.git] / upstream-man-pages / manglsl / xhtml / textureQueryLevels.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3 <!-- saved from url=(0013)about:internet -->
4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>textureQueryLevels - OpenGL Shading Language (GLSL)</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="textureQueryLevels"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>textureQueryLevels — compute the number of accessible mipmap levels of a texture</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsampler1D  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsampler2D  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsampler3D  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsamplerCube  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsampler1DArray  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsampler2DDArray  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsamplerCubeArray  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsampler1DShadow  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsampler2DShadow  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsamplerCubeShadow  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsampler1DArrayShadow  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsampler2DArrayShadow  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">vec2 <b class="fsfunc">textureQueryLevels</b>(</code></td><td>gsamplerCubeArrayShadow  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sampler</code></em></span></dt><dd><p>
5 Specifies the sampler to which the texture whose mipmap level count will be queried is bound.
6 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
7 <code class="function">textureQueryLevels</code> returns the number of accessible mipmap levels
8 are in the texture associated with <em class="parameter"><code>sampler</code></em>.
9 </p><p>
10 If called on an incomplete texture, or if no texture is associated with <em class="parameter"><code>sampler</code></em>, zero is returned.
11 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="versions"></a><h2>Version Support</h2><div class="informaltable"><table border="1"><colgroup><col align="left" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /></colgroup><thead><tr><th align="left"><span class="bold"><strong>Function</strong></span></th><th align="left"><span class="bold"><strong>Version 1.10</strong></span></th><th align="left"><span class="bold"><strong>Version 1.20</strong></span></th><th align="left"><span class="bold"><strong>Version 1.30</strong></span></th><th align="left"><span class="bold"><strong>Version 1.40</strong></span></th><th align="left"><span class="bold"><strong>Version 1.50</strong></span></th><th align="left"><span class="bold"><strong>Version 3.30</strong></span></th><th align="left"><span class="bold"><strong>Version 4.00</strong></span></th><th align="left"><span class="bold"><strong>Version 4.10</strong></span></th><th align="left"><span class="bold"><strong>Version 4.20</strong></span></th><th align="center"><span class="bold"><strong>Version 4.30</strong></span></th></tr><tr><th align="left">textureQueryLevels</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr></thead></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
12 <a href="texelFetch.xml"><span class="citerefentry"><span class="refentrytitle">texelFetch</span></span></a>,
13 <a href="texelFetchOffset.xml"><span class="citerefentry"><span class="refentrytitle">texelFetchOffset</span></span></a>,
14 <a href="texture.xml"><span class="citerefentry"><span class="refentrytitle">texture</span></span></a>,
15 <a href="textureGather.xml"><span class="citerefentry"><span class="refentrytitle">textureGather</span></span></a>,
16 <a href="textureGatherOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureGatherOffset</span></span></a>,
17 <a href="textureGatherOffsets.xml"><span class="citerefentry"><span class="refentrytitle">textureGatherOffsets</span></span></a>,
18 <a href="textureGrad.xml"><span class="citerefentry"><span class="refentrytitle">textureGrad</span></span></a>,
19 <a href="textureGradOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureGradOffset</span></span></a>,
20 <a href="textureLod.xml"><span class="citerefentry"><span class="refentrytitle">textureLod</span></span></a>,
21 <a href="textureLodOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureLodOffset</span></span></a>,
22 <a href="textureOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureOffset</span></span></a>,
23 <a href="textureProj.xml"><span class="citerefentry"><span class="refentrytitle">textureProj</span></span></a>,
24 <a href="textureProjGrad.xml"><span class="citerefentry"><span class="refentrytitle">textureProjGrad</span></span></a>,
25 <a href="textureProjGradOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjGradOffset</span></span></a>,
26 <a href="textureProjLod.xml"><span class="citerefentry"><span class="refentrytitle">textureProjLod</span></span></a>,
27 <a href="textureProjLodOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjLodOffset</span></span></a>,
28 <a href="textureProjOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjOffset</span></span></a>,
29 <a href="textureSize.xml"><span class="citerefentry"><span class="refentrytitle">textureSize</span></span></a>
30 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
31 Copyright <span class="trademark"></span>© 2012 Khronos Group.
32 This material may be distributed subject to the terms and conditions set forth in
33 the Open Publication License, v 1.0, 8 June 1999.
34 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
35 </p></div></div></body></html>