kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

eina: define the in/out params for eina_bezier 

Reviewers: cedric

Differential Revision: https://phab.enlightenment.org/D5835

Signed-off-by: Cedric Bail <cedric@osg.samsung.com>
This commit is contained in:
Bryce Harrington 2018-03-06 16:58:44 -08:00 committed by Cedric Bail
parent 75a2dbf0d3
commit 3b508dfc19
1 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
src/lib/eina/eina_bezier.h
View File

@ -51,15 +51,15 @@ struct _Eina_Bezier
* @brief Sets the values of the points of the given floating
* point cubic bezier curve.
*
* @param b The floating point bezier.
* @param start_x The x coordinate of the start point.
* @param start_y The y coordinate of the start point.
* @param ctrl_start_x The x coordinate of the 1st control point.
* @param ctrl_start_y The y coordinate of the 1st control point.
* @param ctrl_end_x The X coordinate of the 2nd control point.
* @param ctrl_end_y The Y coordinate of the 2nd control point.
* @param end_x The X coordinate of the end point.
* @param end_y The Y coordinate of the end point.
* @param b[out] The floating point bezier.
* @param start_x[in] The x coordinate of the start point.
* @param start_y[in] The y coordinate of the start point.
* @param ctrl_start_x[in] The x coordinate of the 1st control point.
* @param ctrl_start_y[in] The y coordinate of the 1st control point.
* @param ctrl_end_x[in] The X coordinate of the 2nd control point.
* @param ctrl_end_y[in] The Y coordinate of the 2nd control point.
* @param end_x[in] The X coordinate of the end point.
* @param end_y[in] The Y coordinate of the end point.
*
* @p b. No check is done on @p b.
* @since 1.16
@ -70,15 +70,15 @@ EAPI void eina_bezier_values_set(Eina_Bezier *b, double start_x, double start_y,
* @brief Gets the values of the points of the given floating
* point cubic bezier curve.
*
* @param b The floating point bezier.
* @param start_x x coordinate of start point.
* @param start_y y coordinate of start point.
* @param ctrl_start_x x coordinate of 1st control point.
* @param ctrl_start_y y coordinate of 1st control point.
* @param ctrl_end_x x coordinate of 2nd control point.
* @param ctrl_end_y y coordinate of 2nd control point.
* @param end_x x coordinate of end point.
* @param end_y y coordinate of end point.
* @param[in] b The floating point bezier.
* @param[out] start_x x coordinate of start point.
* @param[out] start_y y coordinate of start point.
* @param[out] ctrl_start_x x coordinate of 1st control point.
* @param[out] ctrl_start_y y coordinate of 1st control point.
* @param[out] ctrl_end_x x coordinate of 2nd control point.
* @param[out] ctrl_end_y y coordinate of 2nd control point.
* @param[out] end_x x coordinate of end point.
* @param[out] end_y y coordinate of end point.
*
* @p b. No check is done on @p b.
* @since 1.16
@ -89,7 +89,7 @@ EAPI void eina_bezier_values_get(const Eina_Bezier *b, double *start_x, double *
* @brief Calculates the length of the given floating point cubic bezier
* curve.
*
* @param b The floating point bezier.
* @param[in] b The floating point bezier.
*
* @p b. No check is done on @p b.
* @since 1.16
@ -99,8 +99,8 @@ EAPI double eina_bezier_length_get(const Eina_Bezier *b) EINA_ARG_NONNULL(1);
/**
* @brief Returns the relative position on a bezier at a given length.
*
* @param b The floating point bezier.
* @param len The length along the bezier curve.
* @param[in] b The floating point bezier.
* @param[in] len The length along the bezier curve.
*
* Calculates the proportional location on @p b as a number from
* 0.0 to 1.0 that corresponds to a distance @p len along it.
@ -113,8 +113,8 @@ EAPI double eina_bezier_t_at(const Eina_Bezier *b, double len) EINA_ARG_NONNULL(
/**
* @brief Gets the point on the bezier curve at position t.
*
* @param b The floating point bezier.
* @param t The floating point position between 0.0 and 1.0.
* @param[in] b The floating point bezier.
* @param[in] t The floating point position between 0.0 and 1.0.
* @param[out] px The corresponding point's X coordinate.
* @param[out] py The corresponding point's Y coordinate.
*
@ -126,8 +126,8 @@ EAPI void eina_bezier_point_at(const Eina_Bezier *b, double t, double *px, doubl
/**
* @brief Determines the slope of the bezier at a given position.
*
* @param b The floating point bezier.
* @param t The position along the bezier between 0.0 and 1.0.
* @param[in] b The floating point bezier.
* @param[out] t The position along the bezier between 0.0 and 1.0.
*
* @p b. No check is done on @p b.
* @since 1.16
@ -137,8 +137,8 @@ EAPI double eina_bezier_angle_at(const Eina_Bezier *b, double t) EINA_ARG_NONNUL
/**
* @brief Splits the bezier at a given length.
*
* @param b The floating point bezier.
* @param len The length along the bezier to make the split.
* @param[in] b The floating point bezier.
* @param[in] len The length along the bezier to make the split.
* @param[out] left The resultant split's left portion of the bezier.
* @param[out] right The resultant split's right portion of the bezier.
*
@ -150,11 +150,11 @@ EAPI void eina_bezier_split_at_length(const Eina_Bezier *b, double len, Eina_Bez
/**
* @brief Calculates and returns the bounding box for the bezier.
*
* @param b The floating point bezier.
* @param x The X coordinate of the bounding box.
* @param y The Y coordinate of the bounding box.
* @param w The width of the bounding box.
* @param h The height of the bounding box.
* @param[in] b The floating point bezier.
* @param[out] x The X coordinate of the bounding box.
* @param[out] y The Y coordinate of the bounding box.
* @param[out] w The width of the bounding box.
* @param[out] h The height of the bounding box.
*
* @p b. No check is done on @p b.
* @since 1.17
@ -164,10 +164,10 @@ EAPI void eina_bezier_bounds_get(const Eina_Bezier *b, double *x, double *y, dou
/**
* @brief Finds the bezier between the given interval.
*
* @param b The floating point bezier.
* @param t0 The start of the interval.
* @param t1 The end of the interval.
* @param result The resulting bezier.
* @param[in] b The floating point bezier.
* @param[in] t0 The start of the interval.
* @param[in] t1 The end of the interval.
* @param[out] result The resulting bezier.
*
* @p b. No check is done on @p b.
* @since 1.17