diff options
Diffstat (limited to 'docs/reference/ft2-multiple_masters.html')
| -rw-r--r-- | docs/reference/ft2-multiple_masters.html | 173 |
1 files changed, 136 insertions, 37 deletions
diff --git a/docs/reference/ft2-multiple_masters.html b/docs/reference/ft2-multiple_masters.html index 9085e8d..2a69f91 100644 --- a/docs/reference/ft2-multiple_masters.html +++ b/docs/reference/ft2-multiple_masters.html @@ -3,7 +3,7 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>FreeType-2.6.5 API Reference</title> +<title>FreeType-2.8 API Reference</title> <style type="text/css"> a:link { color: #0000EF; } a:visited { color: #51188E; } @@ -100,22 +100,23 @@ <body> <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table> -<h1>FreeType-2.6.5 API Reference</h1> +<h1>FreeType-2.8 API Reference</h1> <h1 id="multiple_masters">Multiple Masters</h1> <h2>Synopsis</h2> <table class="synopsis"> -<tr><td><a href="#FT_MM_Axis">FT_MM_Axis</a></td><td><a href="#FT_Get_MM_Var">FT_Get_MM_Var</a></td></tr> -<tr><td><a href="#FT_Multi_Master">FT_Multi_Master</a></td><td><a href="#FT_Set_MM_Design_Coordinates">FT_Set_MM_Design_Coordinates</a></td></tr> -<tr><td><a href="#FT_Var_Axis">FT_Var_Axis</a></td><td><a href="#FT_Set_Var_Design_Coordinates">FT_Set_Var_Design_Coordinates</a></td></tr> +<tr><td><a href="#FT_MM_Axis">FT_MM_Axis</a></td><td><a href="#FT_Set_MM_Design_Coordinates">FT_Set_MM_Design_Coordinates</a></td></tr> +<tr><td><a href="#FT_Multi_Master">FT_Multi_Master</a></td><td><a href="#FT_Set_Var_Design_Coordinates">FT_Set_Var_Design_Coordinates</a></td></tr> +<tr><td><a href="#FT_Var_Axis">FT_Var_Axis</a></td><td><a href="#FT_Get_Var_Design_Coordinates">FT_Get_Var_Design_Coordinates</a></td></tr> <tr><td><a href="#FT_Var_Named_Style">FT_Var_Named_Style</a></td><td><a href="#FT_Set_MM_Blend_Coordinates">FT_Set_MM_Blend_Coordinates</a></td></tr> -<tr><td><a href="#FT_MM_Var">FT_MM_Var</a></td><td><a href="#FT_Set_Var_Blend_Coordinates">FT_Set_Var_Blend_Coordinates</a></td></tr> -<tr><td><a href="#FT_Get_Multi_Master">FT_Get_Multi_Master</a></td><td></td></tr> +<tr><td><a href="#FT_MM_Var">FT_MM_Var</a></td><td><a href="#FT_Get_MM_Blend_Coordinates">FT_Get_MM_Blend_Coordinates</a></td></tr> +<tr><td><a href="#FT_Get_Multi_Master">FT_Get_Multi_Master</a></td><td><a href="#FT_Set_Var_Blend_Coordinates">FT_Set_Var_Blend_Coordinates</a></td></tr> +<tr><td><a href="#FT_Get_MM_Var">FT_Get_MM_Var</a></td><td><a href="#FT_Get_Var_Blend_Coordinates">FT_Get_Var_Blend_Coordinates</a></td></tr> </table> <p>The following types and functions are used to manage Multiple Master fonts, i.e., the selection of specific design instances by setting design axis coordinates.</p> -<p>George Williams has extended this interface to make it work with both Type 1 Multiple Masters fonts and GX distortable (var) fonts. Some of these routines only work with MM fonts, others will work with both types. They are similar enough that a consistent interface makes sense.</p> +<p>Besides Adobe MM fonts, the interface supports Apple's TrueType GX and OpenType variation fonts. Some of the routines only work with Adobe MM fonts, others will work with all three types. They are similar enough that a consistent interface makes sense.</p> <div class="section"> <h3 id="FT_MM_Axis">FT_MM_Axis</h3> @@ -130,8 +131,8 @@ } <b>FT_MM_Axis</b>; </pre> -<p>A simple structure used to model a given axis in design space for Multiple Masters fonts.</p> -<p>This structure can't be used for GX var fonts.</p> +<p>A structure to model a given axis in design space for Multiple Masters fonts.</p> +<p>This structure can't be used for TrueType GX or OpenType variation fonts.</p> <h4>fields</h4> <table class="fields"> @@ -162,8 +163,8 @@ } <b>FT_Multi_Master</b>; </pre> -<p>A structure used to model the axes and space of a Multiple Masters font.</p> -<p>This structure can't be used for GX var fonts.</p> +<p>A structure to model the axes and space of a Multiple Masters font.</p> +<p>This structure can't be used for TrueType GX or OpenType variation fonts.</p> <h4>fields</h4> <table class="fields"> @@ -199,30 +200,33 @@ } <b>FT_Var_Axis</b>; </pre> -<p>A simple structure used to model a given axis in design space for Multiple Masters and GX var fonts.</p> +<p>A structure to model a given axis in design space for Multiple Masters, TrueType GX, and OpenType variation fonts.</p> <h4>fields</h4> <table class="fields"> <tr><td class="val" id="name">name</td><td class="desc"> -<p>The axis's name. Not always meaningful for GX.</p> +<p>The axis's name. Not always meaningful for TrueType GX or OpenType variation fonts.</p> </td></tr> <tr><td class="val" id="minimum">minimum</td><td class="desc"> <p>The axis's minimum design coordinate.</p> </td></tr> <tr><td class="val" id="def">def</td><td class="desc"> -<p>The axis's default design coordinate. FreeType computes meaningful default values for MM; it is then an integer value, not in 16.16 format.</p> +<p>The axis's default design coordinate. FreeType computes meaningful default values for Adobe MM fonts.</p> </td></tr> <tr><td class="val" id="maximum">maximum</td><td class="desc"> <p>The axis's maximum design coordinate.</p> </td></tr> <tr><td class="val" id="tag">tag</td><td class="desc"> -<p>The axis's tag (the GX equivalent to ‘name’). FreeType provides default values for MM if possible.</p> +<p>The axis's tag (the equivalent to ‘name’ for TrueType GX and OpenType variation fonts). FreeType provides default values for Adobe MM fonts if possible.</p> </td></tr> <tr><td class="val" id="strid">strid</td><td class="desc"> -<p>The entry in ‘name’ table (another GX version of ‘name’). Not meaningful for MM.</p> +<p>The axis name entry in the font's ‘name’ table. This is another (and often better) version of the ‘name’ field for TrueType GX or OpenType variation fonts. Not meaningful for Adobe MM fonts.</p> </td></tr> </table> +<h4>note</h4> +<p>The fields ‘minimum’, ‘def’, and ‘maximum’ are 16.16 fractional values for TrueType GX and OpenType variation fonts. For Adobe MM fonts, the values are integers.</p> + <hr> <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div> @@ -234,20 +238,24 @@ { <a href="ft2-basic_types.html#FT_Fixed">FT_Fixed</a>* coords; <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> strid; + <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> psid; /* since 2.7.1 */ } <b>FT_Var_Named_Style</b>; </pre> -<p>A simple structure used to model a named style in a GX var font.</p> -<p>This structure can't be used for MM fonts.</p> +<p>A structure to model a named instance in a TrueType GX or OpenType variation font.</p> +<p>This structure can't be used for Adobe MM fonts.</p> <h4>fields</h4> <table class="fields"> <tr><td class="val" id="coords">coords</td><td class="desc"> -<p>The design coordinates for this style. This is an array with one entry for each axis.</p> +<p>The design coordinates for this instance. This is an array with one entry for each axis.</p> </td></tr> <tr><td class="val" id="strid">strid</td><td class="desc"> -<p>The entry in ‘name’ table identifying this style.</p> +<p>The entry in ‘name’ table identifying this instance.</p> +</td></tr> +<tr><td class="val" id="psid">psid</td><td class="desc"> +<p>The entry in ‘name’ table identifying a PostScript name for this instance.</p> </td></tr> </table> @@ -269,25 +277,26 @@ } <b>FT_MM_Var</b>; </pre> -<p>A structure used to model the axes and space of a Multiple Masters or GX var distortable font.</p> -<p>Some fields are specific to one format and not to the other.</p> +<p>A structure to model the axes and space of a Adobe MM, TrueType GX, or OpenType variation font.</p> +<p>Some fields are specific to one format and not to the others.</p> <h4>fields</h4> <table class="fields"> <tr><td class="val" id="num_axis">num_axis</td><td class="desc"> -<p>The number of axes. The maximum value is 4 for MM; no limit in GX.</p> +<p>The number of axes. The maximum value is 4 for Adobe MM fonts; no limit in TrueType GX or OpenType variation fonts.</p> </td></tr> <tr><td class="val" id="num_designs">num_designs</td><td class="desc"> -<p>The number of designs; should be normally 2^num_axis for MM fonts. Not meaningful for GX (where every glyph could have a different number of designs).</p> +<p>The number of designs; should be normally 2^num_axis for Adobe MM fonts. Not meaningful for TrueType GX or OpenType variation fonts (where every glyph could have a different number of designs).</p> </td></tr> <tr><td class="val" id="num_namedstyles">num_namedstyles</td><td class="desc"> -<p>The number of named styles; only meaningful for GX that allows certain design coordinates to have a string ID (in the ‘name’ table) associated with them. The font can tell the user that, for example, Weight=1.5 is ‘Bold’.</p> +<p>The number of named styles; a ‘named style’ is a tuple of design coordinates that has a string ID (in the ‘name’ table) associated with it. The font can tell the user that, for example, [Weight=1.5,Width=1.1] is ‘Bold’. Another name for ‘named style’ is ‘named instance’.</p> +<p>For Adobe Multiple Masters fonts, this value is always zero because the format does not support named styles.</p> </td></tr> <tr><td class="val" id="axis">axis</td><td class="desc"> -<p>An axis descriptor table. GX fonts contain slightly more data than MM. Memory management of this pointer is done internally by FreeType.</p> +<p>An axis descriptor table. TrueType GX and OpenType variation fonts contain slightly more data than Adobe MM fonts. Memory management of this pointer is done internally by FreeType.</p> </td></tr> <tr><td class="val" id="namedstyle">namedstyle</td><td class="desc"> -<p>A named style table. Only meaningful with GX. Memory management of this pointer is done internally by FreeType.</p> +<p>A named style (instance) table. Only meaningful for TrueType GX and OpenType variation fonts. Memory management of this pointer is done internally by FreeType.</p> </td></tr> </table> @@ -303,8 +312,8 @@ <a href="ft2-multiple_masters.html#FT_Multi_Master">FT_Multi_Master</a> *amaster ); </pre> -<p>Retrieve the Multiple Master descriptor of a given font.</p> -<p>This function can't be used with GX fonts.</p> +<p>Retrieve a variation descriptor of a given Adobe MM font.</p> +<p>This function can't be used with TrueType GX or OpenType variation fonts.</p> <h4>input</h4> <table class="fields"> @@ -335,7 +344,8 @@ <a href="ft2-multiple_masters.html#FT_MM_Var">FT_MM_Var</a>* *amaster ); </pre> -<p>Retrieve the Multiple Master/GX var descriptor of a given font.</p> +<p>Retrieve a variation descriptor for a given font.</p> +<p>This function works with all supported variation formats.</p> <h4>input</h4> <table class="fields"> @@ -347,7 +357,7 @@ <h4>output</h4> <table class="fields"> <tr><td class="val" id="amaster">amaster</td><td class="desc"> -<p>The Multiple Masters/GX var descriptor. Allocates a data structure, which the user must deallocate with ‘free’ after use.</p> +<p>The variation descriptor. Allocates a data structure, which the user must deallocate with ‘free’ after use.</p> </td></tr> </table> @@ -367,8 +377,8 @@ <a href="ft2-basic_types.html#FT_Long">FT_Long</a>* coords ); </pre> -<p>For Multiple Masters fonts, choose an interpolated font design through design coordinates.</p> -<p>This function can't be used with GX fonts.</p> +<p>For Adobe MM fonts, choose an interpolated font design through design coordinates.</p> +<p>This function can't be used with TrueType GX or OpenType variation fonts.</p> <h4>inout</h4> <table class="fields"> @@ -403,7 +413,8 @@ <a href="ft2-basic_types.html#FT_Fixed">FT_Fixed</a>* coords ); </pre> -<p>For Multiple Master or GX Var fonts, choose an interpolated font design through design coordinates.</p> +<p>Choose an interpolated font design through design coordinates.</p> +<p>This function works with all supported variation formats.</p> <h4>inout</h4> <table class="fields"> @@ -429,6 +440,42 @@ <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div> <div class="section"> +<h3 id="FT_Get_Var_Design_Coordinates">FT_Get_Var_Design_Coordinates</h3> +<p>Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h).</p> +<pre> + FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) + <b>FT_Get_Var_Design_Coordinates</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a> face, + <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> num_coords, + <a href="ft2-basic_types.html#FT_Fixed">FT_Fixed</a>* coords ); +</pre> + +<p>Get the design coordinates of the currently selected interpolated font.</p> +<p>This function works with all supported variation formats.</p> + +<h4>input</h4> +<table class="fields"> +<tr><td class="val" id="face">face</td><td class="desc"> +<p>A handle to the source face.</p> +</td></tr> +<tr><td class="val" id="num_coords">num_coords</td><td class="desc"> +<p>The number of design coordinates to retrieve. If it is larger than the number of axes, set the excess values to 0.</p> +</td></tr> +</table> + +<h4>output</h4> +<table class="fields"> +<tr><td class="val" id="coords">coords</td><td class="desc"> +<p>The design coordinates array.</p> +</td></tr> +</table> + +<h4>return</h4> +<p>FreeType error code. 0 means success.</p> + +<hr> +<table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div> + +<div class="section"> <h3 id="FT_Set_MM_Blend_Coordinates">FT_Set_MM_Blend_Coordinates</h3> <p>Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h).</p> <pre> @@ -438,7 +485,8 @@ <a href="ft2-basic_types.html#FT_Fixed">FT_Fixed</a>* coords ); </pre> -<p>For Multiple Masters and GX var fonts, choose an interpolated font design through normalized blend coordinates.</p> +<p>Choose an interpolated font design through normalized blend coordinates.</p> +<p>This function works with all supported variation formats.</p> <h4>inout</h4> <table class="fields"> @@ -453,7 +501,43 @@ <p>The number of available design coordinates. If it is larger than the number of axes, ignore the excess values. If it is smaller than the number of axes, use default values for the remaining axes.</p> </td></tr> <tr><td class="val" id="coords">coords</td><td class="desc"> -<p>The design coordinates array (each element must be between 0 and 1.0).</p> +<p>The design coordinates array (each element must be between 0 and 1.0 for Adobe MM fonts, and between -1.0 and 1.0 for TrueType GX and OpenType variation fonts).</p> +</td></tr> +</table> + +<h4>return</h4> +<p>FreeType error code. 0 means success.</p> + +<hr> +<table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div> + +<div class="section"> +<h3 id="FT_Get_MM_Blend_Coordinates">FT_Get_MM_Blend_Coordinates</h3> +<p>Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h).</p> +<pre> + FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) + <b>FT_Get_MM_Blend_Coordinates</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a> face, + <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> num_coords, + <a href="ft2-basic_types.html#FT_Fixed">FT_Fixed</a>* coords ); +</pre> + +<p>Get the normalized blend coordinates of the currently selected interpolated font.</p> +<p>This function works with all supported variation formats.</p> + +<h4>input</h4> +<table class="fields"> +<tr><td class="val" id="face">face</td><td class="desc"> +<p>A handle to the source face.</p> +</td></tr> +<tr><td class="val" id="num_coords">num_coords</td><td class="desc"> +<p>The number of normalized blend coordinates to retrieve. If it is larger than the number of axes, set the excess values to 0.5 for Adobe MM fonts, and to 0 for TrueType GX and OpenType variation fonts.</p> +</td></tr> +</table> + +<h4>output</h4> +<table class="fields"> +<tr><td class="val" id="coords">coords</td><td class="desc"> +<p>The normalized blend coordinates array.</p> </td></tr> </table> @@ -478,5 +562,20 @@ <hr> <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div> +<div class="section"> +<h3 id="FT_Get_Var_Blend_Coordinates">FT_Get_Var_Blend_Coordinates</h3> +<p>Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h).</p> +<pre> + FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) + <b>FT_Get_Var_Blend_Coordinates</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a> face, + <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> num_coords, + <a href="ft2-basic_types.html#FT_Fixed">FT_Fixed</a>* coords ); +</pre> + +<p>This is another name of <a href="ft2-multiple_masters.html#FT_Get_MM_Blend_Coordinates">FT_Get_MM_Blend_Coordinates</a>.</p> + +<hr> +<table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div> + </body> </html> |