File: al_lock_vertex_buffer.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (36 lines) | stat: -rw-r--r-- 875 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
.TH "al_lock_vertex_buffer" "3" "" "Allegro reference manual" ""
.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[]
.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[]
.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(3), al_unlock_vertex_buffer(3)