al_draw_indexed_prim(3alleg5)

📦
version 5.2.11.3 · 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ al_draw_indexed_prim ✨

okay bestie, so this is a page from the 3alleg5 manual — that's the Allegro 5 API, and this little function right here is lowkey a whole icon. 💅

🌸 NAME 🌸

al_draw_indexed_prim — Allegro 5 API, the index-array queen 👑

🦋 SYNOPSIS 🦋

#include <allegro5/allegro_primitives.h>

int al_draw_indexed_prim(const void* vtxs, const ALLEGRO_VERTEX_DECL* decl,
   ALLEGRO_BITMAP* texture, const int* indices, int num_vtx, int type)

💖 DESCRIPTION 💖

So here's the vibe: you've got a big ol' vertex array, right? But you don't wanna draw all of it — you only want a subset. That's where this function comes in. It draws a subset of the passed vertex array, and it uses an index array to tell it exactly which vertices to grab. It's giving "girl with a list, she knows exactly what she wants." 📝✨

Parameters, let's go one by one:

  • texture — the texture to use, bestie. And if you pass NULL? Then you're using only color shaded primitves. (yes, that's how the original spells it, and yes, we're keeping it, no cap 🙈)
  • vtxs — pointer to an array of vertices. Your little vertex collection 🫶
  • decl — pointer to a vertex declaration. And if you set it to NULL, the vtxs are assumed to be of the ALLEGRO_VERTEX type. So like, default mode activated 💫
  • indices — an array of indices into the vertex array. The receipts, the master list, the who's-who 🎀
  • num_vtx — number of indices from the indices array you want to draw. Not all of them? That's fine, pick your faves 🍓
  • type — a member of the ALLEGRO_PRIM_TYPE(3alleg5) enumeration, specifying what kind of primitive to draw. This is the "what are we even making" question 🌈

Returns: the number of primitives drawn. That's your little receipt of how much art you just made. Iconic. 👑

ngl, this one is genuinely obsessed with efficiency — why redraw vertices when you can just point at them with an index array? it's giving main character energy, fr fr.

🌟 SEE ALSO 🌟

and that's the whole page, bestie!! this one came straight out of the Allegro reference manual, page al_draw_indexed_prim(3alleg5) — go draw something pretty with it, ily, mwah 🎀💅💖

📦 where this page comes from