al_draw_vertex_buffer(3)

okay bestie, welcome to the al_draw_vertex_buffer(3) page from the Library Functions Manual — Allegro 5 API edition 💖. This is the function that draws a subset of a vertex buffer, and yes, there are rules. Let's get into it ✨.

🌸 NAME 🌸

al_draw_vertex_buffer — the Allegro 5 API function for drawing a subset of a passed vertex buffer. Iconic, focused, does one job 💅.

✨ SYNOPSIS ✨

#include <allegro5/allegro_primitives.h>

int al_draw_vertex_buffer(ALLEGRO_VERTEX_BUFFER* vertex_buffer,
                 ALLEGRO_BITMAP* texture, int start, int end, int type)

💖 DESCRIPTION 💖

This draws a subset of the vertex buffer you pass in 🫶. Two big vibe checks before you go there:

• The vertex buffer must not be locked 🔒🚫.
• Also, to draw onto memory bitmaps or with memory bitmap textures, the vertex buffer must support reading — i.e. it must be created with the ALLEGRO_PRIM_BUFFER_READWRITE 👑.

🧚 Parameters 🧚

• vertex_buffer — vertex buffer to draw 💅
• texture — texture to use; pass NULL to use only color-shaded primitives ✨
• start — start index of the subset of the vertex buffer to draw
• end — one past the last index of the subset of the vertex buffer to draw
• type — a member of the ALLEGRO_PRIM_TYPE(3) enumeration, specifying what kind of primitive to draw

👑 Returns 👑

Returns: Number of primitives drawn ✨.

🦋 SINCE 🦋

5.1.3 — yes, she's been serving since then 💜.

🎀 SEE ALSO 🎀

• also bestie: ALLEGRO_VERTEX_BUFFER(3)
• and also bestie: ALLEGRO_PRIM_TYPE(3)

🌸 that's a wrap! source/version: Allegro reference manual · page: al_draw_vertex_buffer(3) · date: this footer doesn't print one, so I'm not inventing a date, bestie 💅🌸