upstream-man-pages/man2/glVertex.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="glVertex">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glVertex</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glVertex</refname>
  17         <refpurpose>specify a vertex</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glVertex2s</function></funcdef>
  23                 <paramdef>GLshort <parameter>x</parameter></paramdef>
  24                 <paramdef>GLshort <parameter>y</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27         <funcsynopsis>
  28             <funcprototype>
  29                 <funcdef>void <function>glVertex2i</function></funcdef>
  30                 <paramdef>GLint <parameter>x</parameter></paramdef>
  31                 <paramdef>GLint <parameter>y</parameter></paramdef>
  32             </funcprototype>
  33         </funcsynopsis>
  34         <funcsynopsis>
  35             <funcprototype>
  36                 <funcdef>void <function>glVertex2f</function></funcdef>
  37                 <paramdef>GLfloat <parameter>x</parameter></paramdef>
  38                 <paramdef>GLfloat <parameter>y</parameter></paramdef>
  39             </funcprototype>
  40         </funcsynopsis>
  41         <funcsynopsis>
  42             <funcprototype>
  43                 <funcdef>void <function>glVertex2d</function></funcdef>
  44                 <paramdef>GLdouble <parameter>x</parameter></paramdef>
  45                 <paramdef>GLdouble <parameter>y</parameter></paramdef>
  46             </funcprototype>
  47         </funcsynopsis>
  48         <funcsynopsis>
  49             <funcprototype>
  50                 <funcdef>void <function>glVertex3s</function></funcdef>
  51                 <paramdef>GLshort <parameter>x</parameter></paramdef>
  52                 <paramdef>GLshort <parameter>y</parameter></paramdef>
  53                 <paramdef>GLshort <parameter>z</parameter></paramdef>
  54             </funcprototype>
  55         </funcsynopsis>
  56         <funcsynopsis>
  57             <funcprototype>
  58                 <funcdef>void <function>glVertex3i</function></funcdef>
  59                 <paramdef>GLint <parameter>x</parameter></paramdef>
  60                 <paramdef>GLint <parameter>y</parameter></paramdef>
  61                 <paramdef>GLint <parameter>z</parameter></paramdef>
  62             </funcprototype>
  63         </funcsynopsis>
  64         <funcsynopsis>
  65             <funcprototype>
  66                 <funcdef>void <function>glVertex3f</function></funcdef>
  67                 <paramdef>GLfloat <parameter>x</parameter></paramdef>
  68                 <paramdef>GLfloat <parameter>y</parameter></paramdef>
  69                 <paramdef>GLfloat <parameter>z</parameter></paramdef>
  70             </funcprototype>
  71         </funcsynopsis>
  72         <funcsynopsis>
  73             <funcprototype>
  74                 <funcdef>void <function>glVertex3d</function></funcdef>
  75                 <paramdef>GLdouble <parameter>x</parameter></paramdef>
  76                 <paramdef>GLdouble <parameter>y</parameter></paramdef>
  77                 <paramdef>GLdouble <parameter>z</parameter></paramdef>
  78             </funcprototype>
  79         </funcsynopsis>
  80         <funcsynopsis>
  81             <funcprototype>
  82                 <funcdef>void <function>glVertex4s</function></funcdef>
  83                 <paramdef>GLshort <parameter>x</parameter></paramdef>
  84                 <paramdef>GLshort <parameter>y</parameter></paramdef>
  85                 <paramdef>GLshort <parameter>z</parameter></paramdef>
  86                 <paramdef>GLshort <parameter>w</parameter></paramdef>
  87             </funcprototype>
  88         </funcsynopsis>
  89         <funcsynopsis>
  90             <funcprototype>
  91                 <funcdef>void <function>glVertex4i</function></funcdef>
  92                 <paramdef>GLint <parameter>x</parameter></paramdef>
  93                 <paramdef>GLint <parameter>y</parameter></paramdef>
  94                 <paramdef>GLint <parameter>z</parameter></paramdef>
  95                 <paramdef>GLint <parameter>w</parameter></paramdef>
  96             </funcprototype>
  97         </funcsynopsis>
  98         <funcsynopsis>
  99             <funcprototype>
 100                 <funcdef>void <function>glVertex4f</function></funcdef>
 101                 <paramdef>GLfloat <parameter>x</parameter></paramdef>
 102                 <paramdef>GLfloat <parameter>y</parameter></paramdef>
 103                 <paramdef>GLfloat <parameter>z</parameter></paramdef>
 104                 <paramdef>GLfloat <parameter>w</parameter></paramdef>
 105             </funcprototype>
 106         </funcsynopsis>
 107         <funcsynopsis>
 108             <funcprototype>
 109                 <funcdef>void <function>glVertex4d</function></funcdef>
 110                 <paramdef>GLdouble <parameter>x</parameter></paramdef>
 111                 <paramdef>GLdouble <parameter>y</parameter></paramdef>
 112                 <paramdef>GLdouble <parameter>z</parameter></paramdef>
 113                 <paramdef>GLdouble <parameter>w</parameter></paramdef>
 114             </funcprototype>
 115         </funcsynopsis>
 116     </refsynopsisdiv>
 117     <refsect1 id="parameters"><title>Parameters</title>
 118         <variablelist>
 119         <varlistentry>
 120             <term><parameter>x</parameter></term>
 121             <term><parameter>y</parameter></term>
 122             <term><parameter>z</parameter></term>
 123             <term><parameter>w</parameter></term>
 124             <listitem>
 125                 <para>
 126                     Specify <emphasis>x</emphasis>, <emphasis>y</emphasis>, <emphasis>z</emphasis>, and <emphasis>w</emphasis> coordinates of a vertex.
 127                     Not all parameters are present in all forms of the command.
 128                 </para>
 129             </listitem>
 130         </varlistentry>
 131         </variablelist>
 132     </refsect1>
 133     <refsynopsisdiv><title>C Specification</title>
 134         <funcsynopsis>
 135             <funcprototype>
 136                 <funcdef>void <function>glVertex2sv</function></funcdef>
 137                 <paramdef>const GLshort * <parameter>v</parameter></paramdef>
 138             </funcprototype>
 139         </funcsynopsis>
 140         <funcsynopsis>
 141             <funcprototype>
 142                 <funcdef>void <function>glVertex2iv</function></funcdef>
 143                 <paramdef>const GLint * <parameter>v</parameter></paramdef>
 144             </funcprototype>
 145         </funcsynopsis>
 146         <funcsynopsis>
 147             <funcprototype>
 148                 <funcdef>void <function>glVertex2fv</function></funcdef>
 149                 <paramdef>const GLfloat * <parameter>v</parameter></paramdef>
 150             </funcprototype>
 151         </funcsynopsis>
 152         <funcsynopsis>
 153             <funcprototype>
 154                 <funcdef>void <function>glVertex2dv</function></funcdef>
 155                 <paramdef>const GLdouble * <parameter>v</parameter></paramdef>
 156             </funcprototype>
 157         </funcsynopsis>
 158         <funcsynopsis>
 159             <funcprototype>
 160                 <funcdef>void <function>glVertex3sv</function></funcdef>
 161                 <paramdef>const GLshort * <parameter>v</parameter></paramdef>
 162             </funcprototype>
 163         </funcsynopsis>
 164         <funcsynopsis>
 165             <funcprototype>
 166                 <funcdef>void <function>glVertex3iv</function></funcdef>
 167                 <paramdef>const GLint * <parameter>v</parameter></paramdef>
 168             </funcprototype>
 169         </funcsynopsis>
 170         <funcsynopsis>
 171             <funcprototype>
 172                 <funcdef>void <function>glVertex3fv</function></funcdef>
 173                 <paramdef>const GLfloat * <parameter>v</parameter></paramdef>
 174             </funcprototype>
 175         </funcsynopsis>
 176         <funcsynopsis>
 177             <funcprototype>
 178                 <funcdef>void <function>glVertex3dv</function></funcdef>
 179                 <paramdef>const GLdouble * <parameter>v</parameter></paramdef>
 180             </funcprototype>
 181         </funcsynopsis>
 182         <funcsynopsis>
 183             <funcprototype>
 184                 <funcdef>void <function>glVertex4sv</function></funcdef>
 185                 <paramdef>const GLshort * <parameter>v</parameter></paramdef>
 186             </funcprototype>
 187         </funcsynopsis>
 188         <funcsynopsis>
 189             <funcprototype>
 190                 <funcdef>void <function>glVertex4iv</function></funcdef>
 191                 <paramdef>const GLint * <parameter>v</parameter></paramdef>
 192             </funcprototype>
 193         </funcsynopsis>
 194         <funcsynopsis>
 195             <funcprototype>
 196                 <funcdef>void <function>glVertex4fv</function></funcdef>
 197                 <paramdef>const GLfloat * <parameter>v</parameter></paramdef>
 198             </funcprototype>
 199         </funcsynopsis>
 200         <funcsynopsis>
 201             <funcprototype>
 202                 <funcdef>void <function>glVertex4dv</function></funcdef>
 203                 <paramdef>const GLdouble * <parameter>v</parameter></paramdef>
 204             </funcprototype>
 205         </funcsynopsis>
 206     </refsynopsisdiv>
 207     <refsect1 id="parameters2"><title>Parameters</title>
 208         <variablelist>
 209         <varlistentry>
 210             <term><parameter>v</parameter></term>
 211             <listitem>
 212                 <para>
 213                     Specifies a pointer to an array of two, three, or four elements.
 214                     The elements of a two-element array are
 215                     <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation>
 216                     and
 217                     <inlineequation><mml:math><mml:mi mathvariant="italic">y</mml:mi></mml:math></inlineequation>;
 218                     of a three-element array,
 219                     <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation>,
 220                     <inlineequation><mml:math><mml:mi mathvariant="italic">y</mml:mi></mml:math></inlineequation>,
 221                     and
 222                     <inlineequation><mml:math><mml:mi mathvariant="italic">z</mml:mi></mml:math></inlineequation>;
 223                     and of a four-element array,
 224                     <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation>,
 225                     <inlineequation><mml:math><mml:mi mathvariant="italic">y</mml:mi></mml:math></inlineequation>,
 226                     <inlineequation><mml:math><mml:mi mathvariant="italic">z</mml:mi></mml:math></inlineequation>,
 227                     and
 228                     <inlineequation><mml:math><mml:mi mathvariant="italic">w</mml:mi></mml:math></inlineequation>.
 229                 </para>
 230             </listitem>
 231         </varlistentry>
 232         </variablelist>
 233     </refsect1>
 234     <refsect1 id="description"><title>Description</title>
 235         <para>
 236             <function>glVertex</function> commands are used within <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>/<citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry> pairs to specify
 237             point, line, and polygon vertices.  The current color, normal, texture
 238             coordinates, and fog coordinate are associated with the vertex when <function>glVertex</function>
 239             is called.
 240         </para>
 241         <para>
 242             When only
 243             <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation>
 244             and
 245             <inlineequation><mml:math><mml:mi mathvariant="italic">y</mml:mi></mml:math></inlineequation>
 246             are specified,
 247             <inlineequation><mml:math><mml:mi mathvariant="italic">z</mml:mi></mml:math></inlineequation>
 248             defaults to 0 and
 249             <inlineequation><mml:math><mml:mi mathvariant="italic">w</mml:mi></mml:math></inlineequation>
 250             defaults to 1.  When
 251             <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation>,
 252             <inlineequation><mml:math><mml:mi mathvariant="italic">y</mml:mi></mml:math></inlineequation>,
 253             and
 254             <inlineequation><mml:math><mml:mi mathvariant="italic">z</mml:mi></mml:math></inlineequation>
 255             are specified,
 256             <inlineequation><mml:math><mml:mi mathvariant="italic">w</mml:mi></mml:math></inlineequation>
 257             defaults to 1.
 258         </para>
 259     </refsect1>
 260     <refsect1 id="notes"><title>Notes</title>
 261         <para>
 262             Invoking <function>glVertex</function> outside of a <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>/<citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry> pair
 263             results in undefined behavior.
 264         </para>
 265     </refsect1>
 266     <refsect1 id="seealso"><title>See Also</title>
 267         <para>
 268             <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>,
 269             <citerefentry><refentrytitle>glCallList</refentrytitle></citerefentry>,
 270             <citerefentry><refentrytitle>glColor</refentrytitle></citerefentry>,
 271             <citerefentry><refentrytitle>glEdgeFlag</refentrytitle></citerefentry>,
 272             <citerefentry><refentrytitle>glEvalCoord</refentrytitle></citerefentry>,
 273             <citerefentry><refentrytitle>glFogCoord</refentrytitle></citerefentry>,
 274             <citerefentry><refentrytitle>glIndex</refentrytitle></citerefentry>,
 275             <citerefentry><refentrytitle>glMaterial</refentrytitle></citerefentry>,
 276             <citerefentry><refentrytitle>glMultiTexCoord</refentrytitle></citerefentry>,
 277             <citerefentry><refentrytitle>glNormal</refentrytitle></citerefentry>,
 278             <citerefentry><refentrytitle>glRect</refentrytitle></citerefentry>,
 279             <citerefentry><refentrytitle>glTexCoord</refentrytitle></citerefentry>,
 280             <citerefentry><refentrytitle>glVertexPointer</refentrytitle></citerefentry>
 281         </para>
 282     </refsect1>
 283     <refsect1 id="Copyright"><title>Copyright</title>
 284         <para>
 285             Copyright <trademark class="copyright"></trademark> 1991-2006
 286             Silicon Graphics, Inc. This document is licensed under the SGI
 287             Free Software B License. For details, see
 288             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 289         </para>
 290     </refsect1>
 291 </refentry>