Simd Library Documentation.

Home | Release Notes | Download | Documentation | Issues | GitHub
C Types

Types of Simd Library C API. More...

Enumerations

enum  SimdBayerLayoutType {
  SimdBayerLayoutGrbg ,
  SimdBayerLayoutGbrg ,
  SimdBayerLayoutRggb ,
  SimdBayerLayoutBggr
}
 
enum  SimdBool {
  SimdFalse = 0 ,
  SimdTrue = 1
}
 
enum  SimdCompareType {
  SimdCompareEqual ,
  SimdCompareNotEqual ,
  SimdCompareGreater ,
  SimdCompareGreaterOrEqual ,
  SimdCompareLesser ,
  SimdCompareLesserOrEqual
}
 
enum  SimdCpuDescType { SimdCpuDescModel }
 
enum  SimdCpuInfoType {
  SimdCpuInfoSockets ,
  SimdCpuInfoCores ,
  SimdCpuInfoThreads ,
  SimdCpuInfoCacheL1 ,
  SimdCpuInfoCacheL2 ,
  SimdCpuInfoCacheL3 ,
  SimdCpuInfoRam ,
  SimdCpuInfoSse41 ,
  SimdCpuInfoAvx2 ,
  SimdCpuInfoAvx512bw ,
  SimdCpuInfoAvx512vnni ,
  SimdCpuInfoAmxBf16 ,
  SimdCpuInfoNeon ,
  SimdCpuInfoCurrentFrequency
}
 
enum  SimdDetectionInfoFlags {
  SimdDetectionInfoFeatureHaar = 0 ,
  SimdDetectionInfoFeatureLbp ,
  SimdDetectionInfoFeatureMask = 3 ,
  SimdDetectionInfoHasTilted = 4 ,
  SimdDetectionInfoCanInt16 = 8
}
 
enum  SimdImageFileType {
  SimdImageFileUndefined = 0 ,
  SimdImageFilePgmTxt ,
  SimdImageFilePgmBin ,
  SimdImageFilePpmTxt ,
  SimdImageFilePpmBin ,
  SimdImageFilePng ,
  SimdImageFileJpeg
}
 
enum  SimdOperationBinary8uType {
  SimdOperationBinary8uAverage ,
  SimdOperationBinary8uAnd ,
  SimdOperationBinary8uOr ,
  SimdOperationBinary8uMaximum ,
  SimdOperationBinary8uMinimum ,
  SimdOperationBinary8uSaturatedSubtraction ,
  SimdOperationBinary8uSaturatedAddition
}
 
enum  SimdOperationBinary16iType {
  SimdOperationBinary16iAddition ,
  SimdOperationBinary16iSubtraction
}
 
enum  SimdPixelFormatType {
  SimdPixelFormatNone = 0 ,
  SimdPixelFormatGray8 ,
  SimdPixelFormatUv16 ,
  SimdPixelFormatBgr24 ,
  SimdPixelFormatBgra32 ,
  SimdPixelFormatInt16 ,
  SimdPixelFormatInt32 ,
  SimdPixelFormatInt64 ,
  SimdPixelFormatFloat ,
  SimdPixelFormatDouble ,
  SimdPixelFormatBayerGrbg ,
  SimdPixelFormatBayerGbrg ,
  SimdPixelFormatBayerRggb ,
  SimdPixelFormatBayerBggr ,
  SimdPixelFormatHsv24 ,
  SimdPixelFormatHsl24 ,
  SimdPixelFormatRgb24 ,
  SimdPixelFormatRgba32 ,
  SimdPixelFormatUyvy16 ,
  SimdPixelFormatArgb32
}
 
enum  SimdReduceType {
  SimdReduce2x2 ,
  SimdReduce3x3 ,
  SimdReduce4x4 ,
  SimdReduce5x5
}
 

Detailed Description

Types of Simd Library C API.

Enumeration Type Documentation

◆ SimdBayerLayoutType

Describes Bayer pixel layout.

Enumerator
SimdBayerLayoutGrbg 

A Bayer pixel layout (GRBG).

SimdBayerLayoutGbrg 

A Bayer pixel layout (GBRG).

SimdBayerLayoutRggb 

A Bayer pixel layout (RGGB).

SimdBayerLayoutBggr 

A Bayer pixel layout (BGGR).

◆ SimdBool

enum SimdBool

Describes boolean type.

Enumerator
SimdFalse 

False value.

SimdTrue 

True value.

◆ SimdCompareType

Describes types of compare operation. Operation compare(a, b) is

Enumerator
SimdCompareEqual 

equal to: a == b

SimdCompareNotEqual 

equal to: a != b

SimdCompareGreater 

equal to: a > b

SimdCompareGreaterOrEqual 

equal to: a >= b

SimdCompareLesser 

equal to: a < b

SimdCompareLesserOrEqual 

equal to: a <= b

◆ SimdCpuDescType

Describes type of description which can return function SimdCpuDesc.

Enumerator
SimdCpuDescModel 

A CPU model name.

◆ SimdCpuInfoType

Describes type of information which can return function SimdCpuInfo.

Enumerator
SimdCpuInfoSockets 

A number of sockets.

SimdCpuInfoCores 

A number of psysical CPU cores.

SimdCpuInfoThreads 

A number of logical CPU cores.

SimdCpuInfoCacheL1 

A size of level 1 data cache.

SimdCpuInfoCacheL2 

A size of level 2 cache.

SimdCpuInfoCacheL3 

A size of level 3 cache.

SimdCpuInfoRam 

A size of physical RAM.

SimdCpuInfoSse41 

Availability of SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2 (x86).

SimdCpuInfoAvx2 

Availability of AVX, FMA, AVX2 (x86).

SimdCpuInfoAvx512bw 

Availability of AVX-512F, AVX-512BW (x86).

SimdCpuInfoAvx512vnni 

Availability of AVX-512VNNI (x86).

SimdCpuInfoAmxBf16 

Availability of AVX-512VBMI, AVX-512FP16, AMX-BF16, AMX-INT8 (x86).

SimdCpuInfoNeon 

Availability of NEON (ARM).

SimdCpuInfoCurrentFrequency 

Gets CPU current frequency (for current CPU core).

◆ SimdDetectionInfoFlags

Describes types and flags to get information about classifier cascade with using function SimdDetectionInfo.

Note
This type is used for implementation of Simd::Detection.
Enumerator
SimdDetectionInfoFeatureHaar 

A HAAR cascade classifier type.

SimdDetectionInfoFeatureLbp 

A LBP cascade classifier type.

SimdDetectionInfoFeatureMask 

A mask to select cascade classifier type.

SimdDetectionInfoHasTilted 

A flag which defines existence of tilted features in the HAAR cascade.

SimdDetectionInfoCanInt16 

A flag which defines possibility to use 16-bit integers for calculation.

◆ SimdImageFileType

Describes formats of image file. It is used in functions SimdImageSaveToMemory and SimdImageSaveToFile.

Enumerator
SimdImageFileUndefined 

An undefined image file format (format auto choice).

SimdImageFilePgmTxt 

A PGM (Portable Gray Map) text (P2) image file format.

SimdImageFilePgmBin 

A PGM (Portable Gray Map) binary (P5) image file format.

SimdImageFilePpmTxt 

A PGM (Portable Pixel Map) text (P3) image file format.

SimdImageFilePpmBin 

A PGM (Portable Pixel Map) binary (P6) image file format.

SimdImageFilePng 

A PNG (Portable Network Graphics) image file format.

SimdImageFileJpeg 

A JPEG (Joint Photographic Experts Group) image file format.

◆ SimdOperationBinary8uType

Describes types of binary operation between two images performed by function SimdOperationBinary8u. Images must have the same format (unsigned 8-bit integer for every channel).

Enumerator
SimdOperationBinary8uAverage 

Computes the average value for every channel of every point of two images.
Average(a, b) = (a + b + 1)/2.

SimdOperationBinary8uAnd 

Computes the bitwise AND between two images.

SimdOperationBinary8uOr 

Computes the bitwise OR between two images.

SimdOperationBinary8uMaximum 

Computes maximal value for every channel of every point of two images.

SimdOperationBinary8uMinimum 

Computes minimal value for every channel of every point of two images.

SimdOperationBinary8uSaturatedSubtraction 

Subtracts unsigned 8-bit integer b from unsigned 8-bit integer a and saturates (for every channel of every point of the images).

SimdOperationBinary8uSaturatedAddition 

Adds unsigned 8-bit integer b from unsigned 8-bit integer a and saturates (for every channel of every point of the images).

◆ SimdOperationBinary16iType

Describes types of binary operation between two images performed by function SimdOperationBinary16i. Images must have SimdPixelFormatInt16 pixel format (signed 16-bit integer for every point).

Enumerator
SimdOperationBinary16iAddition 

Performs addition of two images for every point.

SimdOperationBinary16iSubtraction 

Performs subtraction of two images for every point.

◆ SimdPixelFormatType

Describes pixel format types of an image. In particular this type is used in functions SimdBayerToBgr, SimdBayerToBgra, SimdBgraToBayer and SimdBgrToBayer.

Note
This type is corresponds to C++ type Simd::View::Format.
Enumerator
SimdPixelFormatNone 

An undefined pixel format.

SimdPixelFormatGray8 

A 8-bit gray pixel format.

SimdPixelFormatUv16 

A 16-bit (2 8-bit channels) pixel format (UV plane of NV12 pixel format).

SimdPixelFormatBgr24 

A 24-bit (3 8-bit channels) BGR (Blue, Green, Red) pixel format.

SimdPixelFormatBgra32 

A 32-bit (4 8-bit channels) BGRA (Blue, Green, Red, Alpha) pixel format.

SimdPixelFormatInt16 

A single channel 16-bit integer pixel format.

SimdPixelFormatInt32 

A single channel 32-bit integer pixel format.

SimdPixelFormatInt64 

A single channel 64-bit integer pixel format.

SimdPixelFormatFloat 

A single channel 32-bit float point pixel format.

SimdPixelFormatDouble 

A single channel 64-bit float point pixel format.

SimdPixelFormatBayerGrbg 

A 8-bit Bayer pixel format (GRBG).

SimdPixelFormatBayerGbrg 

A 8-bit Bayer pixel format (GBRG).

SimdPixelFormatBayerRggb 

A 8-bit Bayer pixel format (RGGB).

SimdPixelFormatBayerBggr 

A 8-bit Bayer pixel format (BGGR).

SimdPixelFormatHsv24 

A 24-bit (3 8-bit channels) HSV (Hue, Saturation, Value) pixel format.

SimdPixelFormatHsl24 

A 24-bit (3 8-bit channels) HSL (Hue, Saturation, Lightness) pixel format.

SimdPixelFormatRgb24 

A 24-bit (3 8-bit channels) RGB (Red, Green, Blue) pixel format.

SimdPixelFormatRgba32 

A 32-bit (4 8-bit channels) RGBA (Red, Green, Blue, Alpha) pixel format.

SimdPixelFormatUyvy16 

A 16-bit (2 8-bit channels) UYVY422 pixel format.

SimdPixelFormatArgb32 

A 32-bit (4 8-bit channels) ARGB (Alpha, Red, Green, Blue) pixel format.

◆ SimdReduceType

Describes type of algorithm used for image reducing (downscale in 2 times) (see function Simd::ReduceGray).

Enumerator
SimdReduce2x2 

Using of function SimdReduceGray2x2 for image reducing.

SimdReduce3x3 

Using of function SimdReduceGray3x3 for image reducing.

SimdReduce4x4 

Using of function SimdReduceGray4x4 for image reducing.

SimdReduce5x5 

Using of function SimdReduceGray5x5 for image reducing.