drawing_image.h

Overview

This file declares the functions related to the image in the drawing module.

File to include: <native_drawing/drawing_image.h>

Library: libnative_drawing.so

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 12

Related module: Drawing

Summary

Functions

Name	Description
OH_Drawing_Image* OH_Drawing_ImageCreate(void)	Creates an OH_Drawing_Image object that describes an array of two-dimensional pixels to draw.
void OH_Drawing_ImageDestroy(OH_Drawing_Image* image)	Destroys an OH_Drawing_Image object and reclaims the memory occupied by the object.
bool OH_Drawing_ImageBuildFromBitmap(OH_Drawing_Image* image, OH_Drawing_Bitmap* bitmap)	Builds an image from a bitmap by sharing or copying bitmap pixels. If the bitmap is marked as immutable, the pixel memory is shared, not copied. This API may return an error code. For details, call OH_Drawing_ErrorCodeGet. If either image or bitmap is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.
int32_t OH_Drawing_ImageGetWidth(OH_Drawing_Image* image)	Obtains the image width, that is, the number of pixels in each line. This API may return an error code. For details, call OH_Drawing_ErrorCodeGet. If image is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.
int32_t OH_Drawing_ImageGetHeight(OH_Drawing_Image* image)	Obtains the image height, that is, the number of pixel lines. This API may return an error code. For details, call OH_Drawing_ErrorCodeGet. If image is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.
void OH_Drawing_ImageGetImageInfo(OH_Drawing_Image* image, OH_Drawing_Image_Info* imageInfo)	Obtains the image information. After this function is called, the passed-in image information object is filled. This API may return an error code. For details, call OH_Drawing_ErrorCodeGet. If either image or imageInfo is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

Function Description

OH_Drawing_ImageCreate()

OH_Drawing_Image* OH_Drawing_ImageCreate(void)

Description

Creates an OH_Drawing_Image object that describes an array of two-dimensional pixels to draw.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 12

Returns

Type	Description
OH_Drawing_Image*	Returns a pointer to the OH_Drawing_Image object created.

OH_Drawing_ImageDestroy()

void OH_Drawing_ImageDestroy(OH_Drawing_Image* image)

Description

Destroys an OH_Drawing_Image object and reclaims the memory occupied by the object.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 12

Parameters

Name	Description
OH_Drawing_Image* image	Pointer to the OH_Drawing_Image object.

OH_Drawing_ImageBuildFromBitmap()

bool OH_Drawing_ImageBuildFromBitmap(OH_Drawing_Image* image, OH_Drawing_Bitmap* bitmap)

Description

Builds an image from a bitmap by sharing or copying bitmap pixels. If the bitmap is marked as immutable, the pixel memory is shared, not copied.
This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.
If either image or bitmap is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 12

Parameters

Name	Description
OH_Drawing_Image* image	Pointer to the OH_Drawing_Image object.
OH_Drawing_Bitmap* bitmap	Pointer to the OH_Drawing_Bitmap object.

Returns

Type	Description
bool	Returns true if the image is built; returns false otherwise.

OH_Drawing_ImageGetWidth()

int32_t OH_Drawing_ImageGetWidth(OH_Drawing_Image* image)

Description

Obtains the image width, that is, the number of pixels in each line.
This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.
If image is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 12

Parameters

Name	Description
OH_Drawing_Image* image	Pointer to the OH_Drawing_Image object.

Returns

Type	Description
int32_t	Returns the width.

OH_Drawing_ImageGetHeight()

int32_t OH_Drawing_ImageGetHeight(OH_Drawing_Image* image)

Description

Obtains the image height, that is, the number of pixel lines.
This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.
If image is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 12

Parameters

Name	Description
OH_Drawing_Image* image	Pointer to the OH_Drawing_Image object.

Returns

Type	Description
int32_t	Returns the height.

OH_Drawing_ImageGetImageInfo()

void OH_Drawing_ImageGetImageInfo(OH_Drawing_Image* image, OH_Drawing_Image_Info* imageInfo)

Description

Obtains the image information. After this function is called, the passed-in image information object is filled.
This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.
If either image or imageInfo is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 12

Parameters

Name	Description
OH_Drawing_Image* image	Pointer to the OH_Drawing_Image object.
OH_Drawing_Image_Info* imageInfo	Pointer to an OH_Drawing_Image_Info object, which can be created by calling OH_Drawing_Image_Info.