dmFXJoinFields(3dm)

NAME
     dmFXJoinFields - join two fields into a single frame


SYNOPSIS
     #include <dmedia/fx_buffer.h>

     DMstatus dmFXJoinFields
           ( int inputUsage,
             DMfxbuffer *fieldA,
             DMfxbuffer *fieldB,
             DMfxbuffer *dstFrame )


PARAMETERS
     inputUsage   Specifies the modes in which dstFrame will be used as input;
                  says how the image will be read from the buffer and used as
                  input to a plug-in or application.  The value is a bitwise
                  combination of one or more of: bufInputDirect,
                  bufInputTexture, bufInputDrawPixels, bufInputMovie.  The
                  options set must include all of the different ways in which
                  dstFrame will be used.

     fieldA       The "top-most" field.  Scanline 0 of fieldA will be copied
                  to scanline 0 of the destination frame (dstFrame).

     fieldB       The "bottom-most" field.  Scanline 0 of fieldB will be
                  copied to scanline 1 of the destination frame (dstFrame).

     dstFrame     The destination frame to copy the two fields.


DESCRIPTION
     dmFXJoinFields will create a frame from two fields.  The source field
     buffers must be half the height of the destination frame buffer (see
     dmFXAllocateImageBuffers), and the width of the source field buffers must
     be the same as the width of the destination frame buffer.

     The scanlines from fieldA are copied to the even numbered scanlines of
     the destination frame starting at the destination frame's row 0.  The
     scanlines from fieldB are copied to the odd numbered scanlines of the
     destination frame starting at the destination frame's row 1.


RETURN VALUES
     dmFXJoinFields will return DM_SUCCESS on success, and DM_FAILURE on
     failure.  In the case of failure, error information can be obtained from
     dmGetError(3dm).  Potential reasons for failure include:
     FX_ERROR_BAD_PARAMETER   The height of the destination frame buffer is
                              not 2 times the height of the source field
                              buffers

     FX_ERROR_BAD_PARAMETER   The width of the destination frame buffer is not
                              equal to the width of the source field buffers


SEE ALSO
     dmFXSplitFields(3dm), dmFXMovieRenderFields(3dm),
     dmFXMovieInsertFields(3dm), dmFXAllocateImageBuffers(3dm), DMbuffer(4)