alSndpDeallocate.3p
894 Bytes
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
.TH alSndpDeallocate 3P local "Silicon Graphics, Inc."
.SH NAME
.upperok
alSndpDeallocate \- deallocate a sound from a sound player
.SH SYNOPSIS
.nf
\f3
.Op c
#include <libaudio.h>
.sp .8v
void alSndpDeallocate(ALSndPlayer *sndp, ALSndId id);
.Op
\f1
.fi
.SH PARAMETERS
.TP 10
.I sndp
pointer to a sound player.
.TP
.I id
unique number which identifies a sound within a sound player. This
id is returned when the sound is allocated to the sound player.
.SH DESCRIPTION
alSndpDeallocate deallocates a
.I sound
from a sound player,
.I sndp,
freeing up space within the sound player. If the deallocated sound is
the current target sound the target is set to -1.
.SH NOTE
You should only call alSndpDeallocate for a sound after the sound's state
has reached AL_STOPPED.
.SH SEE ALSO
.IR alSndpSetSound (3P),
.IR alSndpGetSound (3P),
.IR alSndpAllocate (3P),
.IR alSndpGetState (3P)