已合并
补充返回错误码细节 #2901
补充返回错误码细节 #2901
已合并
sss创建于 2025年12月16日
2 个文件变更+31-25
@@ -369,7 +369,7 @@ typedef struct OH_Pixelmap_InitializationOptions OH_Pixelmap_InitializationOptio
369 *369 *
370 * @param options 被创建的OH_Pixelmap_InitializationOptions指针。370 * @param options 被创建的OH_Pixelmap_InitializationOptions指针。
371 * @return IMAGE_SUCCESS:执行成功。\n371 * @return IMAGE_SUCCESS:执行成功。\n
372- * IMAGE_BAD_PARAMETER:参数错误372+ * IMAGE_BAD_PARAMETER:创建OH_Pixelmap_InitializationOptions对象失败
373 * @since 12373 * @since 12
374 */374 */
375Image_ErrorCode OH_PixelmapInitializationOptions_Create(OH_Pixelmap_InitializationOptions **options);375Image_ErrorCode OH_PixelmapInitializationOptions_Create(OH_Pixelmap_InitializationOptions **options);
@@ -380,7 +380,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_Create(OH_Pixelmap_Initializati
380 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。380 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。
381 * @param width 图片的宽,单位:像素。381 * @param width 图片的宽,单位:像素。
382 * @return IMAGE_SUCCESS:执行成功。\n382 * @return IMAGE_SUCCESS:执行成功。\n
383- * IMAGE_BAD_PARAMETER:参数错误383+ * IMAGE_BAD_PARAMETER:参数options或width为空
384 * @since 12384 * @since 12
385 */385 */
386Image_ErrorCode OH_PixelmapInitializationOptions_GetWidth(OH_Pixelmap_InitializationOptions *options,386Image_ErrorCode OH_PixelmapInitializationOptions_GetWidth(OH_Pixelmap_InitializationOptions *options,
@@ -392,7 +392,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_GetWidth(OH_Pixelmap_Initializa
392 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。392 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。
393 * @param width 图片的宽,单位:像素。393 * @param width 图片的宽,单位:像素。
394 * @return IMAGE_SUCCESS:执行成功。\n394 * @return IMAGE_SUCCESS:执行成功。\n
395- * IMAGE_BAD_PARAMETER:参数错误395+ * IMAGE_BAD_PARAMETER:参数options为空
396 * @since 12396 * @since 12
397 */397 */
398Image_ErrorCode OH_PixelmapInitializationOptions_SetWidth(OH_Pixelmap_InitializationOptions *options,398Image_ErrorCode OH_PixelmapInitializationOptions_SetWidth(OH_Pixelmap_InitializationOptions *options,
@@ -404,7 +404,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_SetWidth(OH_Pixelmap_Initializa
404 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。404 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。
405 * @param height 图片的高,单位:像素。405 * @param height 图片的高,单位:像素。
406 * @return IMAGE_SUCCESS:执行成功。\n406 * @return IMAGE_SUCCESS:执行成功。\n
407- * IMAGE_BAD_PARAMETER:参数错误407+ * IMAGE_BAD_PARAMETER:参数options或者height为空
408 * @since 12408 * @since 12
409 */409 */
410Image_ErrorCode OH_PixelmapInitializationOptions_GetHeight(OH_Pixelmap_InitializationOptions *options,410Image_ErrorCode OH_PixelmapInitializationOptions_GetHeight(OH_Pixelmap_InitializationOptions *options,
@@ -416,7 +416,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_GetHeight(OH_Pixelmap_Initializ
416 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。416 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。
417 * @param height 图片的高,单位:像素。417 * @param height 图片的高,单位:像素。
418 * @return IMAGE_SUCCESS:执行成功。\n418 * @return IMAGE_SUCCESS:执行成功。\n
419- * IMAGE_BAD_PARAMETER:参数错误419+ * IMAGE_BAD_PARAMETER:参数options为空
420 * @since 12420 * @since 12
421 */421 */
422Image_ErrorCode OH_PixelmapInitializationOptions_SetHeight(OH_Pixelmap_InitializationOptions *options,422Image_ErrorCode OH_PixelmapInitializationOptions_SetHeight(OH_Pixelmap_InitializationOptions *options,
@@ -428,7 +428,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_SetHeight(OH_Pixelmap_Initializ
428 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。428 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。
429 * @param pixelFormat 像素格式{@link PIXEL_FORMAT}。429 * @param pixelFormat 像素格式{@link PIXEL_FORMAT}。
430 * @return IMAGE_SUCCESS:执行成功。\n430 * @return IMAGE_SUCCESS:执行成功。\n
431- * IMAGE_BAD_PARAMETER:参数错误431+ * IMAGE_BAD_PARAMETER:参数options或者pixelFormat为空
432 * @since 12432 * @since 12
433 */433 */
434Image_ErrorCode OH_PixelmapInitializationOptions_GetPixelFormat(OH_Pixelmap_InitializationOptions *options,434Image_ErrorCode OH_PixelmapInitializationOptions_GetPixelFormat(OH_Pixelmap_InitializationOptions *options,
@@ -440,7 +440,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_GetPixelFormat(OH_Pixelmap_Init
440 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。440 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。
441 * @param pixelFormat 像素格式{@link PIXEL_FORMAT}。441 * @param pixelFormat 像素格式{@link PIXEL_FORMAT}。
442 * @return IMAGE_SUCCESS:执行成功。\n442 * @return IMAGE_SUCCESS:执行成功。\n
443- * IMAGE_BAD_PARAMETER:参数错误443+ * IMAGE_BAD_PARAMETER:参数options为空
444 * @since 12444 * @since 12
445 */445 */
446Image_ErrorCode OH_PixelmapInitializationOptions_SetPixelFormat(OH_Pixelmap_InitializationOptions *options,446Image_ErrorCode OH_PixelmapInitializationOptions_SetPixelFormat(OH_Pixelmap_InitializationOptions *options,
@@ -451,7 +451,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_SetPixelFormat(OH_Pixelmap_Init
451 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。451 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。
452 * @param srcpixelFormat 像素格式{@link PIXEL_FORMAT}。452 * @param srcpixelFormat 像素格式{@link PIXEL_FORMAT}。
453 * @return IMAGE_SUCCESS:执行成功。\n453 * @return IMAGE_SUCCESS:执行成功。\n
454- * IMAGE_BAD_PARAMETER:参数错误454+ * IMAGE_BAD_PARAMETER:参数options或者srcpixelFormat为空
455 * @since 12455 * @since 12
456 */456 */
457Image_ErrorCode OH_PixelmapInitializationOptions_GetSrcPixelFormat(OH_Pixelmap_InitializationOptions *options,457Image_ErrorCode OH_PixelmapInitializationOptions_GetSrcPixelFormat(OH_Pixelmap_InitializationOptions *options,
@@ -463,7 +463,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_GetSrcPixelFormat(OH_Pixelmap_I
463 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。463 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。
464 * @param srcpixelFormat 源像素格式{@link PIXEL_FORMAT}。464 * @param srcpixelFormat 源像素格式{@link PIXEL_FORMAT}。
465 * @return IMAGE_SUCCESS:执行成功。\n465 * @return IMAGE_SUCCESS:执行成功。\n
466- * IMAGE_BAD_PARAMETER:参数错误466+ * IMAGE_BAD_PARAMETER:参数options为空
467 * @since 12467 * @since 12
468 */468 */
469Image_ErrorCode OH_PixelmapInitializationOptions_SetSrcPixelFormat(OH_Pixelmap_InitializationOptions *options,469Image_ErrorCode OH_PixelmapInitializationOptions_SetSrcPixelFormat(OH_Pixelmap_InitializationOptions *options,
@@ -503,7 +503,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_SetRowStride(OH_Pixelmap_Initia
503 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。503 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。
504 * @param alphaType 透明度类型{@link PIXELMAP_ALPHA_TYPE}。504 * @param alphaType 透明度类型{@link PIXELMAP_ALPHA_TYPE}。
505 * @return IMAGE_SUCCESS:执行成功。\n505 * @return IMAGE_SUCCESS:执行成功。\n
506- * IMAGE_BAD_PARAMETER:参数错误506+ * IMAGE_BAD_PARAMETER:参数options或者alphaType为空
507 * @since 12507 * @since 12
508 */508 */
509Image_ErrorCode OH_PixelmapInitializationOptions_GetAlphaType(OH_Pixelmap_InitializationOptions *options,509Image_ErrorCode OH_PixelmapInitializationOptions_GetAlphaType(OH_Pixelmap_InitializationOptions *options,
@@ -515,7 +515,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_GetAlphaType(OH_Pixelmap_Initia
515 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。515 * @param options 被操作的OH_Pixelmap_InitializationOptions指针。
516 * @param alphaType 透明度类型{@link PIXELMAP_ALPHA_TYPE}。516 * @param alphaType 透明度类型{@link PIXELMAP_ALPHA_TYPE}。
517 * @return IMAGE_SUCCESS:执行成功。\n517 * @return IMAGE_SUCCESS:执行成功。\n
518- * IMAGE_BAD_PARAMETER:参数错误518+ * IMAGE_BAD_PARAMETER:参数options为空
519 * @since 12519 * @since 12
520 */520 */
521Image_ErrorCode OH_PixelmapInitializationOptions_SetAlphaType(OH_Pixelmap_InitializationOptions *options,521Image_ErrorCode OH_PixelmapInitializationOptions_SetAlphaType(OH_Pixelmap_InitializationOptions *options,
@@ -550,7 +550,7 @@ Image_ErrorCode OH_PixelmapInitializationOptions_SetEditable(OH_Pixelmap_Initial
550 *550 *
551 * @param options 被释放的OH_Pixelmap_InitializationOptions指针。551 * @param options 被释放的OH_Pixelmap_InitializationOptions指针。
552 * @return IMAGE_SUCCESS:执行成功。\n552 * @return IMAGE_SUCCESS:执行成功。\n
553- * IMAGE_BAD_PARAMETER:参数错误553+ * IMAGE_BAD_PARAMETER:参数options为空
554 * @since 12554 * @since 12
555 */555 */
556Image_ErrorCode OH_PixelmapInitializationOptions_Release(OH_Pixelmap_InitializationOptions *options);556Image_ErrorCode OH_PixelmapInitializationOptions_Release(OH_Pixelmap_InitializationOptions *options);
@@ -568,7 +568,7 @@ typedef struct OH_Pixelmap_ImageInfo OH_Pixelmap_ImageInfo;
568 *568 *
569 * @param info 被创建的OH_Pixelmap_ImageInfo指针。569 * @param info 被创建的OH_Pixelmap_ImageInfo指针。
570 * @return IMAGE_SUCCESS:执行成功。\n570 * @return IMAGE_SUCCESS:执行成功。\n
571- * IMAGE_BAD_PARAMETER:参数错误571+ * IMAGE_BAD_PARAMETER:创建info对象失败
572 * @since 12572 * @since 12
573 */573 */
574Image_ErrorCode OH_PixelmapImageInfo_Create(OH_Pixelmap_ImageInfo **info);574Image_ErrorCode OH_PixelmapImageInfo_Create(OH_Pixelmap_ImageInfo **info);
@@ -579,7 +579,7 @@ Image_ErrorCode OH_PixelmapImageInfo_Create(OH_Pixelmap_ImageInfo **info);
579 * @param info 被操作的OH_Pixelmap_ImageInfo指针。579 * @param info 被操作的OH_Pixelmap_ImageInfo指针。
580 * @param width 图片宽,单位:像素。580 * @param width 图片宽,单位:像素。
581 * @return IMAGE_SUCCESS:执行成功。\n581 * @return IMAGE_SUCCESS:执行成功。\n
582- * IMAGE_BAD_PARAMETER:参数错误582+ * IMAGE_BAD_PARAMETER:参数info或者width为空
583 * @since 12583 * @since 12
584 */584 */
585Image_ErrorCode OH_PixelmapImageInfo_GetWidth(OH_Pixelmap_ImageInfo *info, uint32_t *width);585Image_ErrorCode OH_PixelmapImageInfo_GetWidth(OH_Pixelmap_ImageInfo *info, uint32_t *width);
@@ -590,7 +590,7 @@ Image_ErrorCode OH_PixelmapImageInfo_GetWidth(OH_Pixelmap_ImageInfo *info, uint3
590 * @param info 被操作的OH_Pixelmap_ImageInfo指针。590 * @param info 被操作的OH_Pixelmap_ImageInfo指针。
591 * @param height 图片高,单位:像素。591 * @param height 图片高,单位:像素。
592 * @return IMAGE_SUCCESS:执行成功。\n592 * @return IMAGE_SUCCESS:执行成功。\n
593- * IMAGE_BAD_PARAMETER:参数错误593+ * IMAGE_BAD_PARAMETER:参数info或者height为空
594 * @since 12594 * @since 12
595 */595 */
596Image_ErrorCode OH_PixelmapImageInfo_GetHeight(OH_Pixelmap_ImageInfo *info, uint32_t *height);596Image_ErrorCode OH_PixelmapImageInfo_GetHeight(OH_Pixelmap_ImageInfo *info, uint32_t *height);
@@ -612,7 +612,7 @@ Image_ErrorCode OH_PixelmapImageInfo_GetAlphaMode(OH_Pixelmap_ImageInfo *info, i
612 * @param info 被操作的OH_Pixelmap_ImageInfo指针。612 * @param info 被操作的OH_Pixelmap_ImageInfo指针。
613 * @param rowStride 跨距,内存中每行像素所占的空间。613 * @param rowStride 跨距,内存中每行像素所占的空间。
614 * @return IMAGE_SUCCESS:执行成功。\n614 * @return IMAGE_SUCCESS:执行成功。\n
615- * IMAGE_BAD_PARAMETER:参数错误615+ * IMAGE_BAD_PARAMETER:参数info或者rowStride为空
616 * @since 12616 * @since 12
617 */617 */
618Image_ErrorCode OH_PixelmapImageInfo_GetRowStride(OH_Pixelmap_ImageInfo *info, uint32_t *rowStride);618Image_ErrorCode OH_PixelmapImageInfo_GetRowStride(OH_Pixelmap_ImageInfo *info, uint32_t *rowStride);
@@ -623,7 +623,7 @@ Image_ErrorCode OH_PixelmapImageInfo_GetRowStride(OH_Pixelmap_ImageInfo *info, u
623 * @param info 被操作的OH_Pixelmap_ImageInfo指针。623 * @param info 被操作的OH_Pixelmap_ImageInfo指针。
624 * @param pixelFormat 像素格式{@link PIXEL_FORMAT}。624 * @param pixelFormat 像素格式{@link PIXEL_FORMAT}。
625 * @return IMAGE_SUCCESS:执行成功。\n625 * @return IMAGE_SUCCESS:执行成功。\n
626- * IMAGE_BAD_PARAMETER:参数错误626+ * IMAGE_BAD_PARAMETER:参数info或者pixelFormat为空
627 * @since 12627 * @since 12
628 */628 */
629Image_ErrorCode OH_PixelmapImageInfo_GetPixelFormat(OH_Pixelmap_ImageInfo *info, int32_t *pixelFormat);629Image_ErrorCode OH_PixelmapImageInfo_GetPixelFormat(OH_Pixelmap_ImageInfo *info, int32_t *pixelFormat);
@@ -634,7 +634,7 @@ Image_ErrorCode OH_PixelmapImageInfo_GetPixelFormat(OH_Pixelmap_ImageInfo *info,
634 * @param info 被操作的OH_Pixelmap_ImageInfo指针。634 * @param info 被操作的OH_Pixelmap_ImageInfo指针。
635 * @param alphaType 透明度类型{@link PIXELMAP_ALPHA_TYPE}。635 * @param alphaType 透明度类型{@link PIXELMAP_ALPHA_TYPE}。
636 * @return IMAGE_SUCCESS:执行成功。\n636 * @return IMAGE_SUCCESS:执行成功。\n
637- * IMAGE_BAD_PARAMETER:参数错误637+ * IMAGE_BAD_PARAMETER:参数info或者alphaType为空
638 * @since 12638 * @since 12
639 */639 */
640Image_ErrorCode OH_PixelmapImageInfo_GetAlphaType(OH_Pixelmap_ImageInfo *info, int32_t *alphaType);640Image_ErrorCode OH_PixelmapImageInfo_GetAlphaType(OH_Pixelmap_ImageInfo *info, int32_t *alphaType);
@@ -645,7 +645,7 @@ Image_ErrorCode OH_PixelmapImageInfo_GetAlphaType(OH_Pixelmap_ImageInfo *info, i
645 * @param info 被操作的OH_Pixelmap_ImageInfo指针。645 * @param info 被操作的OH_Pixelmap_ImageInfo指针。
646 * @param isHdr 表示是否为HDR。true表示是HDR,false表示不是HDR。646 * @param isHdr 表示是否为HDR。true表示是HDR,false表示不是HDR。
647 * @return IMAGE_SUCCESS:执行成功。\n647 * @return IMAGE_SUCCESS:执行成功。\n
648- * IMAGE_BAD_PARAMETER:参数校验错误 648+ * IMAGE_BAD_PARAMETER:参数info或者isHdr为空
649 * @since 12649 * @since 12
650 */650 */
651Image_ErrorCode OH_PixelmapImageInfo_GetDynamicRange(OH_Pixelmap_ImageInfo *info, bool *isHdr);651Image_ErrorCode OH_PixelmapImageInfo_GetDynamicRange(OH_Pixelmap_ImageInfo *info, bool *isHdr);
@@ -655,7 +655,7 @@ Image_ErrorCode OH_PixelmapImageInfo_GetDynamicRange(OH_Pixelmap_ImageInfo *info
655 *655 *
656 * @param info 被释放的OH_Pixelmap_ImageInfo指针。656 * @param info 被释放的OH_Pixelmap_ImageInfo指针。
657 * @return IMAGE_SUCCESS:执行成功。\n657 * @return IMAGE_SUCCESS:执行成功。\n
658- * IMAGE_BAD_PARAMETER:参数错误658+ * IMAGE_BAD_PARAMETER:参数info为空
659 * @since 12659 * @since 12
660 */660 */
661Image_ErrorCode OH_PixelmapImageInfo_Release(OH_Pixelmap_ImageInfo *info);661Image_ErrorCode OH_PixelmapImageInfo_Release(OH_Pixelmap_ImageInfo *info);
@@ -669,7 +669,9 @@ Image_ErrorCode OH_PixelmapImageInfo_Release(OH_Pixelmap_ImageInfo *info);
669 * @param pixelmap 被创建的OH_PixelmapNative对象指针。669 * @param pixelmap 被创建的OH_PixelmapNative对象指针。
670 * @return IMAGE_SUCCESS:执行成功。\n670 * @return IMAGE_SUCCESS:执行成功。\n
671 * IMAGE_BAD_PARAMETER:参数错误。\n671 * IMAGE_BAD_PARAMETER:参数错误。\n
672- * IMAGE_UNSUPPORTED_OPERATION:操作不支持。672+ * IMAGE_UNSUPPORTED_OPERATION:\n
673+ 1. 参数data或options为空;\n
674+ 2. 参数options无效导致创建pixelmap失败。
673 * @since 12675 * @since 12
674 */676 */
675Image_ErrorCode OH_PixelmapNative_CreatePixelmap(uint8_t *data, size_t dataLength,677Image_ErrorCode OH_PixelmapNative_CreatePixelmap(uint8_t *data, size_t dataLength,
@@ -998,7 +1000,9 @@ Image_ErrorCode OH_PixelmapNative_Destroy(OH_PixelmapNative **pixelmap);
998 * @param dstpixelmap 被操作的OH_PixelmapNative指针,目标pixelmap对象指针。1000 * @param dstpixelmap 被操作的OH_PixelmapNative指针,目标pixelmap对象指针。
999 * @param isPremul 转换方式,true为非预乘转预乘,false为预乘转非预乘。1001 * @param isPremul 转换方式,true为非预乘转预乘,false为预乘转非预乘。
1000 * @return IMAGE_SUCCESS:执行成功。\n1002 * @return IMAGE_SUCCESS:执行成功。\n
1001- * IMAGE_BAD_PARAMETER:参数错误。1003+ * IMAGE_BAD_PARAMETER:\n
1004+ * 1. 参数srcpixelmap或dstpixelmap为空;\n
1005+ * 2. 参数srcpixelmap或dstpixelmap所持有的inner pixelmap为空。
1002 * @since 121006 * @since 12
1003 */1007 */
1004Image_ErrorCode OH_PixelmapNative_ConvertAlphaFormat(OH_PixelmapNative* srcpixelmap,1008Image_ErrorCode OH_PixelmapNative_ConvertAlphaFormat(OH_PixelmapNative* srcpixelmap,
@@ -1010,7 +1014,9 @@ Image_ErrorCode OH_PixelmapNative_ConvertAlphaFormat(OH_PixelmapNative* srcpixel
1010 * @param options 创建像素的属性。1014 * @param options 创建像素的属性。
1011 * @param pixelmap 被创建的OH_PixelmapNative对象指针。1015 * @param pixelmap 被创建的OH_PixelmapNative对象指针。
1012 * @return IMAGE_SUCCESS:执行成功。\n1016 * @return IMAGE_SUCCESS:执行成功。\n
1013- * IMAGE_BAD_PARAMETER:参数错误。1017+ * IMAGE_BAD_PARAMETER:\n
1018+ * 1. 参数options为空或者无效的options导致创建pixelmap失败;\n
1019+ * 2. 参数options无效导致创建pixelmap失败。
1014 * @since 121020 * @since 12
1015 */1021 */
1016Image_ErrorCode OH_PixelmapNative_CreateEmptyPixelmap(OH_Pixelmap_InitializationOptions *options,1022Image_ErrorCode OH_PixelmapNative_CreateEmptyPixelmap(OH_Pixelmap_InitializationOptions *options,
@@ -174,8 +174,8 @@ struct OhosPixelMapCreateOps {
174 /** 图片的alpha类型。取值范围:\n174 /** 图片的alpha类型。取值范围:\n
175 * 0:未知透明度。\n175 * 0:未知透明度。\n
176 * 1:没有alpha或图片全透明。\n176 * 1:没有alpha或图片全透明。\n
177- * 2:RGB前alpha。\n177+ * 2:透明度格式。\n
178- * 3: RGB不前alpha 178+ * 3:非预透明度格式
179 */179 */
180 uint32_t alphaType;180 uint32_t alphaType;
181 /** 图片的缩放类型。取值范围:\n181 /** 图片的缩放类型。取值范围:\n