.\" Automatically generated by Pandoc 3.6.1
.\"
.TH "al_draw_polyline" "3" "" "Allegro reference manual"
.SH NAME
al_draw_polyline \- Allegro 5 API
.SH SYNOPSIS
.IP
.EX
#include \f[B]<allegro5/allegro_primitives.h>\f[R]

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)
.EE
.SH DESCRIPTION
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(3) specifying how to render
the joins between line segments
.IP \[bu] 2
cap_style \- Member of ALLEGRO_LINE_CAP(3) 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[CR]<= 0\f[R] to draw
hairline lines
.IP \[bu] 2
miter_limit \- Parameter for miter join style
.PP
The stride is normally \f[CR]2 * sizeof(float)\f[R] but may be more if
the vertex coordinates are in an array of some structure type, e.g.
.IP
.EX
\f[B]struct\f[R] VertexInfo {
   float x;
   float y;
   int id;
};

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