alSynAllocFX.3p
1 KB
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
.TH alSynAllocFX 3P local "Silicon Graphics, Inc."
.SH NAME
.upperok
alSynAllocFx \- allocate an audio effect processor
.SH SYNOPSIS
.nf
\f3
.Op c
#include <libaudio.h>
.sp .8v
ALFxRef alSynAllocFx(ALSynth *drvr, s16 bus, ALSynConfig *c, ALHeap *hp);
.Op
\f1
.fi
.SH PARAMETERS
.TP 10
.I drvr
pointer to the synthesizer driver
.TP
.I bus
auxilliary bus that feeds the allocated effect
.TP
.I c
pointer to a synthesizer configuration structure
.TP
.I hp
pointer to the heap to use for effect structures
.SH DESCRIPTION
Allocate and assign an effect processor to an auxilliary bus and return a
reference number. The effect will use memory allocated from
.I hp.
.SH NOTE
.I alSynAllocFX
gets called when the application calls
.I alInit,
provided the configuration structure passed to
.I alInit
does not have the effects type parameter set to AL_FX_NONE.
Normally, the application should not call
.I alSynAllocFX
directly.
.SH SEE ALSO
.IR alSynFreeFX (3P),
.IR alSynSetFXMix (3P),
.IR alSynSetFXParam (3P),
.IR alInit (3P)