upstream-man-pages/manglsl/imageSize.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="imageSize">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>imageSize</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>imageSize</refname>
  17         <refpurpose>retrieve the dimensions of an image</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>int <function>imageSize</function></funcdef>
  23                 <paramdef>gimage1D <parameter>image</parameter></paramdef>
  24             </funcprototype>
  25             <funcprototype>
  26                 <funcdef>ivec2 <function>imageSize</function></funcdef>
  27                 <paramdef>gimage2D <parameter>image</parameter></paramdef>
  28             </funcprototype>
  29             <funcprototype>
  30                 <funcdef>ivec3 <function>imageSize</function></funcdef>
  31                 <paramdef>gimage3D <parameter>image</parameter></paramdef>
  32             </funcprototype>
  33             <funcprototype>
  34                 <funcdef>ivec2 <function>imageSize</function></funcdef>
  35                 <paramdef>gimageCube <parameter>image</parameter></paramdef>
  36             </funcprototype>
  37             <funcprototype>
  38                 <funcdef>ivec3 <function>imageSize</function></funcdef>
  39                 <paramdef>gimageCubeArray <parameter>image</parameter></paramdef>
  40             </funcprototype>
  41             <funcprototype>
  42                 <funcdef>ivec2 <function>imageSize</function></funcdef>
  43                 <paramdef>gimageRect <parameter>image</parameter></paramdef>
  44             </funcprototype>
  45             <funcprototype>
  46                 <funcdef>ivec2 <function>imageSize</function></funcdef>
  47                 <paramdef>gimage1DArray <parameter>image</parameter></paramdef>
  48             </funcprototype>
  49             <funcprototype>
  50                 <funcdef>ivec3 <function>imageSize</function></funcdef>
  51                 <paramdef>gimage2DArray <parameter>image</parameter></paramdef>
  52             </funcprototype>
  53             <funcprototype>
  54                 <funcdef>int <function>imageSize</function></funcdef>
  55                 <paramdef>gimageBuffer <parameter>image</parameter></paramdef>
  56             </funcprototype>
  57             <funcprototype>
  58                 <funcdef>ivec2 <function>imageSize</function></funcdef>
  59                 <paramdef>gimage2DMS <parameter>image</parameter></paramdef>
  60             </funcprototype>
  61             <funcprototype>
  62                 <funcdef>ivec3 <function>imageSize</function></funcdef>
  63                 <paramdef>gimage2DMSArray <parameter>image</parameter></paramdef>
  64             </funcprototype>
  65         </funcsynopsis>
  66     </refsynopsisdiv>
  67     <refsect1 id="parameters"><title>Parameters</title>
  68         <variablelist>
  69         <varlistentry>
  70             <term><parameter>image</parameter></term>
  71             <listitem>
  72                 <para>
  73                     Specifies the image to which the texture whose dimensions to retrieve is bound.
  74                 </para>
  75             </listitem>
  76         </varlistentry>
  77         </variablelist>
  78     </refsect1>
  79     <refsect1 id="description"><title>Description</title>
  80         <para>
  81             <function>imageSize</function> returns the dimensions of the image bound to <parameter>image</parameter>.
  82             The components in the return value are filled in,
  83             in order, with the width, height and depth of the image. For the array forms, the last component of the
  84             return value is the number of layers in the texture array.
  85         </para>
  86     </refsect1>
  87     <refsect1 id="versions"><title>Version Support</title>
  88         <informaltable frame="topbot">
  89             #VARTABLECOLS#
  90                 <thead>
  91                     #FUNCTABLEHEADER#
  92                     <row>
  93                         <entry>imageSize</entry>#newin43#
  94                     </row>
  95                 </thead>
  96             </tgroup>
  97         </informaltable>
  98     </refsect1>
  99     <refsect1 id="seealso"><title>See Also</title>
 100         <para>
 101             <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>,
 102             <citerefentry><refentrytitle>imageLoad</refentrytitle></citerefentry>,
 103             <citerefentry><refentrytitle>imageStore</refentrytitle></citerefentry>
 104         </para>
 105     </refsect1>
 106     <refsect1 id="Copyright"><title>Copyright</title>
 107         <para>
 108             Copyright <trademark class="copyright"></trademark> 2011-2012 Khronos Group.
 109             This material may be distributed subject to the terms and conditions set forth in
 110             the Open Publication License, v 1.0, 8 June 1999.
 111             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 112         </para>
 113     </refsect1>
 114 </refentry>