opensolaris man page for mlib_imagescale_inp

mlib_ImageScale_Inp(3MLIB)				    mediaLib Library Functions					mlib_ImageScale_Inp(3MLIB)

NAME
       mlib_ImageScale_Inp - linear scaling, in place

SYNOPSIS
       cc [ flag... ] file... -lmlib [ library... ]
       #include <mlib.h>

       mlib_status mlib_ImageScale_Inp(mlib_image *srcdst, const mlib_s32 *alpha,
	    const mlib_s32 *beta, mlib_s32 shift);

DESCRIPTION
       The mlib_ImageScale_Inp() function performs an in-place linear scaling on the pixels of the source image by multiplying the data by a scale
       factor, shifting, and then adding an offset.

       The following equation is used:

	 srcdst[x][y][i] = srcdst[x][y][i] * alpha[i] * 2**(-shift) +
			   beta[i]

       If the result of the operation underflows/overflows the minimum/maximum value supported by the destination image, then it will  be  clamped
       to the minimum/maximum value respectively.

       The image can be of type MLIB_BYTE, MLIB_SHORT, MLIB_USHORT or MLIB_INT.

PARAMETERS
       The function takes the following arguments:

       srcdst	 Pointer to source and destination image.

       alpha	 Scaling factor. alpha[i] contains the scaling factor for channel i.

       beta	 Offset value. beta[i] contains the offset for channel i.

       shift	 Right shifting factor.

RETURN VALUES
       The function returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       mlib_ImageScale(3MLIB),	mlib_ImageScale_Fp(3MLIB),  mlib_ImageScale_Fp_Inp(3MLIB),  mlib_ImageScale2(3MLIB),  mlib_ImageScale2_Inp(3MLIB),
       attributes(5)

SunOS 5.11							    2 Mar 2007						mlib_ImageScale_Inp(3MLIB)