opensolaris man page for mlib_imagecreate

mlib_ImageCreate(3MLIB) 				    mediaLib Library Functions					   mlib_ImageCreate(3MLIB)

NAME
       mlib_ImageCreate - image creation

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

       mlib_image *mlib_ImageCreate(mlib_type type, mlib_s32 channels,
	    mlib_s32 width, mlib_s32 height);

DESCRIPTION
       The  mlib_ImageCreate()	function  creates  a mediaLib image data structure and allocates memory space for image data. The data type of the
       image can be MLIB_BIT, MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, MLIB_INT, MLIB_FLOAT, or MLIB_DOUBLE.

       To obtain the best performance, it is recommended that you use this function to create a mediaLib image whenever possible, as this  guaran-
       tees alignment.

PARAMETERS
       The function takes the following arguments:

       type	   Image data type.

       channels    Number of channels in the image.

       width	   Width of image in pixels.

       height	   Height of image in pixels.

RETURN VALUES
       The function returns a pointer to the mlib_image data structure.

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

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

SEE ALSO
       mlib_ImageCreateStruct(3MLIB), mlib_ImageCreateSubimage(3MLIB), mlib_ImageDelete(3MLIB), mlib_ImageSetPaddings(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007						   mlib_ImageCreate(3MLIB)