picture_native.h

Overview

The picture_native.h file declares the APIs for obtaining picture data and information.

Library: libpicture.so

File to include: <multimedia/image_framework/image/picture_native.h>

System capability: SystemCapability.Multimedia.Image.Core

Since: 13

Related module: Image_NativeModule

Summary

Types

Name	Description
typedef struct OH_PictureNative OH_PictureNative	Defines a struct for the picture, which is used to perform operations related to the picture.
typedef struct OH_AuxiliaryPictureNative OH_AuxiliaryPictureNative	Defines a struct for the auxiliary picture, which is used to perform operations related to the auxiliary picture.
typedef struct OH_AuxiliaryPictureInfo OH_AuxiliaryPictureInfo	Defines a struct for the auxiliary picture information, which is used to perform operations related to the auxiliary picture information.

Enums

Name	Description
Image_AuxiliaryPictureType { AUXILIARY_PICTURE_TYPE_GAINMAP = 1, AUXILIARY_PICTURE_TYPE_DEPTH_MAP = 2, AUXILIARY_PICTURE_TYPE_UNREFOCUS_MAP = 3, AUXILIARY_PICTURE_TYPE_LINEAR_MAP = 4, AUXILIARY_PICTURE_TYPE_FRAGMENT_MAP = 5 }	Enumerates the auxiliary picture types.

Functions

Name	Description
Image_ErrorCode OH_PictureNative_CreatePicture (OH_PixelmapNative mainPixelmap, OH_PictureNative *picture)	Creates the pointer to an OH_PictureNative struct.
Image_ErrorCode OH_PictureNative_GetMainPixelmap (OH_PictureNative picture, OH_PixelmapNative *mainPixelmap)	Obtains the pointer to the OH_PixelmapNative object of a main picture.
Image_ErrorCode OH_PictureNative_GetHdrComposedPixelmap (OH_PictureNative picture, OH_PixelmapNative *hdrPixelmap)	Obtains the pointer to the OH_PixelmapNative object of an HDR picture.
Image_ErrorCode OH_PictureNative_GetGainmapPixelmap (OH_PictureNative picture, OH_PixelmapNative *gainmapPixelmap)	Obtains the pointer to the OH_PixelmapNative object of a gain map.
Image_ErrorCode OH_PictureNative_SetAuxiliaryPicture (OH_PictureNative picture, Image_AuxiliaryPictureType type, OH_AuxiliaryPictureNative auxiliaryPicture)	Sets an auxiliary picture.
Image_ErrorCode OH_PictureNative_GetAuxiliaryPicture (OH_PictureNative picture, Image_AuxiliaryPictureType type, OH_AuxiliaryPictureNative *auxiliaryPicture)	Obtains an auxiliary picture by type.
Image_ErrorCode OH_PictureNative_GetMetadata (OH_PictureNative picture, Image_MetadataType metadataType, OH_PictureMetadata *metadata)	Obtains the metadata of a picture.
Image_ErrorCode OH_PictureNative_SetMetadata (OH_PictureNative picture, Image_MetadataType metadataType, OH_PictureMetadata metadata)	Sets the metadata for a picture.
Image_ErrorCode OH_PictureNative_Release (OH_PictureNative *picture)	Releases the pointer to an OH_PictureNative struct.
Image_ErrorCode OH_AuxiliaryPictureNative_Create (uint8_t data, size_t dataLength, Image_Size size, Image_AuxiliaryPictureType type, OH_AuxiliaryPictureNative **auxiliaryPicture)	Creates the pointer to an OH_AuxiliaryPictureNative struct.
Image_ErrorCode OH_AuxiliaryPictureNative_WritePixels (OH_AuxiliaryPictureNative auxiliaryPicture, uint8_t source, size_t bufferSize)	Reads pixels in the buffer and writes the result to an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureNative_ReadPixels (OH_AuxiliaryPictureNative auxiliaryPicture, uint8_t destination, size_t *bufferSize)	Reads pixels of an auxiliary picture and writes the result to the buffer.
Image_ErrorCode OH_AuxiliaryPictureNative_GetType (OH_AuxiliaryPictureNative auxiliaryPicture, Image_AuxiliaryPictureType type)	Obtains the type of an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureNative_GetInfo (OH_AuxiliaryPictureNative auxiliaryPicture, OH_AuxiliaryPictureInfo *info)	Obtains the information of an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureNative_SetInfo (OH_AuxiliaryPictureNative auxiliaryPicture, OH_AuxiliaryPictureInfo info)	Sets the information for an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureNative_GetMetadata (OH_AuxiliaryPictureNative auxiliaryPicture, Image_MetadataType metadataType, OH_PictureMetadata *metadata)	Obtains the metadata of an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureNative_SetMetadata (OH_AuxiliaryPictureNative auxiliaryPicture, Image_MetadataType metadataType, OH_PictureMetadata metadata)	Sets the metadata for an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureNative_Release (OH_AuxiliaryPictureNative *picture)	Releases the pointer to an OH_AuxiliaryPictureNative struct.
Image_ErrorCode OH_AuxiliaryPictureInfo_Create (OH_AuxiliaryPictureInfo **info)	Creates an OH_AuxiliaryPictureInfo object.
Image_ErrorCode OH_AuxiliaryPictureInfo_GetType (OH_AuxiliaryPictureInfo info, Image_AuxiliaryPictureType type)	Obtains the auxiliary picture type from the auxiliary picture information.
Image_ErrorCode OH_AuxiliaryPictureInfo_SetType (OH_AuxiliaryPictureInfo *info, Image_AuxiliaryPictureType type)	Sets the auxiliary picture type in the auxiliary picture information.
Image_ErrorCode OH_AuxiliaryPictureInfo_GetSize (OH_AuxiliaryPictureInfo info, Image_Size size)	Obtains the size of an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureInfo_SetSize (OH_AuxiliaryPictureInfo info, Image_Size size)	Sets the size for an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureInfo_GetRowStride (OH_AuxiliaryPictureInfo info, uint32_t rowStride)	Obtains the row stride of an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureInfo_SetRowStride (OH_AuxiliaryPictureInfo *info, uint32_t rowStride)	Sets the row stride for an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureInfo_GetPixelFormat (OH_AuxiliaryPictureInfo info, PIXEL_FORMAT pixelFormat)	Obtains the pixel format of an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureInfo_SetPixelFormat (OH_AuxiliaryPictureInfo *info, PIXEL_FORMAT pixelFormat)	Sets the pixel format for an auxiliary picture.
Image_ErrorCode OH_AuxiliaryPictureInfo_Release (OH_AuxiliaryPictureInfo *info)	Releases the pointer to an OH_AuxiliaryPictureInfo object.