alSynAllocFX, n_alSynAllocFX

Allocates an audio effect processor

Syntax

#include <libaudio.h>     /* libaudio.h */
ALFxRef alSynAllocFX(ALSynth *drvr, s16 bus, ALSynConfig *c, ALHeap *hp);

#include <n_libaudio.h>     /* n_libaudio.h */
ALFxRef	n_alSynAllocFX(             s16 bus, ALSynConfig *c, ALHeap *hp);

Arguments

drvr

Pointer to the synthesizer driver

bus

Auxiliary bus that feeds the allocated effect

c

Pointer to a synthesizer configuration structure

hp

Pointer to the heap to use for effect structures

Description

alSynAllocFX allocates and assigns an effect processor to an auxiliary bus, and it returns a reference number. The effect uses memory allocated from heap.

For details on n_audio library, see "Chapter 28: n_audio library" in the N64 Programming Manual.

Note

This function is called when the application calls alInit, provided the configuration structure passed to alInit does not have the effects type parameter set to AL_FX_NONE. Usually, your application should not call this function (alSynAllocFX) directly.

See Also

alSynFreeFX, alSynSetFXMix, and alSynSetFXParam

Revision History

1999/04/30 Changed Format