ref_vfmethod_configProc - shekh/VirtualDub2 GitHub Wiki

VirtualDub Plugin SDK 1.2

configProc video filter method

configProc

Opens up a Windows GUI dialog box to allow the user to configure the filter's settings.

int configProc(VDXFilterActivation *fa, const VDXFilterFunctions *ff, HWND hWnd);

Parameters

fa	Pointer to filter activation structure.
ff	Pointer to callback function structure.
hwnd	Handle of parent window to use for dialog.

Thread safety

This method is not thread-safe.

Exceptions

This function must not throw exceptions (see Except()).

Return value

Zero if configuration is successful, non-zero on error or if the user canceled configuration.

Remarks

If you do not have a configuration dialog, omit configProc. VirtualDub attempts to open a filter's configuration dialog when a filter is first added, and if configProc returns non-zero, the filter is not added to the chain.

Generally, configProc is implemented as a call to DialogBoxParam() with the given parent window handle. Remember, VirtualDub starts the process, so you will need to use your filter's cached module handle to access dialog box resources.

Any settings exposed here should also be replicated in the filter's scripting interface, so that the filter works properly in batch mode and in Avisynth.

Please make sure your dialog fits in a 640x480 screen -- some video cards with integrated capture do not work unless the desktop resolution is lowered, and so your filter may still be used on a system with a 640x480 or 800x600 desktop.