rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / xhtml / textureSize.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>textureSize - 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="textureSize"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>textureSize — retrieve the dimensions of a level of a texture</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><p><code class="funcdef">int <b class="fsfunc">textureSize</b>(</code>gsampler1D <var class="pdparam">sampler</var>, int <var class="pdparam">lod</var><code>)</code>;</p><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">ivec2 <b class="fsfunc">textureSize</b>(</code></td><td>gsampler2D  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</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">ivec3 <b class="fsfunc">textureSize</b>(</code></td><td>gsampler3D  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</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">ivec2 <b class="fsfunc">textureSize</b>(</code></td><td>gsamplerCube  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</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">int <b class="fsfunc">textureSize</b>(</code></td><td>sampler1DShadow  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</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">ivec2 <b class="fsfunc">textureSize</b>(</code></td><td>sampler2DShadow  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</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">ivec2 <b class="fsfunc">textureSize</b>(</code></td><td>samplerCubeShadow  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</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">ivec3 <b class="fsfunc">textureSize</b>(</code></td><td>samplerCubeArray  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</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">ivec3 <b class="fsfunc">textureSize</b>(</code></td><td>samplerCubeArrayShadow  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</var><code>)</code>;</td></tr></table><p><code class="funcdef">ivec2 <b class="fsfunc">textureSize</b>(</code>gsamplerRect <var class="pdparam">sampler</var><code>)</code>;</p><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">ivec2 <b class="fsfunc">textureSize</b>(</code></td><td>gsamplerRectShadow  </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">ivec2 <b class="fsfunc">textureSize</b>(</code></td><td>gsampler1DArray  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</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">ivec3 <b class="fsfunc">textureSize</b>(</code></td><td>gsampler2DArray  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</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">ivec2 <b class="fsfunc">textureSize</b>(</code></td><td>sampler1DArrayShadow  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</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">ivec3 <b class="fsfunc">textureSize</b>(</code></td><td>sampler2DArrayShadow  </td><td><var class="pdparam">sampler</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">lod</var><code>)</code>;</td></tr></table><p><code class="funcdef">int <b class="fsfunc">textureSize</b>(</code>gsamplerBuffer <var class="pdparam">sampler</var><code>)</code>;</p><p><code class="funcdef">ivec2 <b class="fsfunc">textureSize</b>(</code>gsampler2DMS <var class="pdparam">sampler</var><code>)</code>;</p><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">ivec3 <b class="fsfunc">textureSize</b>(</code></td><td>gsampler2DMSArray  </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 dimensions to retrieve is bound.
6 </p></dd><dt><span class="term"><em class="parameter"><code>lod</code></em></span></dt><dd><p>
7 Specifies the level of the texture for which to retrieve the dimensions.
8 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
9 <code class="function">textureSize</code> returns the dimensions of level <em class="parameter"><code>lod</code></em> (if present)
10 of the texture bound to <em class="parameter"><code>sampler</code></em>. The components in the return value are filled in,
11 in order, with the width, height and depth of the texture. For the array forms, the last component of the
12 return value is the number of layers in the texture array.
13 </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">textureSize</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><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr><tr><th align="left">textureSize (samplerBuffer, samplerRect{Shadow})</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><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr><tr><th align="left">textureSize (samplerCube{Shadow})</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><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</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>
14 <a href="texelFetch.xml"><span class="citerefentry"><span class="refentrytitle">texelFetch</span></span></a>,
15 <a href="texelFetchOffset.xml"><span class="citerefentry"><span class="refentrytitle">texelFetchOffset</span></span></a>,
16 <a href="texture.xml"><span class="citerefentry"><span class="refentrytitle">texture</span></span></a>,
17 <a href="textureGather.xml"><span class="citerefentry"><span class="refentrytitle">textureGather</span></span></a>,
18 <a href="textureGatherOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureGatherOffset</span></span></a>,
19 <a href="textureGatherOffsets.xml"><span class="citerefentry"><span class="refentrytitle">textureGatherOffsets</span></span></a>,
20 <a href="textureGrad.xml"><span class="citerefentry"><span class="refentrytitle">textureGrad</span></span></a>,
21 <a href="textureGradOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureGradOffset</span></span></a>,
22 <a href="textureLod.xml"><span class="citerefentry"><span class="refentrytitle">textureLod</span></span></a>,
23 <a href="textureLodOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureLodOffset</span></span></a>,
24 <a href="textureOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureOffset</span></span></a>,
25 <a href="textureProj.xml"><span class="citerefentry"><span class="refentrytitle">textureProj</span></span></a>,
26 <a href="textureProjGrad.xml"><span class="citerefentry"><span class="refentrytitle">textureProjGrad</span></span></a>,
27 <a href="textureProjGradOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjGradOffset</span></span></a>,
28 <a href="textureProjLod.xml"><span class="citerefentry"><span class="refentrytitle">textureProjLod</span></span></a>,
29 <a href="textureProjLodOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjLodOffset</span></span></a>,
30 <a href="textureProjOffset.xml"><span class="citerefentry"><span class="refentrytitle">textureProjOffset</span></span></a>,
31 <a href="textureQueryLod.xml"><span class="citerefentry"><span class="refentrytitle">textureQueryLod</span></span></a>
32 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
33 Copyright <span class="trademark"></span>© 2011 Khronos Group.
34 This material may be distributed subject to the terms and conditions set forth in
35 the Open Publication License, v 1.0, 8 June 1999.
36 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
37 </p></div></div></body></html>