Intel® Integrated Performance Primitives (Intel® IPP) Developer Guide and Reference

ID 790148
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

ConvGetBufferSize

Computes the size of the work buffer for the ippiConv function.

Syntax

IppStatus ippiConvGetBufferSize (IppiSize src1Size, IppiSize src2Size, IppDataType dataType, int numChannels, IppEnum algType, int* pBufferSize);

Include Files

ippi.h

Parameters

src1Size, src2Size

Size, in pixels, of the source images.

dataType

Data type for convolution. Possible values are ipp32f, ipp16s, or ipp8u.

numChannels

Number of image channels. Possible values are 1, 3, or 4.

algType

Bit-field mask for the algorithm type definition. Possible values are the results of composition of the IppAlgType and IppiROIShape values.

pBufferSize

Pointer to the size of the work buffer.

Description

The ippiConvGetBufferSize function computes the size, in bytes, of the external work buffer needed for the function that performs two-dimensional convolution. The result is stored in the pBufferSize parameter.

Return Values

ippStsNoErr

Indicates no error.

ippStsSizeErr

Indicates an error when the src1Size or src2Size is negative, or equal to zero.

ippStsNullChannelsErr

Indicates an error when the numChannels value differs from 1, 3, or 4.

ippStsDataTypeErr

Indicates an error when the dataType value differs from the ipp32f, ipp16s, or ipp8u.

ippStsAlgTypeErr

Indicates an error when:

  • the result of the bitwise AND operation between algType and ippAlgMask differs from the ippAlgAuto, ippAlgDirect, or ippAlgFFT values;
  • the result of the bitwise AND operation between algType and ippiROIMask differs from the ippiROIFull or ippiROIValid values.

ippStsNullPtrErr

Indicates an error when the pBufferSize is NULL.

See Also