• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# NativeWindow
2
3
4## 概述
5
6提供NativeWindow功能,作为数据生产者,可用来和egl对接。
7
8**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
9
10**起始版本:** 8
11
12
13## 汇总
14
15
16### 文件
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [external_window.h](external__window_8h.md) | 定义获取和使用NativeWindow的相关函数。<br/>**引用文件:**&lt;native_window/external_window.h&gt;<br/>**库:**libnative_window.so |
21
22
23### 结构体
24
25| 名称 | 描述 |
26| -------- | -------- |
27| [Region](_region.md) | 表示本地窗口OHNativeWindow需要更新内容的矩形区域(脏区)。 |
28| [OHHDRMetaData](_o_h_h_d_r_meta_data.md) | HDR元数据结构体定义。 |
29| [OHExtDataHandle](_o_h_ext_data_handle.md) | 扩展数据句柄结构体定义。 |
30
31
32### 类型定义
33
34| 名称 | 描述 |
35| -------- | -------- |
36| [OHNativeWindow](#ohnativewindow) | 提供对OHNativeWindow的访问功能。 |
37| [OHNativeWindowBuffer](#ohnativewindowbuffer) | 提供对OHNativeWindowBuffer的访问功能。 |
38| [Region](#region) | 表示本地窗口OHNativeWindow需要更新内容的矩形区域(脏区)。 |
39
40
41### 枚举
42
43| 名称 | 描述 |
44| -------- | -------- |
45| [NativeWindowOperation](#nativewindowoperation) {<br/>SET_BUFFER_GEOMETRY, GET_BUFFER_GEOMETRY, GET_FORMAT, SET_FORMAT,<br/>GET_USAGE, SET_USAGE, SET_STRIDE, GET_STRIDE,<br/>SET_SWAP_INTERVAL, GET_SWAP_INTERVAL, SET_TIMEOUT, GET_TIMEOUT,<br/>SET_COLOR_GAMUT, GET_COLOR_GAMUT, SET_TRANSFORM, GET_TRANSFORM,<br/>SET_UI_TIMESTAMP<br/>} | OH_NativeWindow_NativeWindowHandleOpt函数中的操作码。 |
46| [OHScalingMode](#ohscalingmode) { OH_SCALING_MODE_FREEZE = 0, OH_SCALING_MODE_SCALE_TO_WINDOW, OH_SCALING_MODE_SCALE_CROP, OH_SCALING_MODE_NO_SCALE_CROP } | 缩放模式Scaling Mode。 |
47| [OHHDRMetadataKey](#ohhdrmetadatakey) {<br/>OH_METAKEY_RED_PRIMARY_X = 0, OH_METAKEY_RED_PRIMARY_Y = 1, OH_METAKEY_GREEN_PRIMARY_X = 2, OH_METAKEY_GREEN_PRIMARY_Y = 3,<br/>OH_METAKEY_BLUE_PRIMARY_X = 4, OH_METAKEY_BLUE_PRIMARY_Y = 5, OH_METAKEY_WHITE_PRIMARY_X = 6, OH_METAKEY_WHITE_PRIMARY_Y = 7,<br/>OH_METAKEY_MAX_LUMINANCE = 8, OH_METAKEY_MIN_LUMINANCE = 9, OH_METAKEY_MAX_CONTENT_LIGHT_LEVEL = 10, OH_METAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL = 11,<br/>OH_METAKEY_HDR10_PLUS = 12, OH_METAKEY_HDR_VIVID = 13<br/>} | 枚举HDR元数据关键字。 |
48
49
50### 函数
51
52| 名称 | 描述 |
53| -------- | -------- |
54| [OH_NativeWindow_CreateNativeWindow](#oh_nativewindow_createnativewindow) (void \*pSurface) | 创建OHNativeWindow实例,每次调用都会产生一个新的OHNativeWindow实例。 |
55| [OH_NativeWindow_DestroyNativeWindow](#oh_nativewindow_destroynativewindow) ([OHNativeWindow](#ohnativewindow) \*window) | 将OHNativeWindow对象的引用计数减1,当引用计数为0的时候,该OHNativeWindow对象会被析构掉。 |
56| [OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer](#oh_nativewindow_createnativewindowbufferfromsurfacebuffer) (void \*pSurfaceBuffer) | 创建OHNativeWindowBuffer实例,每次调用都会产生一个新的OHNativeWindowBuffer实例。 |
57| [OH_NativeWindow_CreateNativeWindowBufferFromNativeBuffer](#oh_nativewindow_createnativewindowbufferfromnativebuffer) ([OH_NativeBuffer](_o_h___native_buffer.md#oh_nativebuffer) \*nativeBuffer) | 创建OHNativeWindowBuffer实例,每次调用都会产生一个新的OHNativeWindowBuffer实例。 |
58| [OH_NativeWindow_DestroyNativeWindowBuffer](#oh_nativewindow_destroynativewindowbuffer) ([OHNativeWindowBuffer](#ohnativewindowbuffer) \*buffer) | 将OHNativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该OHNativeWindowBuffer对象会被析构掉。 |
59| [OH_NativeWindow_NativeWindowRequestBuffer](#oh_nativewindow_nativewindowrequestbuffer) ([OHNativeWindow](#ohnativewindow) \*window, [OHNativeWindowBuffer](#ohnativewindowbuffer) \*\*buffer, int \*fenceFd) | 通过OHNativeWindow对象申请一块OHNativeWindowBuffer,用以内容生产。 |
60| [OH_NativeWindow_NativeWindowFlushBuffer](#oh_nativewindow_nativewindowflushbuffer) ([OHNativeWindow](#ohnativewindow) \*window, [OHNativeWindowBuffer](#ohnativewindowbuffer) \*buffer, int fenceFd, [Region](_region.md) region) | 通过OHNativeWindow将生产好内容的OHNativeWindowBuffer放回到Buffer队列中,用以内容消费。 |
61| [OH_NativeWindow_GetLastFlushedBuffer](#oh_nativewindow_getlastflushedbuffer) ([OHNativeWindow](#ohnativewindow) \*window, [OHNativeWindowBuffer](#ohnativewindowbuffer) \**buffer, int \*fenceFd, float matrix[16]) | 从OHNativeWindow获取上次送回到buffer队列中的OHNativeWindowBuffer。 |
62| [OH_NativeWindow_NativeWindowAbortBuffer](#oh_nativewindow_nativewindowabortbuffer) ([OHNativeWindow](#ohnativewindow) \*window, [OHNativeWindowBuffer](#ohnativewindowbuffer) \*buffer) | 通过OHNativeWindow将之前申请出来的OHNativeWindowBuffer返还到Buffer队列中,供下次再申请。 |
63| [OH_NativeWindow_NativeWindowHandleOpt](#oh_nativewindow_nativewindowhandleopt) ([OHNativeWindow](#ohnativewindow) \*window, int code,...) | 设置/获取OHNativeWindow的属性,包括设置/获取宽高、内容格式等。 |
64| [OH_NativeWindow_GetBufferHandleFromNative](#oh_nativewindow_getbufferhandlefromnative) ([OHNativeWindowBuffer](#ohnativewindowbuffer) \*buffer) | 通过OHNativeWindowBuffer获取该buffer的BufferHandle指针。 |
65| [OH_NativeWindow_NativeObjectReference](#oh_nativewindow_nativeobjectreference) (void \*obj) | 增加一个NativeObject的引用计数。 |
66| [OH_NativeWindow_NativeObjectUnreference](#oh_nativewindow_nativeobjectunreference) (void \*obj) | 减少一个NativeObject的引用计数,当引用计数减少为0时,该NativeObject将被析构掉。 |
67| [OH_NativeWindow_GetNativeObjectMagic](#oh_nativewindow_getnativeobjectmagic) (void \*obj) | 获取NativeObject的MagicId。 |
68| [OH_NativeWindow_NativeWindowSetScalingMode](#oh_nativewindow_nativewindowsetscalingmode) ([OHNativeWindow](#ohnativewindow) \*window, uint32_t sequence, [OHScalingMode](#ohscalingmode) scalingMode) | 设置OHNativeWindow的ScalingMode。 |
69| [OH_NativeWindow_NativeWindowSetMetaData](#oh_nativewindow_nativewindowsetmetadata) ([OHNativeWindow](#ohnativewindow) \*window, uint32_t sequence, int32_t size, const [OHHDRMetaData](_o_h_h_d_r_meta_data.md) \*metaData) | 设置OHNativeWindow的元数据。 |
70| [OH_NativeWindow_NativeWindowSetMetaDataSet](#oh_nativewindow_nativewindowsetmetadataset) ([OHNativeWindow](#ohnativewindow) \*window, uint32_t sequence, [OHHDRMetadataKey](#ohhdrmetadatakey) key, int32_t size, const uint8_t \*metaData) | 设置OHNativeWindow的元数据集。 |
71| [OH_NativeWindow_NativeWindowSetTunnelHandle](#oh_nativewindow_nativewindowsettunnelhandle) ([OHNativeWindow](#ohnativewindow) \*window, const [OHExtDataHandle](_o_h_ext_data_handle.md) \*handle) | 设置OHNativeWindow的TunnelHandle。 |
72
73
74## 类型定义说明
75
76
77### OHNativeWindow
78
79```
80typedef struct NativeWindow OHNativeWindow
81```
82
83**描述**
84
85提供对OHNativeWindow的访问功能。
86
87**起始版本:** 8
88
89
90### OHNativeWindowBuffer
91
92```
93typedef struct NativeWindowBuffer OHNativeWindowBuffer
94```
95
96**描述**
97
98提供对OHNativeWindowBuffer的访问功能。
99
100**起始版本:** 8
101
102
103### Region
104
105```
106typedef struct RegionRegion
107```
108
109**描述**
110
111表示本地窗口OHNativeWindow需要更新内容的矩形区域(脏区)。
112
113**起始版本:** 8
114
115
116## 枚举类型说明
117
118
119### NativeWindowOperation
120
121```
122enum NativeWindowOperation
123```
124
125**描述**
126
127OH_NativeWindow_NativeWindowHandleOpt函数中的操作码。
128
129**起始版本:** 8
130
131| 枚举值 | 描述 |
132| -------- | -------- |
133| SET_BUFFER_GEOMETRY | 设置本地窗口缓冲区几何图形, 函数中的可变参数是 [输入]int32_t width ,[输入] int32_t height。 |
134| GET_BUFFER_GEOMETRY | 获取本地窗口缓冲区几何图形, 函数中的可变参数是 [输出] int32_t \*height, [输出] int32_t \*width。 |
135| GET_FORMAT | 获取本地窗口缓冲区格式, 函数中的可变参数是 [输出] int32_t \*format,获取类型详细请参见[OH_NativeBuffer_Format](_o_h___native_buffer.md#oh_nativebuffer_format)。 |
136| SET_FORMAT | 设置本地窗口缓冲区格式, 函数中的可变参数是 [输入] int32_t format,设置类型详细请参见[OH_NativeBuffer_Format](_o_h___native_buffer.md#oh_nativebuffer_format)。 |
137| GET_USAGE | 获取本地窗口读写方式, 函数中的可变参数是 [输出] int32_t \*usage,获取类型详细请参见[OH_NativeBuffer_Usage](_o_h___native_buffer.md#oh_nativebuffer_usage)。 |
138| SET_USAGE | 设置本地窗口缓冲区读写方式, 函数中的可变参数是 [输入] int32_t usage,设置类型详细请参见[OH_NativeBuffer_Usage](_o_h___native_buffer.md#oh_nativebuffer_usage)。 |
139| SET_STRIDE | 设置本地窗口缓冲区步幅, 函数中的可变参数是 [输入] int32_t stride。 |
140| GET_STRIDE | 获取本地窗口缓冲区步幅, 函数中的可变参数是 [输出] int32_t \*stride。 |
141| SET_SWAP_INTERVAL | 设置本地窗口缓冲区交换间隔, 函数中的可变参数是 [输入] int32_t interval。 |
142| GET_SWAP_INTERVAL | 获取本地窗口缓冲区交换间隔, 函数中的可变参数是 [输出] int32_t \*interval。 |
143| SET_TIMEOUT | 设置请求本地窗口缓冲区的超时等待时间, 函数中的可变参数是 [输入] int32_t timeout。 |
144| GET_TIMEOUT | 获取请求本地窗口缓冲区的超时等待时间, 函数中的可变参数是 [输出] int32_t \*timeout。 |
145| SET_COLOR_GAMUT | 设置本地窗口缓冲区色彩空间, 函数中的可变参数是 [输入] int32_t colorGamut。 |
146| GET_COLOR_GAMUT | 获取本地窗口缓冲区色彩空间, 函数中的可变参数是 [out int32_t \*colorGamut]。 |
147| SET_TRANSFORM | 设置本地窗口缓冲区变换, 函数中的可变参数是 [输入] int32_t transform。 |
148| GET_TRANSFORM | 获取本地窗口缓冲区变换, 函数中的可变参数是 [输出] int32_t \*transform。 |
149| SET_UI_TIMESTAMP | 设置本地窗口缓冲区UI时间戳, 函数中的可变参数是 [输入] uint64_t uiTimestamp。 |
150
151
152### OHHDRMetadataKey
153
154```
155enum OHHDRMetadataKey
156```
157
158**描述**
159
160枚举HDR元数据关键字。
161
162**起始版本:** 9
163
164**弃用:** 从API version 10开始废弃,不再提供替代接口。
165
166| 枚举值 | 描述 |
167| -------- | -------- |
168| OH_METAKEY_RED_PRIMARY_X | 红基色X坐标。 |
169| OH_METAKEY_RED_PRIMARY_Y | 红基色Y坐标。 |
170| OH_METAKEY_GREEN_PRIMARY_X | 绿基色X坐标。 |
171| OH_METAKEY_GREEN_PRIMARY_Y | 绿基色Y坐标。 |
172| OH_METAKEY_BLUE_PRIMARY_X | 蓝基色X坐标。 |
173| OH_METAKEY_BLUE_PRIMARY_Y | 蓝基色Y坐标。 |
174| OH_METAKEY_WHITE_PRIMARY_X | 白点X坐标。 |
175| OH_METAKEY_WHITE_PRIMARY_Y | 白点Y坐标。 |
176| OH_METAKEY_MAX_LUMINANCE | 最大的光亮度。 |
177| OH_METAKEY_MIN_LUMINANCE | 最小的光亮度。 |
178| OH_METAKEY_MAX_CONTENT_LIGHT_LEVEL | 最大的内容亮度水平。 |
179| OH_METAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL | 最大的帧平均亮度水平。 |
180| OH_METAKEY_HDR10_PLUS | HDR10 Plus。 |
181| OH_METAKEY_HDR_VIVID | Vivid。 |
182
183
184### OHScalingMode
185
186```
187enum OHScalingMode
188```
189
190**描述**
191
192缩放模式 Scaling Mode
193
194**起始版本:** 9
195
196**弃用:** 从API version 10开始废弃,不再提供替代接口。
197
198| 枚举值 | 描述 |
199| -------- | -------- |
200| OH_SCALING_MODE_FREEZE | 在接收到窗口大小的缓冲区之前,不可以更新窗口内容。 |
201| OH_SCALING_MODE_SCALE_TO_WINDOW | 缓冲区在二维中缩放以匹配窗口大小。 |
202| OH_SCALING_MODE_SCALE_CROP | 缓冲区被统一缩放,使得缓冲区的较小尺寸与窗口大小匹配。 |
203| OH_SCALING_MODE_NO_SCALE_CROP | 窗口被裁剪为缓冲区裁剪矩形的大小,裁剪矩形之外的像素被视为完全透明。 |
204
205
206## 函数说明
207
208
209### OH_NativeWindow_CreateNativeWindow()
210
211```
212OHNativeWindow* OH_NativeWindow_CreateNativeWindow (void * pSurface)
213```
214
215**描述**
216
217创建OHNativeWindow实例,每次调用都会产生一个新的OHNativeWindow实例。
218
219**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
220
221**起始版本:** 8
222
223**参数:**
224
225| 名称 | 描述 |
226| -------- | -------- |
227| pSurface | 一个指向生产者ProduceSurface的指针,类型为sptr&lt;OHOS::Surface&gt;。 |
228
229**返回:**
230
231返回一个指针,指向OHNativeWindow的结构体实例。
232
233> **说明:**
234>
235> 此接口不支持使用,可通过[OH_NativeImage_AcquireNativeWindow](_o_h___native_image.md#oh_nativeimage_acquirenativewindow)获取,或通过XComponent创建。
236
237
238### OH_NativeWindow_CreateNativeWindowBufferFromNativeBuffer()
239
240```
241OHNativeWindowBuffer* OH_NativeWindow_CreateNativeWindowBufferFromNativeBuffer (OH_NativeBuffer * nativeBuffer)
242```
243
244**描述**
245
246创建OHNativeWindowBuffer实例,每次调用都会产生一个新的OHNativeWindowBuffer实例。
247
248**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
249
250**起始版本:** 11
251
252**参数:**
253
254| 名称 | 描述 |
255| -------- | -------- |
256| nativeBuffer | 一个指向OH_NativeBuffer的指针。 |
257
258**返回:**
259
260返回一个指针,指向OHNativeWindowBuffer的结构体实例。
261
262
263### OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer()
264
265```
266OHNativeWindowBuffer* OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void * pSurfaceBuffer)
267```
268
269**描述**
270
271创建OHNativeWindowBuffer实例,每次调用都会产生一个新的OHNativeWindowBuffer实例。
272
273**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow274
275**起始版本:** 8
276
277**参数:**
278
279| 名称 | 描述 |
280| -------- | -------- |
281| pSurfaceBuffer | 一个指向生产者buffer的指针,类型为sptr&lt;OHOS::SurfaceBuffer&gt;。 |
282
283**返回:**
284
285返回一个指针,指向OHNativeWindowBuffer的结构体实例。
286
287> **说明:**
288>
289> 此接口不支持使用,可通过[OH_NativeWindow_CreateNativeWindowBufferFromNativeBuffer](#oh_nativewindow_createnativewindowbufferfromnativebuffer)替代。
290
291
292### OH_NativeWindow_DestroyNativeWindow()
293
294```
295void OH_NativeWindow_DestroyNativeWindow (OHNativeWindow * window)
296```
297
298**描述**
299
300将OHNativeWindow对象的引用计数减1,当引用计数为0的时候,该OHNativeWindow对象会被析构掉。
301
302**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
303
304**起始版本:** 8
305
306**参数:**
307
308| 名称 | 描述 |
309| -------- | -------- |
310| window | 一个OHNativeWindow的结构体实例的指针。 |
311
312
313### OH_NativeWindow_DestroyNativeWindowBuffer()
314
315```
316void OH_NativeWindow_DestroyNativeWindowBuffer (OHNativeWindowBuffer * buffer)
317```
318
319**描述**
320
321将OHNativeWindowBuffer对象的引用计数减1,当引用计数为0的时候,该OHNativeWindowBuffer对象会被析构掉。
322
323**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
324
325**起始版本:** 8
326
327**参数:**
328
329| 名称 | 描述 |
330| -------- | -------- |
331| buffer | 一个OHNativeWindowBuffer的结构体实例的指针。 |
332
333
334### OH_NativeWindow_GetBufferHandleFromNative()
335
336```
337BufferHandle* OH_NativeWindow_GetBufferHandleFromNative (OHNativeWindowBuffer * buffer)
338```
339
340**描述**
341
342通过OHNativeWindowBuffer获取该buffer的BufferHandle指针。
343
344**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
345
346**起始版本:** 8
347
348**参数:**
349
350| 名称 | 描述 |
351| -------- | -------- |
352| buffer | 一个OHNativeWindowBuffer的结构体实例的指针。 |
353
354**返回:**
355
356BufferHandle 返回一个指针,指向BufferHandle的结构体实例。
357
358
359### OH_NativeWindow_GetLastFlushedBuffer()
360
361```
362int32_t OH_NativeWindow_GetLastFlushedBuffer (OHNativeWindow * window, OHNativeWindowBuffer **buffer, int *fenceFd, float matrix[16])
363```
364
365**描述**
366
367从OHNativeWindow获取上次送回到buffer队列中的OHNativeWindowBuffer。
368
369**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
370
371**起始版本:** 11
372
373**参数:**
374
375| 名称 | 描述 |
376| -------- | -------- |
377| window | 一个OHNativeWindow的结构体实例的指针。 |
378| buffer | 一个OHNativeWindowBuffer结构体指针的指针。 |
379| fenceFd | 一个文件描述符的指针。 |
380| matrix | 表示检索到的4*4变换矩阵。 |
381
382**返回:**
383
384返回值为0表示执行成功。
385
386
387### OH_NativeWindow_GetNativeObjectMagic()
388
389```
390int32_t OH_NativeWindow_GetNativeObjectMagic (void * obj)
391```
392
393**描述**
394
395获取NativeObject的MagicId。
396
397**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
398
399**起始版本:** 8
400
401**参数:**
402
403| 名称 | 描述 |
404| -------- | -------- |
405| obj | 一个OHNativeWindow或者OHNativeWindowBuffer的结构体实例的指针。 |
406
407**返回:**
408
409MagicId 返回值为魔鬼数字,每个NativeObject唯一。
410
411
412### OH_NativeWindow_NativeObjectReference()
413
414```
415int32_t OH_NativeWindow_NativeObjectReference (void * obj)
416```
417
418**描述**
419
420增加一个NativeObject的引用计数。
421
422**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
423
424**起始版本:** 8
425
426**参数:**
427
428| 名称 | 描述 |
429| -------- | -------- |
430| obj | 一个OHNativeWindow或者OHNativeWindowBuffer的结构体实例的指针。 |
431
432**返回:**
433
434返回值为0表示执行成功。
435
436
437### OH_NativeWindow_NativeObjectUnreference()
438
439```
440int32_t OH_NativeWindow_NativeObjectUnreference (void * obj)
441```
442
443**描述**
444
445减少一个NativeObject的引用计数,当引用计数减少为0时,该NativeObject将被析构掉。
446
447**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
448
449**起始版本:** 8
450
451**参数:**
452
453| 名称 | 描述 |
454| -------- | -------- |
455| obj | 一个OHNativeWindow或者OHNativeWindowBuffer的结构体实例的指针。 |
456
457**返回:**
458
459返回值为0表示执行成功。
460
461
462### OH_NativeWindow_NativeWindowAbortBuffer()
463
464```
465int32_t OH_NativeWindow_NativeWindowAbortBuffer (OHNativeWindow * window, OHNativeWindowBuffer * buffer )
466```
467
468**描述**
469
470通过OHNativeWindow将之前申请出来的OHNativeWindowBuffer返还到Buffer队列中,供下次再申请。
471
472**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
473
474**起始版本:** 8
475
476**参数:**
477
478| 名称 | 描述 |
479| -------- | -------- |
480| window | 一个OHNativeWindow的结构体实例的指针。 |
481| buffer | 一个OHNativeWindowBuffer的结构体实例的指针。 |
482
483**返回:**
484
485返回值为0表示执行成功。
486
487
488### OH_NativeWindow_NativeWindowFlushBuffer()
489
490```
491int32_t OH_NativeWindow_NativeWindowFlushBuffer (OHNativeWindow * window, OHNativeWindowBuffer * buffer, int fenceFd, Region region )
492```
493
494**描述**
495
496通过OHNativeWindow将生产好内容的OHNativeWindowBuffer放回到Buffer队列中,用以内容消费。
497
498**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
499
500**起始版本:** 8
501
502**参数:**
503
504| 名称 | 描述 |
505| -------- | -------- |
506| window | 一个OHNativeWindow的结构体实例的指针。 |
507| buffer | 一个OHNativeWindowBuffer的结构体实例的指针。 |
508| fenceFd | 一个文件描述符句柄,用以同步时序。 |
509| region | 表示一块脏区域,该区域有内容更新。 |
510
511**返回:**
512
513返回值为0表示执行成功。
514
515
516### OH_NativeWindow_NativeWindowHandleOpt()
517
518```
519int32_t OH_NativeWindow_NativeWindowHandleOpt (OHNativeWindow * window, int code,  ... )
520```
521
522**描述**
523
524设置/获取OHNativeWindow的属性,包括设置/获取宽高、内容格式等。
525
526**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
527
528**起始版本:** 8
529
530**参数:**
531
532| 名称 | 描述 |
533| -------- | -------- |
534| window | 一个OHNativeWindow的结构体实例的指针。 |
535| code | 表示操作码,详见[NativeWindowOperation](#nativewindowoperation)。 |
536| ... | 可变参数,必须与操作码一一对应。 |
537
538**返回:**
539
540返回值为0表示执行成功。
541
542
543### OH_NativeWindow_NativeWindowRequestBuffer()
544
545```
546int32_t OH_NativeWindow_NativeWindowRequestBuffer (OHNativeWindow * window, OHNativeWindowBuffer ** buffer, int * fenceFd )
547```
548
549**描述**
550
551通过OHNativeWindow对象申请一块OHNativeWindowBuffer,用以内容生产。
552
553**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
554
555**起始版本:** 8
556
557**参数:**
558
559| 名称 | 描述 |
560| -------- | -------- |
561| window | 一个OHNativeWindow的结构体实例的指针。 |
562| buffer | 一个OHNativeWindowBuffer的结构体实例的二级指针。 |
563| fenceFd | 一个文件描述符句柄。 |
564
565**返回:**
566
567返回值为0表示执行成功。
568
569
570### OH_NativeWindow_NativeWindowSetMetaData()
571
572```
573int32_t OH_NativeWindow_NativeWindowSetMetaData (OHNativeWindow * window, uint32_t sequence, int32_t size, const OHHDRMetaData * metaData )
574```
575
576**描述**
577
578设置OHNativeWindow的元数据。
579
580**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
581
582**起始版本:** 9
583
584**参数:**
585
586| 名称 | 描述 |
587| -------- | -------- |
588| window | 一个OHNativeWindow的结构体实例的指针。 |
589| sequence | 生产缓冲区的序列。 |
590| size | OHHDRMetaData数组的大小。 |
591| metaDate | 指向OHHDRMetaData数组的指针。 |
592
593**返回:**
594
595返回值为0表示执行成功。
596
597**弃用:**
598
599从API version 10开始废弃,不再提供替代接口。
600
601
602### OH_NativeWindow_NativeWindowSetMetaDataSet()
603
604```
605int32_t OH_NativeWindow_NativeWindowSetMetaDataSet (OHNativeWindow * window, uint32_t sequence, OHHDRMetadataKey key, int32_t size, const uint8_t * metaData )
606```
607
608**描述**
609
610设置OHNativeWindow的元数据集。
611
612**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
613
614**起始版本:** 9
615
616**参数:**
617
618| 名称 | 描述 |
619| -------- | -------- |
620| window | 一个OHNativeWindow的结构体实例的指针。 |
621| sequence | 生产缓冲区的序列。 |
622| key | 枚举值OHHDRMetadataKey。 |
623| size | uint8_t向量的大小。 |
624| metaDate | 指向uint8_t向量的指针。 |
625
626**返回:**
627
628返回值为0表示执行成功。
629
630**弃用:**
631
632从API version 10开始废弃,不再提供替代接口。
633
634
635### OH_NativeWindow_NativeWindowSetScalingMode()
636
637```
638int32_t OH_NativeWindow_NativeWindowSetScalingMode (OHNativeWindow * window, uint32_t sequence, OHScalingMode scalingMode )
639```
640
641**描述**
642
643设置OHNativeWindow的ScalingMode。
644
645**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
646
647**起始版本:** 9
648
649**参数:**
650
651| 名称 | 描述 |
652| -------- | -------- |
653| window | 一个OHNativeWindow的结构体实例的指针。 |
654| sequence | 生产缓冲区的序列。 |
655| scalingMode | 枚举值OHScalingMode。 |
656
657**返回:**
658
659返回值为0表示执行成功。
660
661**弃用:**
662
663从API version 10开始废弃,不再提供替代接口。
664
665
666### OH_NativeWindow_NativeWindowSetTunnelHandle()
667
668```
669int32_t OH_NativeWindow_NativeWindowSetTunnelHandle (OHNativeWindow * window, const OHExtDataHandle * handle )
670```
671
672**描述**
673
674设置OHNativeWindow的TunnelHandle。
675
676**系统能力:** SystemCapability.Graphic.Graphic2D.NativeWindow
677
678**起始版本:** 9
679
680**参数:**
681
682| 名称 | 描述 |
683| -------- | -------- |
684| window | 一个OHNativeWindow的结构体实例的指针。 |
685| handle | 指向OHExtDataHandle的指针。 |
686
687**返回:**
688
689返回值为0表示执行成功。
690
691**弃用:**
692
693从API version 10开始废弃,不再提供替代接口。
694