dmFXUpdateImageBuffer(3dm)

NAME
     dmFXUpdateImageBuffer, dmFXUpdateImageBuffers, dmFXGetBufferFormat -
     change the active size of a special effects buffer

SYNOPSIS
     #include <dmedia/fx_buffer.h>

     DMstatus dmFXUpdateImageBuffer
         ( const DMparams* imageFormat,
           DMfxbuffer*     buffer );

     DMstatus dmFXUpdateImageBuffers
         ( const DMparams* imageFormat,
           int             numberOfBuffers,
           DMfxbuffer*     buffers[] );

     DMparams* dmFXGetBufferFormat
         ( DMfxbuffer buffer );


PARAMETERS
     imageFormat       A parameter list that describes the new image size to
                       be stored in the buffer.

     buffer            An image buffer.

     numberOfBuffers   The number of elements in the array buffers.

     buffers           An array of image buffers.


DESCRIPTION
     A special-effects image buffer has a fixed size, which is the amount of
     storage allocated to store an image.  By default, the buffers deals with
     images of that size.  They can also be used to deal with images that are
     smaller.  To do this, the "active size" of the buffer must be changed
     with dmFXUpdateImageBuffer or dmFXUpdateImageBuffers.

     dmFXUpdateImageBuffer is used to update the size of a single buffer, and
     dmFXUpdateImageBuffers is used to update the size of several buffers at
     once.  The new size is taken from the DM_IMAGE_WIDTH and DM_IMAGE_HEIGHT
     parameters in imageFormat.

     The current size of a buffer, as well as its other image format
     parameters, can be obtained by calling dmFXGetBufferFormat.



RETURN VALUES
     dmFXUpdateImageBuffer and dmFXUpdateImageBuffers will return DM_SUCCESS
     if the size of all of the buffers was changed, or DM_FAILURE if not.
     The parameter list returned by dmFXGetBufferFormat is owned by the
     buffer.  It may be queried, but should not be modified or freed.


SEE ALSO
     dmFXAllocateImageBuffers(3dm)