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

Related module: Image

Summary

Structs

Name	Description
struct OhosPixelMapInfo	Describes the information about a PixelMap.

Enums

Name	Description
{ OHOS_IMAGE_RESULT_SUCCESS = 0, OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 }	Enumerates the error codes returned by the functions.
{ OHOS_PIXEL_MAP_FORMAT_NONE = 0, OHOS_PIXEL_MAP_FORMAT_RGBA_8888 = 3, OHOS_PIXEL_MAP_FORMAT_RGB_565 = 2 }	Enumerates the PixelMap formats.
{ OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE = 0, OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP = 1 }	Enumerates the PixelMap scale modes.

Functions

Name	Description
int32_t OH_GetImageInfo (napi_env env, napi_value value, OhosPixelMapInfo *info)	Obtains the information about a PixelMap object and stores the information to the OhosPixelMapInfo struct.
int32_t 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 (napi_env env, napi_value value)	Unlocks the memory of a PixelMap object. This function is used with OH_AccessPixels in pairs.