C4 Engine
C4 Engine API Documentation

Sound::SetFrequencyVariationCompletionCallback

Defined in:  C4Sound.h
Installs a completion callback function that is invoked when a frequency variation has completed.
Prototype

void SetFrequencyVariationCompletionCallback(VariationCallback *callback, void *cookie = nullptr);

Parameters
callback The frequency variation completion callback function. This parameter may be nullptr, in which case the sound has no frequency variation completion callback function.
cookie The cookie that is passed to the frequency variation completion callback function as its last parameter.
Description
The SetFrequencyVariationCompletionCallback function installs a completion callback function that is invoked every time that a frequency variation operation completes for the sound for which it is installed. The VariationCallback type is defined as follows.

typedef void VariationCallback(Sound *, void *);

When the function pointed to by the callback parameter is called, the pointer to the sound object and the value supplied in the cookie parameter are passed to it. By default, there is no frequency variation completion callback function installed.
See Also

Sound::VaryFrequency

Sound::FrequencyVarying

Sound::SetVolumeVariationCompletionCallback