.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "al_lock_vertex_buffer" "3alleg5" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_lock_vertex_buffer - Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <allegro5/allegro_primitives.h>

void* al_lock_vertex_buffer(ALLEGRO_VERTEX_BUFFER* buffer, int offset,
   int length, int flags)
\f[R]
.fi
.SH DESCRIPTION
.PP
Locks a vertex buffer so you can access its data.
Will return NULL if the parameters are invalid, if reading is requested
from a write only buffer, or if the buffer is already locked.
.PP
\f[I]Parameters:\f[R]
.IP \[bu] 2
buffer - Vertex buffer to lock
.IP \[bu] 2
offset - Vertex index of the start of the locked range
.IP \[bu] 2
length - How many vertices to lock
.IP \[bu] 2
flags - ALLEGRO_LOCK_READONLY, ALLEGRO_LOCK_WRITEONLY or
ALLEGRO_LOCK_READWRITE
.SH SINCE
.PP
5.1.3
.SH SEE ALSO
.PP
ALLEGRO_VERTEX_BUFFER(3alleg5), al_unlock_vertex_buffer(3alleg5)