[Git][freetype/freetype][master] Document `FT_Outline_Decompose` degenerate segments.

[Werner Lemberg (@wl)]

Werner Lemberg pushed to branch master at FreeType / FreeType

Commits:

• e34a860a
  by Ben Wagner at 2022-01-27T21:49:47+01:00

  Document `FT_Outline_Decompose` degenerate segments.
  
  `FT_Outline_Decompose` does not filter out and can return degenerate
  segments in an outline. This can be surprising when attemping to
  stroke such an outline. Clarify the existing documentation on this
  matter to cover all forms of degeneracy (without specifying exactly
  how they will be reported), why they might arise, and better explain in
  what cases they may be an issue.
  
  * include/freetype/ftoutlin.h (FT_Outline_Decompose): update
  documentation.
  
  Fixes #952.
  

1 changed file:

• include/freetype/ftoutln.h

Changes:

include/freetype/ftoutln.h

---

...	...	@@ -109,11 +109,13 @@ FT_BEGIN_HEADER
109	109	* FreeType error code. 0~means success.
110	110	*
111	111	* @note:
112		- * A contour that contains a single point only is represented by a 'move
113		- * to' operation followed by 'line to' to the same point. In most cases,
114		- * it is best to filter this out before using the outline for stroking
115		- * purposes (otherwise it would result in a visible dot when round caps
116		- * are used).
	112	+ * Degenerate contours, segments, and Bezier arcs may be reported. In
	113	+ * most cases, it is best to filter these out before using the outline
	114	+ * for stroking or other path modification purposes (which may cause
	115	+ * degenerate segments to become non-degenrate and visible, like when
	116	+ * stroke caps are used or the path is otherwise outset). Some glyph
	117	+ * outlines may contain deliberate degenerate single points for mark
	118	+ * attachement.
117	119	*
118	120	* Similarly, the function returns success for an empty outline also
119	121	* (doing nothing, this is, not calling any emitter); if necessary, you

—
View it on GitLab.
You're receiving this email because of your account on gitlab.freedesktop.org. If you'd like to receive fewer emails, you can adjust your notification settings.