al_lock_index_buffer(3)

💅 al_lock_index_buffer(3) 💅

okay so bestie, we're in the Library Functions Manual and this is the Allegro 5 API page for al_lock_index_buffer. Pull up a chair, hydrate, and let's lock an index buffer the right way ✨

💖 NAME 💖

al_lock_index_buffer — Allegro 5 API. That's the whole name situation: this is the Allegro 5 API function for locking an index buffer, periodt 💅

✨ SYNOPSIS ✨

#include <allegro5/allegro_primitives.h>

void* al_lock_index_buffer(ALLEGRO_INDEX_BUFFER* buffer, int offset,
    int length, int flags)

🎀 DESCRIPTION 🎀

Locks an index buffer so you can access its data — yes, that's the whole point, bestie. It returns NULL if the parameters are invalid, if reading is requested from a write only buffer, and if the buffer is already locked. So like, check yourself before you wreck yourself on those three conditions 😭

Parameters:

• buffer — the index buffer you wanna lock 🫶
• offset — the element index of the start of the locked range; think "where the lock begins" ✨
• length — how many indices to lock, i.e. the size of your locked little zone 💅
• flags — one of ALLEGRO_LOCK_READONLY, ALLEGRO_LOCK_WRITEONLY or ALLEGRO_LOCK_READWRITE; pick your access vibe, but only from those exact three 🌈

🦋 SINCE 🦋

5.1.8 — she's been around since 5.1.8, iconic behavior 👑

🌈 SEE ALSO 🌈

• ALLEGRO_INDEX_BUFFER(3) — the index buffer bestie herself
• al_unlock_index_buffer(3) — the unlock counterpart, because what goes locked must eventually unlock 💖

---

Cute lil sign-off: this page is from the Allegro reference manual, and the footer name is al_lock_index_buffer(3). No date listed on the original footer, so I'm not gonna invent one — mwah 💋