Manual Pages for UNIX Operating System command usage for man mlib_ImageSqrShift_Inp

mediaLib Library Functions          mlib_ImageSqrShift_Inp(3MLIB)



NAME
     mlib_ImageSqrShift_Inp - square with shifting, in place

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

     mlib_status mlib_ImageSqrShift_Inp(mlib_image *srcdst, mlib_s32 shift);


DESCRIPTION
     The mlib_ImageSqrShift_Inp() function computes the square of
     each  pixel in the source image and scales the result by the
     shift factor, in place.


     It uses the following equation:

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


PARAMETERS
     The function takes the following arguments:

     srcdst    Pointer to source and destination image.


     shift     Right shifting factor. 0 < shift < 31.


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

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



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|


SEE ALSO
     mlib_ImageSqrShift(3MLIB), attributes(5)




SunOS 5.11           Last change: 2 Mar 2007                    1