git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-08 05:33:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

docs: minor changes (#868)

Browse source
This commit is contained in:
Mira Grudzinska 2021-10-04 10:03:48 +02:00 • committed by GitHub
parent 72727ea322
commit aeda0e0ad3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
inc/thorvg.h
View file

@ -293,25 +293,25 @@ public:
*/
TVG_DEPRECATED Result bounds(float* x, float* y, float* w, float* h) const noexcept;
/**
* @brief Gets the axis-aligned bounding box of the paint object.
*
* In case @p transform is @c true, all object's transformations are applied first, and then the bounding box is established. Otherwise, the bounding box is determined before any transformations.
*
* @param[out] x The x coordinate of the upper left corner of the object.
* @param[out] y The y coordinate of the upper left corner of the object.
* @param[out] w The width of the object.
* @param[out] h The height of the object.
* @param[in] transformed if @c true, apply the transformation of the paint.
* @param[in] transformed If @c true, the paint's transformations are taken into account, otherwise they aren't.
*
* @return Result::Success when succeed, Result::InsufficientCondition otherwise.
*
* @note The bounding box doesn't indicate the actual drawing region. It's the smallest rectangle that encloses the object.
*
*
* @BETA_API
*/
Result bounds(float* x, float* y, float* w, float* h, bool transformed) const noexcept;
/**
* @brief Duplicates the object.
*