git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-15 04:24:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

doc: make it up missing parameter information.

Browse source
This commit is contained in:
Hermet Park 2023-11-08 11:06:23 +09:00 • committed by Hermet Park
parent d1bae0b44c
commit 2082343463
2 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
inc/thorvg.h
View file

@ -1274,12 +1274,19 @@ public:
/** /**
* @brief Loads a raw data from a memory block with a given size. * @brief Loads a raw data from a memory block with a given size.
* *
* @param[in] paint A Tvg_Paint pointer to the picture object.
* @param[in] data A pointer to a memory location where the content of the picture raw data is stored.
* @param[in] w The width of the image @p data in pixels.
* @param[in] h The height of the image @p data in pixels.
* @param[in] premultiplied If @c true, the given image data is alpha-premultiplied.
* @param[in] copy If @c true the data are copied into the engine local buffer, otherwise they are not.
*
* @retval Result::Success When succeed, Result::InsufficientCondition otherwise. * @retval Result::Success When succeed, Result::InsufficientCondition otherwise.
* @retval Result::FailedAllocation An internal error possibly with memory allocation. * @retval Result::FailedAllocation An internal error possibly with memory allocation.
* *
* @since 0.9 * @since 0.9
*/ */
Result load(uint32_t* data, uint32_t w, uint32_t h, bool premultiplied, bool copy) noexcept; Result load(uint32_t* data, uint32_t w, uint32_t h, bool premultiplied, bool copy = false) noexcept;
/** /**
* @brief Sets or removes the triangle mesh to deform the image. * @brief Sets or removes the triangle mesh to deform the image.

7
src/bindings/capi/thorvg_capi.h
View file

@ -1968,6 +1968,13 @@ TVG_API Tvg_Result tvg_picture_load(Tvg_Paint* paint, const char* path);
/*! /*!
* \brief Loads a picture data from a memory block of a given size. * \brief Loads a picture data from a memory block of a given size.
* *
* \param[in] paint A Tvg_Paint pointer to the picture object.
* \param[in] data A pointer to a memory location where the content of the picture raw data is stored.
* \param[in] w The width of the image @p data in pixels.
* \param[in] h The height of the image @p data in pixels.
* \param[in] premultiplied If @c true, the given image data is alpha-premultiplied.
* \param[in] copy If @c true the data are copied into the engine local buffer, otherwise they are not.
*
* \return Tvg_Result enumeration. * \return Tvg_Result enumeration.
* \retval TVG_RESULT_SUCCESS Succeed. * \retval TVG_RESULT_SUCCESS Succeed.
* \retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer or no data are provided or the @p width or @p height value is zero or less. * \retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Paint pointer or no data are provided or the @p width or @p height value is zero or less.