1# OH_NativeBuffer
2
3## 概述
4
5提供NativeBuffer功能,通过提供的接口,可以实现共享内存的申请、使用、属性查询、释放等操作。
6
7**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
8
9**起始版本:** 9
10
11
12## 汇总
13
14
15### 文件
16
17| 名称 | 描述 |
18| -------- | -------- |
19| [native_buffer.h](native__buffer_8h.md) | 定义获取和使用NativeBuffer的相关函数。 |
20
21
22### 结构体
23
24| 名称 | 描述 |
25| -------- | -------- |
26| struct  [OH_NativeBuffer_Config](_o_h___native_buffer___config.md) | OH_NativeBuffer的属性配置,用于申请新的OH_NativeBuffer实例或查询现有实例的相关属性 |
27| struct  [OH_NativeBuffer_Plane](_o_h___native_buffer___plane.md) | 单个图像平面格式信息。 |
28| struct  [OH_NativeBuffer_Planes](_o_h___native_buffer___planes.md) | OH_NativeBuffer的图像平面格式信息。 |
29| struct  [OH_NativeBuffer_ColorXY](_o_h___native_buffer___color_x_y.md) | 表示基色的X和Y坐标。 |
30| struct  [OH_NativeBuffer_Smpte2086](_o_h___native_buffer___smpte2086.md) | 表示smpte2086静态元数据。 |
31| struct  [OH_NativeBuffer_Cta861](_o_h___native_buffer___cta861.md) | 表示CTA-861.3静态元数据。 |
32| struct  [OH_NativeBuffer_StaticMetadata](_o_h___native_buffer___static_metadata.md) | 表示HDR静态元数据。 |
33
34
35### 类型定义
36
37| 名称 | 描述 |
38| -------- | -------- |
39| typedef struct [OH_NativeBuffer](#oh_nativebuffer)  [OH_NativeBuffer](#oh_nativebuffer) | 提供OH_NativeBuffer结构体声明 |
40| typedef enum [OH_NativeBuffer_Usage](#oh_nativebuffer_usage-1)  [OH_NativeBuffer_Usage](#oh_nativebuffer_usage) | OH_NativeBuffer的用途。 |
41| typedef enum [OH_NativeBuffer_Format](#oh_nativebuffer_format-1)  [OH_NativeBuffer_Format](#oh_nativebuffer_format) | OH_NativeBuffer的格式。 |
42| typedef enum [OH_NativeBuffer_ColorSpace](#oh_nativebuffer_colorspace-1)  [OH_NativeBuffer_ColorSpace](#oh_nativebuffer_colorspace) | OH_NativeBuffer的颜色空间 |
43| typedef enum [OH_NativeBuffer_TransformType](#oh_nativebuffer_transformtype-1)  [OH_NativeBuffer_TransformType](#oh_nativebuffer_transformtype) | OH_NativeBuffer的转换类型。 |
44| typedef enum [OH_NativeBuffer_ColorGamut](#oh_nativebuffer_colorgamut-1)  [OH_NativeBuffer_ColorGamut](#oh_nativebuffer_colorgamut) | OH_NativeBuffer的色域。 |
45| typedef enum [OHNativeErrorCode](_native_window.md#ohnativeerrorcode-1)  [OHNativeErrorCode](#ohnativeerrorcode) | 接口错误码说明(仅用于查询)。 |
46| typedef struct [OH_NativeBuffer_Config](_o_h___native_buffer___config.md)  [OH_NativeBuffer_Config](#oh_nativebuffer_config) | OH_NativeBuffer的属性配置,用于申请新的OH_NativeBuffer实例或查询现有实例的相关属性 |
47| typedef struct [OH_NativeBuffer_Plane](_o_h___native_buffer___plane.md)  [OH_NativeBuffer_Plane](#oh_nativebuffer_plane) | 单个图像平面格式信息。 |
48| typedef struct [OH_NativeBuffer_Planes](_o_h___native_buffer___planes.md)  [OH_NativeBuffer_Planes](#oh_nativebuffer_planes) | OH_NativeBuffer的图像平面格式信息。 |
49| typedef enum [OH_NativeBuffer_MetadataType](#oh_nativebuffer_metadatatype)  [OH_NativeBuffer_MetadataType](#oh_nativebuffer_metadatatype) | OH_NativeBuffer的图像标准。 |
50| typedef struct [OH_NativeBuffer_ColorXY](_o_h___native_buffer___color_x_y.md)  [OH_NativeBuffer_ColorXY](#oh_nativebuffer_colorxy) | 表示基色的X和Y坐标。 |
51| typedef struct [OH_NativeBuffer_Smpte2086](_o_h___native_buffer___smpte2086.md)  [OH_NativeBuffer_Smpte2086](#oh_nativebuffer_smpte2086) | 表示smpte2086静态元数据。 |
52| typedef struct [OH_NativeBuffer_Cta861](_o_h___native_buffer___cta861.md)  [OH_NativeBuffer_Cta861](#oh_nativebuffer_cta861) | 表示CTA-861.3静态元数据。 |
53| typedef struct [OH_NativeBuffer_StaticMetadata](_o_h___native_buffer___static_metadata.md)  [OH_NativeBuffer_StaticMetadata](#oh_nativebuffer_staticmetadata) | 表示HDR静态元数据。 |
54| typedef enum [OH_NativeBuffer_MetadataKey](#oh_nativebuffer_metadatakey-1)  [OH_NativeBuffer_MetadataKey](#oh_nativebuffer_metadatakey) | 表示OH_NativeBuffer的HDR元数据种类的键值。 |
55
56
57### 枚举
58
59| 名称 | 描述 |
60| -------- | -------- |
61| [OH_NativeBuffer_Usage](#oh_nativebuffer_usage-1) {<br/>NATIVEBUFFER_USAGE_CPU_READ = (1ULL &lt;&lt; 0), NATIVEBUFFER_USAGE_CPU_WRITE = (1ULL &lt;&lt; 1), NATIVEBUFFER_USAGE_MEM_DMA = (1ULL &lt;&lt; 3), NATIVEBUFFER_USAGE_HW_RENDER = (1ULL &lt;&lt; 8),<br/>NATIVEBUFFER_USAGE_HW_TEXTURE = (1ULL &lt;&lt; 9), NATIVEBUFFER_USAGE_CPU_READ_OFTEN = (1ULL &lt;&lt; 16), NATIVEBUFFER_USAGE_ALIGNMENT_512 = (1ULL &lt;&lt; 18)<br/>} | OH_NativeBuffer的用途。 |
62| [OH_NativeBuffer_Format](#oh_nativebuffer_format-1) {<br/>NATIVEBUFFER_PIXEL_FMT_CLUT8 = 0, NATIVEBUFFER_PIXEL_FMT_CLUT1, NATIVEBUFFER_PIXEL_FMT_CLUT4, NATIVEBUFFER_PIXEL_FMT_RGB_565 = 3,<br/>NATIVEBUFFER_PIXEL_FMT_RGBA_5658, NATIVEBUFFER_PIXEL_FMT_RGBX_4444, NATIVEBUFFER_PIXEL_FMT_RGBA_4444, NATIVEBUFFER_PIXEL_FMT_RGB_444,<br/>NATIVEBUFFER_PIXEL_FMT_RGBX_5551, NATIVEBUFFER_PIXEL_FMT_RGBA_5551, NATIVEBUFFER_PIXEL_FMT_RGB_555, NATIVEBUFFER_PIXEL_FMT_RGBX_8888,<br/>NATIVEBUFFER_PIXEL_FMT_RGBA_8888, NATIVEBUFFER_PIXEL_FMT_RGB_888, NATIVEBUFFER_PIXEL_FMT_BGR_565, NATIVEBUFFER_PIXEL_FMT_BGRX_4444,<br/>NATIVEBUFFER_PIXEL_FMT_BGRA_4444, NATIVEBUFFER_PIXEL_FMT_BGRX_5551, NATIVEBUFFER_PIXEL_FMT_BGRA_5551, NATIVEBUFFER_PIXEL_FMT_BGRX_8888,<br/>NATIVEBUFFER_PIXEL_FMT_BGRA_8888, NATIVEBUFFER_PIXEL_FMT_YUV_422_I, NATIVEBUFFER_PIXEL_FMT_YCBCR_422_SP, NATIVEBUFFER_PIXEL_FMT_YCRCB_422_SP,<br/>NATIVEBUFFER_PIXEL_FMT_YCBCR_420_SP, NATIVEBUFFER_PIXEL_FMT_YCRCB_420_SP, NATIVEBUFFER_PIXEL_FMT_YCBCR_422_P, NATIVEBUFFER_PIXEL_FMT_YCRCB_422_P,<br/>NATIVEBUFFER_PIXEL_FMT_YCBCR_420_P, NATIVEBUFFER_PIXEL_FMT_YCRCB_420_P, NATIVEBUFFER_PIXEL_FMT_YUYV_422_PKG, NATIVEBUFFER_PIXEL_FMT_UYVY_422_PKG,<br/>NATIVEBUFFER_PIXEL_FMT_YVYU_422_PKG, NATIVEBUFFER_PIXEL_FMT_VYUY_422_PKG, NATIVEBUFFER_PIXEL_FMT_RGBA_1010102, NATIVEBUFFER_PIXEL_FMT_YCBCR_P010,<br/>NATIVEBUFFER_PIXEL_FMT_YCRCB_P010, NATIVEBUFFER_PIXEL_FMT_RAW10, NATIVEBUFFER_PIXEL_FMT_VENDER_MASK = 0X7FFF0000, NATIVEBUFFER_PIXEL_FMT_BUTT = 0X7FFFFFFF<br/>} | OH_NativeBuffer的格式。 |
63| [OH_NativeBuffer_ColorSpace](#oh_nativebuffer_colorspace-1) {<br/>OH_COLORSPACE_NONE, OH_COLORSPACE_BT601_EBU_FULL, OH_COLORSPACE_BT601_SMPTE_C_FULL, OH_COLORSPACE_BT709_FULL,<br/>OH_COLORSPACE_BT2020_HLG_FULL, OH_COLORSPACE_BT2020_PQ_FULL, OH_COLORSPACE_BT601_EBU_LIMIT, OH_COLORSPACE_BT601_SMPTE_C_LIMIT,<br/>OH_COLORSPACE_BT709_LIMIT, OH_COLORSPACE_BT2020_HLG_LIMIT, OH_COLORSPACE_BT2020_PQ_LIMIT, OH_COLORSPACE_SRGB_FULL,<br/>OH_COLORSPACE_P3_FULL, OH_COLORSPACE_P3_HLG_FULL, OH_COLORSPACE_P3_PQ_FULL, OH_COLORSPACE_ADOBERGB_FULL,<br/>OH_COLORSPACE_SRGB_LIMIT, OH_COLORSPACE_P3_LIMIT, OH_COLORSPACE_P3_HLG_LIMIT, OH_COLORSPACE_P3_PQ_LIMIT,<br/>OH_COLORSPACE_ADOBERGB_LIMIT, OH_COLORSPACE_LINEAR_SRGB, OH_COLORSPACE_LINEAR_BT709, OH_COLORSPACE_LINEAR_P3,<br/>OH_COLORSPACE_LINEAR_BT2020, OH_COLORSPACE_DISPLAY_SRGB, OH_COLORSPACE_DISPLAY_P3_SRGB, OH_COLORSPACE_DISPLAY_P3_HLG,<br/>OH_COLORSPACE_DISPLAY_P3_PQ, OH_COLORSPACE_DISPLAY_BT2020_SRGB, OH_COLORSPACE_DISPLAY_BT2020_HLG, OH_COLORSPACE_DISPLAY_BT2020_PQ<br/>} | OH_NativeBuffer的颜色空间 |
64| [OH_NativeBuffer_TransformType](#oh_nativebuffer_transformtype-1) {<br/>NATIVEBUFFER_ROTATE_NONE = 0, NATIVEBUFFER_ROTATE_90, NATIVEBUFFER_ROTATE_180, NATIVEBUFFER_ROTATE_270,<br/>NATIVEBUFFER_FLIP_H, NATIVEBUFFER_FLIP_V, NATIVEBUFFER_FLIP_H_ROT90, NATIVEBUFFER_FLIP_V_ROT90,<br/>NATIVEBUFFER_FLIP_H_ROT180, NATIVEBUFFER_FLIP_V_ROT180, NATIVEBUFFER_FLIP_H_ROT270, NATIVEBUFFER_FLIP_V_ROT270<br/>} | OH_NativeBuffer的转换类型。 |
65| [OH_NativeBuffer_ColorGamut](#oh_nativebuffer_colorgamut-1) {<br/>NATIVEBUFFER_COLOR_GAMUT_NATIVE = 0, NATIVEBUFFER_COLOR_GAMUT_STANDARD_BT601 = 1, NATIVEBUFFER_COLOR_GAMUT_STANDARD_BT709 = 2, NATIVEBUFFER_COLOR_GAMUT_DCI_P3 = 3,<br/>NATIVEBUFFER_COLOR_GAMUT_SRGB = 4, NATIVEBUFFER_COLOR_GAMUT_ADOBE_RGB = 5, NATIVEBUFFER_COLOR_GAMUT_DISPLAY_P3 = 6, NATIVEBUFFER_COLOR_GAMUT_BT2020 = 7,<br/>NATIVEBUFFER_COLOR_GAMUT_BT2100_PQ = 8, NATIVEBUFFER_COLOR_GAMUT_BT2100_HLG = 9, NATIVEBUFFER_COLOR_GAMUT_DISPLAY_BT2020 = 10<br/>} | OH_NativeBuffer的色域。 |
66| [OHNativeErrorCode](#ohnativeerrorcode-1) {<br/>NATIVE_ERROR_OK = 0, NATIVE_ERROR_INVALID_ARGUMENTS = 40001000, NATIVE_ERROR_NO_PERMISSION = 40301000, NATIVE_ERROR_NO_BUFFER = 40601000,<br/>NATIVE_ERROR_NO_CONSUMER = 41202000, NATIVE_ERROR_NOT_INIT = 41203000, NATIVE_ERROR_CONSUMER_CONNECTED = 41206000, NATIVE_ERROR_BUFFER_STATE_INVALID = 41207000,<br/>NATIVE_ERROR_BUFFER_IN_CACHE = 41208000, NATIVE_ERROR_BUFFER_QUEUE_FULL = 41209000, NATIVE_ERROR_BUFFER_NOT_IN_CACHE = 41210000,NATIVE_ERROR_CONSUMER_DISCONNECTED = 41211000,NATIVE_ERROR_CONSUMER_NO_LISTENER_REGISTERED = 41212000, NATIVE_ERROR_UNSUPPORTED = 50102000,<br/>NATIVE_ERROR_UNKNOWN = 50002000,NATIVE_ERROR_HDI_ERROR = 50007000,NATIVE_ERROR_BINDER_ERROR = 50401000, NATIVE_ERROR_EGL_STATE_UNKNOWN = 60001000, NATIVE_ERROR_EGL_API_FAILED = 60002000<br/>} | 接口错误码说明(仅用于查询)。  |
67| [OH_NativeBuffer_MetadataType](#oh_nativebuffer_metadatatype-1) { OH_VIDEO_HDR_HLG, OH_VIDEO_HDR_HDR10, OH_VIDEO_HDR_VIVID,OH_VIDEO_NONE = -1 } | OH_NativeBuffer的图像标准。 |
68| [OH_NativeBuffer_MetadataKey](#oh_nativebuffer_metadatakey-1) { OH_HDR_METADATA_TYPE, OH_HDR_STATIC_METADATA, OH_HDR_DYNAMIC_METADATA } | 表示OH_NativeBuffer的HDR元数据种类的键值。 |
69
70
71### 函数
72
73| 名称 | 描述 |
74| -------- | -------- |
75| [OH_NativeBuffer](#oh_nativebuffer) \* [OH_NativeBuffer_Alloc](#oh_nativebuffer_alloc) (const [OH_NativeBuffer_Config](_o_h___native_buffer___config.md) \*config) | 通过OH_NativeBuffer_Config创建OH_NativeBuffer实例,每次调用都会产生一个新的OH_NativeBuffer实例 |
76| int32_t [OH_NativeBuffer_Reference](#oh_nativebuffer_reference) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer) | 将OH_NativeBuffer对象的引用计数加1 |
77| int32_t [OH_NativeBuffer_Unreference](#oh_nativebuffer_unreference) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer) | 将OH_NativeBuffer对象的引用计数减1,当引用计数为0的时候,该NativeBuffer对象会被析构掉 |
78| void [OH_NativeBuffer_GetConfig](#oh_nativebuffer_getconfig) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer, [OH_NativeBuffer_Config](_o_h___native_buffer___config.md) \*config) | 用于获取OH_NativeBuffer的属性 |
79| int32_t [OH_NativeBuffer_Map](#oh_nativebuffer_map) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer, void \*\*virAddr) | 将OH_NativeBuffer对应的ION内存映射到进程空间 |
80| int32_t [OH_NativeBuffer_Unmap](#oh_nativebuffer_unmap) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer) | 将OH_NativeBuffer对应的ION内存从进程空间移除 |
81| uint32_t [OH_NativeBuffer_GetSeqNum](#oh_nativebuffer_getseqnum) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer) | 获取OH_NativeBuffer的序列号 |
82| int32_t [OH_NativeBuffer_SetColorSpace](#oh_nativebuffer_setcolorspace) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer, [OH_NativeBuffer_ColorSpace](#oh_nativebuffer_colorspace) colorSpace) | 为OH_NativeBuffer设置颜色空间属性。 |
83| int32_t [OH_NativeBuffer_MapPlanes](#oh_nativebuffer_mapplanes) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer, void \*\*virAddr, [OH_NativeBuffer_Planes](_o_h___native_buffer___planes.md) \*outPlanes) | 将OH_NativeBuffer对应的多通道ION内存映射到进程空间。 |
84| int32_t [OH_NativeBuffer_FromNativeWindowBuffer](#oh_nativebuffer_fromnativewindowbuffer) ([OHNativeWindowBuffer](_native_window.md#ohnativewindowbuffer) \*nativeWindowBuffer, [OH_NativeBuffer](#oh_nativebuffer) \*\*buffer) | 将OHNativeWindowBuffer实例转换为OH_NativeBuffer实例。 |
85| int32_t [OH_NativeBuffer_GetColorSpace](#oh_nativebuffer_getcolorspace) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer, [OH_NativeBuffer_ColorSpace](#oh_nativebuffer_colorspace) \*colorSpace) | 获取OH_NativeBuffer颜色空间属性。 |
86| int32_t [OH_NativeBuffer_SetMetadataValue](#oh_nativebuffer_setmetadatavalue) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer, [OH_NativeBuffer_MetadataKey](#oh_nativebuffer_metadatakey) metadataKey, int32_t size, uint8_t \*metaData) | 为OH_NativeBuffer设置元数据属性值。 |
87| int32_t [OH_NativeBuffer_GetMetadataValue](#oh_nativebuffer_getmetadatavalue) ([OH_NativeBuffer](#oh_nativebuffer) \*buffer, [OH_NativeBuffer_MetadataKey](#oh_nativebuffer_metadatakey) metadataKey, int32_t \*size, uint8_t \*\*metaData) | 获取OH_NativeBuffer元数据属性值。 |
88
89
90## 类型定义说明
91
92
93### OH_NativeBuffer
94
95```
96typedef struct OH_NativeBuffer OH_NativeBuffer
97```
98
99**描述**
100
101提供OH_NativeBuffer结构体声明
102
103**起始版本:** 9
104
105
106### OH_NativeBuffer_ColorGamut
107
108```
109typedef enum OH_NativeBuffer_ColorGamut OH_NativeBuffer_ColorGamut
110```
111
112**描述**
113
114OH_NativeBuffer的色域。
115
116**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
117
118**起始版本:** 12
119
120
121### OH_NativeBuffer_ColorSpace
122
123```
124typedef enum OH_NativeBuffer_ColorSpace OH_NativeBuffer_ColorSpace
125```
126
127**描述**
128
129OH_NativeBuffer的颜色空间
130
131**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
132
133**起始版本:** 11
134
135
136### OH_NativeBuffer_ColorXY
137
138```
139typedef struct OH_NativeBuffer_ColorXY OH_NativeBuffer_ColorXY
140```
141
142**描述**
143
144表示基色的X和Y坐标。
145
146**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
147
148**起始版本:** 12
149
150
151### OH_NativeBuffer_Config
152
153```
154typedef struct OH_NativeBuffer_Config OH_NativeBuffer_Config
155```
156
157**描述**
158
159OH_NativeBuffer的属性配置,用于申请新的OH_NativeBuffer实例或查询现有实例的相关属性
160
161**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
162
163**起始版本:** 9
164
165
166### OH_NativeBuffer_Cta861
167
168```
169typedef struct OH_NativeBuffer_Cta861 OH_NativeBuffer_Cta861
170```
171
172**描述**
173
174表示CTA-861.3静态元数据。
175
176**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
177
178**起始版本:** 12
179
180
181### OH_NativeBuffer_Format
182
183```
184typedef enum OH_NativeBuffer_Format OH_NativeBuffer_Format
185```
186
187**描述**
188
189OH_NativeBuffer的格式。
190
191**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
192
193**起始版本:** 10
194
195
196### OH_NativeBuffer_MetadataKey
197
198```
199typedef enum OH_NativeBuffer_MetadataKey OH_NativeBuffer_MetadataKey
200```
201
202**描述**
203
204表示OH_NativeBuffer的HDR元数据种类的键值。
205
206**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
207
208**起始版本:** 12
209
210
211### OH_NativeBuffer_MetadataType
212
213```
214typedef enum OH_NativeBuffer_MetadataType OH_NativeBuffer_MetadataType
215```
216
217**描述**
218
219OH_NativeBuffer的图像标准。
220
221**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
222
223**起始版本:** 12
224
225
226### OH_NativeBuffer_Plane
227
228```
229typedef struct OH_NativeBuffer_Plane OH_NativeBuffer_Plane
230```
231
232**描述**
233
234单个图像平面格式信息。
235
236**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
237
238**起始版本:** 12
239
240
241### OH_NativeBuffer_Planes
242
243```
244typedef struct OH_NativeBuffer_Planes OH_NativeBuffer_Planes
245```
246
247**描述**
248
249OH_NativeBuffer的图像平面格式信息。
250
251**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
252
253**起始版本:** 12
254
255
256### OH_NativeBuffer_Smpte2086
257
258```
259typedef struct OH_NativeBuffer_Smpte2086 OH_NativeBuffer_Smpte2086
260```
261
262**描述**
263
264表示smpte2086静态元数据。
265
266**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
267
268**起始版本:** 12
269
270
271### OH_NativeBuffer_StaticMetadata
272
273```
274typedef struct OH_NativeBuffer_StaticMetadata OH_NativeBuffer_StaticMetadata
275```
276
277**描述**
278
279表示HDR静态元数据。
280
281**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
282
283**起始版本:** 12
284
285
286### OH_NativeBuffer_TransformType
287
288```
289typedef enum OH_NativeBuffer_TransformType OH_NativeBuffer_TransformType
290```
291
292**描述**
293
294OH_NativeBuffer的转换类型。
295
296**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
297
298**起始版本:** 12
299
300
301### OH_NativeBuffer_Usage
302
303```
304typedef enum OH_NativeBuffer_Usage OH_NativeBuffer_Usage
305```
306
307**描述**
308
309OH_NativeBuffer的用途。
310
311**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
312
313**起始版本:** 10
314
315
316### OHNativeErrorCode
317
318```
319typedef enum OHNativeErrorCodeOHNativeErrorCode
320```
321
322**描述**
323
324接口错误码说明(仅用于查询)。
325
326**起始版本:** 12
327
328
329## 枚举类型说明
330
331
332### OH_NativeBuffer_ColorGamut
333
334```
335enum OH_NativeBuffer_ColorGamut
336```
337
338**描述**
339
340OH_NativeBuffer的色域。
341
342**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
343
344**起始版本:** 12
345
346| 枚举值 | 描述 |
347| -------- | -------- |
348| NATIVEBUFFER_COLOR_GAMUT_NATIVE | 默认色域格式 |
349| NATIVEBUFFER_COLOR_GAMUT_STANDARD_BT601 | Standard BT601 色域格式 |
350| NATIVEBUFFER_COLOR_GAMUT_STANDARD_BT709 | Standard BT709 色域格式 |
351| NATIVEBUFFER_COLOR_GAMUT_DCI_P3 | DCI P3 色域格式 |
352| NATIVEBUFFER_COLOR_GAMUT_SRGB | SRGB 色域格式 |
353| NATIVEBUFFER_COLOR_GAMUT_ADOBE_RGB | Adobe RGB 色域格式 |
354| NATIVEBUFFER_COLOR_GAMUT_DISPLAY_P3 | Display P3 色域格式 |
355| NATIVEBUFFER_COLOR_GAMUT_BT2020 | BT2020 色域格式 |
356| NATIVEBUFFER_COLOR_GAMUT_BT2100_PQ | BT2100 PQ 色域格式 |
357| NATIVEBUFFER_COLOR_GAMUT_BT2100_HLG | BT2100 HLG 色域格式 |
358| NATIVEBUFFER_COLOR_GAMUT_DISPLAY_BT2020 | Display BT2020 色域格式 |
359
360
361### OH_NativeBuffer_ColorSpace
362
363```
364enum OH_NativeBuffer_ColorSpace
365```
366
367**描述**
368
369OH_NativeBuffer的颜色空间
370
371**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
372
373**起始版本:** 11
374
375| 枚举值 | 描述 |
376| -------- | -------- |
377| OH_COLORSPACE_NONE | 无颜色空间 |
378| OH_COLORSPACE_BT601_EBU_FULL | 色域范围为BT601_P, 传递函数为BT709, 转换矩阵为BT601_P, 数据范围为RANGE_FULL |
379| OH_COLORSPACE_BT601_SMPTE_C_FULL | 色域范围为BT601_N, 传递函数为BT709, 转换矩阵为BT601_N, 数据范围为RANGE_FULL |
380| OH_COLORSPACE_BT709_FULL | 色域范围为BT709, 传递函数为BT709, 转换矩阵为BT709, 数据范围为RANGE_FULL |
381| OH_COLORSPACE_BT2020_HLG_FULL | 色域范围为BT2020, 传递函数为HLG, 转换矩阵为BT2020, 数据范围为RANGE_FULL |
382| OH_COLORSPACE_BT2020_PQ_FULL | 色域范围为BT2020, 传递函数为PQ, 转换矩阵为BT2020, 数据范围为RANGE_FULL |
383| OH_COLORSPACE_BT601_EBU_LIMIT | 色域范围为BT601_P, 传递函数为BT709, 转换矩阵为BT601_P, 数据范围为RANGE_LIMITED |
384| OH_COLORSPACE_BT601_SMPTE_C_LIMIT | 色域范围为BT601_N, 传递函数为BT709, 转换矩阵为BT601_N, 数据范围为RANGE_LIMITED |
385| OH_COLORSPACE_BT709_LIMIT | 色域范围为BT709, 传递函数为BT709, 转换矩阵为BT709, 数据范围为RANGE_LIMITED |
386| OH_COLORSPACE_BT2020_HLG_LIMIT | 色域范围为BT2020, 传递函数为HLG, 转换矩阵为BT2020, 数据范围为RANGE_LIMITED |
387| OH_COLORSPACE_BT2020_PQ_LIMIT | 色域范围为BT2020, 传递函数为PQ, 转换矩阵为BT2020, 数据范围为RANGE_LIMITED |
388| OH_COLORSPACE_SRGB_FULL | 色域范围为SRGB, 传递函数为SRGB, 转换矩阵为BT601_N, 数据范围为RANGE_FULL |
389| OH_COLORSPACE_P3_FULL | 色域范围为P3_D65, 传递函数为SRGB, 转换矩阵为P3, 数据范围为RANGE_FULL |
390| OH_COLORSPACE_P3_HLG_FULL | 色域范围为P3_D65, 传递函数为HLG, 转换矩阵为P3, 数据范围为RANGE_FULL |
391| OH_COLORSPACE_P3_PQ_FULL | 色域范围为P3_D65, 传递函数为PQ, 转换矩阵为P3, 数据范围为RANGE_FULL |
392| OH_COLORSPACE_ADOBERGB_FULL | 色域范围为ADOBERGB, 传递函数为ADOBERGB, 转换矩阵为ADOBERGB, 数据范围为RANGE_FULL |
393| OH_COLORSPACE_SRGB_LIMIT | 色域范围为SRGB, 传递函数为SRGB, 转换矩阵为BT601_N, 数据范围为RANGE_LIMITED |
394| OH_COLORSPACE_P3_LIMIT | 色域范围为P3_D65, 传递函数为SRGB, 转换矩阵为P3, 数据范围为RANGE_LIMITED |
395| OH_COLORSPACE_P3_HLG_LIMIT | 色域范围为P3_D65, 传递函数为HLG, 转换矩阵为P3, 数据范围为RANGE_LIMITED |
396| OH_COLORSPACE_P3_PQ_LIMIT | 色域范围为P3_D65, 传递函数为PQ, 转换矩阵为P3, 数据范围为RANGE_LIMITED |
397| OH_COLORSPACE_ADOBERGB_LIMIT | 色域范围为ADOBERGB, 传递函数为ADOBERGB, 转换矩阵为ADOBERGB, 数据范围为RANGE_LIMITED |
398| OH_COLORSPACE_LINEAR_SRGB | 色域范围为SRGB, 传递函数为LINEAR |
399| OH_COLORSPACE_LINEAR_BT709 | 等同于 OH_COLORSPACE_LINEAR_SRGB |
400| OH_COLORSPACE_LINEAR_P3 | 色域范围为P3_D65, 传递函数为LINEAR |
401| OH_COLORSPACE_LINEAR_BT2020 | 色域范围为BT2020, 传递函数为LINEAR |
402| OH_COLORSPACE_DISPLAY_SRGB | 等同于 OH_COLORSPACE_SRGB_FULL |
403| OH_COLORSPACE_DISPLAY_P3_SRGB | 等同于 OH_COLORSPACE_P3_FULL |
404| OH_COLORSPACE_DISPLAY_P3_HLG | 等同于 OH_COLORSPACE_P3_HLG_FULL |
405| OH_COLORSPACE_DISPLAY_P3_PQ | 等同于 OH_COLORSPACE_P3_PQ_FULL |
406| OH_COLORSPACE_DISPLAY_BT2020_SRGB | 色域范围为BT2020, 传递函数为SRGB, 转换矩阵为BT2020, 数据范围为RANGE_FULL |
407| OH_COLORSPACE_DISPLAY_BT2020_HLG | 等同于 OH_COLORSPACE_BT2020_HLG_FULL |
408| OH_COLORSPACE_DISPLAY_BT2020_PQ | 等同于 OH_COLORSPACE_BT2020_PQ_FULL |
409
410
411### OH_NativeBuffer_Format
412
413```
414enum OH_NativeBuffer_Format
415```
416
417**描述**
418
419OH_NativeBuffer的格式。
420
421**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
422
423**起始版本:** 10
424
425| 枚举值 | 描述 |
426| -------- | -------- |
427| NATIVEBUFFER_PIXEL_FMT_CLUT8<sup>12+</sup> | CLUT8格式 |
428| NATIVEBUFFER_PIXEL_FMT_CLUT1<sup>12+</sup> | CLUT1格式 |
429| NATIVEBUFFER_PIXEL_FMT_CLUT4<sup>12+</sup> | CLUT4格式 |
430| NATIVEBUFFER_PIXEL_FMT_RGB_565 | RGB565格式 |
431| NATIVEBUFFER_PIXEL_FMT_RGBA_5658 | RGBA5658格式 |
432| NATIVEBUFFER_PIXEL_FMT_RGBX_4444 | RGBX4444格式 |
433| NATIVEBUFFER_PIXEL_FMT_RGBA_4444 | RGBA4444格式 |
434| NATIVEBUFFER_PIXEL_FMT_RGB_444 | RGB444格式 |
435| NATIVEBUFFER_PIXEL_FMT_RGBX_5551 | RGBX5551格式 |
436| NATIVEBUFFER_PIXEL_FMT_RGBA_5551 | RGBA5551格式 |
437| NATIVEBUFFER_PIXEL_FMT_RGB_555 | RGB555格式 |
438| NATIVEBUFFER_PIXEL_FMT_RGBX_8888 | RGBX8888格式 |
439| NATIVEBUFFER_PIXEL_FMT_RGBA_8888 | RGBA8888格式 |
440| NATIVEBUFFER_PIXEL_FMT_RGB_888 | RGB888格式 |
441| NATIVEBUFFER_PIXEL_FMT_BGR_565 | BGR565格式 |
442| NATIVEBUFFER_PIXEL_FMT_BGRX_4444 | BGRX4444格式 |
443| NATIVEBUFFER_PIXEL_FMT_BGRA_4444 | BGRA4444格式 |
444| NATIVEBUFFER_PIXEL_FMT_BGRX_5551 | BGRX5551格式 |
445| NATIVEBUFFER_PIXEL_FMT_BGRA_5551 | BGRA5551格式 |
446| NATIVEBUFFER_PIXEL_FMT_BGRX_8888 | BGRX8888格式 |
447| NATIVEBUFFER_PIXEL_FMT_BGRA_8888 | BGRA8888格式 |
448| NATIVEBUFFER_PIXEL_FMT_YUV_422_I<sup>12+</sup> | YUV422 interleaved 格式 |
449| NATIVEBUFFER_PIXEL_FMT_YCBCR_422_SP<sup>12+</sup> | YCBCR422 semi-planar 格式 |
450| NATIVEBUFFER_PIXEL_FMT_YCRCB_422_SP<sup>12+</sup> | YCRCB422 semi-planar 格式 |
451| NATIVEBUFFER_PIXEL_FMT_YCBCR_420_SP<sup>12+</sup> | YCBCR420 semi-planar 格式 |
452| NATIVEBUFFER_PIXEL_FMT_YCRCB_420_SP<sup>12+</sup> | YCRCB420 semi-planar 格式 |
453| NATIVEBUFFER_PIXEL_FMT_YCBCR_422_P<sup>12+</sup> | YCBCR422 planar 格式 |
454| NATIVEBUFFER_PIXEL_FMT_YCRCB_422_P<sup>12+</sup> | YCRCB422 planar 格式 |
455| NATIVEBUFFER_PIXEL_FMT_YCBCR_420_P<sup>12+</sup> | YCBCR420 planar 格式 |
456| NATIVEBUFFER_PIXEL_FMT_YCRCB_420_P<sup>12+</sup> | YCRCB420 planar 格式 |
457| NATIVEBUFFER_PIXEL_FMT_YUYV_422_PKG<sup>12+</sup> | YUYV422 packed 格式 |
458| NATIVEBUFFER_PIXEL_FMT_UYVY_422_PKG<sup>12+</sup> | UYVY422 packed 格式 |
459| NATIVEBUFFER_PIXEL_FMT_YVYU_422_PKG<sup>12+</sup> | YVYU422 packed 格式 |
460| NATIVEBUFFER_PIXEL_FMT_VYUY_422_PKG<sup>12+</sup> | VYUY422 packed 格式 |
461| NATIVEBUFFER_PIXEL_FMT_RGBA_1010102<sup>12+</sup> | RGBA_1010102 packed 格式 |
462| NATIVEBUFFER_PIXEL_FMT_YCBCR_P010<sup>12+</sup> | YCBCR420 semi-planar 10bit packed 格式 |
463| NATIVEBUFFER_PIXEL_FMT_YCRCB_P010<sup>12+</sup> | YCRCB420 semi-planar 10bit packed 格式 |
464| NATIVEBUFFER_PIXEL_FMT_RAW10<sup>12+</sup> | Raw 10bit packed 格式 |
465| NATIVEBUFFER_PIXEL_FMT_VENDER_MASK<sup>12+</sup> | vendor mask 格式 |
466| NATIVEBUFFER_PIXEL_FMT_BUTT | 无效格式 |
467
468
469### OH_NativeBuffer_MetadataKey
470
471```
472enum OH_NativeBuffer_MetadataKey
473```
474
475**描述**
476
477表示OH_NativeBuffer的HDR元数据种类的键值。
478
479**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
480
481**起始版本:** 12
482
483| 枚举值 | 描述 |
484| -------- | -------- |
485| OH_HDR_METADATA_TYPE | 元数据类型,其值见[OH_NativeBuffer_MetadataType](#oh_nativebuffer_metadatatype),size为OH_NativeBuffer_MetadataType大小。 |
486| OH_HDR_STATIC_METADATA | 静态元数据,其值见[OH_NativeBuffer_StaticMetadata](_o_h___native_buffer___static_metadata.md),size为OH_NativeBuffer_StaticMetadata大小。 |
487| OH_HDR_DYNAMIC_METADATA | 动态元数据,其值见视频流中SEI的字节流,size的取值范围为1-3000。 |
488
489
490### OH_NativeBuffer_MetadataType
491
492```
493enum OH_NativeBuffer_MetadataType
494```
495
496**描述**
497
498OH_NativeBuffer的图像标准。
499
500**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
501
502**起始版本:** 12
503
504| 枚举值 | 描述 |
505| -------- | -------- |
506| OH_VIDEO_HDR_HLG | 视频HLG。 |
507| OH_VIDEO_HDR_HDR10 | 视频HDR10。 |
508| OH_VIDEO_HDR_VIVID | 视频HDR VIVID。 |
509| OH_VIDEO_NONE<sup>13+</sup> | 无元数据。 |
510
511
512### OH_NativeBuffer_TransformType
513
514```
515enum OH_NativeBuffer_TransformType
516```
517
518**描述**
519
520OH_NativeBuffer的转换类型。
521
522**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
523
524**起始版本:** 12
525
526| 枚举值 | 描述 |
527| -------- | -------- |
528| NATIVEBUFFER_ROTATE_NONE | 不旋转 |
529| NATIVEBUFFER_ROTATE_90 | 旋转90度 |
530| NATIVEBUFFER_ROTATE_180 | 旋转180度 |
531| NATIVEBUFFER_ROTATE_270 | 旋转270度 |
532| NATIVEBUFFER_FLIP_H | 水平翻转 |
533| NATIVEBUFFER_FLIP_V | 垂直翻转 |
534| NATIVEBUFFER_FLIP_H_ROT90 | 水平翻转并旋转90度 |
535| NATIVEBUFFER_FLIP_V_ROT90 | 垂直翻转并旋转90度 |
536| NATIVEBUFFER_FLIP_H_ROT180 | 水平翻转并旋转180度 |
537| NATIVEBUFFER_FLIP_V_ROT180 | 垂直翻转并旋转180度 |
538| NATIVEBUFFER_FLIP_H_ROT270 | 水平翻转并旋转270度 |
539| NATIVEBUFFER_FLIP_V_ROT270 | 垂直翻转并旋转270度 |
540
541
542### OH_NativeBuffer_Usage
543
544```
545enum OH_NativeBuffer_Usage
546```
547
548**描述**
549
550OH_NativeBuffer的用途。
551
552**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
553
554**起始版本:** 10
555
556| 枚举值 | 描述 |
557| -------- | -------- |
558| NATIVEBUFFER_USAGE_CPU_READ | CPU可读 |
559| NATIVEBUFFER_USAGE_CPU_WRITE | CPU可写 |
560| NATIVEBUFFER_USAGE_MEM_DMA | 直接内存访问缓冲区 |
561| NATIVEBUFFER_USAGE_HW_RENDER<sup>12+</sup> | GPU可写 |
562| NATIVEBUFFER_USAGE_HW_TEXTURE<sup>12+</sup> | GPU可读 |
563| NATIVEBUFFER_USAGE_CPU_READ_OFTEN<sup>12+</sup> | CPU可直接映射 |
564| NATIVEBUFFER_USAGE_ALIGNMENT_512<sup>12+</sup> | 512字节对齐 |
565
566
567### OHNativeErrorCode
568
569```
570enum OHNativeErrorCode
571```
572
573**描述**
574
575接口错误码说明(仅用于查询)。
576
577**起始版本:** 12
578
579| 枚举值 | 描述 |
580| -------- | -------- |
581| NATIVE_ERROR_OK | 成功 |
582| NATIVE_ERROR_INVALID_ARGUMENTS | 入参无效 |
583| NATIVE_ERROR_NO_PERMISSION | 无权限操作 |
584| NATIVE_ERROR_NO_BUFFER | 无空闲可用的buffer |
585| NATIVE_ERROR_NO_CONSUMER | 消费端不存在 |
586| NATIVE_ERROR_NOT_INIT | 未初始化 |
587| NATIVE_ERROR_CONSUMER_CONNECTED | 消费端已经被连接 |
588| NATIVE_ERROR_BUFFER_STATE_INVALID | buffer状态不符合预期 |
589| NATIVE_ERROR_BUFFER_IN_CACHE | buffer已在缓存队列中 |
590| NATIVE_ERROR_BUFFER_QUEUE_FULL | 队列已满 |
591| NATIVE_ERROR_BUFFER_NOT_IN_CACHE | buffer不在缓存队列中 |
592| NATIVE_ERROR_CONSUMER_DISCONNECTED | 消费端已经被断开连接 |
593| NATIVE_ERROR_CONSUMER_NO_LISTENER_REGISTERED | 消费端未注册listener回调函数 |
594| NATIVE_ERROR_UNSUPPORTED | 当前设备或平台不支持 |
595| NATIVE_ERROR_UNKNOWN | 未知错误,请查看日志 |
596| NATIVE_ERROR_HDI_ERROR  | HDI接口调用失败   |
597| NATIVE_ERROR_BINDER_ERROR  | 跨进程通信失败   |
598| NATIVE_ERROR_EGL_STATE_UNKNOWN | egl环境状态异常 |
599| NATIVE_ERROR_EGL_API_FAILED | egl接口调用失败 |
600
601
602## 函数说明
603
604
605### OH_NativeBuffer_Alloc()
606
607```
608OH_NativeBuffer* OH_NativeBuffer_Alloc (const OH_NativeBuffer_Config* config)
609```
610
611**描述**
612
613通过OH_NativeBuffer_Config创建OH_NativeBuffer实例,每次调用都会产生一个新的OH_NativeBuffer实例。
614本接口需要与OH_NativeBuffer_Unreference接口配合使用,否则会存在内存泄露。
615本接口为非线程安全类型接口。
616
617**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
618
619**起始版本:** 9
620
621**参数:**
622
623| 名称 | 描述 |
624| -------- | -------- |
625| config | 一个指向OH_NativeBuffer_Config类型的指针 |
626
627**返回:**
628
629创建成功则返回一个指向OH_NativeBuffer结构体实例的指针,否则返回NULL
630
631
632### OH_NativeBuffer_FromNativeWindowBuffer()
633
634```
635int32_t OH_NativeBuffer_FromNativeWindowBuffer (OHNativeWindowBuffer *nativeWindowBuffer, OH_NativeBuffer **buffer )
636```
637
638**描述**
639
640将OHNativeWindowBuffer实例转换为OH_NativeBuffer实例。
641本接口为非线程安全类型接口。
642
643**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
644
645**起始版本:** 12
646
647**参数:**
648
649| 名称 | 描述 |
650| -------- | -------- |
651| nativeWindowBuffer | 一个指向OHNativeWindowBuffer实例的指针。 |
652| buffer | 一个指向OH_NativeBuffer实例的指针。 |
653
654**返回:**
655
656返回值为0表示执行成功,其他返回值可参考[OHNativeErrorCode](#ohnativeerrorcode)。
657
658
659### OH_NativeBuffer_GetColorSpace()
660
661```
662int32_t OH_NativeBuffer_GetColorSpace (OH_NativeBuffer *buffer, OH_NativeBuffer_ColorSpace *colorSpace )
663```
664
665**描述**
666
667获取OH_NativeBuffer颜色空间属性。
668本接口为非线程安全类型接口。
669
670**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
671
672**起始版本:** 12
673
674**参数:**
675
676| 名称 | 描述 |
677| -------- | -------- |
678| buffer | 一个指向OH_NativeBuffer实例的指针。 |
679| colorSpace | OH_NativeBuffer的颜色空间,其值从[OH_NativeBuffer_ColorSpace](#oh_nativebuffer_colorspace)获取。 |
680
681**返回:**
682
683返回值为0表示执行成功,其他返回值可参考[OHNativeErrorCode](#ohnativeerrorcode)。
684
685
686### OH_NativeBuffer_GetConfig()
687
688```
689void OH_NativeBuffer_GetConfig (OH_NativeBuffer *buffer, OH_NativeBuffer_Config* config )
690```
691
692**描述**
693
694用于获取OH_NativeBuffer的属性。
695本接口为非线程安全类型接口。
696
697**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
698
699**起始版本:** 9
700
701**参数:**
702
703| 名称 | 描述 |
704| -------- | -------- |
705| buffer | 一个指向OH_NativeBuffer实例的指针 |
706| config | 一个指向OH_NativeBuffer_Config的指针,用于接收OH_NativeBuffer的属性 |
707
708
709### OH_NativeBuffer_GetMetadataValue()
710
711```
712int32_t OH_NativeBuffer_GetMetadataValue (OH_NativeBuffer *buffer, OH_NativeBuffer_MetadataKey metadataKey, int32_t *size, uint8_t **metaData )
713```
714
715**描述**
716
717获取OH_NativeBuffer元数据属性值。
718本接口为非线程安全类型接口。
719
720**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
721
722**起始版本:** 12
723
724**参数:**
725
726| 名称 | 描述 |
727| -------- | -------- |
728| buffer | 一个指向OH_NativeBuffer实例的指针。 |
729| metadataKey | OH_NativeBuffer的元数据类型,其值从[OH_NativeBuffer_MetadataKey](#oh_nativebuffer_metadatakey)获取。 |
730| size | uint8_t向量的大小,其取值范围见[OH_NativeBuffer_MetadataKey](#oh_nativebuffer_metadatakey)。 |
731| metaDate | 指向uint8_t向量的二级指针。 |
732
733**返回:**
734
735返回值为0表示执行成功,其他返回值可参考[OHNativeErrorCode](#ohnativeerrorcode)。
736
737
738### OH_NativeBuffer_GetSeqNum()
739
740```
741uint32_t OH_NativeBuffer_GetSeqNum (OH_NativeBuffer *buffer)
742```
743
744**描述**
745
746获取OH_NativeBuffer的序列号。
747本接口为非线程安全类型接口。
748
749**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
750
751**起始版本:** 9
752
753**参数:**
754
755| 名称 | 描述 |
756| -------- | -------- |
757| buffer | 一个指向OH_NativeBuffer实例的指针 |
758
759**返回:**
760
761返回对应OH_NativeBuffer的唯一序列号
762
763
764### OH_NativeBuffer_Map()
765
766```
767int32_t OH_NativeBuffer_Map (OH_NativeBuffer *buffer, void **virAddr )
768```
769
770**描述**
771
772将OH_NativeBuffer对应的ION内存映射到进程空间。
773本接口需要与OH_NativeBuffer_Unmap接口配合使用。
774本接口为非线程安全类型接口。
775
776**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
777
778**起始版本:** 9
779
780**参数:**
781
782| 名称 | 描述 |
783| -------- | -------- |
784| buffer | 一个指向OH_NativeBuffer实例的指针 |
785| virAddr | 一个二级指针,二级指针指向映射到当前进程的虚拟内存的地址 |
786
787**返回:**
788
789返回值为0表示执行成功,其他返回值可参考[OHNativeErrorCode](#ohnativeerrorcode)。
790
791
792### OH_NativeBuffer_MapPlanes()
793
794```
795int32_t OH_NativeBuffer_MapPlanes (OH_NativeBuffer *buffer, void **virAddr, OH_NativeBuffer_Planes *outPlanes )
796```
797
798**描述**
799
800将OH_NativeBuffer对应的多通道ION内存映射到进程空间。
801本接口为非线程安全类型接口。
802
803**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
804
805**起始版本:** 12
806
807**参数:**
808
809| 名称 | 描述 |
810| -------- | -------- |
811| buffer | 一个指向OH_NativeBuffer实例的指针。 |
812| virAddr | 一个二级指针,二级指针指向映射到当前进程的虚拟内存的地址。 |
813| outPlanes | 一个指向所有图像平面格式信息的指针。 |
814
815**返回:**
816
817返回值为0表示执行成功,其他返回值可参考[OHNativeErrorCode](#ohnativeerrorcode)。
818
819
820### OH_NativeBuffer_Reference()
821
822```
823int32_t OH_NativeBuffer_Reference (OH_NativeBuffer *buffer)
824```
825
826**描述**
827
828将OH_NativeBuffer对象的引用计数加1。
829本接口需要与OH_NativeBuffer_Unreference接口配合使用,否则会存在内存泄露。
830本接口为非线程安全类型接口。
831
832**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
833
834**起始版本:** 9
835
836**参数:**
837
838| 名称 | 描述 |
839| -------- | -------- |
840| buffer | 一个指向OH_NativeBuffer实例的指针 |
841
842**返回:**
843
844返回值为0表示执行成功,其他返回值可参考[OHNativeErrorCode](#ohnativeerrorcode)。
845
846
847### OH_NativeBuffer_SetColorSpace()
848
849```
850int32_t OH_NativeBuffer_SetColorSpace (OH_NativeBuffer *buffer, OH_NativeBuffer_ColorSpace colorSpace )
851```
852
853**描述**
854
855为OH_NativeBuffer设置颜色空间属性。
856本接口为非线程安全类型接口。
857
858**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
859
860**起始版本:** 11
861
862**参数:**
863
864| 名称 | 描述 |
865| -------- | -------- |
866| buffer | 一个指向OH_NativeBuffer实例的指针。 |
867| colorSpace | 为OH_NativeBuffer设置的颜色空间,其值从[OH_NativeBuffer_ColorSpace](#oh_nativebuffer_colorspace)获取。 |
868
869**返回:**
870
871返回值为0表示执行成功,其他返回值可参考[OHNativeErrorCode](#ohnativeerrorcode)。
872
873
874### OH_NativeBuffer_SetMetadataValue()
875
876```
877int32_t OH_NativeBuffer_SetMetadataValue (OH_NativeBuffer *buffer, OH_NativeBuffer_MetadataKey metadataKey, int32_t size, uint8_t *metaData )
878```
879
880**描述**
881
882为OH_NativeBuffer设置元数据属性值。
883本接口为非线程安全类型接口。
884
885**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
886
887**起始版本:** 12
888
889**参数:**
890
891| 名称 | 描述 |
892| -------- | -------- |
893| buffer | 一个指向OH_NativeBuffer实例的指针。 |
894| metadataKey | OH_NativeBuffer的元数据类型,其值从[OH_NativeBuffer_MetadataKey](#oh_nativebuffer_metadatakey-1)获取。 |
895| size | uint8_t向量的大小,其取值范围见[OH_NativeBuffer_MetadataKey](#oh_nativebuffer_metadatakey-1)。 |
896| metaDate | 指向uint8_t向量的指针。 |
897
898**返回:**
899
900返回值为0表示执行成功,其他返回值可参考[OHNativeErrorCode](#ohnativeerrorcode)。
901
902
903### OH_NativeBuffer_Unmap()
904
905```
906int32_t OH_NativeBuffer_Unmap (OH_NativeBuffer *buffer)
907```
908
909**描述**
910
911将OH_NativeBuffer对应的ION内存从进程空间移除。
912本接口为非线程安全类型接口。
913
914**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
915
916**起始版本:** 9
917
918**参数:**
919
920| 名称 | 描述 |
921| -------- | -------- |
922| buffer | 一个指向OH_NativeBuffer实例的指针 |
923
924**返回:**
925
926返回值为0表示执行成功,其他返回值可参考[OHNativeErrorCode](#ohnativeerrorcode)。
927
928
929### OH_NativeBuffer_Unreference()
930
931```
932int32_t OH_NativeBuffer_Unreference (OH_NativeBuffer *buffer)
933```
934
935**描述**
936
937将OH_NativeBuffer对象的引用计数减1,当引用计数为0的时候,该NativeBuffer对象会被析构掉。
938本接口为非线程安全类型接口。
939
940**系统能力:** SystemCapability.Graphic.Graphic2D.NativeBuffer
941
942**起始版本:** 9
943
944**参数:**
945
946| 名称 | 描述 |
947| -------- | -------- |
948| buffer | 一个指向OH_NativeBuffer实例的指针 |
949
950**返回:**
951
952返回值为0表示执行成功,其他返回值可参考[OHNativeErrorCode](#ohnativeerrorcode)。
953