zakarya/puzzles
1
0
Fork 0
mirror of git://git.tartarus.org/simon/puzzles.git synced 2025-04-21 08:01:30 -07:00
Code Issues Packages Projects Releases Wiki Activity

Clarify documentation of draw_polygon()'s coordinate format.

Browse Source 
Previously, this function's documentation just stated that `coords`
contained the X and Y coordinates of the polygon's vertices, without
specifying in what order they were listed. Thus, it would have been
reasonable to (wrongly) assume that all the X coordinates were listed
in the first half of the array, followed by all the Y coordinates.

Now it's clear that each point's X and Y coordinates are stored
directly next to each other, and in that order.
This commit is contained in:
Franklin Wei
2024-08-11 20:57:51 -04:00
committed by Simon Tatham
parent 2a57df6be9
commit a993fd45eb
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
devel.but
View File

@ -2162,7 +2162,11 @@ This function may be used for both drawing and printing.
Draws an outlined or filled polygon in the puzzle window. Draws an outlined or filled polygon in the puzzle window.
\c{coords} is an array of \cw{(2*npoints)} integers, containing the \c{coords} is an array of \cw{(2*npoints)} integers, containing the
\c{x} and \c{y} coordinates of \c{npoints} vertices. \c{x} and \c{y} coordinates of \c{npoints} vertices. The \c{x} and
\c{y} coordinates are stored in interleaved order, with each vertex's
\c{x} coordinate before its \c{y} coordinate. For example, the first
vertex's \c{x} and \c{y} coordinates are \c{coords[0]} and
\c{coords[1]}, respectively.
\c{fillcolour} and \c{outlinecolour} are integer indices into the \c{fillcolour} and \c{outlinecolour} are integer indices into the
colours array returned by the back end function \cw{colours()} colours array returned by the back end function \cw{colours()}