---
name: "al_lock_index_buffer"
section: "3alleg5"
platform: "linux"
package: "allegro5-doc"
version: "2:5.2.10.1+dfsg-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/al_lock_index_buffer/3alleg5"
---

# al\_lock\_index\_buffer(3alleg5)

Allegro 5 API

## NAME

al\_lock\_index\_buffer - Allegro 5 API

## SYNOPSIS

-

  ```
  #include <allegro5/allegro_primitives.h>
  void* al_lock_index_buffer(ALLEGRO_INDEX_BUFFER* buffer, int offset,
      int length, int flags)
  ```

## DESCRIPTION

Locks a index buffer so you can access its data. Will return NULL if the parameters are invalid, if reading is requested from a write only buffer and if the buffer is already locked.

*Parameters:*

- •

  buffer - Index buffer to lock

- •

  offset - Element index of the start of the locked range

- •

  length - How many indices to lock

- •

  flags - ALLEGRO\_LOCK\_READONLY, ALLEGRO\_LOCK\_WRITEONLY or ALLEGRO\_LOCK\_READWRITE

## SINCE

5\.1.8

## SEE ALSO

ALLEGRO\_INDEX\_BUFFER(3alleg5), al\_unlock\_index\_buffer(3alleg5)