FMOD_DSP_SYSTEM_DEREGISTER_CALLBACK

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_DSP_SYSTEM_DEREGISTER_CALLBACK

This callback is called when the user unloads a DSP plugin, or shuts down FMOD using System::close or System::release. The function can be used as a 'one off' shut down for the plugin after all instances have been freed.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_DSP_SYSTEM_DEREGISTER_CALLBACK(
  FMOD_DSP_STATE *dsp_state
);

Parameters

dsp_state

Pointer to the plugin state. The user can use this variable to access runtime plugin specific variables and plugin writer user data. Do not cast this to FMOD_DSP! The instance pointer in the state for this callback will be 0 / null. Only 'systemobject' and 'callbacks' are valid for use.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

The callback is not associated with any DSP instance, so the instance member of FMOD_DSP_STATE will be 0 / NULL. Functions that the user would have to call for this callback to be called.

Remember to return FMOD_OK at the bottom of the function, or an appropriate error code from FMOD_RESULT.

See Also




Version 1.10.03 Built on Feb 1, 2018