Multiplies pixel values of two images.
Syntax
Case 1: Not-in-place operation on integer or complex data
IppStatus ippiMul_<mod>(const Ipp<datatype>* pSrc1, int src1Step, const Ipp<datatype>* pSrc2, int src2Step, Ipp<datatype>* pDst, int dstStep, IppiSize roiSize, int scaleFactor);
Supported values for mod:
8u_C1RSfs |
16u_C1RSfs |
16s_C1RSfs |
16sc_C1RSfs |
32sc_C1RSfs |
8u_C3RSfs |
16u_C3RSfs |
16s_C3RSfs |
16sc_C3RSfs |
32sc_C3RSfs |
8u_AC4RSfs |
16u_AC4RSfs |
16s_AC4RSfs |
16sc_AC4RSfs |
32sc_AC4RSfs |
8u_C4RSfs |
16u_C4RSfs |
16s_C4RSfs |
|
|
Case 2: Not-in-place operation on floating-point or complex data
IppStatus ippiMul_<mod>(const Ipp<datatype>* pSrc1, int src1Step, const Ipp<datatype>* pSrc2, int src2Step, Ipp<datatype>* pDst, int dstStep, IppiSize roiSize);
Supported values for mod:
32f_C1R |
32fc_C1R |
32f_C3R |
32fc_C3R |
32f_AC4R |
32fc_AC4R |
32f_C3R |
|
Case 3: In-place operation on integer or complex data
IppStatus ippiMul_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pSrcDst, int srcDstStep, IppiSize roiSize, int scaleFactor);
Supported values for mod:
8u_C1IRSfs |
16u_C1IRSfs |
16s_C1IRSfs |
16sc_C1IRSfs |
32sc_C1IRSfs |
8u_C3IRSfs |
16u_C3IRSfs |
16s_C3IRSfs |
16sc_C3IRSfs |
32sc_C3IRSfs |
8u_AC4IRSfs |
16u_AC4IRSfs |
16s_AC4IRSfs |
16sc_AC4IRSfs |
32sc_AC4IRSfs |
8u_C4IRSfs |
16u_C4IRSfs |
16s_C4IRSfs |
|
|
Case 4: In-place operation on floating-point or complex data
IppStatus ippiMul_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pSrcDst, int srcDstStep, IppiSize roiSize);
Supported values for mod:
32f_C1IR |
332fc_C1IR |
32f_C3IR |
32fc_C3IR |
32f_AC4IR |
32fc_AC4IR |
32f_C4IR |
|
Parameters
pSrc, pSrc1, pSrc2 |
Pointers to the source images ROI. |
srcStep, src1Step, src2Step |
Distances in bytes between starts of consecutive lines in the source images. |
pDst |
Pointer to the destination image ROI. |
dstStep |
Distance in bytes between starts of consecutive lines in the destination image. |
pSrcDst |
Pointer to the source and destination image ROI for the in-place operation. |
srcDstStep |
Distance in bytes between starts of consecutive lines in the source and destination image for the in-place operation. |
roiSize |
Size of the source and destination ROI in pixels. |
scaleFactor |
Scale factor (see Integer Result Scaling). |
Description
The function ippiMul is declared in the ippi.h file. It operates with ROI (see Regions of Interest in Intel IPP).
This function multiplies corresponding pixel values of two source image buffers and places the results in a destination buffer. In case of operations on integer data, the resulting values are scaled by scaleFactor.
For complex data, the function processes both real and imaginary parts of pixel values.
Warning
Step values must be positive for functions that operate on complex data.
Note that the functions with AC4 descriptor do not process alpha channelss.
Return Values
ippStsNoErr |
Indicates no error. Any other value indicates an error or a warning. |
ippStsNullPtrErr |
Indicates an error condition if any of the pointers is NULL. |
ippStsSizeErr |
Indicates an error condition if roiSize has a field with zero or negative value. |
ippStsStepErr |
Indicates an error condition if any of the specified buffer step values is zero or negative for functions that operate on complex data. |