# image_pixel_map_napi.h


## Overview

The **image_pixel_map_napi.h** file declares the APIs used to lock, access, and unlock a PixelMap.

**Library**: libpixelmap_ndk.z.so

**File to include**: <multimedia/image_framework/image_pixel_map_napi.h>

**Since**: 8

**Deprecated from**: 10

**Substitute**: [image_pixel_map_mdk.h](image__pixel__map__mdk_8h.md)

**Related module**: [Image](image.md)


## Summary


### Structs

| Name| Description| 
| -------- | -------- |
| struct  [OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) | Describes the information about a PixelMap. | 


### Enums

| Name| Description| 
| -------- | -------- |
| { [OHOS_IMAGE_RESULT_SUCCESS](image.md#error-codes-returned-by-functions) = 0,<br>[OHOS_IMAGE_RESULT_BAD_PARAMETER](image.md#error-codes-returned-by-functions) = -1 } | Enumerates the error codes returned by the functions.| 
| { [OHOS_PIXEL_MAP_FORMAT_NONE](image.md#pixel-formats) = 0,<br>[OHOS_PIXEL_MAP_FORMAT_RGBA_8888](image.md#pixel-formats) = 3,<br>[OHOS_PIXEL_MAP_FORMAT_RGB_565](image.md#pixel-formats) = 2 } | Enumerates the PixelMap formats.| 
| { [OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE](image.md#anonymous-enum) = 0,<br>[OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP](image.md#anonymous-enum) = 1 } | Enumerates the PixelMap scale modes.| 


### Functions

| Name| Description| 
| -------- | -------- |
| int32_t [OH_GetImageInfo](image.md#oh_getimageinfo) (napi_env env, napi_value value, [OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) \*info) | Obtains the information about a **PixelMap** object and stores the information to the [OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) struct. | 
| int32_t [OH_AccessPixels](image.md#oh_accesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | Obtains the memory address of a **PixelMap** object and locks the memory. | 
| int32_t [OH_UnAccessPixels](image.md#oh_unaccesspixels) (napi_env env, napi_value value) | Unlocks the memory of a **PixelMap** object. This function is used with **OH_AccessPixels** in pairs. |