.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "al_draw_polyline" "3alleg5" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_draw_polyline - Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <allegro5/allegro_primitives.h>

void al_draw_polyline(const float* vertices, int vertex_stride,
   int vertex_count, int join_style, int cap_style,
   ALLEGRO_COLOR color, float thickness, float miter_limit)
\f[R]
.fi
.SH DESCRIPTION
.PP
Draw a series of line segments.
.IP \[bu] 2
vertices - Interleaved array of (x, y) vertex coordinates
.IP \[bu] 2
vertex_stride - the number of bytes between pairs of vertices (the
stride)
.IP \[bu] 2
vertex_count - Number of vertices in the array
.IP \[bu] 2
join_style - Member of ALLEGRO_LINE_JOIN(3alleg5) specifying how to
render the joins between line segments
.IP \[bu] 2
cap_style - Member of ALLEGRO_LINE_CAP(3alleg5) specifying how to render
the end caps
.IP \[bu] 2
color - Color of the line
.IP \[bu] 2
thickness - Thickness of the line, pass \f[V]<= 0\f[R] to draw hairline
lines
.IP \[bu] 2
miter_limit - Parameter for miter join style
.PP
The stride is normally \f[V]2 * sizeof(float)\f[R] but may be more if
the vertex coordinates are in an array of some structure type, e.g.
.IP
.nf
\f[C]
struct VertexInfo {
   float x;
   float y;
   int id;
};

void my_draw(struct VertexInfo verts[], int vertex_count, ALLEGRO_COLOR c)
{
   al_draw_polyline((float *)verts, sizeof(VertexInfo), vertex_count,
      ALLEGRO_LINE_JOIN_NONE, ALLEGRO_LINE_CAP_NONE, c, 1.0, 1.0);
}
\f[R]
.fi
.PP
The stride may also be negative if the vertices are stored in reverse
order.
.SH SINCE
.PP
5.1.0
.SH SEE ALSO
.PP
al_draw_polygon(3alleg5), ALLEGRO_LINE_JOIN(3alleg5),
ALLEGRO_LINE_CAP(3alleg5)