dmFXSplitFields(3dm)					  dmFXSplitFields(3dm)

NAME    [Toc]    [Back]

     dmFXSplitFields - split a frame out into two fields

SYNOPSIS    [Toc]    [Back]

     #include <dmedia/fx_buffer.h>

     DMstatus dmFXSplitFields    [Toc]    [Back]
	   ( int inputUsage,
	     DMfxbuffer	*srcFrame,
	     DMfxbuffer	*fieldA,
	     DMfxbuffer	*fieldB	)

PARAMETERS    [Toc]    [Back]

     inputUsage	  Specifies the	modes in which the destination field buffers
		  (fieldA and fieldB) will be used as input; says how the
		  image	will be	read from the buffers 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 fieldA and	fieldB
		  will be used.

     srcFrame	  The source frame to copy scanlines from.  The	even numbered
		  scanlines (counting from 0) will be copied to	fieldA,	and
		  the odd numbered scanlines will be copied to fieldB.

     fieldA	  The "top-most" field.

     fieldB	  The "bottom-most" field.

DESCRIPTION    [Toc]    [Back]

     dmFXSplitFields will create two fields from a single frame.  The source
     frame buffer must be twice	the height of the two field buffers (see
     mFXAllocateImageBuffers), and the source frame width must match the width
     of	the two	field buffers.

     The scanlines from	the source frame are split out into two	field buffers.
     The even numbered scanlines (counting from	0) from	the source frame
     (srcFrame)	are copied into	fieldA,	and the	odd numbered scanlines are
     copied into fieldB.

RETURN VALUES    [Toc]    [Back]

     dmFXSplitFields 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:






									Page 1






dmFXSplitFields(3dm)					  dmFXSplitFields(3dm)



     FX_ERROR_BAD_PARAMETER   The height of the	source frame buffer is not 2
			      times the	height of the destination field
			      buffers

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

SEE ALSO    [Toc]    [Back]

     dmFXJoinFields(3dm), dmFXMovieRenderFields(3dm),
     dmFXMovieInsertFields(3dm), dmFXAllocateImageBuffers(3dm),	DMbuffer(4)


									PPPPaaaaggggeeee 2222