ref_iface_IVDXFilterPreview_SampleCurrentFrame - shekh/VirtualDub2 GitHub Wiki

VirtualDub Plugin SDK 1.2

IVDXFilterPreview interface

IVDXFilterPreview:: SampleCurrentFrame

Requests the current frame for analysis.

void SampleCurrentFrame();

Thread safety

This method is not thread-safe.

Errors

Errors may not be returned from this function (see SetError()).

Remarks

SampleCurrentFrame() is usually called in response to a user request to display information about the current frame, such as an image histogram. It causes the source frame to be sent to the sampling callback specified by SetSampleCallback().

V12+ only: The frame is sent to the callback in the same format as the filter would receive in its Run() method. This means that the sampling callback must be able to process any source image format that the filter supports.