mlib_ImageSetPaddings(3MLImediaLib Library Functiomlib_ImageSetPaddings(3MLIB)NAMEmlib_ImageSetPaddings - set paddings
SYNOPSIS
cc [ flag... ] file... -lmlib [ library... ]
#include <mlib.h>
mlib_status mlib_ImageSetPaddings(mlib_image *img, mlib_u8 left,
mlib_u8 top, mlib_u8 right, mlib_u8 bottom);
DESCRIPTION
The mlib_ImageSetPaddings() function sets new values for the paddings
field of the mlib_image structure as follows:
img->paddings[0] = left;
img->paddings[1] = top;
img->paddings[2] = right;
img->paddings[3] = bottom;
By default, an image structure creation function, such as mlib_Image‐
Create(), mlib_ImageCreateStruct(), or mlib_ImageCreateSubimage(), sets
the paddings field of the mlib_image structure as follows:
img->paddings[0] = 0;
img->paddings[1] = 0;
img->paddings[2] = 0;
img->paddings[3] = 0;
Note that this function is needed only when the edge condition
MLIB_EDGE_SRC_PADDED is used.
The mlib_image->paddings field denotes the amount of paddings on each
side of an image, from which the real image border can be seen. When
MLIB_EDGE_SRC_PADDED is specified as the edge condition, a geometric
function uses the "real" source image border for clipping the destina‐
tion image.
PARAMETERS
The function takes the following arguments:
img Pointer to image data structure.
left Number of columns padded on the left side.
top Number of rows padded on the top.
right Number of columns padded on the right side.
bottom Number of rows padded at the bottom.
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 ALSOmlib_ImageGetPaddings(3MLIB), mlib_ImageCreate(3MLIB), mlib_ImageCreat‐
eStruct(3MLIB), mlib_ImageCreateSubimage(3MLIB),
mlib_ImageAffine(3MLIB), attributes(5)SunOS 5.10 2 Mar 2007 mlib_ImageSetPaddings(3MLIB)
