160 lines
8 KiB
XML
160 lines
8 KiB
XML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
||
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
||
|
|
<refentry id="glLineWidth">
|
||
|
|
<refmeta>
|
||
|
|
<refmetainfo>
|
||
|
|
<copyright>
|
||
|
|
<year>1991-2006</year>
|
||
|
|
<holder>Silicon Graphics, Inc.</holder>
|
||
|
|
</copyright>
|
||
|
|
</refmetainfo>
|
||
|
|
<refentrytitle>glLineWidth</refentrytitle>
|
||
|
|
<manvolnum>3G</manvolnum>
|
||
|
|
</refmeta>
|
||
|
|
<refnamediv>
|
||
|
|
<refname>glLineWidth</refname>
|
||
|
|
<refpurpose>specify the width of rasterized lines</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsynopsisdiv><title>C Specification</title>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>void <function>glLineWidth</function></funcdef>
|
||
|
|
<paramdef>GLfloat <parameter>width</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
<!-- eqn: ignoring delim $$ -->
|
||
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>width</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
Specifies the width of rasterized lines.
|
||
|
|
The initial value is 1.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="description"><title>Description</title>
|
||
|
|
<para>
|
||
|
|
<function>glLineWidth</function> specifies the rasterized width of both aliased and antialiased
|
||
|
|
lines.
|
||
|
|
Using a line width other than 1 has different effects,
|
||
|
|
depending on whether line antialiasing is enabled.
|
||
|
|
To enable and disable line antialiasing, call
|
||
|
|
<citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glDisable</refentrytitle></citerefentry>
|
||
|
|
with argument <constant>GL_LINE_SMOOTH</constant>. Line antialiasing is initially
|
||
|
|
disabled.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
If line antialiasing is disabled,
|
||
|
|
the actual width is determined by rounding the supplied width
|
||
|
|
to the nearest integer.
|
||
|
|
(If the rounding results in the value 0,
|
||
|
|
it is as if the line width were 1.)
|
||
|
|
If
|
||
|
|
<inlineequation><mml:math>
|
||
|
|
<!-- eqn: | DELTA x | >= | DELTA y |:-->
|
||
|
|
<mml:mrow>
|
||
|
|
<mml:mfenced open="∣" close="∣">
|
||
|
|
<mml:mrow>
|
||
|
|
<mml:mo>Δ</mml:mo>
|
||
|
|
<mml:mi mathvariant="italic">x</mml:mi>
|
||
|
|
</mml:mrow>
|
||
|
|
</mml:mfenced>
|
||
|
|
<mml:mo>>=</mml:mo>
|
||
|
|
<mml:mfenced open="∣" close="∣">
|
||
|
|
<mml:mrow>
|
||
|
|
<mml:mo>Δ</mml:mo>
|
||
|
|
<mml:mi mathvariant="italic">y</mml:mi>
|
||
|
|
</mml:mrow>
|
||
|
|
</mml:mfenced>
|
||
|
|
</mml:mrow>
|
||
|
|
</mml:math></inlineequation>,
|
||
|
|
<emphasis>i</emphasis> pixels are filled in each column that is rasterized,
|
||
|
|
where <emphasis>i</emphasis> is the rounded value of <parameter>width</parameter>.
|
||
|
|
Otherwise,
|
||
|
|
<emphasis>i</emphasis> pixels are filled in each row that is rasterized.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
If antialiasing is enabled,
|
||
|
|
line rasterization produces a fragment for each pixel square
|
||
|
|
that intersects the region lying within the rectangle having width
|
||
|
|
equal to the current line width,
|
||
|
|
length equal to the actual length of the line,
|
||
|
|
and centered on the mathematical line segment.
|
||
|
|
The coverage value for each fragment is the window coordinate area
|
||
|
|
of the intersection of the rectangular region with the corresponding
|
||
|
|
pixel square.
|
||
|
|
This value is saved and used in the final rasterization step.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
Not all widths can be supported when line antialiasing is enabled. If an
|
||
|
|
unsupported width is requested, the nearest supported width is used.
|
||
|
|
Only width 1 is guaranteed to be supported; others depend on the
|
||
|
|
implementation. Likewise, there is a range for aliased line widths as well.
|
||
|
|
To query the range of supported widths and the size
|
||
|
|
difference between supported widths within the range, call <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>
|
||
|
|
with arguments <constant>GL_ALIASED_LINE_WIDTH_RANGE</constant>,
|
||
|
|
<constant>GL_SMOOTH_LINE_WIDTH_RANGE</constant>, and <constant>GL_SMOOTH_LINE_WIDTH_GRANULARITY</constant>.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="notes"><title>Notes</title>
|
||
|
|
<para>
|
||
|
|
The line width specified by <function>glLineWidth</function> is always returned when <constant>GL_LINE_WIDTH</constant>
|
||
|
|
is queried.
|
||
|
|
Clamping and rounding for aliased and antialiased lines have no effect on the specified value.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
Nonantialiased line width may be clamped to an implementation-dependent maximum. Call <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with <constant>GL_ALIASED_LINE_WIDTH_RANGE</constant> to determine the maximum width.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
In OpenGL 1.2, the tokens <constant>GL_LINE_WIDTH_RANGE</constant> and <constant>GL_LINE_WIDTH_GRANULARITY</constant> were replaced by <constant>GL_ALIASED_LINE_WIDTH_RANGE</constant>,
|
||
|
|
<constant>GL_SMOOTH_LINE_WIDTH_RANGE</constant>, and <constant>GL_SMOOTH_LINE_WIDTH_GRANULARITY</constant>. The old names are retained for backward compatibility, but should not be used in new code.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="errors"><title>Errors</title>
|
||
|
|
<para>
|
||
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>width</parameter> is less than or equal to 0.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<constant>GL_INVALID_OPERATION</constant> is generated if <function>glLineWidth</function>
|
||
|
|
is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
|
||
|
|
and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="associatedgets"><title>Associated Gets</title>
|
||
|
|
<para>
|
||
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_LINE_WIDTH</constant>
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_ALIASED_LINE_WIDTH_RANGE</constant>
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_SMOOTH_LINE_WIDTH_RANGE</constant>
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_SMOOTH_LINE_WIDTH_GRANULARITY</constant>
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry> with argument <constant>GL_LINE_SMOOTH</constant>
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="seealso"><title>See Also</title>
|
||
|
|
<para>
|
||
|
|
<citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry>
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
||
|
|
<para>
|
||
|
|
Copyright <trademark class="copyright"></trademark> 1991-2006
|
||
|
|
Silicon Graphics, Inc. This document is licensed under the SGI
|
||
|
|
Free Software B License. For details, see
|
||
|
|
<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
</refentry>
|