From ebfc5f096a7cb655846be8bf9a3b7ccd8f6e6bed Mon Sep 17 00:00:00 2001 From: Giorgio Arena Date: Tue, 12 Dec 2017 14:50:25 +0000 Subject: COMPMID-556 Fix Color Convert documentation Change-Id: Iec0728cbe33be1c006499c7892841baf584485f7 Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/112908 Reviewed-by: Anthony Barbier Tested-by: Anthony Barbier --- arm_compute/core/CL/kernels/CLColorConvertKernel.h | 17 +++++++++-------- arm_compute/runtime/CL/functions/CLColorConvert.h | 17 +++++++++-------- arm_compute/runtime/NEON/functions/NEColorConvert.h | 17 +++++++++-------- 3 files changed, 27 insertions(+), 24 deletions(-) diff --git a/arm_compute/core/CL/kernels/CLColorConvertKernel.h b/arm_compute/core/CL/kernels/CLColorConvertKernel.h index 23f1c56c6f..edd05ef007 100644 --- a/arm_compute/core/CL/kernels/CLColorConvertKernel.h +++ b/arm_compute/core/CL/kernels/CLColorConvertKernel.h @@ -53,26 +53,27 @@ public: /** Set the input and output of the kernel * - * @param[in] input Source tensor - * @param[out] output Destination tensor + * @param[in] input Source tensor. Formats supported: RGBA8888/UYVY422/YUYV422/RGB888 + * @param[out] output Destination tensor. Formats supported: RGB888 (if the formats of @p input are RGBA8888/UYVY422/YUYV422), + * RGBA8888 (if the formats of @p input are UYVY422/YUYV422/RGB888/) */ void configure(const ICLTensor *input, ICLTensor *output); /** Set the input and output of the kernel * - * @param[in] input multi-planar source image - * @param[out] output single-planar destination image + * @param[in] input Multi-planar source image. Formats supported: NV12/NV21/IYUV + * @param[out] output Single-planar destination image. Formats supported: RGB888/RGBA8888 */ void configure(const ICLMultiImage *input, ICLImage *output); /** Set the input and output of the kernel * - * @param[in] input single-planar source image - * @param[out] output multi-planar destination image + * @param[in] input Single-planar source image. Formats supported: RGB888/RGBA8888/UYVY422/YUYV422 + * @param[out] output Multi-planar destination image. Formats supported: NV12/IYUV/YUV444 (if the formats of @p input are RGB888/RGB8888) */ void configure(const ICLImage *input, ICLMultiImage *output); /** Set the input and output of the kernel * - * @param[in] input multi-planar source image - * @param[out] output multi-planar destination image + * @param[in] input Multi-planar source image. Formats supported: NV12/NV21/IYUV + * @param[out] output Multi-planar destination image. Formats supported: YUV444/IYUV (if the formats of @p input are NV12/NV21)/NV12 (if the format of @p input is IYUV) */ void configure(const ICLMultiImage *input, ICLMultiImage *output); diff --git a/arm_compute/runtime/CL/functions/CLColorConvert.h b/arm_compute/runtime/CL/functions/CLColorConvert.h index 12457a0cf2..dd7de45478 100644 --- a/arm_compute/runtime/CL/functions/CLColorConvert.h +++ b/arm_compute/runtime/CL/functions/CLColorConvert.h @@ -41,26 +41,27 @@ class CLColorConvert : public ICLSimpleFunction public: /** Initialize the function's source, destination * - * @param[in] input The input single-planar tensor from which to convert - * @param[in] output The converted single-planar output tensor + * @param[in] input Source tensor. Formats supported: RGBA8888/UYVY422/YUYV422/RGB888 + * @param[out] output Destination tensor. Formats supported: RGB888 (if the formats of @p input are RGBA8888/UYVY422/YUYV422), + * RGBA8888 (if the formats of @p input are UYVY422/YUYV422/RGB888/) */ void configure(const ICLTensor *input, ICLTensor *output); /** Initialize the function's source, destination * - * @param[in] input The multi-planar input image from which to convert - * @param[in] output The converted single-planar output image + * @param[in] input Multi-planar source image. Formats supported: NV12/NV21/IYUV + * @param[out] output Single-planar destination image. Formats supported: RGB888/RGBA8888 */ void configure(const ICLMultiImage *input, ICLImage *output); /** Initialize the function's source, destination * - * @param[in] input The single-planar input image from which to convert - * @param[in] output The converted multi-planar output image + * @param[in] input Single-planar source image. Formats supported: RGB888/RGBA8888/UYVY422/YUYV422 + * @param[out] output Multi-planar destination image. Formats supported: NV12/IYUV/YUV444 (if the formats of @p input are RGB888/RGB8888) */ void configure(const ICLImage *input, ICLMultiImage *output); /** Initialize the function's source, destination * - * @param[in] input The multi-planar input image from which to convert - * @param[in] output The converted multi-planar output image + * @param[in] input Multi-planar source image. Formats supported: NV12/NV21/IYUV + * @param[out] output Multi-planar destination image. Formats supported: YUV444/IYUV (if the formats of @p input are NV12/NV21)/NV12 (if the format of @p input is IYUV) */ void configure(const ICLMultiImage *input, ICLMultiImage *output); }; diff --git a/arm_compute/runtime/NEON/functions/NEColorConvert.h b/arm_compute/runtime/NEON/functions/NEColorConvert.h index 2997778ed5..ab0bf14609 100644 --- a/arm_compute/runtime/NEON/functions/NEColorConvert.h +++ b/arm_compute/runtime/NEON/functions/NEColorConvert.h @@ -38,26 +38,27 @@ class NEColorConvert : public INESimpleFunction public: /** Initialize the function's source, destination * - * @param[in] input The input single-planar tensor from which to convert - * @param[in] output The converted single-planar output tensor + * @param[in] input Source tensor. Formats supported: RGBA8888/UYVY422/YUYV422/RGB888 + * @param[out] output Destination tensor. Formats supported: RGB888 (if the formats of @p input are RGBA8888/UYVY422/YUYV422), + * RGBA8888 (if the formats of @p input are UYVY422/YUYV422/RGB888/) */ void configure(const ITensor *input, ITensor *output); /** Initialize the function's source, destination * - * @param[in] input The multi-planar input image from which to convert - * @param[in] output The converted single-planar output image + * @param[in] input Multi-planar source image. Formats supported: NV12/NV21/IYUV + * @param[out] output Single-planar destination image. Formats supported: RGB888/RGBA8888 */ void configure(const IMultiImage *input, IImage *output); /** Initialize the function's source, destination * - * @param[in] input The single-planar input image from which to convert - * @param[in] output The converted multi-planar output image + * @param[in] input Single-planar source image. Formats supported: RGB888/RGBA8888/UYVY422/YUYV422 + * @param[out] output Multi-planar destination image. Formats supported: NV12/IYUV/YUV444 (if the formats of @p input are RGB888/RGB8888) */ void configure(const IImage *input, IMultiImage *output); /** Initialize the function's source, destination * - * @param[in] input The multi-planar input image from which to convert - * @param[in] output The converted multi-planar output image + * @param[in] input Multi-planar source image. Formats supported: NV12/NV21/IYUV + * @param[out] output Multi-planar destination image. Formats supported: YUV444/IYUV (if the formats of @p input are NV12/NV21)/NV12 (if the format of @p input is IYUV) */ void configure(const IMultiImage *input, IMultiImage *output); }; -- cgit v1.2.1