al_draw_polyline(3)

🌸 NAME 🌸

al_draw_polyline — Allegro 5 API. This is page al_draw_polyline(3) from the Library Functions Manual, and she's here to draw a series of line segments for you, bestie. ✨

🦋 SYNOPSIS 🦋

              #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)

💖 DESCRIPTION 💖

Okay so the whole vibe: draw a series of line segments. That's the main character energy. 🎀

Here's the cast of parameters, and yes every single one matters:

• vertices — interleaved array of (x, y) vertex coordinates. Cute little coordinate pairs living their best life together.
• vertex_stride — the number of bytes between pairs of vertices (the stride). Yes, bytes. She's measuring the gap, not the drip. 💅
• vertex_count — number of vertices in the array.
• join_style — member of ALLEGRO_LINE_JOIN(3) specifying how to render the joins between line segments.
• cap_style — member of ALLEGRO_LINE_CAP(3) specifying how to render the end caps.
• color — color of the line.
• thickness — thickness of the line, pass <= 0 to draw hairline lines. Hairline is giving ✨delicate✨.
• miter_limit — parameter for miter join style.

The stride is normally 2 * sizeof(float) but may be more if the vertex coordinates are in an array of some structure type, e.g.:

              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);
              }

The stride may also be negative if the vertices are stored in reverse order. Not me learning that and gasping 😭 — but fr fr, it's allowed.

⭐ SINCE ⭐

5.1.0 — she's been iconic since then. 👑

🌈 SEE ALSO 🌈

• al_draw_polygon(3)
• ALLEGRO_LINE_JOIN(3)
• ALLEGRO_LINE_CAP(3)

---

mwah 💋 — source/version: Allegro reference manual · date: not listed on the page · footer page: al_draw_polyline(3). That's the whole tea, bestie. 🍓