dmFXGetDMBuffer(3dm)

NAME
     dmFXGetDMBuffer - return the DMbuffer associated with a DMfxbuffer


SYNOPSIS
     #include <dmedia/fx_buffer.h>

     DMstatus dmFXGetDMBuffer
           ( DMfxbuffer* fxbuffer,
             DMbuffer*   returnDMBuffer,
             DMparams**  returnFormat )


PARAMETERS
     fxbuffer         A buffer that was created with dmFXAllocateImageBuffers.


     returnDMBuffer   A pointer to a DMbuffer* to fill in.


DESCRIPTION
     Some implementations of DMfxbuffers use DMbuffers internally to hold
     images.  An application can get a pointer to this DMbuffer, if there is
     one, by calling dmFXGetDMBuffer.


     If there is an a DMbuffer associated with fxbuffer, then returnDMBuffer
     will be set, returnFormat will be set to describe the format of the image
     in the buffer, and DM_SUCCESS will be returned.  Both returnDMBuffer and
     returnFormat are valid only until the next operation on the same
     DMfxbuffer.


     If there is no associated DMbuffer, then DM_FAILURE is returned.


SEE ALSO
     dmFXAllocateImageBuffers(3dm), DMbuffer(4).