mlib_ImageBlend1_Fp_Inp(3MLIB)

Name

mlib_ImageBlend1_Fp_Inp - blend with an alpha image

Synopsis

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

mlib_status mlib_ImageBlend1_Fp_Inp(mlib_image *src1dst,
     const mlib_image *src2, const mlib_image *alpha);

Description

The mlib_ImageBlend1_Fp_Inp() function blends two images together, in place, on a pixel-by-pixel basis using an alpha image, when alpha is also on a pixel basis. The alpha image can be a single-channel image or have the same number of channels as the source and destination images.

It uses the following equation when the alpha image is a single-channel image:

src1dst[x][y][i] = alpha[x][y][0]*src1dst[x][y][i] +
                   (1 - alpha[x][y][0])*src2[x][y][i]

It uses the following equation when the alpha image has the same number of channels as the source and destination images:

src1dst[x][y][i] = alpha[x][y][i]*src1dst[x][y][i] +
                   (1 - alpha[x][y][i])*src2[x][y][i]

Parameters

The function takes the following arguments:

src1dst

Pointer to first source and destination image.

src2

Pointer to second source image.

alpha

Alpha image used to control blending. The pixels in this image should have values in the range of [0.0,1.0].

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_ImageBlend(3MLIB), mlib_ImageBlend_Fp(3MLIB), mlib_ImageBlend1_Inp(3MLIB), mlib_ImageBlend2_Fp_Inp(3MLIB), mlib_ImageBlend2_Inp(3MLIB), attributes(5)