FMOD_DSP_DIALOG_CALLBACK

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_DSP_DIALOG_CALLBACK

This callback is called when the user wants the plugin to display a configuration dialog box. This is not always nescessary, so this can be left blank if wanted.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_DSP_DIALOG_CALLBACK(
  FMOD_DSP_STATE *dsp_state,
  void *hwnd,
  int show
);

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 handle to the user created DSP handle is stored within the FMOD_DSP_STATE structure.

hwnd

This is the target hwnd to display the dialog in. It must not pop up on this hwnd, it must actually be drawn within it.

show

1 = show the dialog, 0 = hide/remove the dialog.

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

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