cairo-close-path (cr)

cr -- a cairo-t context

Adds a line segment to the path from the current point to the beginning of the current sub-path, the most recent point passed to the cairo-move-to function, and closes this sub-path. After this call the current point will be at the joined endpoint of the sub-path.

The behavior of the cairo-close-path function is distinct from simply calling the cairo-line-to function with the equivalent coordinate in the case of stroking. When a closed sub-path is stroked, there are no caps on the ends of the sub-path. Instead, there is a line join connecting the final and initial segments of the sub-path.

If there is no current point before the call to the cairo-close-path function, this function will have no effect. As of Cairo version 1.2.4 any call to the cairo-close-path function will place an explicit :move-to element into the path immediately after the :close-path element, which can be seen in the cairo-copy-path function for example. This can simplify path processing in some cases as it may not be necessary to save the "last :move-to point" during processing as the :move-to immediately after the :close-path will provide that point.