upstream-man-pages/man2/glResetMinmax.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="glResetMinmax">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glResetMinmax</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glResetMinmax</refname>
  17         <refpurpose>reset minmax table entries to initial values</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glResetMinmax</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>target</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Must be
  34                     <constant>GL_MINMAX</constant>.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         </variablelist>
  39     </refsect1>
  40     <refsect1 id="description"><title>Description</title>
  41         <para>
  42             <function>glResetMinmax</function> resets the elements of the current minmax table to their
  43             initial values: the ``maximum'' element receives the minimum possible
  44             component values, and the ``minimum'' element receives the maximum
  45             possible component values.
  46         </para>
  47     </refsect1>
  48     <refsect1 id="notes"><title>Notes</title>
  49         <para>
  50             <function>glResetMinmax</function> is present only if <code>ARB_imaging</code> is returned when <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>
  51             is called with an argument of <constant>GL_EXTENSIONS</constant>.
  52         </para>
  53     </refsect1>
  54     <refsect1 id="errors"><title>Errors</title>
  55         <para>
  56             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_MINMAX</constant>.
  57         </para>
  58         <para>
  59             <constant>GL_INVALID_OPERATION</constant> is generated if <function>glResetMinmax</function> is executed
  60             between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
  61             execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
  62         </para>
  63     </refsect1>
  64     <refsect1 id="seealso"><title>See Also</title>
  65         <para>
  66             <citerefentry><refentrytitle>glMinmax</refentrytitle></citerefentry>
  67         </para>
  68     </refsect1>
  69     <refsect1 id="Copyright"><title>Copyright</title>
  70         <para>
  71             Copyright <trademark class="copyright"></trademark> 1991-2006
  72             Silicon Graphics, Inc. This document is licensed under the SGI
  73             Free Software B License. For details, see
  74             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  75         </para>
  76     </refsect1>
  77 </refentry>