dmIC(3dm)dmIC(3dm)NAME
dmICSetSrcParams, dmICGetSrcParams, dmICGetDefaultSrcParams - manipulate
image converter context src image format
SYNOPSIS
#include <dmedia/dm_imageconvert.h>
#include <dmedia/dm_image.h>
DMstatus dmICSetSrcParams(DMimageconverter converter, DMparams* srcParams);
DMstatus dmICGetSrcParams(DMimageconverter converter, DMparams* srcParams);
DMstatus dmICGetDefaultSrcParams(DMimageconverter converter, DMparams* srcParams);
DESCRIPTION
The source parameters describe the input image of the image converter.
The minimum set of parameters that must be present in the srcParams are:
DM_IMAGE_WIDTH
an integer that describes the width of the image in pixels
DM_IMAGE_HEIGHT
an integer that describes the height of the image in pixels
DM_IMAGE_PACKING
an enum that describes the packing type of the image data
DM_IMAGE_ORIENTATION
an enum describes the orientation of the image
Valid values for each of these parameters are described in
dmedia/dm_image.h.
dmICSetSrcParams sets the parameters that describe the input image format
of the DMbuffer passed to the image converter in the next dmICSend call.
DM_FAILURE is returned if the any of the required parameters is not
present or if any of the parameter value is invalid. When this happens,
the input format of the converter is set to be the input format described
by the last successful dmICSetSrcParams call.
dmICGetSrcParams gets the parameters that describe the input image format
of the DMbuffer returned in the previous dmICReceive call. Prior to any
successful dmICReceive, the parameters returned are not defined.
dmICGetDefaultSrcParams returns the set of parameters and their default
values that the converter understands and will examine in the
dmICSetSrcParams call.
Page 1
dmIC(3dm)dmIC(3dm)SEE ALSOdmSetImageDefaults(3dm), mvGetTrackDataParams(3dm), dmICCreate(3dm),
dmICSend(3dm), dmICReceive(3dm), dmSetImageDefaults(3dm),
dmICSetSrcParams(3dm), dmICSetConvParams(3dm), dmGetError(3dm),
dmICWork(3dm).
Page 2