• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# image_pixel_map_napi.h
2
3
4## Overview
5
6Declares the APIs that can lock, access, and unlock pixel map data.
7
8**Since:**
98
10
11**Related Modules:**
12
13[Image](image.md)
14
15
16## Summary
17
18
19### Structs
20
21| Name | Description |
22| -------- | -------- |
23| [OhosPixelMapInfo](_ohos_pixel_map_info.md) | Defines the pixel map information.  |
24
25
26### Enums
27
28| Name | Description |
29| -------- | -------- |
30| { OHOS_IMAGE_RESULT_SUCCESS = 0, OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 } | Enumerates the error codes returned by a function.  |
31| { OHOS_PIXEL_MAP_FORMAT_NONE = 0, OHOS_PIXEL_MAP_FORMAT_RGBA_8888 = 3, OHOS_PIXEL_MAP_FORMAT_RGB_565 = 2 } | Enumerates the pixel formats.  |
32
33
34### Functions
35
36| Name | Description |
37| -------- | -------- |
38| [OH_GetImageInfo](image.md#oh_getimageinfo) (napi_env env, napi_value value, [OhosPixelMapInfo](_ohos_pixel_map_info.md) \*info) | Obtains the **PixelMap** information and stores the information to the [OhosPixelMapInfo](_ohos_pixel_map_info.md) structure.  |
39| [OH_AccessPixels](image.md#oh_accesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | Obtains the memory address of the **PixelMap** object data and locks the memory.  |
40| [OH_UnAccessPixels](image.md#oh_unaccesspixels) (napi_env env, napi_value value) | Unlocks the memory of the **PixelMap** object data. This function is used with [OH_AccessPixels](image.md#oh_accesspixels) in pairs.  |
41
42