upstream-doc/man4/glCullFace.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="glCullFace">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glCullFace</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glCullFace</refname>
  17         <refpurpose>specify whether front- or back-facing facets can be culled</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glCullFace</function></funcdef>
  23                 <paramdef>GLenum <parameter>mode</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>mode</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specifies whether front- or back-facing facets are candidates for culling.
  34                     Symbolic constants
  35                     <constant>GL_FRONT</constant>, <constant>GL_BACK</constant>, and <constant>GL_FRONT_AND_BACK</constant> are accepted.
  36                     The initial value is <constant>GL_BACK</constant>.
  37                 </para>
  38             </listitem>
  39         </varlistentry>
  40         </variablelist>
  41     </refsect1>
  42     <refsect1 id="description"><title>Description</title>
  43         <para>
  44             <function>glCullFace</function> specifies whether front- or back-facing facets are culled
  45             (as specified by <emphasis>mode</emphasis>) when facet culling is enabled. Facet
  46             culling is initially disabled.
  47             To enable and disable facet culling, call the
  48             <citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glDisable</refentrytitle></citerefentry> commands
  49             with the argument <constant>GL_CULL_FACE</constant>.
  50             Facets include triangles,
  51             quadrilaterals,
  52             polygons, and
  53             rectangles.
  54         </para>
  55         <para>
  56             <citerefentry><refentrytitle>glFrontFace</refentrytitle></citerefentry> specifies which of the clockwise and counterclockwise facets
  57             are front-facing and back-facing.
  58             See <citerefentry><refentrytitle>glFrontFace</refentrytitle></citerefentry>.
  59         </para>
  60     </refsect1>
  61     <refsect1 id="notes"><title>Notes</title>
  62         <para>
  63             If <parameter>mode</parameter> is <constant>GL_FRONT_AND_BACK</constant>, no facets are drawn, but other
  64             primitives such as points and lines are drawn.
  65         </para>
  66     </refsect1>
  67     <refsect1 id="errors"><title>Errors</title>
  68         <para>
  69             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>mode</parameter> is not an accepted value.
  70         </para>
  71     </refsect1>
  72     <refsect1 id="associatedgets"><title>Associated Gets</title>
  73         <para>
  74             <citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry> with argument <constant>GL_CULL_FACE</constant>
  75         </para>
  76         <para>
  77             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_CULL_FACE_MODE</constant>
  78         </para>
  79     </refsect1>
  80     <refsect1 id="seealso"><title>See Also</title>
  81         <para>
  82             <citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry>,
  83             <citerefentry><refentrytitle>glFrontFace</refentrytitle></citerefentry>
  84         </para>
  85     </refsect1>
  86     <refsect1 id="Copyright"><title>Copyright</title>
  87         <para>
  88             Copyright <trademark class="copyright"></trademark> 1991-2006
  89             Silicon Graphics, Inc. This document is licensed under the SGI
  90             Free Software B License. For details, see
  91             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  92         </para>
  93     </refsect1>
  94 </refentry>