upstream-doc/man4/glPointSize.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="glPointSize">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glPointSize</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glPointSize</refname>
  17         <refpurpose>specify the diameter of rasterized points</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glPointSize</function></funcdef>
  23                 <paramdef>GLfloat <parameter>size</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <!-- eqn: ignoring delim $$ -->
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>size</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specifies the diameter of rasterized points.
  35                     The initial value is 1.
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         </variablelist>
  40     </refsect1>
  41     <refsect1 id="description"><title>Description</title>
  42         <para>
  43             <function>glPointSize</function> specifies the rasterized diameter of points. If point size mode
  44             is disabled (see <citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry> with parameter
  45             <constant>GL_PROGRAM_POINT_SIZE</constant>), this value will be used to rasterize points. Otherwise,
  46             the value written to the shading language built-in variable <code>gl_PointSize</code> will be used.
  47         </para>
  48     </refsect1>
  49     <refsect1 id="notes"><title>Notes</title>
  50         <para>
  51             The point size specified by <function>glPointSize</function> is always returned when
  52             <constant>GL_POINT_SIZE</constant> is queried.  Clamping and rounding for points have no effect on the specified value.
  53         </para>
  54     </refsect1>
  55     <refsect1 id="errors"><title>Errors</title>
  56         <para>
  57             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>size</parameter> is less than or equal to 0.
  58         </para>
  59     </refsect1>
  60     <refsect1 id="associatedgets"><title>Associated Gets</title>
  61         <para>
  62             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POINT_SIZE_RANGE</constant>
  63         </para>
  64         <para>
  65             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POINT_SIZE_GRANULARITY</constant>
  66         </para>
  67         <para>
  68             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POINT_SIZE</constant>
  69         </para>
  70         <para>
  71             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POINT_SIZE_MIN</constant>
  72         </para>
  73         <para>
  74             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POINT_SIZE_MAX</constant>
  75         </para>
  76         <para>
  77             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POINT_FADE_THRESHOLD_SIZE</constant>
  78         </para>
  79         <para>
  80             <citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry> with argument <constant>GL_PROGRAM_POINT_SIZE</constant>
  81         </para>
  82     </refsect1>
  83     <refsect1 id="seealso"><title>See Also</title>
  84         <para>
  85             <citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry>,
  86             <citerefentry><refentrytitle>glPointParameter</refentrytitle></citerefentry>
  87         </para>
  88     </refsect1>
  89     <refsect1 id="Copyright"><title>Copyright</title>
  90         <para>
  91             Copyright <trademark class="copyright"></trademark> 1991-2006
  92             Silicon Graphics, Inc. This document is licensed under the SGI
  93             Free Software B License. For details, see
  94             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  95         </para>
  96     </refsect1>
  97 </refentry>