Go to main content

man pages section 3: Multimedia Library Functions

Exit Print View

Updated: July 2017
 
 

mlib_ImageBlend1_Inp(3MLIB)

Name

mlib_ImageBlend1_Inp - blend with an alpha image, in place

Synopsis

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

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

Description

The mlib_ImageBlend1_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] = a[x][y][0]*src1dst[x][y][i] +
                   (1 - a[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] = a[x][y][i]*src1dst[x][y][i] +
                   (1 - a[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 a value equals (alpha * 2**(-8)) for MLIB_BYTE image, (alpha * 2**(-15)) for MLIB_SHORT image, (alpha * 2**(-16)) for MLIB_USHORT image, and (alpha * 2**(-31)) for MLIB_INT image.

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