26. Saturation

26.1. Function Overview

Adjust the color saturation.

26.2. API Reference

26.2.1. CVI_ISP_SetSaturationAttr

【Description】

Set saturation attribute parameter.

【Syntax】

CVI_S32 CVI_ISP_SetSaturationAttr(VI_PIPE ViPipe, const ISP_SATURATION_ATTR_S *pstSaturationAttr);

【Parameter】

Parameter

Description

Input/Output

ViPipe

VI_PIPE number

Input

pstSaturationAttr

Saturation attribute parameters

Input

【Return Value】

Return value

Description

0

Success

Non 0

Failure. An error code is returned. For details, see chapter Error Codes.

【Requirement】

  • Header files: cvi_isp.h, cvi_comm_isp.h

  • Library files: libisp.so

【Note】

None.

【Example】

None.

【Related topic】

26.2.2. CVI_ISP_GetSaturationAttr

【Description】

Set saturation attribute parameter.

【Syntax】

CVI_S32 CVI_ISP_GetSaturationAttr(VI_PIPE ViPipe, ISP_SATURATION_ATTR_S *pstSaturationAttr);

【Parameter】

Parameter

Description

Input/Output

ViPipe

VI_PIPE number

Input

pstSaturationAttr

Saturation attribute parameters

output

【Return Value】

Return value

Description

0

Success

Non 0

Failure. An error code is returned. For details, see chapter Error Codes.

【Requirement】

  • Header files: cvi_isp.h, cvi_comm_isp.h

  • Library files: libisp.so

【Note】

None.

【Example】

None.

【Related topic】

26.3. Data Types

26.3.1. ISP_SATURATION_MANUAL_ATTR_S

【Description】

Saturation attribute manual parameters

【Syntax】

typedef struct _ISP_SATURATION_MANUAL_ATTR_S {
   CVI_U8 Saturation;
} ISP_SATURATION_MANUAL_ATTR_S;

【Member】

Member

Description

Saturation

An array of three values defining the UV gain for the output. Find the UV gain according to the input saturation. The larger the value, the higher the saturation; otherwise, the smaller.

Value range: [0x0, 0xFF]

Data type: CVI_U8

【Note】

None.

【Related Data Type and Interface】

26.3.2. ISP_SATURATION_AUTO_ATTR_S

【Description】

Saturation attribute auto parameters

【Syntax】

typedef struct _ISP_SATURATION_AUTO_ATTR_S {
   CVI_U8 Saturation[ISP_AUTO_ISO_STRENGTH_NUM];
} ISP_SATURATION_AUTO_ATTR_S;

【Member】

Member

Description

Saturation

An array of three values defining the UV gain for the output. Find the UV gain according to the input saturation. The larger the value, the higher the saturation; otherwise, the smaller.

Value range: [0x0, 0xFF]

Data type: CVI_U8

【Note】

None.

【Related Data Type and Interface】

26.3.3. ISP_SATURATION_ATTR_S

【Description】

Saturation attribute parameters

【Syntax】

typedef struct _ISP_SATURATION_ATTR_S {
   ISP_OP_TYPE_E enOpType;
   ISP_SATURATION_AUTO_ATTR_S stAuto;
   ISP_SATURATION_MANUAL_ATTR_S stManual;
} ISP_SATURATION_ATTR_S;

【Member】

Member

Description

enOpType

Working type

OP_TYPE_AUTO: automatic mode

OP_TYPE_MANUAL: manual mode

stAuto

Manual mode parameter attributes

stManual

Automatic mode parameter attributes

【Note】

None.

【Related Data Type and Interface】