cogl-path: Add documentation for the angles of cogl_path_arc

This adds documentation for how Cogl interprets the angles given to
cogl_path_arc.
This commit is contained in:
Neil Roberts 2010-04-22 18:03:57 +01:00
parent 308ca6cb14
commit 2b8abbdaa8

View File

@ -179,13 +179,19 @@ cogl_path_rel_line_to (float x,
* @center_y: Y coordinate of the elliptical arc center * @center_y: Y coordinate of the elliptical arc center
* @radius_x: X radius of the elliptical arc * @radius_x: X radius of the elliptical arc
* @radius_y: Y radius of the elliptical arc * @radius_y: Y radius of the elliptical arc
* @angle_1: Angle in the unit-circle at which the arc begin * @angle_1: Angle in degrees at which the arc begin
* @angle_2: Angle in the unit-circle at which the arc ends * @angle_2: Angle in degrees at which the arc ends
* *
* Adds an elliptical arc segment to the current path. A straight line * Adds an elliptical arc segment to the current path. A straight line
* segment will link the current pen location with the first vertex * segment will link the current pen location with the first vertex
* of the arc. If you perform a move_to to the arcs start just before * of the arc. If you perform a move_to to the arcs start just before
* drawing it you create a free standing arc. * drawing it you create a free standing arc.
*
* The angles are measured in degrees where 0° is in the direction of
* the positive X axis and 90° is in the direction of the positive Y
* axis. The angle of the arc begins at @angle_1 and heads towards
* @angle_2 (so if @angle_2 is less than @angle_1 it will decrease,
* otherwise it will increase).
**/ **/
void void
cogl_path_arc (float center_x, cogl_path_arc (float center_x,