mlib_ImageChannelCopy (3MLIB)

Name

Synopsis

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

mlib_status mlib_ImageChannelCopy(mlib_image *dst, const mlib_image *src,
     mlib_s32 cmask);

Description

The mlib_ImageChannelCopy() function copies the selected channels of the source image into the corresponding channels of the destination image. The data type of the image can be MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, MLIB_INT, MLIB_FLOAT, or MLIB_DOUBLE.

Parameters

The function takes the following arguments:

dst

Pointer to a destination image.

src

Pointer to a source image.

cmask

Source or destination channel selection mask. Each bit of the mask represents a channel in the image data. The least significant bit (LSB) of the mask corresponds to the last channel in the image data. A bit with a value of 1 indicates that the channel is selected.

Return Values

The function returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

Attributes

See attributes(5) for descriptions of the following attributes:

See also

mlib_ImageChannelExtract(3MLIB), mlib_ImageChannelInsert(3MLIB), mlib_ImageChannelMerge(3MLIB), mlib_ImageChannelSplit(3MLIB), attributes(5)