• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ImageEffect_FilterNames
2
3## 概述
4
5滤镜名信息。
6
7**起始版本:** 12
8
9**相关模块:** [ImageEffect](capi-imageeffect.md)
10
11**所在头文件:** [image_effect_filter.h](capi-image-effect-filter-h.md)
12
13## 汇总
14
15### 成员变量
16
17| 名称 | 描述 |
18| -- | -- |
19| uint32_t size = 0 | 滤镜名个数。 |
20| const char** nameList = nullptr | 滤镜名列表。 |
21
22
23### 成员函数
24
25| 名称 | typedef关键字 | 描述 |
26| -- | -- | -- |
27| [OH_EffectFilterInfo *OH_EffectFilterInfo_Create()](#oh_effectfilterinfo_create) | OH_EffectFilterInfo_Create() | 创建OH_EffectFilterInfo实例,调用[OH_EffectFilterInfo_Release](capi-imageeffect-imageeffect-filternames.md#oh_effectfilterinfo_release)进行资源释放。<br>**起始版本:** 12<br>**系统能力:** SystemCapability.Multimedia.ImageEffect.Core |
28| [ImageEffect_ErrorCode OH_EffectFilterInfo_SetFilterName(OH_EffectFilterInfo *info, const char *name)](#oh_effectfilterinfo_setfiltername) | OH_EffectFilterInfo_SetFilterName() | 设置滤镜名。<br>**起始版本:** 12<br>**系统能力:** SystemCapability.Multimedia.ImageEffect.Core |
29| [ImageEffect_ErrorCode OH_EffectFilterInfo_GetFilterName(OH_EffectFilterInfo *info, char **name)](#oh_effectfilterinfo_getfiltername) | OH_EffectFilterInfo_GetFilterName() | 获取滤镜名。<br>**起始版本:** 12<br>**系统能力:** SystemCapability.Multimedia.ImageEffect.Core |
30| [ImageEffect_ErrorCode OH_EffectFilterInfo_SetSupportedBufferTypes(OH_EffectFilterInfo *info, uint32_t size,ImageEffect_BufferType *bufferTypeArray)](#oh_effectfilterinfo_setsupportedbuffertypes) | OH_EffectFilterInfo_SetSupportedBufferTypes() | 设置滤镜所支持的内存类型。<br>**起始版本:** 12<br>**系统能力:** SystemCapability.Multimedia.ImageEffect.Core |
31| [ImageEffect_ErrorCode OH_EffectFilterInfo_GetSupportedBufferTypes(OH_EffectFilterInfo *info, uint32_t *size,ImageEffect_BufferType **bufferTypeArray)](#oh_effectfilterinfo_getsupportedbuffertypes) | OH_EffectFilterInfo_GetSupportedBufferTypes() | 获取滤镜所支持的内存类型。<br>**起始版本:** 12<br>**系统能力:** SystemCapability.Multimedia.ImageEffect.Core |
32| [ImageEffect_ErrorCode OH_EffectFilterInfo_SetSupportedFormats(OH_EffectFilterInfo *info, uint32_t size,ImageEffect_Format *formatArray)](#oh_effectfilterinfo_setsupportedformats) | OH_EffectFilterInfo_SetSupportedFormats() | 设置滤镜所支持的像素格式。<br>**起始版本:** 12<br>**系统能力:** SystemCapability.Multimedia.ImageEffect.Core |
33| [ImageEffect_ErrorCode OH_EffectFilterInfo_GetSupportedFormats(OH_EffectFilterInfo *info, uint32_t *size,ImageEffect_Format **formatArray)](#oh_effectfilterinfo_getsupportedformats) | OH_EffectFilterInfo_GetSupportedFormats() | 获取滤镜所支持的像素格式。<br>**起始版本:** 12<br>**系统能力:** SystemCapability.Multimedia.ImageEffect.Core |
34| [ImageEffect_ErrorCode OH_EffectFilterInfo_Release(OH_EffectFilterInfo *info)](#oh_effectfilterinfo_release) | OH_EffectFilterInfo_Release() | 销毁OH_EffectFilterInfo实例。<br>**起始版本:** 12<br>**系统能力:** SystemCapability.Multimedia.ImageEffect.Core |
35
36## 成员函数说明
37
38### OH_EffectFilterInfo_Create()
39
40```
41OH_EffectFilterInfo *OH_EffectFilterInfo_Create()
42```
43
44**描述**
45
46创建OH_EffectFilterInfo实例,调用[OH_EffectFilterInfo_Release](capi-imageeffect-imageeffect-filternames.md#oh_effectfilterinfo_release)进行资源释放。
47
48**系统能力:** SystemCapability.Multimedia.ImageEffect.Core
49
50**起始版本:** 12
51
52**返回:**
53
54| 类型 | 说明 |
55| -- | -- |
56| [OH_EffectFilterInfo](capi-imageeffect-oh-effectfilterinfo.md) | 返回一个指向OH_EffectFilterInfo实例的指针,创建失败时返回空指针。 |
57
58### OH_EffectFilterInfo_SetFilterName()
59
60```
61ImageEffect_ErrorCode OH_EffectFilterInfo_SetFilterName(OH_EffectFilterInfo *info, const char *name)
62```
63
64**描述**
65
66设置滤镜名。
67
68**系统能力:** SystemCapability.Multimedia.ImageEffect.Core
69
70**起始版本:** 12
71
72**参数:**
73
74| 参数项 | 描述 |
75| -- | -- |
76| [OH_EffectFilterInfo](capi-imageeffect-oh-effectfilterinfo.md) *info | 滤镜信息指针。 |
77| const char *name | 滤镜名,例如:OH_EFFECT_BRIGHTNESS_FILTER。 |
78
79**返回:**
80
81| 类型 | 说明 |
82| -- | -- |
83| [ImageEffect_ErrorCode](capi-image-effect-errors-h.md#imageeffect_errorcode) | [EFFECT_SUCCESS](capi-image-effect-errors-h.md#imageeffect_errorcode)如果方法调用成功。<br>         [EFFECT_ERROR_PARAM_INVALID](capi-image-effect-errors-h.md#imageeffect_errorcode)如果入参为空指针。 |
84
85### OH_EffectFilterInfo_GetFilterName()
86
87```
88ImageEffect_ErrorCode OH_EffectFilterInfo_GetFilterName(OH_EffectFilterInfo *info, char **name)
89```
90
91**描述**
92
93获取滤镜名。
94
95**系统能力:** SystemCapability.Multimedia.ImageEffect.Core
96
97**起始版本:** 12
98
99**参数:**
100
101| 参数项 | 描述 |
102| -- | -- |
103| [OH_EffectFilterInfo](capi-imageeffect-oh-effectfilterinfo.md) *info | 滤镜信息指针。 |
104| char **name | 指向char数组的指针,返回滤镜名。 |
105
106**返回:**
107
108| 类型 | 说明 |
109| -- | -- |
110| [ImageEffect_ErrorCode](capi-image-effect-errors-h.md#imageeffect_errorcode) | [EFFECT_SUCCESS](capi-image-effect-errors-h.md#imageeffect_errorcode)如果方法调用成功。<br>         [EFFECT_ERROR_PARAM_INVALID](capi-image-effect-errors-h.md#imageeffect_errorcode)如果入参为空指针。 |
111
112### OH_EffectFilterInfo_SetSupportedBufferTypes()
113
114```
115ImageEffect_ErrorCode OH_EffectFilterInfo_SetSupportedBufferTypes(OH_EffectFilterInfo *info, uint32_t size,ImageEffect_BufferType *bufferTypeArray)
116```
117
118**描述**
119
120设置滤镜所支持的内存类型。
121
122**系统能力:** SystemCapability.Multimedia.ImageEffect.Core
123
124**起始版本:** 12
125
126**参数:**
127
128| 参数项 | 描述 |
129| -- | -- |
130| [OH_EffectFilterInfo](capi-imageeffect-oh-effectfilterinfo.md) *info | 滤镜信息指针。 |
131| uint32_t size | 滤镜所支持内存类型[ImageEffect_BufferType](capi-image-effect-filter-h.md#imageeffect_buffertype)个数。 |
132| ImageEffect_BufferType *bufferTypeArray | 滤镜所支持内存类型[ImageEffect_BufferType](capi-image-effect-filter-h.md#imageeffect_buffertype)数组。 |
133
134**返回:**
135
136| 类型 | 说明 |
137| -- | -- |
138| [ImageEffect_ErrorCode](capi-image-effect-errors-h.md#imageeffect_errorcode) | [EFFECT_SUCCESS](capi-image-effect-errors-h.md#imageeffect_errorcode)如果方法调用成功。<br>         [EFFECT_ERROR_PARAM_INVALID](capi-image-effect-errors-h.md#imageeffect_errorcode)如果入参为空指针。 |
139
140### OH_EffectFilterInfo_GetSupportedBufferTypes()
141
142```
143ImageEffect_ErrorCode OH_EffectFilterInfo_GetSupportedBufferTypes(OH_EffectFilterInfo *info, uint32_t *size,ImageEffect_BufferType **bufferTypeArray)
144```
145
146**描述**
147
148获取滤镜所支持的内存类型。
149
150**系统能力:** SystemCapability.Multimedia.ImageEffect.Core
151
152**起始版本:** 12
153
154**参数:**
155
156| 参数项 | 描述 |
157| -- | -- |
158| [OH_EffectFilterInfo](capi-imageeffect-oh-effectfilterinfo.md) *info | 滤镜信息指针。 |
159| uint32_t *size | 滤镜所支持内存类型[ImageEffect_BufferType](capi-image-effect-filter-h.md#imageeffect_buffertype)个数。 |
160| ImageEffect_BufferType **bufferTypeArray | 滤镜所支持内存类型[ImageEffect_BufferType](capi-image-effect-filter-h.md#imageeffect_buffertype)数组。 |
161
162**返回:**
163
164| 类型 | 说明 |
165| -- | -- |
166| [ImageEffect_ErrorCode](capi-image-effect-errors-h.md#imageeffect_errorcode) | [EFFECT_SUCCESS](capi-image-effect-errors-h.md#imageeffect_errorcode)如果方法调用成功。<br>         [EFFECT_ERROR_PARAM_INVALID](capi-image-effect-errors-h.md#imageeffect_errorcode)如果入参为空指针。 |
167
168### OH_EffectFilterInfo_SetSupportedFormats()
169
170```
171ImageEffect_ErrorCode OH_EffectFilterInfo_SetSupportedFormats(OH_EffectFilterInfo *info, uint32_t size,ImageEffect_Format *formatArray)
172```
173
174**描述**
175
176设置滤镜所支持的像素格式。
177
178**系统能力:** SystemCapability.Multimedia.ImageEffect.Core
179
180**起始版本:** 12
181
182**参数:**
183
184| 参数项 | 描述 |
185| -- | -- |
186| [OH_EffectFilterInfo](capi-imageeffect-oh-effectfilterinfo.md) *info | 滤镜信息指针。 |
187| uint32_t size | 滤镜所支持像素格式[ImageEffect_Format](capi-image-effect-filter-h.md#imageeffect_format)个数。 |
188| ImageEffect_Format *formatArray | 滤镜所支持像素格式[ImageEffect_Format](capi-image-effect-filter-h.md#imageeffect_format)数组。 |
189
190**返回:**
191
192| 类型 | 说明 |
193| -- | -- |
194| [ImageEffect_ErrorCode](capi-image-effect-errors-h.md#imageeffect_errorcode) | [EFFECT_SUCCESS](capi-image-effect-errors-h.md#imageeffect_errorcode)如果方法调用成功。<br>         [EFFECT_ERROR_PARAM_INVALID](capi-image-effect-errors-h.md#imageeffect_errorcode)如果入参为空指针。 |
195
196### OH_EffectFilterInfo_GetSupportedFormats()
197
198```
199ImageEffect_ErrorCode OH_EffectFilterInfo_GetSupportedFormats(OH_EffectFilterInfo *info, uint32_t *size,ImageEffect_Format **formatArray)
200```
201
202**描述**
203
204获取滤镜所支持的像素格式。
205
206**系统能力:** SystemCapability.Multimedia.ImageEffect.Core
207
208**起始版本:** 12
209
210**参数:**
211
212| 参数项 | 描述 |
213| -- | -- |
214| [OH_EffectFilterInfo](capi-imageeffect-oh-effectfilterinfo.md) *info | 滤镜信息指针。 |
215| uint32_t *size | 滤镜所支持像素格式[ImageEffect_Format](capi-image-effect-filter-h.md#imageeffect_format)个数。 |
216| ImageEffect_Format **formatArray | 滤镜所支持像素格式[ImageEffect_Format](capi-image-effect-filter-h.md#imageeffect_format)数组。 |
217
218**返回:**
219
220| 类型 | 说明 |
221| -- | -- |
222| [ImageEffect_ErrorCode](capi-image-effect-errors-h.md#imageeffect_errorcode) | [EFFECT_SUCCESS](capi-image-effect-errors-h.md#imageeffect_errorcode)如果方法调用成功。<br>         [EFFECT_ERROR_PARAM_INVALID](capi-image-effect-errors-h.md#imageeffect_errorcode)如果入参为空指针。 |
223
224### OH_EffectFilterInfo_Release()
225
226```
227ImageEffect_ErrorCode OH_EffectFilterInfo_Release(OH_EffectFilterInfo *info)
228```
229
230**描述**
231
232销毁OH_EffectFilterInfo实例。
233
234**系统能力:** SystemCapability.Multimedia.ImageEffect.Core
235
236**起始版本:** 12
237
238**参数:**
239
240| 参数项 | 描述 |
241| -- | -- |
242| [OH_EffectFilterInfo](capi-imageeffect-oh-effectfilterinfo.md) *info | 滤镜信息指针。 |
243
244**返回:**
245
246| 类型 | 说明 |
247| -- | -- |
248| [ImageEffect_ErrorCode](capi-image-effect-errors-h.md#imageeffect_errorcode) | [EFFECT_SUCCESS](capi-image-effect-errors-h.md#imageeffect_errorcode)如果方法调用成功。<br>         [EFFECT_ERROR_PARAM_INVALID](capi-image-effect-errors-h.md#imageeffect_errorcode)如果入参为空指针。 |
249
250
251