# external_window.h


## 概述

定义获取和使用NativeWindow的相关函数。

**自从：**

8

**相关模块：**

[NativeWindow](_native_window.md)


## 汇总


### 结构体

  | 结构体名称 | 描述 | 
| -------- | -------- |
| [Region](_region.md) | 表示本地窗口NativeWindow需要更新内容的矩形区域（脏区）。 | 
| [Region::Rect](_rect.md) | 矩形区域。 | 
| [OHHDRMetaData](_o_h_h_d_r_meta_data.md) | HDR元数据结构体定义 。 | 
| [OHExtDataHandle](_o_h_ext_data_handle.md) | 扩展数据句柄结构体定义 。 | 


### 类型定义

  | 类型定义名称 | 描述 | 
| -------- | -------- |
| OHNativeWindow | 提供对NativeWindow的访问功能 | 
| OHNativeWindowBuffer | 提供对NativeWindowBuffer的访问功能 | 
| [Region](_region.md) | 表示本地窗口NativeWindow需要更新内容的矩形区域（脏区） | 


### 枚举

  | 枚举名称 | 描述 | 
| -------- | -------- |
| [NativeWindowOperation](_native_window.md#nativewindowoperation)  {   SET_BUFFER_GEOMETRY, GET_BUFFER_GEOMETRY, GET_FORMAT, SET_FORMAT,   GET_USAGE, SET_USAGE, SET_STRIDE, GET_STRIDE,   SET_SWAP_INTERVAL, GET_SWAP_INTERVAL, SET_TIMEOUT, GET_TIMEOUT,   SET_COLOR_GAMUT, GET_COLOR_GAMUT, SET_TRANSFORM, GET_TRANSFORM,   SET_UI_TIMESTAMP } | OH_NativeWindow_NativeWindowHandleOpt函数中的操作码 | 
| [OHScalingMode](_native_window.md.#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 | 
| [OHHDRMetadataKey](_native_window.md#ohhdrmetadatakey) {   OH_METAKEY_RED_PRIMARY_X = 0, OH_METAKEY_RED_PRIMARY_Y = 1, OH_METAKEY_GREEN_PRIMARY_X = 2, OH_METAKEY_GREEN_PRIMARY_Y = 3,   OH_METAKEY_BLUE_PRIMARY_X = 4, OH_METAKEY_BLUE_PRIMARY_Y = 5, OH_METAKEY_WHITE_PRIMARY_X = 6, OH_METAKEY_WHITE_PRIMARY_Y = 7,   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,   OH_METAKEY_HDR10_PLUS = 12, OH_METAKEY_HDR_VIVID = 13 } | 枚举HDR元数据关键字 | 


### 函数

| 函数名称 | 描述 | 
| -------- | -------- |
| [OH_NativeWindow_CreateNativeWindow]( _native_window.md#ohnativewindowcreatenativewindow) (void \*pSurface) | 创建NativeWindow实例，每次调用都会产生一个新的NativeWindow实例 | 
| [OH_NativeWindow_DestroyNativeWindow]( _native_window.md#ohnativewindowdestroynativewindow) (OHNativeWindow \*window) | 将NativeWindow对象的引用计数减1，当引用计数为0的时候，该NativeWindow对象会被析构掉 | 
| [OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer]( _native_window.md#ohnativewindowcreatenativewindowbufferfromsurfacebuffer) (void \*pSurfaceBuffer) | 创建NativeWindowBuffer实例，每次调用都会产生一个新的NativeWindowBuffer实例 | 
| [OH_NativeWindow_DestroyNativeWindowBuffer]( _native_window.md#ohnativewindowdestroynativewindowbuffer) (OHNativeWindowBuffer \*buffer) | 将NativeWindowBuffer对象的引用计数减1，当引用计数为0的时候，该NativeWindowBuffer对象会被析构掉 | 
| [OH_NativeWindow_NativeWindowRequestBuffer]( _native_window.md#ohnativewindownativewindowrequestbuffer) (OHNativeWindow \*window, OHNativeWindowBuffer \*\*buffer, int \*fenceFd) | 通过NativeWindow对象申请一块NativeWindowBuffer，用以内容生产 | 
| [OH_NativeWindow_NativeWindowFlushBuffer]( _native_window.md#ohnativewindownativewindowflushbuffer) (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer, int fenceFd, [Region](_region.md) region) | 通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中，用以内容消费 | 
| [OH_NativeWindow_NativeWindowAbortBuffer]( _native_window.md#ohnativewindownativewindowabortbuffer) (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer) | 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中，供下次再申请 | 
| [OH_NativeWindow_NativeWindowHandleOpt]( _native_window.md#ohnativewindownativewindowhandleopt) (OHNativeWindow \*window, int code,...) | 设置/获取NativeWindow的属性，包括设置/获取宽高、内容格式等 | 
| [OH_NativeWindow_GetBufferHandleFromNative]( _native_window.md#ohnativewindowgetbufferhandlefromnative) (OHNativeWindowBuffer \*buffer) | 通过NativeWindowBuffer获取该buffer的BufferHandle指针 | 
| [OH_NativeWindow_NativeObjectReference]( _native_window.md#ohnativewindownativeobjectreference) (void \*obj) | 增加一个NativeObject的引用计数 | 
| [OH_NativeWindow_NativeObjectUnreference]( _native_window.md#ohnativewindownativeobjectunreference) (void \*obj) | 减少一个NativeObject的引用计数，当引用计数减少为0时，该NativeObject将被析构掉 | 
| [OH_NativeWindow_GetNativeObjectMagic]( _native_window.md#ohnativewindowgetnativeobjectmagic) (void \*obj) | 获取NativeObject的MagicId | 
| [OH_NativeWindow_NativeWindowSetScalingMode]( _native_window.md#ohnativewindownativewindowsetscalingmode) (OHNativeWindow \*window, uint32_t sequence, [OHScalingMode]( _native_window.md#ohscalingmode) scalingMode) | 设置NativeWindow的ScalingMode | 
| [OH_NativeWindow_NativeWindowSetMetaData]( _native_window.md#ohnativewindownativewindowsetmetadata) (OHNativeWindow \*window, uint32_t sequence, int32_t size, const [OHHDRMetaData](_o_h_h_d_r_meta_data.md) \*metaData) | 设置NativeWindow的元数据 | 
| [OH_NativeWindow_NativeWindowSetMetaDataSet]( _native_window.md#ohnativewindownativewindowsetmetadataset) (OHNativeWindow \*window, uint32_t sequence, [OHHDRMetadataKey]( _native_window.md#ohhdrmetadatakey) key, int32_t size, const uint8_t \*metaData) | 设置NativeWindow的元数据集。 | 
| [OH_NativeWindow_NativeWindowSetTunnelHandle]( _native_window.md#ohnativewindownativewindowsettunnelhandle) (OHNativeWindow \*window, const [OHExtDataHandle](_o_h_ext_data_handle.md) \*handle) | 设置NativeWindow的TunnelHandle。 |