File: al_reserve_samples.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (37 lines) | stat: -rw-r--r-- 1,083 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
.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
automatically create a voice with an attached mixer, which becomes the
default mixer.
This diagram illustrates the structures that are set up:
.IP
.nf
\f[C]
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ sample\ instance\ 1
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ /\ sample\ instance\ 2
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)