dmPMSetupVideoFilter(3dm)

NAME
     dmPMSetupVideoFilter, dmPMExecuteVideoFilter, dmPMCleanupVideoFilter,
     dmPMBufferSetupVideoFilter, dmPMBufferExecuteVideoFilter - sets up,
     executes, and cleanups video filters


SYNOPSIS
     #include <dmedia/fx_plugin_mgr.h>

     DMstatus dmPMSetupVideoFilter
           ( DMeffect* effect,
             void *src,
             DMparams *srcParams,
             unsigned int part,
             unsigned int total )

     DMstatus dmPMExecuteVideoFilter
           ( DMeffect* effect,
             void *src,
             DMparams *srcParams,
             void *dst,
             DMparams *dstParams,
             unsigned int part,
             unsigned int total )

     DMstatus dmPMCleanupVideoFilter
           ( DMeffect* effect )

     DMstatus dmPMBufferSetupVideoFilter
           ( DMeffect* effect,
             DMfxbuffer *srcBuffer,
             DMparams *srcParams,
             unsigned int part,
             unsigned int total )

     DMstatus dmPMBufferExecuteVideoFilter
           ( DMeffect* effect,
             DMfxbuffer *srcBuffer,
             DMparams *srcParams,
             DMfxbuffer *dstBuffer,
             DMparams *dstParams,
             unsigned int part,
             unsigned int total )


PARAMETERS
     effect      A pointer to a DMeffect, which was returned from
                 dmPMCreateEffect.

     src         A pointer to the video source image.
     srcParams   The source parameter/value list, a pointer to DMparams, can
                 be created with dmParamsCreate.

     part        Goes from 0 to total (inclusive).

     total       The total number of frames.

     dst         A pointer to the video destination image.

     dstParams   The destination parameter/value list, a pointer to DMparams,
                 can be created with dmParamsCreate.

     srcBuffer   A pointer to a DMfxbuffer for the source, which was returned
                 from dmFXAllocateImageBuffers.

     dstBuffer   A pointer to a DMfxbuffer for the destination, which was
                 returned from dmFXAllocateImageBuffers.


DESCRIPTION
     Video filters may have user customizable settings in the form of a dialog
     box.  Calling dmPMSetupVideoFilter allows the video filter plugin to post
     the dialog and query values from the user.  Because all plugins must have
     default values, calling dmPMSetupVideoFilter is optional.  Calling
     dmPMExecuteVideoFilter will cause the video filter to be executed on your
     video clip.  dmPMCleanupVideoFilter does not normally need to be called
     directly from your application.


RETURN VALUES
     dmPMSetupVideoFilter will return DM_SUCCESS if successful, or will return
     DM_FAILURE if it fails.  dmPMExecuteVideoFilter will return DM_SUCCESS if
     successful, or will return DM_FAILURE if it fails.
     dmPMCleanupVideoFilter will return DM_SUCCESS if successful, or will
     return DM_FAILURE if it fails.  dmPMBufferSetupVideoFilter will return
     DM_SUCCESS if successful, or will return DM_FAILURE if it fails.
     dmPMBufferExecuteVideoFilter will return DM_SUCCESS if successful, or
     will return DM_FAILURE if it fails.


SEE ALSO
     dmPMCreateManager(3dm), dmPMCreateEffect(3dm), dmGetError(3dm).