typedef struct ImageEffect_FilterNames {...} ImageEffect_FilterNames The struct describes the filter name information.
Since: 12
Related module: ImageEffect
Header file: image_effect_filter.h
The following table lists the declarations supporting C++ syntax.
| Name | Description |
|---|---|
| uint32_t size = 0 | Number of filter names. |
| const char **nameList = nullptr | List of filter names. |
The following table lists the declarations supporting C syntax.
| Name | Description |
|---|---|
| uint32_t size | Number of filter names. |
| const char **nameList | List of filter names. |
| Name | typedef Keyword | Description |
|---|---|---|
| OH_EffectFilterInfo *OH_EffectFilterInfo_Create() | OH_EffectFilterInfo_Create() | Creates an OH_EffectFilterInfo instance. The instance must be released by calling OH_EffectFilterInfo_Release when it is no longer needed. Since: 12 System capability: SystemCapability.Multimedia.ImageEffect.Core |
| ImageEffect_ErrorCode OH_EffectFilterInfo_SetFilterName(OH_EffectFilterInfo *info, const char *name) | OH_EffectFilterInfo_SetFilterName() | Sets a filter name. Since: 12 System capability: SystemCapability.Multimedia.ImageEffect.Core |
| ImageEffect_ErrorCode OH_EffectFilterInfo_GetFilterName(OH_EffectFilterInfo *info, char **name) | OH_EffectFilterInfo_GetFilterName() | Obtains a filter name. Since: 12 System capability: SystemCapability.Multimedia.ImageEffect.Core |
| ImageEffect_ErrorCode OH_EffectFilterInfo_SetSupportedBufferTypes(OH_EffectFilterInfo *info, uint32_t size,ImageEffect_BufferType *bufferTypeArray) | OH_EffectFilterInfo_SetSupportedBufferTypes() | Sets the buffer types supported by a filter. Since: 12 System capability: SystemCapability.Multimedia.ImageEffect.Core |
| ImageEffect_ErrorCode OH_EffectFilterInfo_GetSupportedBufferTypes(OH_EffectFilterInfo *info, uint32_t *size,ImageEffect_BufferType **bufferTypeArray) | OH_EffectFilterInfo_GetSupportedBufferTypes() | Obtains the buffer types supported by a filter. Since: 12 System capability: SystemCapability.Multimedia.ImageEffect.Core |
| ImageEffect_ErrorCode OH_EffectFilterInfo_SetSupportedFormats(OH_EffectFilterInfo *info, uint32_t size,ImageEffect_Format *formatArray) | OH_EffectFilterInfo_SetSupportedFormats() | Sets the pixel formats supported by a filter. Since: 12 System capability: SystemCapability.Multimedia.ImageEffect.Core |
| ImageEffect_ErrorCode OH_EffectFilterInfo_GetSupportedFormats(OH_EffectFilterInfo *info, uint32_t *size,ImageEffect_Format **formatArray) | OH_EffectFilterInfo_GetSupportedFormats() | Obtains the pixel formats supported by a filter. Since: 12 System capability: SystemCapability.Multimedia.ImageEffect.Core |
| ImageEffect_ErrorCode OH_EffectFilterInfo_Release(OH_EffectFilterInfo *info) | OH_EffectFilterInfo_Release() | Destroys an OH_EffectFilterInfo instance. Since: 12 System capability: SystemCapability.Multimedia.ImageEffect.Core |
OH_EffectFilterInfo *OH_EffectFilterInfo_Create()
Description
Creates an OH_EffectFilterInfo instance. The instance must be released by calling OH_EffectFilterInfo_Release when it is no longer needed.
System capability: SystemCapability.Multimedia.ImageEffect.Core
Since: 12
Returns
| Type | Description |
|---|---|
| OH_EffectFilterInfo | Pointer to the OH_EffectFilterInfo instance created. If the operation fails, a null pointer is returned. |
ImageEffect_ErrorCode OH_EffectFilterInfo_SetFilterName(OH_EffectFilterInfo *info, const char *name)
Description
Sets a filter name.
System capability: SystemCapability.Multimedia.ImageEffect.Core
Since: 12
Parameters
| Name | Description |
|---|---|
| OH_EffectFilterInfo *info | Pointer to the filter information. |
| const char *name | Pointer to the filter name, for example, OH_EFFECT_BRIGHTNESS_FILTER. |
Returns
| Type | Description |
|---|---|
| ImageEffect_ErrorCode | EFFECT_SUCCESS: The function is called successfully. EFFECT_ERROR_PARAM_INVALID: The input parameter is a null pointer. |
ImageEffect_ErrorCode OH_EffectFilterInfo_GetFilterName(OH_EffectFilterInfo *info, char **name)
Description
Obtains a filter name.
System capability: SystemCapability.Multimedia.ImageEffect.Core
Since: 12
Parameters
| Name | Description |
|---|---|
| OH_EffectFilterInfo *info | Pointer to the filter information. |
| char **name | Double pointer to the char array holding the filter name. |
Returns
| Type | Description |
|---|---|
| ImageEffect_ErrorCode | EFFECT_SUCCESS: The function is called successfully. EFFECT_ERROR_PARAM_INVALID: The input parameter is a null pointer. |
ImageEffect_ErrorCode OH_EffectFilterInfo_SetSupportedBufferTypes(OH_EffectFilterInfo *info, uint32_t size,ImageEffect_BufferType *bufferTypeArray)
Description
Sets the buffer types supported by a filter.
System capability: SystemCapability.Multimedia.ImageEffect.Core
Since: 12
Parameters
| Name | Description |
|---|---|
| OH_EffectFilterInfo *info | Pointer to the filter information. |
| uint32_t size | Number of buffer types supported, where each type corresponds to a value in the ImageEffect_BufferType enumeration. |
| ImageEffect_BufferType *bufferTypeArray | Pointer to the array of the buffer types supported, where each type corresponds to a value in the ImageEffect_BufferType enumeration. |
Returns
| Type | Description |
|---|---|
| ImageEffect_ErrorCode | EFFECT_SUCCESS: The function is called successfully. EFFECT_ERROR_PARAM_INVALID: The input parameter is a null pointer. |
ImageEffect_ErrorCode OH_EffectFilterInfo_GetSupportedBufferTypes(OH_EffectFilterInfo *info, uint32_t *size,ImageEffect_BufferType **bufferTypeArray)
Description
Obtains the buffer types supported by a filter.
System capability: SystemCapability.Multimedia.ImageEffect.Core
Since: 12
Parameters
| Name | Description |
|---|---|
| OH_EffectFilterInfo *info | Pointer to the filter information. |
| uint32_t *size | Number of buffer types supported, where each type corresponds to a value in the ImageEffect_BufferType enumeration. |
| ImageEffect_BufferType **bufferTypeArray | Pointer to the array of the buffer types supported, where each type corresponds to a value in the ImageEffect_BufferType enumeration. |
Returns
| Type | Description |
|---|---|
| ImageEffect_ErrorCode | EFFECT_SUCCESS: The function is called successfully. EFFECT_ERROR_PARAM_INVALID: The input parameter is a null pointer. |
ImageEffect_ErrorCode OH_EffectFilterInfo_SetSupportedFormats(OH_EffectFilterInfo *info, uint32_t size,ImageEffect_Format *formatArray)
Description
Sets the pixel formats supported by a filter.
System capability: SystemCapability.Multimedia.ImageEffect.Core
Since: 12
Parameters
| Name | Description |
|---|---|
| OH_EffectFilterInfo *info | Pointer to the filter information. |
| uint32_t size | Number of pixel formats supported, where each format corresponds to a value in the ImageEffect_Format enumeration. |
| ImageEffect_Format *formatArray | Pointer to the array of the pixel formats supported, where each format corresponds to a value in the ImageEffect_Format enumeration. |
Returns
| Type | Description |
|---|---|
| ImageEffect_ErrorCode | EFFECT_SUCCESS: The function is called successfully. EFFECT_ERROR_PARAM_INVALID: The input parameter is a null pointer. |
ImageEffect_ErrorCode OH_EffectFilterInfo_GetSupportedFormats(OH_EffectFilterInfo *info, uint32_t *size,ImageEffect_Format **formatArray)
Description
Obtains the pixel formats supported by a filter.
System capability: SystemCapability.Multimedia.ImageEffect.Core
Since: 12
Parameters
| Name | Description |
|---|---|
| OH_EffectFilterInfo *info | Pointer to the filter information. |
| uint32_t *size | Number of pixel formats supported, where each format corresponds to a value in the ImageEffect_Format enumeration. |
| ImageEffect_Format **formatArray | Pointer to the array of the pixel formats supported, where each format corresponds to a value in the ImageEffect_Format enumeration. |
Returns
| Type | Description |
|---|---|
| ImageEffect_ErrorCode | EFFECT_SUCCESS: The function is called successfully. EFFECT_ERROR_PARAM_INVALID: The input parameter is a null pointer. |
ImageEffect_ErrorCode OH_EffectFilterInfo_Release(OH_EffectFilterInfo *info)
Description
Destroys an OH_EffectFilterInfo instance.
System capability: SystemCapability.Multimedia.ImageEffect.Core
Since: 12
Parameters
| Name | Description |
|---|---|
| OH_EffectFilterInfo *info | Pointer to the filter information. |
Returns
| Type | Description |
|---|---|
| ImageEffect_ErrorCode | EFFECT_SUCCESS: The function is called successfully. EFFECT_ERROR_PARAM_INVALID: The input parameter is a null pointer. |