1mlib_ImageClear(3MLIB)    mediaLib Library Functions    mlib_ImageClear(3MLIB)
2
3
4

NAME

6       mlib_ImageClear - clear
7

SYNOPSIS

9       cc [ flag... ] file... -lmlib [ library... ]
10       #include <mlib.h>
11
12       mlib_status mlib_ImageClear(mlib_image *img, const mlib_s32 *color);
13
14

DESCRIPTION

16       The  mlib_ImageClear()  function sets an image to a specific color. The
17       data  type  of  the  image  can  be  MLIB_BIT,  MLIB_BYTE,  MLIB_SHORT,
18       MLIB_USHORT, or MLIB_INT.
19
20
21       It uses the following equation:
22
23         img[x][y][i] = color[i]
24
25

PARAMETERS

27       The function takes the following arguments:
28
29       img      Pointer to an image.
30
31
32       color    Array  of color values by channel. color[i] contains the value
33                for channel i.
34
35

RETURN VALUES

37       The function returns MLIB_SUCCESS if successful. Otherwise  it  returns
38       MLIB_FAILURE.
39

ATTRIBUTES

41       See attributes(5) for descriptions of the following attributes:
42
43
44
45
46       ┌─────────────────────────────┬─────────────────────────────┐
47       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
48       ├─────────────────────────────┼─────────────────────────────┤
49       │Interface Stability          │Committed                    │
50       ├─────────────────────────────┼─────────────────────────────┤
51       │MT-Level                     │MT-Safe                      │
52       └─────────────────────────────┴─────────────────────────────┘
53

SEE ALSO

55       mlib_ImageClear_Fp(3MLIB),    mlib_ImageClearEdge(3MLIB),   mlib_Image‐
56       ClearEdge_Fp(3MLIB), attributes(5)
57
58
59
60SunOS 5.11                        2 Mar 2007            mlib_ImageClear(3MLIB)