From 9ab2b37e3e110c1bee6c429e90a58e42eece6c8a Mon Sep 17 00:00:00 2001 From: "Seungho, Baek" Date: Thu, 2 Jul 2020 10:51:45 +0900 Subject: [PATCH] Add comment in the capture.h - Add @return comment at the GetNativeImageSource() Change-Id: Ic46eac21b4f138871ae5e1a7b9dc19140da85b9e Signed-off-by: Seungho, Baek --- dali/public-api/capture/capture.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/dali/public-api/capture/capture.h b/dali/public-api/capture/capture.h index 29ee5b5..d27865b 100755 --- a/dali/public-api/capture/capture.h +++ b/dali/public-api/capture/capture.h @@ -176,6 +176,7 @@ public: * @param[in] source source actor to be used for capture. * @param[in] size captured size. * @param[in] path image file path to be saved as a file. + * If path is empty string, the captured result is not be saved as a file. * @param[in] clearColor background color of captured scene * @param[in] quality The value to control image quality for jpeg file format in the range [1, 100] */ @@ -189,6 +190,7 @@ public: * @param[in] source source actor to be used for capture. * @param[in] size captured size. * @param[in] path image file path to be saved as a file. + * If path is empty string, the captured result is not be saved as a file. * @param[in] clearColor background color of captured scene */ void Start( Actor source, const Vector2& size, const std::string &path, const Vector4& clearColor ); @@ -201,6 +203,7 @@ public: * @param[in] source source actor to be used for capture. * @param[in] size captured size. * @param[in] path image file path to be saved as a file. + * If path is empty string, the captured result is not be saved as a file. * @note Clear color is transparent. */ void Start( Actor source, const Vector2& size, const std::string &path ); @@ -209,6 +212,8 @@ public: * @brief Get NativeImageSourcePtr that is saved captured image. * * @SINCE_1_5.10 + * + * @return NativeImageSourcePtr Captured result that can be rendered with DALi */ Dali::NativeImageSourcePtr GetNativeImageSource() const; -- 2.7.4