drawing_bitmap.h

概述

文件中定义了与位图相关的功能函数。

相关示例： NDKAPIDrawing (API14)

引用文件： <native_drawing/drawing_bitmap.h>

库： libnative_drawing.so

起始版本： 8

相关模块： Drawing

汇总

结构体

名称	typedef关键字	描述
OH_Drawing_BitmapFormat	OH_Drawing_BitmapFormat	结构体用于描述位图像素的格式，包括颜色类型和透明度类型。

函数

名称	描述
OH_Drawing_Bitmap* OH_Drawing_BitmapCreate(void)	用于创建一个位图对象。
void OH_Drawing_BitmapDestroy(OH_Drawing_Bitmap* bitmap)	用于销毁位图对象并回收该对象占有内存。
OH_Drawing_Bitmap* OH_Drawing_BitmapCreateFromPixels(OH_Drawing_Image_Info* imageInfo, void* pixels, uint32_t rowBytes)	用于创建一个位图对象，并将位图像素存储内存地址设置为开发者申请内存的地址。本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。 imageInfo、pixels任意一个为NULL或者rowBytes等于0时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BitmapBuild(OH_Drawing_Bitmap* bitmap,const uint32_t width, const uint32_t height, const OH_Drawing_BitmapFormat* bitmapFormat)	用于初始化位图对象的宽度和高度，并且为该位图设置像素格式。本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。 bitmap、bitmapFormat任意一个为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
uint32_t OH_Drawing_BitmapGetWidth(OH_Drawing_Bitmap* bitmap)	用于获取指定位图的宽度。本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。 bitmap为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
uint32_t OH_Drawing_BitmapGetHeight(OH_Drawing_Bitmap* bitmap)	用于获取指定位图的高度。本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。 bitmap为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
OH_Drawing_ColorFormat OH_Drawing_BitmapGetColorFormat(OH_Drawing_Bitmap* bitmap)	用于获取指定位图的像素存储格式。本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。 bitmap为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
OH_Drawing_AlphaFormat OH_Drawing_BitmapGetAlphaFormat(OH_Drawing_Bitmap* bitmap)	用于获取指定位图的像素透明度分量。本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。 bitmap为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void* OH_Drawing_BitmapGetPixels(OH_Drawing_Bitmap* bitmap)	用于获取指定位图的像素地址，可以通过像素地址获取到位图的像素数据。本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。 bitmap为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BitmapGetImageInfo(OH_Drawing_Bitmap* bitmap, OH_Drawing_Image_Info* imageInfo)	用于获取指定位图的信息。本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。 bitmap、imageInfo任意一个为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
bool OH_Drawing_BitmapReadPixels(OH_Drawing_Bitmap* bitmap, const OH_Drawing_Image_Info* dstInfo,void* dstPixels, size_t dstRowBytes, int32_t srcX, int32_t srcY)	将位图中的矩形区域像素数据读取到指定的内存缓冲区中。本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。 bitmap、dstInfo、dstPixels任意一个为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

函数说明

OH_Drawing_BitmapCreate()

OH_Drawing_Bitmap* OH_Drawing_BitmapCreate(void)

描述

用于创建一个位图对象。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

返回：

类型	说明
OH_Drawing_Bitmap*	函数会返回一个指针，指针指向创建的位图对象。

OH_Drawing_BitmapDestroy()

void OH_Drawing_BitmapDestroy(OH_Drawing_Bitmap* bitmap)

描述

用于销毁位图对象并回收该对象占有内存。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

参数：

参数项	描述
OH_Drawing_Bitmap* bitmap	指向位图对象的指针。

OH_Drawing_BitmapCreateFromPixels()

OH_Drawing_Bitmap* OH_Drawing_BitmapCreateFromPixels(OH_Drawing_Image_Info* imageInfo, void* pixels, uint32_t rowBytes)

描述

用于创建一个位图对象，并将位图像素存储内存地址设置为开发者申请内存的地址。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
imageInfo、pixels任意一个为NULL或者rowBytes等于0时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 12

参数：

参数项	描述
OH_Drawing_Image_Info* imageInfo	指向图片信息对象OH_Drawing_Image_Info的指针。
void* pixels	指向像素存储的内存首地址，内存由开发者申请，保证有效性。
uint32_t rowBytes	每行像素的大小，小于等于0时无效。

返回：

类型	说明
OH_Drawing_Bitmap*	函数返回一个指针，指针指向创建的位图对象OH_Drawing_Bitmap。

OH_Drawing_BitmapBuild()

void OH_Drawing_BitmapBuild(OH_Drawing_Bitmap* bitmap,const uint32_t width, const uint32_t height, const OH_Drawing_BitmapFormat* bitmapFormat)

描述

用于初始化位图对象的宽度和高度，并且为该位图设置像素格式。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
bitmap、bitmapFormat任意一个为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

参数：

参数项	描述
OH_Drawing_Bitmap* bitmap	指向位图对象的指针。
const uint32_t width	位图要初始化设置的宽度。
const uint32_t height	位图要初始化设置的高度。
const OH_Drawing_BitmapFormat* bitmapFormat	位图要初始化设置的像素格式，包括像素的颜色类型和透明度类型。

OH_Drawing_BitmapGetWidth()

uint32_t OH_Drawing_BitmapGetWidth(OH_Drawing_Bitmap* bitmap)

描述

用于获取指定位图的宽度。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
bitmap为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

参数：

参数项	描述
OH_Drawing_Bitmap* bitmap	指向位图对象的指针。

返回：

类型	说明
uint32_t	函数返回位图的宽度。

OH_Drawing_BitmapGetHeight()

uint32_t OH_Drawing_BitmapGetHeight(OH_Drawing_Bitmap* bitmap)

描述

用于获取指定位图的高度。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
bitmap为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

参数：

参数项	描述
OH_Drawing_Bitmap* bitmap	指向位图对象的指针。

返回：

类型	说明
uint32_t	函数返回位图的高度。

OH_Drawing_BitmapGetColorFormat()

OH_Drawing_ColorFormat OH_Drawing_BitmapGetColorFormat(OH_Drawing_Bitmap* bitmap)

描述

用于获取指定位图的像素存储格式。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
bitmap为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 12

参数：

参数项	描述
OH_Drawing_Bitmap* bitmap	指向位图对象的指针。

返回：

类型	说明
OH_Drawing_ColorFormat	函数返回位图的像素存储格式，支持格式参考OH_Drawing_ColorFormat。

OH_Drawing_BitmapGetAlphaFormat()

OH_Drawing_AlphaFormat OH_Drawing_BitmapGetAlphaFormat(OH_Drawing_Bitmap* bitmap)

描述

用于获取指定位图的像素透明度分量。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
bitmap为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 12

参数：

参数项	描述
OH_Drawing_Bitmap* bitmap	指向位图对象的指针。

返回：

类型	说明
OH_Drawing_AlphaFormat	函数返回位图的像素透明度分量，支持格式参考OH_Drawing_AlphaFormat。

OH_Drawing_BitmapGetPixels()

void* OH_Drawing_BitmapGetPixels(OH_Drawing_Bitmap* bitmap)

描述

用于获取指定位图的像素地址，可以通过像素地址获取到位图的像素数据。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
bitmap为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

参数：

参数项	描述
OH_Drawing_Bitmap* bitmap	指向位图对象的指针。

返回：

类型	说明
void*	函数返回位图的像素地址。

OH_Drawing_BitmapGetImageInfo()

void OH_Drawing_BitmapGetImageInfo(OH_Drawing_Bitmap* bitmap, OH_Drawing_Image_Info* imageInfo)

描述

用于获取指定位图的信息。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
bitmap、imageInfo任意一个为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 12

参数：

参数项	描述
OH_Drawing_Bitmap* bitmap	指向位图对象OH_Drawing_Bitmap的指针。
OH_Drawing_Image_Info* imageInfo	指向图片信息对象OH_Drawing_Image_Info的指针。

OH_Drawing_BitmapReadPixels()

bool OH_Drawing_BitmapReadPixels(OH_Drawing_Bitmap* bitmap, const OH_Drawing_Image_Info* dstInfo,void* dstPixels, size_t dstRowBytes, int32_t srcX, int32_t srcY)

描述

将位图中的矩形区域像素数据读取到指定的内存缓冲区中。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
bitmap、dstInfo、dstPixels任意一个为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 12

参数：

参数项	描述
OH_Drawing_Bitmap* bitmap	指向位图对象OH_Drawing_Bitmap的指针。
const OH_Drawing_Image_Info* dstInfo	指向图片信息对象OH_Drawing_Image_Info的指针。
void* dstPixels	目标像素存储区域。
size_t dstRowBytes	目标像素数据每行的字节数，应大于或等于图片信息对象中的最小每行字节数。
int32_t srcX	源位图中读取像素数据的起始x轴坐标，应小于源位图的宽度。
int32_t srcY	源位图中读取像素数据的起始y轴坐标，应小于源位图的高度。