opensolaris man page for mlib_imagecolorordereddither8x8

mlib_ImageColorOrderedDither8x8(3MLIB)			    mediaLib Library Functions			    mlib_ImageColorOrderedDither8x8(3MLIB)

NAME
       mlib_ImageColorOrderedDither8x8 - true color to indexed color conversion using ordered dithering

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

       mlib_status (mlib_image *dst, const mlib_image *src, const mlib_s32 *dmask,
	    mlib_s32 scale, const void *colormap);

DESCRIPTION
       The  mlib_ImageColorOrderedDither8x8()  function  converts a true color image to a pseudo color image with the method of ordered dithering.
       The source image can be an MLIB_BYTE or MLIB_SHORT image with three or four channels. The destination must be a single-channel MLIB_BYTE or
       MLIB_SHORT image.

       This  function works only with a colorcube, rather than a general lookup table. The last parameter, colormap, is an internal data structure
       (which may include a colorcube) for inverse color mapping. Create it by calling the mlib_ImageColorTrue2IndexInit() function.

PARAMETERS
       The function takes the following arguments:

       dst	   Pointer to destination or destination image.

       src	   Pointer to source or source image.

       dmask	   Pointer to the 8x8 dither mask, in row major order. The dither mask is transposed differently for different channels to  reduce
		   artifacts.

       scale	   Scaling factor for dmask to convert the input integer coefficients into floating-point coefficients:

		     floating-point coefficient = integer coefficient * 
		     2**(-scale)

       colormap    Internal data structure for inverse color mapping.

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_ImageColorErrorDiffusion3x3(3MLIB), mlib_ImageColorTrue2Index(3MLIB), mlib_ImageColorTrue2IndexFree(3MLIB), mlib_ImageColorTrue2Index-
       Init(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007				    mlib_ImageColorOrderedDither8x8(3MLIB)