clutter/base-types: Clarify docs for point_inside_quadrilateral
The final version of the function was changed to allow points that are touching the edge of a quadrilateral to be counted as "inside". Update the function documentation to refect this. Also clarify that the function is written in such a way that it is agnostic to clockwise or anticlockwise vertex ordering. https://gitlab.gnome.org/GNOME/mutter/merge_requests/783
This commit is contained in:
parent
006eb6d81e
commit
26b76ee95d
@ -592,13 +592,13 @@ clutter_point_compare_line (const ClutterPoint *p,
|
|||||||
/**
|
/**
|
||||||
* clutter_point_inside_quadrilateral:
|
* clutter_point_inside_quadrilateral:
|
||||||
* @point: a #ClutterPoint to test
|
* @point: a #ClutterPoint to test
|
||||||
* @vertices: array of vertices of the quadrilateral, in clockwise order,
|
* @vertices: array of vertices of the quadrilateral, in either clockwise or
|
||||||
* from top-left to bottom-left
|
* anticlockwise order.
|
||||||
*
|
*
|
||||||
* Determines whether a point is inside the convex quadrilateral provided,
|
* Determines whether a point is inside the convex quadrilateral provided,
|
||||||
* and not on any of its edges or vertices.
|
* or on any of its edges or vertices.
|
||||||
*
|
*
|
||||||
* Returns: %TRUE if @point is inside the quadrilateral
|
* Returns: %TRUE if @point is inside or touching the quadrilateral
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
clutter_point_inside_quadrilateral (const ClutterPoint *point,
|
clutter_point_inside_quadrilateral (const ClutterPoint *point,
|
||||||
|
Loading…
x
Reference in New Issue
Block a user