mediaLib Library Functions                 mlibImageScale(3MLIB)



NAME
     mlibImageScale - linear scaling

SYNOPSIS
     cc [ flag... ] file... -lmlib [ library... ]
     #include 

     mlibstatus mlibImageScale(mlibimage *dst,
          const mlibimage *src, const mlibs32 *alpha, const mlibs32 *beta,
          mlibs32 shift);


DESCRIPTION
     The mlibImageScale() function performs a 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:

       dst[x][y][i] = src[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 respec-
     tively.


     See the following table for  available  variations  of  this
     linear scaling function.



        Type [*]      BYTE   SHORT       USHORT            INT        FLOAT       DOUBLE
     
     MLIBYTE        Y      Y       Y                Y               Y       Y
     
     MLIBSHORT       Y      Y       Y                Y               Y       Y
     
     MLIBUSHORT      Y      Y       Y                Y               Y       Y
     
     MLIBINT         Y      Y       Y                Y               Y       Y



     [*] Each row represents a  source  data  type.  Each  column
     represents a destination data type.





SunOS 5.11           Last change: 2 Mar 2007                    1






mediaLib Library Functions                 mlibImageScale(3MLIB)



PARAMETERS
     The function takes the following arguments:

     dst      Pointer to destination image.


     src      Pointer to source image.


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


     beta     Offset value. beta[i] contains the offset for chan-
              nel i.


     shift    Right shifting factor.


RETURN VALUES
     The function returns MLIBSUCES if  successful.  Otherwise
     it returns MLIBFAILURE.

ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Interface Stability          Committed                   
    
     MT-Level                     MT-Safe                     
    


SEE ALSO
     mlibImageScaleFp(3MLIB),    mlibImageScaleFpInp(3MLIB),
     mlibImageScaleInp(3MLIB),         mlibImageScale2(3MLIB),
     mlibImageScale2Inp(3MLIB), attributes(5)












SunOS 5.11           Last change: 2 Mar 2007                    2