diff options
Diffstat (limited to 'modules/freetype2/docs/reference/ft2-module_management.html')
| -rw-r--r-- | modules/freetype2/docs/reference/ft2-module_management.html | 85 |
1 files changed, 65 insertions, 20 deletions
diff --git a/modules/freetype2/docs/reference/ft2-module_management.html b/modules/freetype2/docs/reference/ft2-module_management.html index 52d364781..b14dae4cc 100644 --- a/modules/freetype2/docs/reference/ft2-module_management.html +++ b/modules/freetype2/docs/reference/ft2-module_management.html @@ -1,9 +1,9 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> +"https://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>FreeType-2.7.1 API Reference</title> +<title>FreeType-2.9.1 API Reference</title> <style type="text/css"> a:link { color: #0000EF; } a:visited { color: #51188E; } @@ -100,20 +100,25 @@ <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.7.1 API Reference</h1> +<h1>FreeType-2.9.1 API Reference</h1> <h1 id="module_management">Module Management</h1> <h2>Synopsis</h2> <table class="synopsis"> -<tr><td><a href="#FT_Module">FT_Module</a></td><td><a href="#FT_Add_Default_Modules">FT_Add_Default_Modules</a></td><td><a href="#FT_Renderer">FT_Renderer</a></td></tr> -<tr><td><a href="#FT_Module_Constructor">FT_Module_Constructor</a></td><td> </td><td><a href="#FT_Renderer_Class">FT_Renderer_Class</a></td></tr> -<tr><td><a href="#FT_Module_Destructor">FT_Module_Destructor</a></td><td><a href="#FT_Property_Set">FT_Property_Set</a></td><td> </td></tr> -<tr><td><a href="#FT_Module_Requester">FT_Module_Requester</a></td><td><a href="#FT_Property_Get">FT_Property_Get</a></td><td><a href="#FT_Get_Renderer">FT_Get_Renderer</a></td></tr> -<tr><td><a href="#FT_Module_Class">FT_Module_Class</a></td><td> </td><td><a href="#FT_Set_Renderer">FT_Set_Renderer</a></td></tr> -<tr><td> </td><td><a href="#FT_New_Library">FT_New_Library</a></td><td> </td></tr> -<tr><td><a href="#FT_Add_Module">FT_Add_Module</a></td><td><a href="#FT_Done_Library">FT_Done_Library</a></td><td><a href="#FT_Set_Debug_Hook">FT_Set_Debug_Hook</a></td></tr> -<tr><td><a href="#FT_Get_Module">FT_Get_Module</a></td><td><a href="#FT_Reference_Library">FT_Reference_Library</a></td><td> </td></tr> -<tr><td><a href="#FT_Remove_Module">FT_Remove_Module</a></td><td> </td><td><a href="#FT_Driver">FT_Driver</a></td></tr> +<tr><td><a href="#FT_Module">FT_Module</a></td><td> </td></tr> +<tr><td><a href="#FT_Module_Constructor">FT_Module_Constructor</a></td><td><a href="#FT_New_Library">FT_New_Library</a></td></tr> +<tr><td><a href="#FT_Module_Destructor">FT_Module_Destructor</a></td><td><a href="#FT_Done_Library">FT_Done_Library</a></td></tr> +<tr><td><a href="#FT_Module_Requester">FT_Module_Requester</a></td><td><a href="#FT_Reference_Library">FT_Reference_Library</a></td></tr> +<tr><td><a href="#FT_Module_Class">FT_Module_Class</a></td><td> </td></tr> +<tr><td> </td><td><a href="#FT_Renderer">FT_Renderer</a></td></tr> +<tr><td><a href="#FT_Add_Module">FT_Add_Module</a></td><td><a href="#FT_Renderer_Class">FT_Renderer_Class</a></td></tr> +<tr><td><a href="#FT_Get_Module">FT_Get_Module</a></td><td> </td></tr> +<tr><td><a href="#FT_Remove_Module">FT_Remove_Module</a></td><td><a href="#FT_Get_Renderer">FT_Get_Renderer</a></td></tr> +<tr><td><a href="#FT_Add_Default_Modules">FT_Add_Default_Modules</a></td><td><a href="#FT_Set_Renderer">FT_Set_Renderer</a></td></tr> +<tr><td> </td><td> </td></tr> +<tr><td><a href="#FT_Property_Set">FT_Property_Set</a></td><td><a href="#FT_Set_Debug_Hook">FT_Set_Debug_Hook</a></td></tr> +<tr><td><a href="#FT_Property_Get">FT_Property_Get</a></td><td> </td></tr> +<tr><td><a href="#FT_Set_Default_Properties">FT_Set_Default_Properties</a></td><td><a href="#FT_Driver">FT_Driver</a></td></tr> </table> @@ -148,7 +153,7 @@ <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_ModuleRec_* <b>FT_Module</b>; </pre> -<p>A handle to a given FreeType module object. Each module can be a font driver, a renderer, or anything else that provides services to the formers.</p> +<p>A handle to a given FreeType module object. A module can be a font driver, a renderer, or anything else that provides services to the former.</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> @@ -411,11 +416,11 @@ <p>The module name.</p> </td></tr> <tr><td class="val" id="property_name">property_name</td><td class="desc"> -<p>The property name. Properties are described in the ‘Synopsis’ subsection of the module's documentation.</p> +<p>The property name. Properties are described in section ‘<a href="ft2-properties.html#properties">Driver properties</a>’.</p> <p>Note that only a few modules have properties.</p> </td></tr> <tr><td class="val" id="value">value</td><td class="desc"> -<p>A generic pointer to a variable or structure that gives the new value of the property. The exact definition of ‘value’ is dependent on the property; see the ‘Synopsis’ subsection of the module's documentation.</p> +<p>A generic pointer to a variable or structure that gives the new value of the property. The exact definition of ‘value’ is dependent on the property; see section ‘<a href="ft2-properties.html#properties">Driver properties</a>’.</p> </td></tr> </table> @@ -463,14 +468,14 @@ <p>The module name.</p> </td></tr> <tr><td class="val" id="property_name">property_name</td><td class="desc"> -<p>The property name. Properties are described in the ‘Synopsis’ subsection of the module's documentation.</p> +<p>The property name. Properties are described in section ‘<a href="ft2-properties.html#properties">Driver properties</a>’.</p> </td></tr> </table> <h4>inout</h4> <table class="fields"> <tr><td class="val" id="value">value</td><td class="desc"> -<p>A generic pointer to a variable or structure that gives the value of the property. The exact definition of ‘value’ is dependent on the property; see the ‘Synopsis’ subsection of the module's documentation.</p> +<p>A generic pointer to a variable or structure that gives the value of the property. The exact definition of ‘value’ is dependent on the property; see section ‘<a href="ft2-properties.html#properties">Driver properties</a>’.</p> </td></tr> </table> @@ -502,6 +507,46 @@ <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_Default_Properties">FT_Set_Default_Properties</h3> +<p>Defined in FT_MODULE_H (freetype/ftmodapi.h).</p> +<pre> + FT_EXPORT( <span class="keyword">void</span> ) + <b>FT_Set_Default_Properties</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library ); +</pre> + +<p>If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is set, this function reads the ‘FREETYPE_PROPERTIES’ environment variable to control driver properties. See section ‘<a href="ft2-properties.html#properties">Driver properties</a>’ for more.</p> +<p>If the compilation option is not set, this function does nothing.</p> +<p>‘FREETYPE_PROPERTIES’ has the following syntax form (broken here into multiple lines for better readability).</p> +<pre class="colored"> + <optional whitespace> + <module-name1> ':' + <property-name1> '=' <property-value1> + <whitespace> + <module-name2> ':' + <property-name2> '=' <property-value2> + ... +</pre> +<p>Example:</p> +<pre class="colored"> + FREETYPE_PROPERTIES=truetype:interpreter-version=35 \ + cff:no-stem-darkening=1 \ + autofitter:warping=1 +</pre> + +<h4>inout</h4> +<table class="fields"> +<tr><td class="val" id="library">library</td><td class="desc"> +<p>A handle to a new library object.</p> +</td></tr> +</table> + +<h4>since</h4> +<p>2.8</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_New_Library">FT_New_Library</h3> <p>Defined in FT_MODULE_H (freetype/ftmodapi.h).</p> <pre> @@ -511,7 +556,7 @@ </pre> <p>This function is used to create a new FreeType library instance from a given memory object. It is thus possible to use libraries with distinct memory allocators within the same program. Note, however, that the used <a href="ft2-system_interface.html#FT_Memory">FT_Memory</a> structure is expected to remain valid for the life of the <a href="ft2-base_interface.html#FT_Library">FT_Library</a> object.</p> -<p>Normally, you would call this function (followed by a call to <a href="ft2-module_management.html#FT_Add_Default_Modules">FT_Add_Default_Modules</a> or a series of calls to <a href="ft2-module_management.html#FT_Add_Module">FT_Add_Module</a>) instead of <a href="ft2-base_interface.html#FT_Init_FreeType">FT_Init_FreeType</a> to initialize the FreeType library.</p> +<p>Normally, you would call this function (followed by a call to <a href="ft2-module_management.html#FT_Add_Default_Modules">FT_Add_Default_Modules</a> or a series of calls to <a href="ft2-module_management.html#FT_Add_Module">FT_Add_Module</a>, and a call to <a href="ft2-module_management.html#FT_Set_Default_Properties">FT_Set_Default_Properties</a>) instead of <a href="ft2-base_interface.html#FT_Init_FreeType">FT_Init_FreeType</a> to initialize the FreeType library.</p> <p>Don't use <a href="ft2-base_interface.html#FT_Done_FreeType">FT_Done_FreeType</a> but <a href="ft2-module_management.html#FT_Done_Library">FT_Done_Library</a> to destroy a library instance.</p> <h4>input</h4> @@ -597,7 +642,7 @@ <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_RendererRec_* <b>FT_Renderer</b>; </pre> -<p>A handle to a given FreeType renderer. A renderer is a special module in charge of converting a glyph image to a bitmap, when necessary. Each renderer supports a given glyph image format, and one or more target surface depths.</p> +<p>A handle to a given FreeType renderer. A renderer is a module in charge of converting a glyph's outline image to a bitmap. It supports a single glyph image format, and one or more target surface depths.</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> @@ -770,7 +815,7 @@ <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_DriverRec_* <b>FT_Driver</b>; </pre> -<p>A handle to a given FreeType font driver object. Each font driver is a special module capable of creating faces from font files.</p> +<p>A handle to a given FreeType font driver object. A font driver is a module capable of creating faces from font files.</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> |