upstream-man-pages/man2/glGetMinmaxParameter.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="glGetMinmaxParameter">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGetMinmaxParameter</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGetMinmaxParameter</refname>
  17         <refpurpose>get minmax parameters</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glGetMinmaxParameterfv</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLenum <parameter>pname</parameter></paramdef>
  25                 <paramdef>GLfloat * <parameter>params</parameter></paramdef>
  26             </funcprototype>
  27         </funcsynopsis>
  28         <funcsynopsis>
  29             <funcprototype>
  30                 <funcdef>void <function>glGetMinmaxParameteriv</function></funcdef>
  31                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  32                 <paramdef>GLenum <parameter>pname</parameter></paramdef>
  33                 <paramdef>GLint * <parameter>params</parameter></paramdef>
  34             </funcprototype>
  35         </funcsynopsis>
  36     </refsynopsisdiv>
  37     <refsect1 id="parameters"><title>Parameters</title>
  38         <variablelist>
  39         <varlistentry>
  40             <term><parameter>target</parameter></term>
  41             <listitem>
  42                 <para>
  43                     Must be
  44                     <constant>GL_MINMAX</constant>.
  45                 </para>
  46             </listitem>
  47         </varlistentry>
  48         <varlistentry>
  49             <term><parameter>pname</parameter></term>
  50             <listitem>
  51                 <para>
  52                     The parameter to be retrieved.
  53                     Must be one of
  54                     <constant>GL_MINMAX_FORMAT</constant> or
  55                     <constant>GL_MINMAX_SINK</constant>.
  56                 </para>
  57             </listitem>
  58         </varlistentry>
  59         <varlistentry>
  60             <term><parameter>params</parameter></term>
  61             <listitem>
  62                 <para>
  63                     A pointer to storage for the retrieved parameters.
  64                 </para>
  65             </listitem>
  66         </varlistentry>
  67         </variablelist>
  68     </refsect1>
  69     <refsect1 id="description"><title>Description</title>
  70         <para>
  71             <function>glGetMinmaxParameter</function> retrieves parameters for the current minmax table by setting
  72             <parameter>pname</parameter> to one of the following values:
  73         </para>
  74         <para>
  75         </para>
  76         <informaltable frame="topbot">
  77             <tgroup cols="2" align="left">
  78                 <colspec/>
  79                 <colspec/>
  80                 <thead>
  81                     <row>
  82                         <entry rowsep="1" align="left"><emphasis role="bold">
  83                         Parameter
  84                         </emphasis></entry>
  85                         <entry rowsep="1" align="left"><emphasis role="bold">
  86                         Description
  87                         </emphasis></entry>
  88                     </row>
  89                 </thead>
  90                 <tbody>
  91                     <row>
  92                         <entry align="left">
  93                         <constant>GL_MINMAX_FORMAT</constant>
  94                         </entry>
  95                         <entry align="left">
  96                         Internal format of minmax table
  97                         </entry>
  98                     </row>
  99                     <row>
 100                         <entry align="left">
 101                         <constant>GL_MINMAX_SINK</constant>
 102                         </entry>
 103                         <entry align="left">
 104                         Value of the <emphasis>sink</emphasis> parameter
 105                         </entry>
 106                     </row>
 107                 </tbody>
 108             </tgroup>
 109         </informaltable>
 110         <para>
 111         </para>
 112     </refsect1>
 113     <refsect1 id="notes"><title>Notes</title>
 114         <para>
 115             <function>glGetMinmaxParameter</function> is present only if <code>ARB_imaging</code> is returned when <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>
 116             is called with an argument of <constant>GL_EXTENSIONS</constant>.
 117         </para>
 118     </refsect1>
 119     <refsect1 id="errors"><title>Errors</title>
 120         <para>
 121             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_MINMAX</constant>.
 122         </para>
 123         <para>
 124             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not one of the allowable
 125             values.
 126         </para>
 127         <para>
 128             <constant>GL_INVALID_OPERATION</constant> is generated if <function>glGetMinmaxParameter</function> is executed
 129             between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
 130             execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
 131         </para>
 132     </refsect1>
 133     <refsect1 id="seealso"><title>See Also</title>
 134         <para>
 135             <citerefentry><refentrytitle>glMinmax</refentrytitle></citerefentry>,
 136             <citerefentry><refentrytitle>glGetMinmax</refentrytitle></citerefentry>
 137         </para>
 138     </refsect1>
 139     <refsect1 id="Copyright"><title>Copyright</title>
 140         <para>
 141             Copyright <trademark class="copyright"></trademark> 1991-2006
 142             Silicon Graphics, Inc. This document is licensed under the SGI
 143             Free Software B License. For details, see
 144             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 145         </para>
 146     </refsect1>
 147 </refentry>