carb::audio::UserDataDestructor

Defined in carb/audio/AudioTypes.h

typedef void (*carb::audio::UserDataDestructor)(void *userData)

prototype for the optional destructor function for a user data object.

Remark

This destroys the user data object associated with an object. The parent object may be a sound data object or sound group, but is irrelevant here since it is not passed into this destructor. This destructor is optional. If specified, it will be called any time the user data object is replaced with a setUserData() function or when the containing object itself is being destroyed.

Parameters

data – [in] the user data object to be destroyed. This will never be nullptr.

Returns

no return value.