Content-type: text/html Man page of mlib_ImageClear

mlib_ImageClear

Section: mediaLib Library Functions (3MLIB)
Updated: 2 Mar 2007
Index Return to Main Contents
 

NAME

mlib_ImageClear - clear  

SYNOPSIS

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

mlib_status mlib_ImageClear(mlib_image *img, const mlib_s32 *color);

 

DESCRIPTION

The mlib_ImageClear() function sets an image to a specific color. The data type of the image can be MLIB_BIT, MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, or MLIB_INT.

It uses the following equation:

img[x][y][i] = color[i]

 

PARAMETERS

The function takes the following arguments:

img

Pointer to an image.

color

Array of color values by channel. color[i] contains the value for channel i.

 

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 TYPEATTRIBUTE VALUE

Interface StabilityCommitted

MT-Level

 

SEE ALSO

mlib_ImageClear_Fp(3MLIB), mlib_ImageClearEdge(3MLIB), mlib_ImageClearEdge_Fp(3MLIB), attributes(5)


 

Index

NAME
SYNOPSIS
DESCRIPTION
PARAMETERS
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:37:58 GMT, October 02, 2010