opensolaris man page for mlib_videocolorrgbint_to_bgraint

mlib_VideoColorRGBint_to_BGRAint(3MLIB) 		    mediaLib Library Functions			   mlib_VideoColorRGBint_to_BGRAint(3MLIB)

NAME
       mlib_VideoColorRGBint_to_BGRAint - convert RGB interleaved to BGRA interleaved

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

       void mlib_VideoColorRGBint_to_BGRAint(mlib_u8 *bgra,
	    const mlib_u8 *rgb, const mlib_u8 *a_array,
	    mlib_u8 a_const, mlib_s32 w, mlib_s32 h,
	    mlib_s32 dlb, mlib_s32 slb, mlib_s32 alb);

DESCRIPTION
       The interleaved RGB stream and the A values are combined into an interleaved BGRA byte stream.

       The alpha values for this function work in the following fashion:

	   o	  If  the  a_array  pointer is not NULL, the values are taken from there. It has to have the at least 1/3 the dimension of the RGB
		  buffer.

	   o	  If the a_array pointer is NULL, the alpha values for every pixel are set to a_const.

       In other words, this function's inner loop works like this:

	 bgra[0] = rgb[2];
	 bgra[1] = rgb[1];
	 bgra[2] = rgb[0];
	 bgra[3] = (a_array == NULL) ? a_const : a_array[0];

PARAMETERS
       The function takes the following arguments:

       bgra	  Pointer to the output BGRA buffer.

       rgb	  Pointer to the input RGB buffer.

       a_array	  Pointer to the alpha buffer.

       a_const	  Constant alpha value.

       w	  Image width in pixels.

       h	  Image height in lines.

       dlb	  Linebytes of the output buffer.

       slb	  Linebytes of the input buffer.

       alb	  Linebytes of the alpha buffer.

RETURN VALUES
       None.

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

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

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

SunOS 5.11							    2 Mar 2007				   mlib_VideoColorRGBint_to_BGRAint(3MLIB)