1mlib_ImageSetPaddings(3MLIBm)ediaLib Library Functionmslib_ImageSetPaddings(3MLIB)
2
3
4

NAME

6       mlib_ImageSetPaddings - set paddings
7

SYNOPSIS

9       cc [ flag... ] file... -lmlib [ library... ]
10       #include <mlib.h>
11
12       mlib_status mlib_ImageSetPaddings(mlib_image *img, mlib_u8 left,
13            mlib_u8 top, mlib_u8 right, mlib_u8 bottom);
14
15

DESCRIPTION

17       The  mlib_ImageSetPaddings()  function sets new values for the paddings
18       field of the mlib_image structure as follows:
19
20         img->paddings[0] = left;
21         img->paddings[1] = top;
22         img->paddings[2] = right;
23         img->paddings[3] = bottom;
24
25
26
27       By default, an image structure creation function, such  as  mlib_Image‐
28       Create(), mlib_ImageCreateStruct(), or mlib_ImageCreateSubimage(), sets
29       the paddings field of the mlib_image structure as follows:
30
31         img->paddings[0] = 0;
32         img->paddings[1] = 0;
33         img->paddings[2] = 0;
34         img->paddings[3] = 0;
35
36
37
38       Note that  this  function  is  needed  only  when  the  edge  condition
39       MLIB_EDGE_SRC_PADDED is used.
40
41
42       The  mlib_image->paddings  field denotes the amount of paddings on each
43       side of an image, from which the real image border can  be  seen.  When
44       MLIB_EDGE_SRC_PADDED  is  specified  as the edge condition, a geometric
45       function uses the "real" source image border for clipping the  destina‐
46       tion image.
47

PARAMETERS

49       The function takes the following arguments:
50
51       img       Pointer to image data structure.
52
53
54       left      Number of columns padded on the left side.
55
56
57       top       Number of rows padded on the top.
58
59
60       right     Number of columns padded on the right side.
61
62
63       bottom    Number of rows padded at the bottom.
64
65

RETURN VALUES

67       The  function  returns MLIB_SUCCESS if successful. Otherwise it returns
68       MLIB_FAILURE.
69

ATTRIBUTES

71       See attributes(5) for descriptions of the following attributes:
72
73
74
75
76       ┌─────────────────────────────┬─────────────────────────────┐
77       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
78       ├─────────────────────────────┼─────────────────────────────┤
79       │Interface Stability          │Committed                    │
80       ├─────────────────────────────┼─────────────────────────────┤
81       │MT-Level                     │MT-Safe                      │
82       └─────────────────────────────┴─────────────────────────────┘
83

SEE ALSO

85       mlib_ImageGetPaddings(3MLIB), mlib_ImageCreate(3MLIB), mlib_ImageCreat‐
86       eStruct(3MLIB),                        mlib_ImageCreateSubimage(3MLIB),
87       mlib_ImageAffine(3MLIB), attributes(5)
88
89
90
91SunOS 5.11                        2 Mar 2007      mlib_ImageSetPaddings(3MLIB)
Impressum