Skip to content

Commit

Permalink
Add doc for cubicToQuadratic
Browse files Browse the repository at this point in the history
  • Loading branch information
madig committed Nov 7, 2018
1 parent a4398bd commit e77743f
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,34 @@ Using code allows you to define an inclusion function (not available for exclusi
``cubicToQuadratic``
^^^^^^^^^^^^^^^^^^^^

What it does...
Converts outlines from cubic (PostScript flavor) to quadratic (TrueType flavor).
It is run by default when producing TrueType-flavored OpenType fonts. Honors the
UFO's ``com.github.googlei18n.cu2qu.curve_type`` lib key.

Example...
.. code:: xml
When to use...
<key>com.github.googlei18n.ufo2ft.filters</key>
<array>
<dict>
<key>name</key>
<string>cubicToQuadratic</key>
<!-- Optionally, the filter can save the result of the conversion
to the UFO's lib key "com.github.googlei18n.cu2qu.curve_type",
which can be either "cubic" or "quadratic". This avoids
running the filter on it again. You can also manually set the
lib key to "quadratic" if your font is made using quadratic
curves, which saves you explicit configuration here or with
fontmake. -->
<key>rememberCurveType</key>
<true /> <!-- The default. -->
</dict>
</array>
When not to use...
When to use: Your font is drawn using cubic curves and you want to produce a
TrueType-flavored OpenType font.

When not to use: Your font is drawn using quadratic curves and you want to
produce a TrueType-flavored OpenType font.

``decomposeComponents``
^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit e77743f

Please sign in to comment.