1# oh_display_info.h 2<!--Kit: ArkUI--> 3<!--Subsystem: Window--> 4<!--Owner: @oh_wangxk; @logn--> 5<!--Designer: @hejunfei1991--> 6<!--Tester: @qinliwen0417--> 7<!--Adviser: @ge-yafang--> 8 9## 概述 10 11提供屏幕的公共枚举、公共定义等。 12 13**引用文件：** <window_manager/oh_display_info.h> 14 15**库：** libnative_display_manager.so 16 17**系统能力：** SystemCapability.WindowManager.WindowManager.Core 18 19**起始版本：** 12 20 21**相关模块：** [OH_DisplayManager](capi-oh-displaymanager.md) 22 23## 汇总 24 25### 结构体 26 27| 名称 | typedef关键字 | 描述 | 28| -- | -- | -- | 29| [NativeDisplayManager_Rect](capi-nativedisplaymanager-rect.md) | NativeDisplayManager_Rect | 矩形区域。 | 30| [NativeDisplayManager_WaterfallDisplayAreaRects](capi-nativedisplaymanager-waterfalldisplayarearects.md) | NativeDisplayManager_WaterfallDisplayAreaRects | 瀑布屏曲面部分显示区域。 | 31| [NativeDisplayManager_CutoutInfo](capi-nativedisplaymanager-cutoutinfo.md) | NativeDisplayManager_CutoutInfo | 挖孔屏、刘海屏、瀑布屏等不可用屏幕区域信息。 | 32| [NativeDisplayManager_DisplayHdrFormat](capi-nativedisplaymanager-displayhdrformat.md) | NativeDisplayManager_DisplayHdrFormat | 显示设备支持的所有HDR格式。 | 33| [NativeDisplayManager_DisplayColorSpace](capi-nativedisplaymanager-displaycolorspace.md) | NativeDisplayManager_DisplayColorSpace | 显示设备支持的所有色域类型。 | 34| [NativeDisplayManager_DisplayInfo](capi-nativedisplaymanager-displayinfo.md) | NativeDisplayManager_DisplayInfo | 显示设备的对象属性。 | 35| [NativeDisplayManager_DisplaysInfo](capi-nativedisplaymanager-displaysinfo.md) | NativeDisplayManager_DisplaysInfo | 多显示设备的Display对象。 | 36 37### 宏定义 38 39| 名称 | 描述 | 40|--------------|-----------| 41| [OH_DISPLAY_NAME_LENGTH](#oh_display_name_length) 32 | 屏幕名称的最大长度。 | 42 43### 枚举 44 45| 名称 | typedef关键字 | 描述 | 46| -- | -- | -- | 47| [NativeDisplayManager_Rotation](#nativedisplaymanager_rotation) | NativeDisplayManager_Rotation | 屏幕顺时针的旋转角度。 | 48| [NativeDisplayManager_Orientation](#nativedisplaymanager_orientation) | NativeDisplayManager_Orientation | 屏幕的旋转方向。 | 49| [NativeDisplayManager_ErrorCode](#nativedisplaymanager_errorcode) | NativeDisplayManager_ErrorCode | 屏幕管理接口返回状态码枚举。 | 50| [NativeDisplayManager_FoldDisplayMode](#nativedisplaymanager_folddisplaymode) | NativeDisplayManager_FoldDisplayMode | 可折叠设备的显示模式枚举。 | 51| [NativeDisplayManager_DisplayState](#nativedisplaymanager_displaystate) | NativeDisplayManager_DisplayState | 显示设备的状态枚举。 | 52| [NativeDisplayManager_SourceMode](#nativedisplaymanager_sourcemode) | NativeDisplayManager_SourceMode | 设备的显示模式枚举。 | 53 54## 宏定义说明 55 56### OH_DISPLAY_NAME_LENGTH 57 58``` 59#define OH_DISPLAY_NAME_LENGTH 32 60``` 61 62**描述** 63 64屏幕名称的最大长度。 65 66**起始版本：** 14 67 68## 枚举类型说明 69 70### NativeDisplayManager_Rotation 71 72``` 73enum NativeDisplayManager_Rotation 74``` 75 76**描述** 77 78屏幕顺时针的旋转角度。 79 80**起始版本：** 12 81 82| 枚举项 | 描述 | 83| -- | -- | 84| DISPLAY_MANAGER_ROTATION_0 = 0 | 代表屏幕顺时针旋转角度0度。 | 85| DISPLAY_MANAGER_ROTATION_90 = 1 | 代表屏幕顺时针旋转角度90度。 | 86| DISPLAY_MANAGER_ROTATION_180 = 2 | 代表屏幕顺时针旋转角度180度。 | 87| DISPLAY_MANAGER_ROTATION_270 = 3 | 代表屏幕顺时针旋转角度270度。 | 88 89### NativeDisplayManager_Orientation 90 91``` 92enum NativeDisplayManager_Orientation 93``` 94 95**描述** 96 97屏幕的旋转方向。 98 99**起始版本：** 12 100 101| 枚举项 | 描述 | 102| -- | -- | 103| DISPLAY_MANAGER_PORTRAIT = 0 | 表示设备当前以竖屏方式显示。 | 104| DISPLAY_MANAGER_LANDSCAPE = 1 | 表示设备当前以横屏方式显示。 | 105| DISPLAY_MANAGER_PORTRAIT_INVERTED = 2 | 表示设备当前以反向竖屏方式显示。 | 106| DISPLAY_MANAGER_LANDSCAPE_INVERTED = 3 | 表示设备当前以反向横屏方式显示。 | 107| DISPLAY_MANAGER_UNKNOWN | 表示显示未识别屏幕方向。 | 108 109### NativeDisplayManager_ErrorCode 110 111``` 112enum NativeDisplayManager_ErrorCode 113``` 114 115**描述** 116 117屏幕管理接口返回状态码枚举。 118 119**起始版本：** 12 120 121| 枚举项 | 描述 | 122| -- | -- | 123| DISPLAY_MANAGER_OK = 0 | 成功。 | 124| DISPLAY_MANAGER_ERROR_NO_PERMISSION = 201 | 权限校验失败，应用无权限使用该API，需要申请权限。 | 125| DISPLAY_MANAGER_ERROR_NOT_SYSTEM_APP = 202 | 权限校验失败，非系统应用使用了系统API。 | 126| DISPLAY_MANAGER_ERROR_INVALID_PARAM = 401 | 参数检查失败。 | 127| DISPLAY_MANAGER_ERROR_DEVICE_NOT_SUPPORTED = 801 | 该设备不支持此API。 | 128| DISPLAY_MANAGER_ERROR_INVALID_SCREEN = 1400001 | 操作的显示设备无效。 | 129| DISPLAY_MANAGER_ERROR_INVALID_CALL = 1400002 | 当前操作对象无操作权限。 | 130| DISPLAY_MANAGER_ERROR_SYSTEM_ABNORMAL = 1400003 | 系统服务工作异常。 | 131| DISPLAY_MANAGER_ERROR_ILLEGAL_PARAM = 1400004 | 非法参数。<br>**起始版本：** 20 | 132 133### NativeDisplayManager_FoldDisplayMode 134 135``` 136enum NativeDisplayManager_FoldDisplayMode 137``` 138 139**描述** 140 141可折叠设备的显示模式枚举。 142 143**起始版本：** 12 144 145| 枚举项 | 描述 | 146| -- | -- | 147| DISPLAY_MANAGER_FOLD_DISPLAY_MODE_UNKNOWN = 0 | 表示设备当前折叠显示模式未知。 | 148| DISPLAY_MANAGER_FOLD_DISPLAY_MODE_FULL = 1 | 表示设备当前全屏显示。 | 149| DISPLAY_MANAGER_FOLD_DISPLAY_MODE_MAIN = 2 | 表示设备当前主屏幕显示。 | 150| DISPLAY_MANAGER_FOLD_DISPLAY_MODE_SUB = 3 | 表示设备当前子屏幕显示。 | 151| DISPLAY_MANAGER_FOLD_DISPLAY_MODE_COORDINATION = 4 | 表示设备当前双屏协同显示。 | 152 153### NativeDisplayManager_DisplayState 154 155``` 156enum NativeDisplayManager_DisplayState 157``` 158 159**描述** 160 161显示设备的状态枚举。 162 163**起始版本：** 14 164 165| 枚举项 | 描述 | 166| -- | -- | 167| DISPLAY_MANAGER_DISPLAY_STATE_UNKNOWN = 0 | 表示显示设备状态未知。 | 168| DISPLAY_MANAGER_DISPLAY_STATE_OFF = 1 | 表示显示设备状态为关闭。 | 169| DISPLAY_MANAGER_DISPLAY_STATE_ON = 2 | 表示显示设备状态为开启。 | 170| DISPLAY_MANAGER_DISPLAY_STATE_DOZE = 3 | 表示显示设备为低电耗模式。 | 171| DISPLAY_MANAGER_DISPLAY_STATE_DOZE_SUSPEND = 4 | 表示显示设备为睡眠模式，CPU为挂起状态。 | 172| DISPLAY_MANAGER_DISPLAY_STATE_VR = 5 | 表示显示设备为VR模式。 | 173| DISPLAY_MANAGER_DISPLAY_STATE_ON_SUSPEND = 6 | 表示显示设备为开启状态，CPU为挂起状态。 | 174 175### NativeDisplayManager_SourceMode 176 177``` 178enum NativeDisplayManager_SourceMode 179``` 180 181**描述** 182 183设备的显示模式枚举。 184 185**起始版本：** 20 186 187| 枚举项 | 描述 | 188| -- | -- | 189| DISPLAY_SOURCE_MODE_NONE = 0 | 表示设备当前未使用。 | 190| DISPLAY_SOURCE_MODE_MAIN = 1 | 表示设备当前为主屏。 | 191| DISPLAY_SOURCE_MODE_MIRROR = 2 | 表示设备当前为镜像显示模式。 | 192| DISPLAY_SOURCE_MODE_EXTEND = 3 | 表示设备当前为扩展显示模式。 | 193| DISPLAY_SOURCE_MODE_ALONE = 4 | 表示设备当前为异源显示模式。 | 194 195