File: al_reserve_samples.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 (38 lines) | stat: -rw-r--r-- 1,188 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
37
38
.TH "al_reserve_samples" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_reserve_samples \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_audio.h>

bool\ al_reserve_samples(int\ reserve_samples)
\f[]
.fi
.SH DESCRIPTION
.PP
Reserves a number of sample instances, attaching them to the default
mixer.
If no default mixer is set when this function is called, then it will
create one and attach it to the default voice.
If no default voice has been set, it, too, will be created.
.PP
This diagram illustrates the structures that are set up:
.IP
.nf
\f[C]
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sample\ instance\ 1
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ /\ sample\ instance\ 2
default\ voice\ <\-\-\ default\ mixer\ <\-\-\-\ \ \ \ \ \ \ \ \ .
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \\\ \ \ \ \ \ \ \ .
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sample\ instance\ N
\f[]
.fi
.PP
Returns true on success, false on error.
al_install_audio(3) must have been called first.
.SH SEE ALSO
.PP
al_set_default_mixer(3), al_play_sample(3)