未验证 提交 fa69ec95 编写于 作者: O openharmony_ci 提交者: Gitee

回退 'Pull Request !21765 : 回退 'Pull Request !21597 : add native api''

上级 1bb848e3
......@@ -45,7 +45,12 @@
- [drawing_text_typography.h](drawing__text__typography_8h.md)
- [drawing_types.h](drawing__types_8h.md)
- [external_window.h](external__window_8h.md)
- [image_mdk.h](image__mdk_8h.md)
- [image_mdk_common.h](image__mdk__common_8h.md)
- [image_pixel_map_mdk.h](image__pixel__map__mdk_8h.md)
- [image_pixel_map_napi.h](image__pixel__map__napi_8h.md)
- [image_receiver_mdk.h](image__receiver__mdk_8h.md)
- [image_source_mdk.h](image__source__mdk_8h.md)
- [log.h](log_8h.md)
- [native_buffer.h](native__buffer_8h.md)
- [native_image.h](native__image_8h.md)
......@@ -109,8 +114,23 @@
- [OH_NativeXComponent_TouchPoint](_o_h___native_x_component___touch_point.md)
- [OHExtDataHandle](_o_h_ext_data_handle.md)
- [OHHDRMetaData](_o_h_h_d_r_meta_data.md)
- [OHOS::Media::OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md)
- [OHOS::Media::OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md)
- [OHOS::Media::OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md)
- [OhosImageDecodingOps](_ohos_image_decoding_ops.md)
- [OhosImageReceiverInfo](_ohos_image_receiver_info.md)
- [OhosImageRegion](_ohos_image_region.md)
- [OhosImageSize](_ohos_image_size.md)
- [OhosImageSource](_ohos_image_source.md)
- [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md)
- [OhosImageSourceInfo](_ohos_image_source_info.md)
- [OhosImageSourceOps](_ohos_image_source_ops.md)
- [OhosImageSourceProperty](_ohos_image_source_property.md)
- [OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md)
- [OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md)
- [OhosImageSourceUpdateData](_ohos_image_source_update_data.md)
- [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md)
- [OhosPixelMapInfo](_ohos_pixel_map_info.md)
- [OhosPixelMapInfos](_ohos_pixel_map_infos.md)
- [RawFileDescriptor](_raw_file_descriptor.md)
- [Region](_region.md)
- [Rect](_rect.md)
......
# OHOS::Media::OhosImageComponent
## 概述
定义图像组成信息。
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [byteBuffer](#bytebuffer) | 像素数据地址 |
| [size](#size) | 内存中的像素数据大小 |
| [componentType](#componenttype) | 像素数据类型 |
| [rowStride](#rowstride) | 像素数据行宽 |
| [pixelStride](#pixelstride) | 像素数据的像素大小 |
## 结构体成员变量说明
### byteBuffer
```
uint8_t* OHOS::Media::OhosImageComponent::byteBuffer
```
**描述:**
像素数据地址
### componentType
```
int32_t OHOS::Media::OhosImageComponent::componentType
```
**描述:**
像素数据类型
### pixelStride
```
int32_t OHOS::Media::OhosImageComponent::pixelStride
```
**描述:**
像素数据的像素大小
### rowStride
```
int32_t OHOS::Media::OhosImageComponent::rowStride
```
**描述:**
像素数据行宽
### size
```
size_t OHOS::Media::OhosImageComponent::size
```
**描述:**
内存中的像素数据大小
# OHOS::Media::OhosImageRect
## 概述
定义图像矩形信息。
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [x](#x) | 矩形x坐标值 |
| [y](#y) | 矩形y坐标值 |
| [width](#width) | 矩形宽度值,用pixels表示 |
| [height](#height) | 矩形高度值,用pixels表示 |
## 结构体成员变量说明
### height
```
int32_t OHOS::Media::OhosImageRect::height
```
**描述:**
矩形高度值,用pixels表示
### width
```
int32_t OHOS::Media::OhosImageRect::width
```
**描述:**
矩形宽度值,用pixels表示
### x
```
int32_t OHOS::Media::OhosImageRect::x
```
**描述:**
矩形x坐标值
### y
```
int32_t OHOS::Media::OhosImageRect::y
```
**描述:**
矩形y坐标值
# OHOS::Media::OhosPixelMapInfo
## 概述
用于定义 pixel map 的相关信息。
**起始版本:**
8
**废弃起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [width](#width) | 图片的宽,用pixels表示 |
| [height](#height) | 图片的高,用pixels表示 |
| [rowSize](#rowsize) | 每行的bytes数 |
| [pixelFormat](#pixelformat) | Pixel 的格式 |
## 结构体成员变量说明
### height
```
uint32_t OHOS::Media::OhosPixelMapInfo::height
```
**描述:**
图片的高, 用pixels表示
### pixelFormat
```
int32_t OHOS::Media::OhosPixelMapInfo::pixelFormat
```
**描述:**
Pixel 的格式
### rowSize
```
uint32_t OHOS::Media::OhosPixelMapInfo::rowSize
```
**描述:**
每行的bytes数
### width
```
uint32_t OHOS::Media::OhosPixelMapInfo::width
```
**描述:**
图片的宽, 用pixels表示
# OhosImageDecodingOps
## 概述
定义图像源解码选项。 此选项给[OH_ImageSource_CreatePixelMap](image.md#oh_imagesource_createpixelmap)[OH_ImageSource_CreatePixelMapList](image.md#oh_imagesource_createpixelmaplist)这两个接口使用。
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [editable](image.md#editable) | 定义输出的像素位图是否可编辑 |
| [pixelFormat](image.md#pixelformat-23) | 定义输出的像素格式 |
| [fitDensity](image.md#fitdensity) | 定义解码目标的像素密度 |
| [index](image.md#index) | 定义图像源解码指数 |
| [sampleSize](image.md#samplesize) | 定义解码样本大小选项 |
| [rotate](image.md#rotate) | 定义解码旋转选项 |
| [size](image.md#size-27) | 定义解码目标像素宽高的大小 |
| [region](image.md#region) | 定义图像源解码的像素范围 |
# OhosImageReceiverInfo
## 概述
定义**ImageReceiver**的相关信息。
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| width | 消费端接收图片时的默认图像宽度,用pixels表示 |
| height | 消费端接收图片时的默认图像高度,用pixels表示 |
| format | 通过接收器创建图像格式OHOS_IMAGE_FORMAT_JPEG |
| capicity | 图片缓存数量的最大值 |
# OhosImageRegion
## 概述
定义图像源解码的范围选项。 [OhosImageDecodingOps](_ohos_image_decoding_ops.md), [OH_ImageSource_CreatePixelMap](image.md#oh_imagesource_createpixelmap) and [OH_ImageSource_CreatePixelMapList](image.md#oh_imagesource_createpixelmaplist).
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [x](image.md#x) | 起始x坐标,用pixels表示 |
| [y](image.md#y) | 起始y坐标,用pixels表示 |
| [width](image.md#width) | 宽度范围,用pixels表示 |
| [height](image.md#height) | 高度范围,用pixels表示 |
# OhosImageSize
## 概述
定义图像大小。
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [width](#width) | 像素中的图像宽度,用pixels表示 |
| [height](#height) | 像素中的图像高度,用pixels表示 |
## 结构体成员变量说明
### height
```
int32_t OhosImageSize::height
```
**描述:**
像素中的图像高度,用pixels表示
### width
```
int32_t OhosImageSize::width
```
**描述:**
像素中的图像宽度,用pixels表示
# OhosImageSource
## 概述
定义图像源输入资源,每次仅接收一种类型。由[OH_ImageSource_Create](image.md#oh_imagesource_create)获取。
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [uri](image.md#uri) = nullptr | 图像源资源标识符,接受文件资源或者base64资源 |
| [uriSize](image.md#urisize) = 0 | 图像源资源长度 |
| [fd](image.md#fd) = -1 | 图像源文件资源描述符 |
| [buffer](image.md#buffer-12) = nullptr | 图像源缓冲区资源,解手格式化包缓冲区或者base64缓冲区 |
| [bufferSize](image.md#buffersize-12) = 0 | 图像源缓冲区资源大小 |
# OhosImageSourceDelayTimeList
## 概述
定义图像源延迟时间列表。由[OH_ImageSource_GetDelayTime](image.md#oh_imagesource_getdelaytime)获取。
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [delayTimeList](image.md#delaytimelist) | 图像源延迟时间列表头地址 |
| [size](image.md#size-47) = 0 | 图像源延迟时间列表大小 |
# OhosImageSourceInfo
## 概述
定义图像源信息,由[OH_ImageSource_GetImageInfo](image.md#oh_imagesource_getimageinfo)获取。
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [pixelFormat](image.md#pixelformat-33) | 图像源像素格式, 由[OH_ImageSource_Create()](image.md#oh_imagesource_create)设置 |
| [colorSpace](image.md#colorspace) | 图像源色彩空间 |
| [alphaType](image.md#alphatype) | 图像源透明度类型 |
| [density](image.md#density-22) | 图像源密度, 由 [OH_ImageSource_Create()](image.md#oh_imagesource_create)设置 |
| [size](image.md#size-37) | 图像源像素宽高的大小 |
# OhosImageSourceOps
## 概述
定义图像源选项信息。 此选项给[OH_ImageSource_Create](image.md#oh_imagesource_create)[OH_ImageSource_CreateIncremental](image.md#oh_imagesource_createincremental)这两个接口使用。
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [density](image.md#density-12) | 图像源像素密度 |
| [pixelFormat](image.md#pixelformat-13) | 图像源像素格式,通常用于描述YUV缓冲区 |
| [size](image.md#size-17) | 图像源像素宽高的大小 |
# OhosImageSourceProperty
## 概述
定义图像源属性键值字符串。 此选项给[OH_ImageSource_GetImageProperty](image.md#oh_imagesource_getimageproperty) and [OH_ImageSource_ModifyImageProperty](image.md#oh_imagesource_modifyimageproperty)这两个接口使用。
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [value](image.md#value) = nullptr | 定义图像源属性键值字符串头地址 |
| [size](image.md#size-77) = 0 | 定义图像源属性键值字符串大小 |
# OhosImageSourceSupportedFormat
## 概述
定义图像源支持的格式字符串。 此选项给[OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md)[OH_ImageSource_GetSupportedFormats](image.md#oh_imagesource_getsupportedformats)这两个接口使用。
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [format](image.md#format) = nullptr | 图像源支持的格式字符串头地址 |
| [size](image.md#size-57) = 0 | 图像源支持的格式字符串大小 |
# OhosImageSourceSupportedFormatList
## 概述
定义图像源支持的格式字符串列表。 由[OH_ImageSource_GetSupportedFormats](image.md#oh_imagesource_getsupportedformats)获取
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [supportedFormatList](image.md#supportedformatlist) = nullptr | 图像源支持的格式字符串列表头地址 |
| [size](image.md#size-67) = 0 | 图像源支持的格式字符串列表大小 |
# OhosImageSourceUpdateData
## 概述
定义图像源更新数据选项,由[OH_ImageSource_UpdateData](image.md#oh_imagesource_updatedata)获取。
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [buffer](image.md#buffer-22) = nullptr | 图像源更新数据缓冲区 |
| [bufferSize](image.md#buffersize-22) = 0 | 图像源更新数据缓冲区大小 |
| [offset](image.md#offset) = 0 | 图像源更新数据缓冲区的开端 |
| [updateLength](image.md#updatelength) = 0 | 图像源更新数据缓冲区的更新数据长度 |
| [isCompleted](image.md#iscompleted) = 0 | 图像源更新数据在此节中完成 |
......@@ -3,12 +3,13 @@
## 概述
用于定义创建 pixel map 设置选项的相关信息.
用于定义创建 pixel map 设置选项的相关信息
**起始版本:**
10
**相关模块:**
**相关模块**
[Image](image.md)
......@@ -20,12 +21,12 @@
| 名称 | 描述 |
| -------- | -------- |
| [width](#width) | 图片的宽,用pixels表示。 |
| [height](#height) | 图片的高,用pixels表示。 |
| [pixelFormat](#pixelformat) | 图片的格式 |
| [editable](#editable) | 图片的编辑类型 |
| [alphaType](#alphatype) | 图片的alpha类型 |
| [scaleMode](#scalemode) | 图片的缩放类型 |
| [width](#width) | 图片的宽, 用pixels表示 |
| [height](#height) | 图片的高, 用pixels表示 |
| [pixelFormat](#pixelformat) | 图片的格式 |
| [editable](#editable) | 图片的编辑类型 |
| [alphaType](#alphatype) | 图片的alpha类型 |
| [scaleMode](#scalemode) | 图片的缩放类型 |
## 结构体成员变量说明
......@@ -33,59 +34,65 @@
### alphaType
```
uint32_t OhosPixelMapCreateOps::alphaType
```
**描述:**
图片的alpha类型。
**描述:**
图片的alpha类型
### editable
```
uint32_t OhosPixelMapCreateOps::editable
```
**描述:**
图片的编辑类型。
**描述:**
图片的编辑类型
### height
```
uint32_t OhosPixelMapCreateOps::height
```
**描述:**
图片的高,用pixels表示。
**描述:**
图片的高, 用pixels表示
### pixelFormat
```
int32_t OhosPixelMapCreateOps::pixelFormat
```
**描述:**
图片的格式。
**描述:**
图片的格式
### scaleMode
```
uint32_t OhosPixelMapCreateOps::scaleMode
```
**描述:**
图片的缩放类型。
**描述:**
图片的缩放类型
### width
```
uint32_t OhosPixelMapCreateOps::width
```
**描述:**
图片的宽,用pixels表示。
**描述:**
图片的宽, 用pixels表示
# OhosPixelMapInfo
# OhosPixelMapInfos
## 概述
......@@ -7,7 +7,7 @@
**起始版本:**
8
10
**相关模块:**
......@@ -19,12 +19,12 @@
### 成员变量
| 成员变量名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| [width](#width) | 图片的宽,用pixels表示。 |
| [height](#height) | 图片的高,用pixels表示。 |
| [rowSize](#rowsize) | 每行的bytes数 |
| [pixelFormat](#pixelformat) | Pixel的格式。 |
| [width](#width) | 图片的宽, 用pixels表示 |
| [height](#height) | 图片的高, 用pixels表示 |
| [rowSize](#rowsize) | 每行的bytes数 |
| [pixelFormat](#pixelformat) | Pixel 的格式 |
## 结构体成员变量说明
......@@ -32,47 +32,43 @@
### height
```
uint32_t OhosPixelMapInfo::height
uint32_t OhosPixelMapInfos::height
```
**描述:**
图片的高,用pixels表示。
图片的高, 用pixels表示
### pixelFormat
```
int32_t OhosPixelMapInfo::pixelFormat
int32_t OhosPixelMapInfos::pixelFormat
```
**描述:**
Pixel的格式。
Pixel 的格式
### rowSize
```
uint32_t OhosPixelMapInfo::rowSize
uint32_t OhosPixelMapInfos::rowSize
```
**描述:**
每行的bytes数
每行的bytes数
### width
```
uint32_t OhosPixelMapInfo::width
uint32_t OhosPixelMapInfos::width
```
**描述:**
图片的宽,用pixels表示。
图片的宽, 用pixels表示
# image_mdk.h
## 概述
声明访问图像剪辑矩形、大小、格式和组件数据的函数。
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OHOS::Media::OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) | 定义图像矩形信息。 |
| [OHOS::Media::OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md) | 定义图像组成信息。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [OHOS::Media::ImageNative](image.md#imagenative) | 为图像接口定义native层图像对象。 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| { [OHOS::Media::OHOS_IMAGE_FORMAT_YCBCR_422_SP](image.md) = 1000,<br/>[OHOS::Media::OHOS_IMAGE_FORMAT_JPEG](image.md) = 2000, } | 图像格式枚举值。 |
| { [OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_YUV_Y](image.md) = 1,<br/>[OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_YUV_U](image.md) = 2,<br/>[OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_YUV_V](image.md) = 3,<br/>[OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_JPEG](image.md) = 4, } | 图像组成类型枚举值。 |
### 函数
| 名称 | 描述 |
| -------- | -------- |
| [OHOS::Media::OH_Image_InitImageNative](image.md#oh_image_initimagenative) (napi_env env, napi_value source) | 从输入的JavaScript Native API **图像** 对象中解析 native **ImageNative** 对象。 |
| [OHOS::Media::OH_Image_ClipRect](image.md#oh_image_cliprect) (const [ImageNative](image.md#imagenative) \*native, struct [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) \*rect) | 获取native **ImageNative** 对象 [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) 信息。 |
| [OHOS::Media::OH_Image_Size](image.md#oh_image_size) (const [ImageNative](image.md#imagenative) \*native, struct [OhosImageSize](_ohos_image_size.md) \*size) | 获取native **ImageNative** 对象的 [OhosImageSize](_ohos_image_size.md) 信息。 |
| [OHOS::Media::OH_Image_Format](image.md#oh_image_format) (const [ImageNative](image.md#imagenative) \*native, int32_t \*format) | 获取native **ImageNative** 对象的图像格式。 |
| [OHOS::Media::OH_Image_GetComponent](image.md#oh_image_getcomponent) (const [ImageNative](image.md#imagenative) \*native, int32_t componentType, struct [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md) \*componentNative) | 从 native **ImageNative** 对象中获取 [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md)。 |
| [OHOS::Media::OH_Image_Release](image.md#oh_image_release) ([ImageNative](image.md#imagenative) \*native) | 释放 **ImageNative** native对象。 |
# image_mdk_common.h
## 概述
声明图像常用的枚举值和结构体。
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OhosImageSize](_ohos_image_size.md) | 定义图像大小。 |
### 宏定义
| 名称 | 描述 |
| -------- | -------- |
| **IMAGE_RESULT_BASE** 62980096 | 接口返回值的基础值 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| [IRNdkErrCode](image.md#irndkerrcode) {<br/>IMAGE_RESULT_SUCCESS = 0,<br/>IMAGE_RESULT_BAD_PARAMETER = -1,<br/>IMAGE_RESULT_IMAGE_RESULT_BASE = IMAGE_RESULT_BASE,<br/>IMAGE_RESULT_ERR_IPC = IMAGE_RESULT_BASE + 1,<br/>IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST = IMAGE_RESULT_BASE + 2,<br/>IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL = IMAGE_RESULT_BASE + 3,<br/>IMAGE_RESULT_DECODE_ABNORMAL = IMAGE_RESULT_BASE + 4,<br/>IMAGE_RESULT_DATA_ABNORMAL = IMAGE_RESULT_BASE + 5,<br/>IMAGE_RESULT_MALLOC_ABNORMAL = IMAGE_RESULT_BASE + 6,<br/>IMAGE_RESULT_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 7,<br/>IMAGE_RESULT_INIT_ABNORMAL = IMAGE_RESULT_BASE + 8,<br/>IMAGE_RESULT_GET_DATA_ABNORMAL = IMAGE_RESULT_BASE + 9,<br/>IMAGE_RESULT_TOO_LARGE = IMAGE_RESULT_BASE + 10,<br/>IMAGE_RESULT_TRANSFORM = IMAGE_RESULT_BASE + 11,<br/>IMAGE_RESULT_COLOR_CONVERT = IMAGE_RESULT_BASE + 12,<br/>IMAGE_RESULT_CROP = IMAGE_RESULT_BASE + 13,<br/>IMAGE_RESULT_SOURCE_DATA = IMAGE_RESULT_BASE + 14,<br/>IMAGE_RESULT_SOURCE_DATA_INCOMPLETE = IMAGE_RESULT_BASE + 15,<br/>IMAGE_RESULT_MISMATCHED_FORMAT = IMAGE_RESULT_BASE + 16,<br/>IMAGE_RESULT_UNKNOWN_FORMAT = IMAGE_RESULT_BASE + 17,<br/>IMAGE_RESULT_SOURCE_UNRESOLVED = IMAGE_RESULT_BASE + 18,<br/>IMAGE_RESULT_INVALID_PARAMETER = IMAGE_RESULT_BASE + 19,<br/>IMAGE_RESULT_DECODE_FAILED = IMAGE_RESULT_BASE + 20,<br/>IMAGE_RESULT_PLUGIN_REGISTER_FAILED = IMAGE_RESULT_BASE + 21,<br/>IMAGE_RESULT_PLUGIN_CREATE_FAILED = IMAGE_RESULT_BASE + 22,<br/>IMAGE_RESULT_ENCODE_FAILED = IMAGE_RESULT_BASE + 23,<br/>IMAGE_RESULT_ADD_PIXEL_MAP_FAILED = IMAGE_RESULT_BASE + 24,<br/>IMAGE_RESULT_HW_DECODE_UNSUPPORT = IMAGE_RESULT_BASE + 25,<br/>IMAGE_RESULT_DECODE_HEAD_ABNORMAL = IMAGE_RESULT_BASE + 26,<br/>IMAGE_RESULT_DECODE_EXIF_UNSUPPORT = IMAGE_RESULT_BASE + 27,<br/>IMAGE_RESULT_PROPERTY_NOT_EXIST = IMAGE_RESULT_BASE + 28,<br/>IMAGE_RESULT_MEDIA_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 30,<br/>IMAGE_RESULT_MEDIA_TOO_LARGE = IMAGE_RESULT_BASE + 31,<br/>IMAGE_RESULT_MEDIA_MALLOC_FAILED = IMAGE_RESULT_BASE + 32,<br/>IMAGE_RESULT_MEDIA_END_OF_STREAM = IMAGE_RESULT_BASE + 33,<br/>IMAGE_RESULT_MEDIA_IO_ABNORMAL = IMAGE_RESULT_BASE + 34,<br/>IMAGE_RESULT_MEDIA_MALFORMED = IMAGE_RESULT_BASE + 35,<br/>IMAGE_RESULT_MEDIA_BUFFER_TOO_SMALL = IMAGE_RESULT_BASE + 36,<br/>IMAGE_RESULT_MEDIA_OUT_OF_RANGE = IMAGE_RESULT_BASE + 37,<br/>IMAGE_RESULT_MEDIA_STATUS_ABNORMAL = IMAGE_RESULT_BASE + 38,<br/>IMAGE_RESULT_MEDIA_VALUE_INVALID = IMAGE_RESULT_BASE + 39,<br/>IMAGE_RESULT_MEDIA_NULL_POINTER = IMAGE_RESULT_BASE + 40,<br/>IMAGE_RESULT_MEDIA_INVALID_OPERATION = IMAGE_RESULT_BASE + 41,<br/>IMAGE_RESULT_MEDIA_ERR_PLAYER_NOT_INIT = IMAGE_RESULT_BASE + 42,<br/>IMAGE_RESULT_MEDIA_EARLY_PREPARE = IMAGE_RESULT_BASE + 43,<br/>IMAGE_RESULT_MEDIA_SEEK_ERR = IMAGE_RESULT_BASE + 44,<br/>IMAGE_RESULT_MEDIA_PERMISSION_DENIED = IMAGE_RESULT_BASE + 45,<br/>IMAGE_RESULT_MEDIA_DEAD_OBJECT = IMAGE_RESULT_BASE + 46,<br/>IMAGE_RESULT_MEDIA_TIMED_OUT = IMAGE_RESULT_BASE + 47,<br/>IMAGE_RESULT_MEDIA_TRACK_NOT_ALL_SUPPORTED = IMAGE_RESULT_BASE + 48,<br/>IMAGE_RESULT_MEDIA_ADAPTER_INIT_FAILED = IMAGE_RESULT_BASE + 49,<br/>IMAGE_RESULT_MEDIA_WRITE_PARCEL_FAIL = IMAGE_RESULT_BASE + 50,<br/>IMAGE_RESULT_MEDIA_READ_PARCEL_FAIL = IMAGE_RESULT_BASE + 51,<br/>IMAGE_RESULT_MEDIA_NO_AVAIL_BUFFER = IMAGE_RESULT_BASE + 52,<br/>IMAGE_RESULT_MEDIA_INVALID_PARAM = IMAGE_RESULT_BASE + 53, IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 54,<br/>IMAGE_RESULT_MEDIA_CREATE_CODEC_ADAPTER_FAILED = IMAGE_RESULT_BASE + 55,<br/>IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 56,<br/>IMAGE_RESULT_MEDIA_ZCODEC_CREATE_FAILED = IMAGE_RESULT_BASE + 57,<br/>IMAGE_RESULT_MEDIA_ZCODEC_NOT_EXIST = IMAGE_RESULT_BASE + 58,<br/>IMAGE_RESULT_MEDIA_JNI_CLASS_NOT_EXIST = IMAGE_RESULT_BASE + 59,<br/>IMAGE_RESULT_MEDIA_JNI_METHOD_NOT_EXIST = IMAGE_RESULT_BASE + 60,<br/>IMAGE_RESULT_MEDIA_JNI_NEW_OBJ_FAILED = IMAGE_RESULT_BASE + 61,<br/>IMAGE_RESULT_MEDIA_JNI_COMMON_ERROR = IMAGE_RESULT_BASE + 62,<br/>IMAGE_RESULT_MEDIA_DISTRIBUTE_NOT_SUPPORT = IMAGE_RESULT_BASE + 63,<br/>IMAGE_RESULT_MEDIA_SOURCE_NOT_SET = IMAGE_RESULT_BASE + 64,<br/>IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 65,<br/>IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 66,<br/>IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT = IMAGE_RESULT_BASE + 67,<br/>IMAGE_RESULT_MEDIA_RTSP_CAPTURE_NOT_INIT = IMAGE_RESULT_BASE + 68,<br/>IMAGE_RESULT_MEDIA_RTSP_SOURCE_URL_INVALID = IMAGE_RESULT_BASE + 69,<br/>IMAGE_RESULT_MEDIA_RTSP_VIDEO_TRACK_NOT_FOUND = IMAGE_RESULT_BASE + 70,<br/>IMAGE_RESULT_MEDIA_RTSP_CAMERA_NUM_REACH_MAX = IMAGE_RESULT_BASE + 71,<br/>IMAGE_RESULT_MEDIA_SET_VOLUME = IMAGE_RESULT_BASE + 72,<br/>IMAGE_RESULT_MEDIA_NUMBER_OVERFLOW = IMAGE_RESULT_BASE + 73,<br/>IMAGE_RESULT_MEDIA_DIS_PLAYER_UNSUPPORTED = IMAGE_RESULT_BASE + 74,<br/>IMAGE_RESULT_MEDIA_DENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 75,<br/>IMAGE_RESULT_MEDIA_ENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 76,<br/>IMAGE_RESULT_MEDIA_READ_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 150,<br/>IMAGE_RESULT_MEDIA_WRITE_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 151,<br/>IMAGE_RESULT_MEDIA_PIXELMAP_NOT_ALLOW_MODIFY = IMAGE_RESULT_BASE + 152,<br/>IMAGE_RESULT_MEDIA_CONFIG_FAILED = IMAGE_RESULT_BASE + 153,<br/>IMAGE_RESULT_JNI_ENV_ABNORMAL = IMAGE_RESULT_BASE + 154,<br/>IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED = IMAGE_RESULT_BASE + 155,<br/>IMAGE_RESULT_CREATE_SURFACE_FAILED = IMAGE_RESULT_BASE + 156,<br/>IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED = IMAGE_RESULT_BASE + 157,<br/>IMAGE_RESULT_GET_SURFACE_FAILED = IMAGE_RESULT_BASE + 158,<br/>IMAGE_RESULT_SURFACE_ACQUIRE_BUFFER_FAILED = IMAGE_RESULT_BASE + 159,<br/>IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED = IMAGE_RESULT_BASE + 160,<br/>IMAGE_RESULT_REGISTER_LISTENER_FAILED = IMAGE_RESULT_BASE + 161,<br/>IMAGE_RESULT_REGISTER_BUFFER_FAILED = IMAGE_RESULT_BASE + 162,<br/>IMAGE_RESULT_FREAD_FAILED = IMAGE_RESULT_BASE + 163,<br/>IMAGE_RESULT_PEEK_FAILED = IMAGE_RESULT_BASE + 164,<br/>IMAGE_RESULT_SEEK_FAILED = IMAGE_RESULT_BASE + 165,<br/>IMAGE_RESULT_STREAM_SIZE_ERROR = IMAGE_RESULT_BASE + 166,<br/>IMAGE_RESULT_FILE_FD_ERROR = IMAGE_RESULT_BASE + 167,<br/>IMAGE_RESULT_FILE_DAMAGED = IMAGE_RESULT_BASE + 168,<br/>IMAGE_RESULT_CREATE_DECODER_FAILED = IMAGE_RESULT_BASE + 169,<br/>IMAGE_RESULT_CREATE_ENCODER_FAILED = IMAGE_RESULT_BASE + 170,<br/>IMAGE_RESULT_CHECK_FORMAT_ERROR = IMAGE_RESULT_BASE + 171,<br/>IMAGE_RESULT_THIRDPART_SKIA_ERROR = IMAGE_RESULT_BASE + 172,<br/>IMAGE_RESULT_HW_DECODE_FAILED = IMAGE_RESULT_BASE + 173,<br/>IMAGE_RESULT_ALLOCATER_TYPE_ERROR = IMAGE_RESULT_BASE + 174,<br/>IMAGE_RESULT_ALPHA_TYPE_ERROR = IMAGE_RESULT_BASE + 175,<br/>IMAGE_RESULT_INDEX_INVALID = IMAGE_RESULT_BASE + 176,<br/>IMAGE_RESULT_MEDIA_UNKNOWN = IMAGE_RESULT_BASE + 200<br/>} | 可能出现的返回值的枚举。 |
# image_pixel_map_mdk.h
## 概述
声明可以锁定并访问pixelmap数据的方法,声明解锁的方法。 Need link **libpixelmapndk.z.so**
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OhosPixelMapInfos](_ohos_pixel_map_infos.md) | 用于定义 pixel map 的相关信息。 |
| [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) | 用于定义创建 pixel map 设置选项的相关信息。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [NativePixelMap](image.md#nativepixelmap) | 定义native层pixelmap数据类型名称。 |
| [OhosPixelMapInfos](image.md#ohospixelmapinfos) | 用于定义 pixel map 的相关信息。 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| { [OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN](image.md) = 0,<br/>[OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE](image.md) = 1,<br/>[OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL](image.md) = 2,<br/>[OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL](image.md) = 3 } | PixelMap 透明度类型的枚举。 |
| { [OHOS_PIXEL_MAP_READ_ONLY](image.md) = 0,<br/>[OHOS_PIXEL_MAP_EDITABLE](image.md) = 1 } | PixelMap 编辑类型的枚举。 |
### 函数
| 名称 | 描述 |
| -------- | -------- |
| [OH_PixelMap_CreatePixelMap](image.md#oh_pixelmap_createpixelmap) (napi_env env, [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) info, void \*buf, size_t len, napi_value \*res) | 创建**PixelMap**对象。 |
| [OH_PixelMap_CreateAlphaPixelMap](image.md#oh_pixelmap_createalphapixelmap) (napi_env env, napi_value source, napi_value \*alpha) | 根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。 |
| [OH_PixelMap_InitNativePixelMap](image.md#oh_pixelmap_initnativepixelmap) (napi_env env, napi_value source) | 初始化**PixelMap**对象数据。 |
| [OH_PixelMap_GetBytesNumberPerRow](image.md#oh_pixelmap_getbytesnumberperrow) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*num) | 获取**PixelMap**对象每行字节数。 |
| [OH_PixelMap_GetIsEditable](image.md#oh_pixelmap_getiseditable) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*editable) | 获取**PixelMap**对象是否可编辑的状态。 |
| [OH_PixelMap_IsSupportAlpha](image.md#oh_pixelmap_issupportalpha) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*alpha) | 获取**PixelMap**对象是否支持Alpha通道。 |
| [OH_PixelMap_SetAlphaAble](image.md#oh_pixelmap_setalphaable) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t alpha) | 设置**PixelMap**对象的Alpha通道。 |
| [OH_PixelMap_GetDensity](image.md#oh_pixelmap_getdensity) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*density) | 获取**PixelMap**对象像素密度。 |
| [OH_PixelMap_SetDensity](image.md#oh_pixelmap_setdensity) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t density) | 设置**PixelMap**对象像素密度。 |
| [OH_PixelMap_SetOpacity](image.md#oh_pixelmap_setopacity) (const [NativePixelMap](image.md#nativepixelmap) \*native, float opacity) | 设置**PixelMap**对象的透明度。 |
| [OH_PixelMap_Scale](image.md#oh_pixelmap_scale) (const [NativePixelMap](image.md#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的缩放。 |
| [OH_PixelMap_Translate](image.md#oh_pixelmap_translate) (const [NativePixelMap](image.md#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的偏移。 |
| [OH_PixelMap_Rotate](image.md#oh_pixelmap_rotate) (const [NativePixelMap](image.md#nativepixelmap) \*native, float angle) | 设置**PixelMap**对象的旋转。 |
| [OH_PixelMap_Flip](image.md#oh_pixelmap_flip) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t x, int32_t y) | 设置**PixelMap**对象的翻转。 |
| [OH_PixelMap_Crop](image.md#oh_pixelmap_crop) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t x, int32_t y, int32_t width, int32_t height) | 设置**PixelMap**对象的裁剪。 |
| [OH_PixelMap_GetImageInfo](image.md#oh_pixelmap_getimageinfo) (const [NativePixelMap](image.md#nativepixelmap) \*native, [OhosPixelMapInfos](_ohos_pixel_map_infos.md) \*info) | 获取**PixelMap**对象图像信息。 |
| [OH_PixelMap_AccessPixels](image.md#oh_pixelmap_accesspixels) (const [NativePixelMap](image.md#nativepixelmap) \*native, void \*\*addr) | 获取native **PixelMap** 对象数据的内存地址,并锁定该内存。 |
| [OH_PixelMap_UnAccessPixels](image.md#oh_pixelmap_unaccesspixels) (const [NativePixelMap](image.md#nativepixelmap) \*native) | 释放native **PixelMap**对象数据的内存锁,用于匹配方法 [OH_PixelMap_AccessPixels](image.md#oh_pixelmap_accesspixels)。 |
......@@ -19,122 +19,24 @@
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OhosPixelMapInfo](_ohos_pixel_map_info.md) | 用于定义 pixel map 的相关信息。 |
| [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) | 用于定义创建 pixel map 设置选项的相关信息。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [NativePixelMap](image.md#nativepixelmap) | 用于定义NativePixelMap数据类型名称。 |
| [OHOS::Media::OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) | 用于定义 pixel map 的相关信息。 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| { OHOS_IMAGE_RESULT_SUCCESS = 0, OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 } | 函数方法返回值的错误码的枚举。 |
| { OHOS_PIXEL_MAP_FORMAT_NONE = 0, OHOS_PIXEL_MAP_FORMAT_RGBA_8888 = 3, OHOS_PIXEL_MAP_FORMAT_RGB_565 = 2 } | pixel 格式的枚举。 |
| { OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN = 0, OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE = 1, OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL = 2, OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL = 3 } | PixelMap alpha 类型的枚举。 |
| { OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE = 0, OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP = 1 } | PixelMap 缩放类型的枚举。 |
| { OHOS_PIXEL_MAP_READ_ONLY = 0, OHOS_PIXEL_MAP_EDITABLE = 1 } | PixelMap 编辑类型的枚举。 |
| { [OHOS::Media::OHOS_IMAGE_RESULT_SUCCESS](image.md) = 0,<br/>[OHOS::Media::OHOS_IMAGE_RESULT_BAD_PARAMETER](image.md) = -1 } | 函数方法返回值的错误码的枚举。 |
| { [OHOS::Media::OHOS_PIXEL_MAP_FORMAT_NONE](image.md) = 0,<br/>[OHOS::Media::OHOS_PIXEL_MAP_FORMAT_RGBA_8888](image.md) = 3,<br/>[OHOS::Media::OHOS_PIXEL_MAP_FORMAT_RGB_565](image.md) = 2 } | pixel 格式的枚举。 |
| { [OHOS::Media::OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE](image.md) = 0,<br/>[OHOS::Media::OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP](image.md) = 1 } | PixelMap 缩放类型的枚举。 |
### 函数
| 名称 | 描述 |
| -------- | -------- |
| [OH_GetImageInfo](image.md#oh_getimageinfo) (napi_env env, napi_value value, [OhosPixelMapInfo](_ohos_pixel_map_info.md) \*info) | 获取 **PixelMap** 的信息,并记录信息到[OhosPixelMapInfo](_ohos_pixel_map_info.md)结构中。 |
| [OH_AccessPixels](image.md#oh_accesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | 获取**PixelMap**对象数据的内存地址,并锁定该内存。 |
| [OH_UnAccessPixels](image.md#oh_unaccesspixels) (napi_env env, napi_value value) | 释放**PixelMap**对象数据的内存锁, 用于匹配方法[OH_AccessPixels](image.md#oh_accesspixels)。 |
| [OH_PixelMap_CreatePixelMap](image.md#oh_pixelmap_createpixelmap) (napi_env env, [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) info, void \*buf, size_t len, napi_value \*res) | 创建**PixelMap**对象。 |
| [OH_PixelMap_CreateAlphaPixelMap](image.md#oh_pixelmap_createalphapixelmap) (napi_env env, napi_value source, napi_value \*alpha) | 根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。 |
| [OH_PixelMap_InitNativePixelMap](image.md#oh_pixelmap_initnativepixelmap) (napi_env env, napi_value source) | 初始化**PixelMap**对象数据。 |
| [OH_PixelMap_GetBytesNumberPerRow](image.md#oh_pixelmap_getbytesnumberperrow) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*num) | 获取**PixelMap**对象每行字节数。 |
| [OH_PixelMap_GetIsEditable](image.md#oh_pixelmap_getiseditable) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*[editable](#editable)) | 获取**PixelMap**对象是否可编辑的状态。 |
| [OH_PixelMap_IsSupportAlpha](image.md#oh_pixelmap_issupportalpha) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*alpha) | 获取**PixelMap**对象是否支持Alpha通道。 |
| [OH_PixelMap_SetAlphaAble](image.md#oh_pixelmap_setalphaable) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t alpha) | 设置**PixelMap**对象的Alpha通道。 |
| [OH_PixelMap_GetDensity](image.md#oh_pixelmap_getdensity) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*density) | 获取**PixelMap**对象像素密度。 |
| [OH_PixelMap_SetDensity](image.md#oh_pixelmap_setdensity) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t density) | 设置**PixelMap**对象像素密度。 |
| [OH_PixelMap_SetOpacity](image.md#oh_pixelmap_setopacity) (const [NativePixelMap](image.md#nativepixelmap) \*native, float opacity) | 设置**PixelMap**对象的透明度。 |
| [OH_PixelMap_Scale](image.md#oh_pixelmap_scale) (const [NativePixelMap](image.md#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的缩放。 |
| [OH_PixelMap_Translate](image.md#oh_pixelmap_translate) (const [NativePixelMap](image.md#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的偏移。 |
| [OH_PixelMap_Rotate](image.md#oh_pixelmap_rotate) (const [NativePixelMap](image.md#nativepixelmap) \*native, float angle) | 设置**PixelMap**对象的旋转。 |
| [OH_PixelMap_Flip](image.md#oh_pixelmap_flip) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t x, int32_t y) | 设置**PixelMap**对象的翻转。 |
| [OH_PixelMap_Crop](image.md#oh_pixelmap_crop) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t x, int32_t y, int32_t [width](#width), int32_t [height](#height)) | 设置**PixelMap**对象的裁剪。 |
### 变量
| 名称 | 描述 |
| -------- | -------- |
| [width](#width) | 图片的宽, 用pixels表示。|
| [height](#height) | 图片的高, 用pixels表示。|
| [pixelFormat](#pixelformat) | 图片的格式。|
| [editable](#editable) | 图片的编辑类型。|
| [alphaType](#alphatype) | 图片的alpha类型。|
| [scaleMode](#scalemode) | 图片的缩放类型。|
## 变量说明
### alphaType
```
uint32_t alphaType
```
**描述:**
图片的alpha类型。
### editable
```
uint32_t editable
```
**描述:**
图片的编辑类型。
### height
```
uint32_t height
```
**描述:**
图片的高, 用pixels表示。
### pixelFormat
```
int32_t pixelFormat
```
**描述:**
图片的格式。
### scaleMode
```
uint32_t scaleMode
```
**描述:**
图片的缩放类型。
### width
```
uint32_t width
```
**描述:**
图片的宽, 用pixels表示。
| [OHOS::Media::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) | 获取 **PixelMap** 的信息,并记录信息到[OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md)结构中。 |
| [OHOS::Media::OH_AccessPixels](image.md#oh_accesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | 获取**PixelMap**对象数据的内存地址,并锁定该内存。 |
| [OHOS::Media::OH_UnAccessPixels](image.md#oh_unaccesspixels) (napi_env env, napi_value value) | 释放**PixelMap**对象数据的内存锁, 用于匹配方法**OH_AccessPixels**。 |
# image_receiver_mdk.h
## 概述
声明从native层获取图片数据的方法。
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OhosImageReceiverInfo](_ohos_image_receiver_info.md) | 定义**ImageReceiver**的相关信息。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [ImageReceiverNative](image.md#imagereceivernative) | 用于定义ImageReceiverNative数据类型名称。 |
| (\*[OH_Image_Receiver_On_Callback](image.md#oh_image_receiver_on_callback)) () | 定义native层图片的回调方法。 |
### 函数
| 名称 | 描述 |
| -------- | -------- |
| [OH_Image_Receiver_CreateImageReceiver](image.md#oh_image_receiver_createimagereceiver) (napi_env env, struct [OhosImageReceiverInfo](_ohos_image_receiver_info.md) info, napi_value \*res) | 创建应用层 **ImageReceiver** 对象。 |
| [OH_Image_Receiver_InitImageReceiverNative](image.md#oh_image_receiver_initimagereceivernative) (napi_env env, napi_value source) | 通过应用层**ImageReceiver**对象初始化native层[ImageReceiverNative](image.md#imagereceivernative)对象。 |
| [OH_Image_Receiver_GetReceivingSurfaceId](image.md#oh_image_receiver_getreceivingsurfaceid) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, char \*id, size_t len) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取receiver的id。 |
| [OH_Image_Receiver_ReadLatestImage](image.md#oh_image_receiver_readlatestimage) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, napi_value \*image) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取最新的一张图片。 |
| [OH_Image_Receiver_ReadNextImage](image.md#oh_image_receiver_readnextimage) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, napi_value \*image) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取下一张图片。 |
| [OH_Image_Receiver_On](image.md#oh_image_receiver_on) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, [OH_Image_Receiver_On_Callback](image.md#oh_image_receiver_on_callback) callback) | 注册一个[OH_Image_Receiver_On_Callback](image.md#oh_image_receiver_on_callback)回调事件。每当接收新图片,该回调事件就会响应。 |
| [OH_Image_Receiver_GetSize](image.md#oh_image_receiver_getsize) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, struct [OhosImageSize](_ohos_image_size.md) \*size) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取**ImageReceiver**的大小。 |
| [OH_Image_Receiver_GetCapacity](image.md#oh_image_receiver_getcapacity) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, int32_t \*capacity) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取**ImageReceiver**的容量。 |
| [OH_Image_Receiver_GetFormat](image.md#oh_image_receiver_getformat) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, int32_t \*format) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取**ImageReceiver**的格式。 |
| [OH_Image_Receiver_Release](image.md#oh_image_receiver_release) ([ImageReceiverNative](image.md#imagereceivernative) \*native) | 释放native层 [ImageReceiverNative](image.md#imagereceivernative) 对象。 |
# image_source_mdk.h
## 概述
声明将图片源解码成像素位图的方法。
\@Syscap SystemCapability.Multimedia.Image
**起始版本:**
10
**相关模块:**
[Image](image.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OhosImageRegion](_ohos_image_region.md) | 定义图像源解码的范围选项。 |
| [OhosImageSourceOps](_ohos_image_source_ops.md) | 定义图像源选项信息。 |
| [OhosImageDecodingOps](_ohos_image_decoding_ops.md) | 定义图像源解码选项。 |
| [OhosImageSourceInfo](_ohos_image_source_info.md) | 定义图像源信息。 |
| [OhosImageSource](_ohos_image_source.md) | 定义图像源输入资源,每次仅接收一种类型。 |
| [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) | 定义图像源延迟时间列表。 |
| [OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md) | 定义图像源支持的格式字符串。 |
| [OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md) | 定义图像源支持的格式字符串列表。 |
| [OhosImageSourceProperty](_ohos_image_source_property.md) | 定义图像源属性键值字符串。 |
| [OhosImageSourceUpdateData](_ohos_image_source_update_data.md) | 定义图像源更新数据选项。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [ImageSourceNative](image.md#imagesourcenative) | 为图像源方法定义native层图像源对象。 |
### 函数
| 名称 | 描述 |
| -------- | -------- |
| [OH_ImageSource_Create](image.md#oh_imagesource_create) (napi_env env, struct [OhosImageSource](_ohos_image_source.md) \*src, struct [OhosImageSourceOps](_ohos_image_source_ops.md) \*ops, napi_value \*res) | 通过给定的信息[OhosImageSource](_ohos_image_source.md)[OhosImageSourceOps](_ohos_image_source_ops.md)结构体,获取JavaScript native层API**ImageSource**对象。 |
| [OH_ImageSource_CreateIncremental](image.md#oh_imagesource_createincremental) (napi_env env, struct [OhosImageSource](_ohos_image_source.md) \*source, struct [OhosImageSourceOps](_ohos_image_source_ops.md) \*ops, napi_value \*res) | 通过给定的infomations[OhosImageSource](_ohos_image_source.md)[OhosImageSourceOps](_ohos_image_source_ops.md)结构, 获取增量类型的JavaScript Native API ImageSource对象,图像数据应通过OH_ImageSource_UpdateData更新。 |
| [OH_ImageSource_GetSupportedFormats](image.md#oh_imagesource_getsupportedformats) (struct [OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md) \*res) | 获取所有支持的解码格式元标记。 |
| \*[OH_ImageSource_InitNative](image.md#oh_imagesource_initnative) (napi_env env, napi_value source) | 从输入JavaScript native层API **ImageSource** 对象中,转换成[ImageSourceNative](image.md#imagesourcenative)值。 |
| [OH_ImageSource_CreatePixelMap](image.md#oh_imagesource_createpixelmap) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageDecodingOps](_ohos_image_decoding_ops.md) \*ops, napi_value \*res) | 通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码JavaScript native层API**PixelMap**对象 |
| [OH_ImageSource_CreatePixelMapList](image.md#oh_imagesource_createpixelmaplist) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageDecodingOps](_ohos_image_decoding_ops.md) \*ops, napi_value \*res) | 通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码所有的JavaScript native层API**PixelMap**对象列表 |
| [OH_ImageSource_GetDelayTime](image.md#oh_imagesource_getdelaytime) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) \*res) | 从一些**ImageSource**(如GIF图像源)获取延迟时间列表。 |
| [OH_ImageSource_GetFrameCount](image.md#oh_imagesource_getframecount) (const [ImageSourceNative](image.md#imagesourcenative) \*native, uint32_t \*res) | 从**ImageSource**中获取帧计数。 |
| [OH_ImageSource_GetImageInfo](image.md#oh_imagesource_getimageinfo) (const [ImageSourceNative](image.md#imagesourcenative) \*native, int32_t index, struct [OhosImageSourceInfo](_ohos_image_source_info.md) \*info) | 通过索引从**ImageSource**获取图像源信息。 |
| [OH_ImageSource_GetImageProperty](image.md#oh_imagesource_getimageproperty) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*key, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*value) | 通过关键字从**ImageSource**中获取图像源属性。 |
| [OH_ImageSource_ModifyImageProperty](image.md#oh_imagesource_modifyimageproperty) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*key, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*value) | 通过关键字为**ImageSource**修改图像源属性。 |
| [OH_ImageSource_UpdateData](image.md#oh_imagesource_updatedata) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageSourceUpdateData](_ohos_image_source_update_data.md) \*data) | 为了增量类型的**ImageSource**更新源数据。 |
| [OH_ImageSource_Release](image.md#oh_imagesource_release) ([ImageSourceNative](image.md#imagesourcenative) \*native) | 释放native层图像源 **ImageSourceNative**。 |
### 变量
| 名称 | 描述 |
| -------- | -------- |
| \*[OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE](image.md#ohos_image_property_bits_per_sample) = "BitsPerSample" | 定义每个样本比特的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_ORIENTATION](image.md#ohos_image_property_orientation) = "Orientation" | 定义方向的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_IMAGE_LENGTH](image.md#ohos_image_property_image_length) = "ImageLength" | 定义图像长度的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_IMAGE_WIDTH](image.md#ohos_image_property_image_width) = "ImageWidth" | 定义图像宽度的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_GPS_LATITUDE](image.md#ohos_image_property_gps_latitude) = "GPSLatitude" | 定义GPS纬度的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_GPS_LONGITUDE](image.md#ohos_image_property_gps_longitude) = "GPSLongitude" | 定义GPS经度的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF](image.md#ohos_image_property_gps_latitude_ref) = "GPSLatitudeRef" | 定义GPS纬度参考的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF](image.md#ohos_image_property_gps_longitude_ref) = "GPSLongitudeRef" | 定义GPS经度参考的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL](image.md#ohos_image_property_date_time_original) = "DateTimeOriginal" | 定义初始日期时间的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_EXPOSURE_TIME](image.md#ohos_image_property_exposure_time) = "ExposureTime" | 定义曝光时间的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_SCENE_TYPE](image.md#ohos_image_property_scene_type) = "SceneType" | 定义场景类型的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS](image.md#ohos_image_property_iso_speed_ratings) = "ISOSpeedRatings" | 定义ISO速度等级的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_F_NUMBER](image.md#ohos_image_property_f_number) = "FNumber" | 定义FNumber的图像属性关键字。 |
| \*[OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL](image.md#ohos_image_property_compressed_bits_per_pixel) = "CompressedBitsPerPixel" | 定义每个像素的压缩比特的图像属性关键字。 |
......@@ -1794,7 +1794,12 @@
- [drawing_text_typography.h](reference/native-apis/drawing__text__typography_8h.md)
- [drawing_types.h](reference/native-apis/drawing__types_8h.md)
- [external_window.h](reference/native-apis/external__window_8h.md)
- [image_mdk.h](reference/native-apis/image__mdk_8h.md)
- [image_mdk_common.h](reference/native-apis/image__mdk__common_8h.md)
- [image_pixel_map_mdk.h](reference/native-apis/image__pixel__map__mdk_8h.md)
- [image_pixel_map_napi.h](reference/native-apis/image__pixel__map__napi_8h.md)
- [image_receiver_mdk.h](reference/native-apis/image__receiver__mdk_8h.md)
- [image_source_mdk.h](reference/native-apis/image__source__mdk_8h.md)
- [log.h](reference/native-apis/log_8h.md)
- [native_buffer.h](reference/native-apis/native__buffer_8h.md)
- [native_image.h](reference/native-apis/native__image_8h.md)
......@@ -1858,8 +1863,23 @@
- [OH_NativeXComponent_TouchPoint](reference/native-apis/_o_h___native_x_component___touch_point.md)
- [OHExtDataHandle](reference/native-apis/_o_h_ext_data_handle.md)
- [OHHDRMetaData](reference/native-apis/_o_h_h_d_r_meta_data.md)
- [OHOS::Media::OhosImageComponent](reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_image_component.md)
- [OHOS::Media::OhosImageRect](reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_image_rect.md)
- [OHOS::Media::OhosPixelMapInfo](reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md)
- [OhosImageDecodingOps](reference/native-apis/_ohos_image_decoding_ops.md)
- [OhosImageReceiverInfo](reference/native-apis/_ohos_image_receiver_info.md)
- [OhosImageRegion](reference/native-apis/_ohos_image_region.md)
- [OhosImageSize](reference/native-apis/_ohos_image_size.md)
- [OhosImageSource](reference/native-apis/_ohos_image_source.md)
- [OhosImageSourceDelayTimeList](reference/native-apis/_ohos_image_source_delay_time_list.md)
- [OhosImageSourceInfo](reference/native-apis/_ohos_image_source_info.md)
- [OhosImageSourceOps](reference/native-apis/_ohos_image_source_ops.md)
- [OhosImageSourceProperty](reference/native-apis/_ohos_image_source_property.md)
- [OhosImageSourceSupportedFormat](reference/native-apis/_ohos_image_source_supported_format.md)
- [OhosImageSourceSupportedFormatList](reference/native-apis/_ohos_image_source_supported_format_list.md)
- [OhosImageSourceUpdateData](reference/native-apis/_ohos_image_source_update_data.md)
- [OhosPixelMapCreateOps](reference/native-apis/_ohos_pixel_map_create_ops.md)
- [OhosPixelMapInfo](reference/native-apis/_ohos_pixel_map_info.md)
- [OhosPixelMapInfos](reference/native-apis/_ohos_pixel_map_infos.md)
- [RawFileDescriptor](reference/native-apis/_raw_file_descriptor.md)
- [Region](reference/native-apis/_region.md)
- [Rect](reference/native-apis/_rect.md)
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册