man pages section 3: Multimedia Library Functions

Exit Print View

Updated: July 2014
 
 

mlib_ImageClear_Fp (3MLIB)

Name

mlib_ImageClear_Fp - clear

Synopsis

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

mlib_status mlib_ImageClear_Fp(mlib_image *img, const mlib_d64 *color);

Description

The mlib_ImageClear_Fp() function sets an image to a specific color. The data type of the image can be MLIB_FLOAT or MLIB_DOUBLE.

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 TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe

See also

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