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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
.TH "al_create_index_buffer" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_create_index_buffer \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_primitives.h>
ALLEGRO_INDEX_BUFFER*\ al_create_index_buffer(int\ index_size,
\ \ \ \ const\ void*\ initial_data,\ int\ num_indices,\ int\ flags)
\f[]
.fi
.SH DESCRIPTION
.PP
Creates a index buffer.
Can return NULL if the buffer could not be created (e.g.
the system only supports write\-only buffers).
.RS
.PP
\f[I]Note:\f[]
.PP
This is an advanced feature, often unsupported on lower\-end video
cards.
Be extra mindful of this function failing and make arrangements for
fallback drawing functionality or a nice error message for users with
such lower\-end cards.
.RE
.PP
\f[I]Parameters:\f[]
.IP \[bu] 2
index_size \- Size of the index in bytes.
Supported sizes are 2 for short integers and 4 for integers
.IP \[bu] 2
initial_data \- Memory buffer to copy from to initialize the index
buffer.
Can be \f[C]NULL\f[], in which case the buffer is uninitialized.
.IP \[bu] 2
num_indices \- Number of indices the buffer will hold
.IP \[bu] 2
flags \- A combination of the ALLEGRO_PRIM_BUFFER_FLAGS(3) flags
specifying how this buffer will be created.
Passing 0 is the same as passing \f[C]ALLEGRO_PRIM_BUFFER_STATIC\f[].
.SH SINCE
.PP
5.1.8
.SH SEE ALSO
.PP
ALLEGRO_INDEX_BUFFER(3), al_destroy_index_buffer(3)
|
