dmFXSetupScanlineBuffer(3dm)dmFXSetupScanlineBuffer(3dm)NAMEdmFXSetupScanlineBuffer - get information about a special-effects image
buffer
SYNOPSIS
#include <dmedia/fx_buffer.h>
DMstatus dmFXSetupScanlineBuffer
( DMfxbuffer* buffer,
PRX_ScanlineBuffer* returnInfo )
PARAMETERS
buffer A special-effects image buffer that has been set up for
access with dmFXSetupInputImageBuffer or
dmFXSetupOutputImageBuffer.
returnInfo A PRX_ScanlineBufferRec structure, which will be filled in.
DESCRIPTIONdmFXSetupScanlineBuffer returns information about an image buffer,
including: data, a pointer to the image data, rowBytes the number of
bytes (stride) for each row of the image, bounds, the size of the image.
This function sets all fields of the PRX_ScanlineBufferRec structure,
except for appPrivate.
Under normal circumstances, the number of bytes for each row will be four
times the buffer width. Applications that use DMfxbuffers can count on
this. It can be useful, when debugging plugins, to create buffers that
have a larger internal width. If you are using the debug version of
libfxplugutils, setting the environment variable FX_STRANGE_ROWBYTES to
YES will cause it to create buffers where the width of the storage area
is greater than is needed.
RETURN VALUES
It returns DM_SUCCESS or DM_FAILURE. In the case of failure, error
information can be obtained from dmGetError(3dm).
SEE ALSOdmFXMovieRenderImage(3dm), dmFXSetupInputImageBuffer(3dm),
dmFXSetupScanlineBuffer(3dm), dmFXIsGLExtensionSupported(3dm),
dmGetError(3dm).
Page 1
