<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='xdrlineman'>
<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium -->

<!--  Permission is hereby granted, free of charge, to any person obtaining -->
<!--  a copy of this software and associated documentation files (the -->
<!--  "Software"), to deal in the Software without restriction, including -->
<!--  without limitation the rights to use, copy, modify, merge, publish, -->
<!--  distribute, sublicense, and/or sell copies of the Software, and to -->
<!--  permit persons to whom the Software is furnished to do so, subject to -->
<!--  the following conditions: -->

<!--  The above copyright notice and this permission notice shall be included -->
<!--  in all copies or substantial portions of the Software. -->

<!--  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -->
<!--  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -->
<!--  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -->
<!--  IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR -->
<!--  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -->
<!--  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -->
<!--  OTHER DEALINGS IN THE SOFTWARE. -->

<!--  Except as contained in this notice, the name of the X Consortium shall -->
<!--  not be used in advertising or otherwise to promote the sale, use or -->
<!--  other dealings in this Software without prior written authorization -->
<!--  from the X Consortium. -->

<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by -->
<!--  Digital Equipment Corporation -->

<!--  Portions Copyright \(co 1990, 1991 by -->
<!--  Tektronix, Inc. -->

<!--  Permission to use, copy, modify and distribute this documentation for -->
<!--  any purpose and without fee is hereby granted, provided that the above -->
<!--  copyright notice appears in all copies and that both that copyright notice -->
<!--  and this permission notice appear in all copies, and that the names of -->
<!--  Digital and Tektronix not be used in in advertising or publicity pertaining -->
<!--  to this documentation without specific, written prior permission. -->
<!--  Digital and Tektronix makes no representations about the suitability -->
<!--  of this documentation for any purpose. -->
<!--  It is provided ``as is'' without express or implied warranty. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/XDrLine.man,v 1.3 2003/04/28 22:17:54 herrb Exp $ -->

<!-- .na -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- IN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- Pn listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XDrawLine</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XDrawLine</refname>
<refname>XDrawLines</refname>
<refname>XDrawSegments</refname>
<refname>XSegment</refname>
<refpurpose>draw lines, polygons, and line structure</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>int XDrawLine&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Drawable <emphasis remap='I'>d</emphasis>&hairsp;, GC <emphasis remap='I'>gc</emphasis>&hairsp;,
int <emphasis remap='I'>x1</emphasis>&hairsp;, int <emphasis remap='I'>y1</emphasis>&hairsp;, int <emphasis remap='I'>x2</emphasis>&hairsp;, int <emphasis remap='I'>y2</emphasis>&hairsp;);</para> 

<para>int XDrawLines&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Drawable <emphasis remap='I'>d</emphasis>&hairsp;, GC
<emphasis remap='I'>gc</emphasis>&hairsp;, XPoint *<emphasis remap='I'>points</emphasis>&hairsp;, int <emphasis remap='I'>npoints</emphasis>&hairsp;, int <emphasis remap='I'>mode</emphasis>&hairsp;);</para> 

<para>int XDrawSegments&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Drawable <emphasis remap='I'>d</emphasis>&hairsp;, GC
<emphasis remap='I'>gc</emphasis>&hairsp;, XSegment *<emphasis remap='I'>segments</emphasis>&hairsp;, int <emphasis remap='I'>nsegments</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>d</emphasis></term>
  <listitem>
<para>Specifies the drawable.</para> 
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>Specifies the connection to the X server.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>gc</emphasis></term>
  <listitem>
<para>Specifies the GC.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>mode</emphasis></term>
  <listitem>
<para>Specifies the coordinate mode. 
You can pass
<emphasis remap='I'>&hairsp;CoordModeOrigin&hairsp;</emphasis>
or
<emphasis remap='I'>&hairsp;CoordModePrevious&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>npoints</emphasis></term>
  <listitem>
<para>Specifies the number of points in the array.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>nsegments</emphasis></term>
  <listitem>
<para>Specifies the number of segments in the array.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>points</emphasis></term>
  <listitem>
<para>Specifies an array of points.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>segments</emphasis></term>
  <listitem>
<para>Specifies an array of segments.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>x1</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>y1</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>x2</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>y2</emphasis></term>
  <listitem>
<para>Specify the points (x1, y1) and (x2, y2) to be connected.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XDrawLine&hairsp;</emphasis>
function uses the components of the specified GC to
draw a line between the specified set of points (x1, y1) and (x2, y2).
It does not perform joining at coincident endpoints.
For any given line, 
<emphasis remap='I'>&hairsp;XDrawLine&hairsp;</emphasis>
does not draw a pixel more than once.
If lines intersect, the intersecting pixels are drawn multiple times.</para>  

<para>The
<emphasis remap='I'>&hairsp;XDrawLines&hairsp;</emphasis>
function uses the components of the specified GC to draw 
npoints-1 lines between each pair of points (point[i], point[i+1]) 
in the array of
<emphasis remap='I'>&hairsp;XPoint&hairsp;</emphasis>
structures.
It draws the lines in the order listed in the array.
The lines join correctly at all intermediate points, and if the first and last
points coincide, the first and last lines also join correctly.
For any given line, 
<emphasis remap='I'>&hairsp;XDrawLines&hairsp;</emphasis>
does not draw a pixel more than once.
If thin (zero line-width) lines intersect, 
the intersecting pixels are drawn multiple times.
If wide lines intersect, the intersecting pixels are drawn only once, as though
the entire 
<emphasis remap='I'>&hairsp;PolyLine&hairsp;</emphasis>
protocol request were a single, filled shape.
<emphasis remap='I'>&hairsp;CoordModeOrigin&hairsp;</emphasis>
treats all coordinates as relative to the origin,
and
<emphasis remap='I'>&hairsp;CoordModePrevious&hairsp;</emphasis>
treats all coordinates after the first as relative to the previous point.</para>

<para>The
<emphasis remap='I'>&hairsp;XDrawSegments&hairsp;</emphasis>
function draws multiple, unconnected lines. 
For each segment, 
<emphasis remap='I'>&hairsp;XDrawSegments&hairsp;</emphasis>
draws a
line between (x1, y1) and (x2, y2).
It draws the lines in the order listed in the array of
<emphasis remap='I'>&hairsp;XSegment&hairsp;</emphasis>
structures and does not perform joining at coincident endpoints.
For any given line, 
<emphasis remap='I'>&hairsp;XDrawSegments&hairsp;</emphasis>
does not draw a pixel more than once.  
If lines intersect, the intersecting pixels are drawn multiple times.</para>  

<para>All three functions use these GC components:
function, plane-mask, line-width,
line-style, cap-style, fill-style, subwindow-mode,
clip-x-origin, clip-y-origin, and clip-mask.
The
<emphasis remap='I'>&hairsp;XDrawLines&hairsp;</emphasis>
function also uses the join-style GC component.
All three functions also use these GC mode-dependent components:
foreground, background, tile, stipple, tile-stipple-x-origin, 
tile-stipple-y-origin, dash-offset, and dash-list.</para>

<para><emphasis remap='I'>&hairsp;XDrawLine&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;XDrawLines&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;XDrawSegments&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadDrawable&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadGC&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis>
errors.
<emphasis remap='I'>&hairsp;XDrawLines&hairsp;</emphasis>
can also generate a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error.</para>
</refsect1>

<refsect1 id='structures'><title>STRUCTURES</title>
<para>The
<emphasis remap='I'>&hairsp;XSegment&hairsp;</emphasis>
structure contains:</para>

<literallayout remap='.nf'>
<!-- .0D  0 -->

<!-- .ps \n(PS -->
<!-- .if \n(VS&gt;=40 .vs \n(VSu -->
<!-- .if \n(VS&lt;=39 .vs \n(VSp -->
<!-- .TA .5i -->
<!-- .ta .5i -->
typedef struct {
	short x1, y1, x2, y2;
} XSegment;
<!-- .ce 0  IGNORED -->
<!-- .in \n(OIu  IGNORED -->

</literallayout> <!-- .fi -->

<para>All x and y members are signed integers.
The width and height members are 16-bit unsigned integers.
You should be careful not to generate coordinates and sizes
out of the 16-bit ranges, because the protocol only has 16-bit fields
for these values.</para>
</refsect1>

<refsect1 id='diagnostics'><title>DIAGNOSTICS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadDrawable&hairsp;</emphasis></term>
  <listitem>
<para>A value for a Drawable argument does not name a defined Window or Pixmap.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadGC&hairsp;</emphasis></term>
  <listitem>
<para>A value for a GContext argument does not name a defined GContext.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis></term>
  <listitem>
<para>An
<emphasis remap='I'>&hairsp;InputOnly&hairsp;</emphasis>
window is used as a Drawable.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis></term>
  <listitem>
<para>Some argument or pair of arguments has the correct type and range but fails
to match in some other way required by the request.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis></term>
  <listitem>
<para>Some numeric value falls outside the range of values accepted by the request.
Unless a specific range is specified for an argument, the full range defined
by the argument's type is accepted.  Any argument defined as a set of
alternatives can generate this error.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>XDrawArc(3X11),
XDrawPoint(3X11),
XDrawRectangle(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

