diff options
Diffstat (limited to 'freetype/docs/reference/ft2-module_management.html')
| -rw-r--r-- | freetype/docs/reference/ft2-module_management.html | 169 |
1 files changed, 160 insertions, 9 deletions
diff --git a/freetype/docs/reference/ft2-module_management.html b/freetype/docs/reference/ft2-module_management.html index 455435a7f..227bca3c8 100644 --- a/freetype/docs/reference/ft2-module_management.html +++ b/freetype/docs/reference/ft2-module_management.html @@ -3,7 +3,7 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>FreeType-2.4.10 API Reference</title> +<title>FreeType-2.4.11 API Reference</title> <style type="text/css"> body { font-family: Verdana, Geneva, Arial, Helvetica, serif; color: #000000; @@ -35,22 +35,45 @@ <table align=center><tr><td><font size=-1>[<a href="ft2-index.html">Index</a>]</font></td> <td width="100%"></td> <td><font size=-1>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table> -<center><h1>FreeType-2.4.10 API Reference</h1></center> +<center><h1>FreeType-2.4.11 API Reference</h1></center> <center><h1> Module Management </h1></center> <h2>Synopsis</h2> <table align=center cellspacing=5 cellpadding=0 border=0> -<tr><td></td><td><a href="#FT_Module_Constructor">FT_Module_Constructor</a></td><td></td><td><a href="#FT_Get_Module">FT_Get_Module</a></td><td></td><td><a href="#FT_Set_Debug_Hook">FT_Set_Debug_Hook</a></td></tr> -<tr><td></td><td><a href="#FT_Module_Destructor">FT_Module_Destructor</a></td><td></td><td><a href="#FT_Remove_Module">FT_Remove_Module</a></td><td></td><td><a href="#FT_Add_Default_Modules">FT_Add_Default_Modules</a></td></tr> -<tr><td></td><td><a href="#FT_Module_Requester">FT_Module_Requester</a></td><td></td><td><a href="#FT_Reference_Library">FT_Reference_Library</a></td><td></td><td><a href="#FT_Renderer_Class">FT_Renderer_Class</a></td></tr> -<tr><td></td><td><a href="#FT_Module_Class">FT_Module_Class</a></td><td></td><td><a href="#FT_New_Library">FT_New_Library</a></td><td></td><td><a href="#FT_Get_Renderer">FT_Get_Renderer</a></td></tr> -<tr><td></td><td><a href="#FT_Add_Module">FT_Add_Module</a></td><td></td><td><a href="#FT_Done_Library">FT_Done_Library</a></td><td></td><td><a href="#FT_Set_Renderer">FT_Set_Renderer</a></td></tr> +<tr><td></td><td><a href="#FT_Module_Constructor">FT_Module_Constructor</a></td><td></td><td><a href="#FT_Remove_Module">FT_Remove_Module</a></td><td></td><td><a href="#FT_Set_Debug_Hook">FT_Set_Debug_Hook</a></td></tr> +<tr><td></td><td><a href="#FT_Module_Destructor">FT_Module_Destructor</a></td><td></td><td><a href="#FT_Property_Set">FT_Property_Set</a></td><td></td><td><a href="#FT_Add_Default_Modules">FT_Add_Default_Modules</a></td></tr> +<tr><td></td><td><a href="#FT_Module_Requester">FT_Module_Requester</a></td><td></td><td><a href="#FT_Property_Get">FT_Property_Get</a></td><td></td><td><a href="#FT_Renderer_Class">FT_Renderer_Class</a></td></tr> +<tr><td></td><td><a href="#FT_Module_Class">FT_Module_Class</a></td><td></td><td><a href="#FT_Reference_Library">FT_Reference_Library</a></td><td></td><td><a href="#FT_Get_Renderer">FT_Get_Renderer</a></td></tr> +<tr><td></td><td><a href="#FT_Add_Module">FT_Add_Module</a></td><td></td><td><a href="#FT_New_Library">FT_New_Library</a></td><td></td><td><a href="#FT_Set_Renderer">FT_Set_Renderer</a></td></tr> +<tr><td></td><td><a href="#FT_Get_Module">FT_Get_Module</a></td><td></td><td><a href="#FT_Done_Library">FT_Done_Library</a></td><td></td><td></td></tr> </table><br><br> <table align=center width="87%"><tr><td> -<p>The definitions below are used to manage modules within FreeType. Modules can be added, upgraded, and removed at runtime.</p> +<p>The definitions below are used to manage modules within FreeType. Modules can be added, upgraded, and removed at runtime. Additionally, some module properties can be controlled also.</p> +<p>Here is a list of possible values of the ‘module_name’ field in the <a href="ft2-module_management.html#FT_Module_Class">FT_Module_Class</a> structure.</p> +<pre class="colored"> + autofitter + bdf + cff + gxvalid + otvalid + pcf + pfr + psaux + pshinter + psnames + raster1, raster5 + sfnt + smooth, smooth-lcd, smooth-lcdv + truetype + type1 + type42 + t1cid + winfonts +</pre> +<p>Note that the FreeType Cache sub-system is not a FreeType module.</p> </td></tr></table><br> <table align=center width="75%"><tr><td> <h4><a name="FT_Module_Constructor">FT_Module_Constructor</a></h4> @@ -127,7 +150,7 @@ Defined in FT_MODULE_H (freetype/ftmodapi.h). <p></p> <table cellpadding=3 border=0> <tr valign=top><td><b>module</b></td><td> -<p>The module to finalize.</p> +<p>The module to be searched.</p> </td></tr> <tr valign=top><td><b>name</b></td><td> <p>The name of the interface in the module.</p> @@ -327,6 +350,134 @@ Defined in FT_MODULE_H (freetype/ftmodapi.h). <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table> <table align=center width="75%"><tr><td> +<h4><a name="FT_Property_Set">FT_Property_Set</a></h4> +<table align=center width="87%"><tr><td> +Defined in FT_MODULE_H (freetype/ftmodapi.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <a href="ft2-basic_types.html#FT_Error">FT_Error</a> + <b>FT_Property_Set</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library, + <span class="keyword">const</span> <a href="ft2-basic_types.html#FT_String">FT_String</a>* module_name, + <span class="keyword">const</span> <a href="ft2-basic_types.html#FT_String">FT_String</a>* property_name, + <span class="keyword">const</span> <span class="keyword">void</span>* value ); + +</pre></table><br> +<table align=center width="87%"><tr><td> +<p>Set a property for a given module.</p> +</td></tr></table><br> +<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td> +<p></p> +<table cellpadding=3 border=0> +<tr valign=top><td><b>library</b></td><td> +<p>A handle to the library the module is part of.</p> +</td></tr> +<tr valign=top><td><b>module_name</b></td><td> +<p>The module name.</p> +</td></tr> +<tr valign=top><td><b>property_name</b></td><td> +<p>The property name. Properties are described in the ‘Synopsis’ subsection of the module's documentation.</p> +<p>Note that only a few modules have properties.</p> +</td></tr> +<tr valign=top><td><b>value</b></td><td> +<p>A generic pointer to a variable or structure which 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> +</td></tr> +</table> +</td></tr></table> +<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td> +<p>FreeType error code. 0 means success.</p> +</td></tr></table> +<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td> +<p>If ‘module_name’ isn't a valid module name, or ‘property_name’ doesn't specify a valid property, or if ‘value’ doesn't represent a valid value for the given property, an error is returned.</p> +<p>The following example sets property ‘bar’ (a simple integer) in module ‘foo’ to value 1.</p> +<pre class="colored"> + FT_UInt bar; + + + bar = 1; + FT_Property_Set( library, "foo", "bar", &bar ); +</pre> +<p>It is not possible to set properties of the FreeType Cache sub-system with FT_Property_Set; use ?FTC_Property_Set? instead.</p> +</td></tr></table> +<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>since</b></em></td></tr><tr><td> +<p>2.4.11</p> +</td></tr></table> +</td></tr></table> +<hr width="75%"> +<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td> +<td width="100%"></td> +<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table> + +<table align=center width="75%"><tr><td> +<h4><a name="FT_Property_Get">FT_Property_Get</a></h4> +<table align=center width="87%"><tr><td> +Defined in FT_MODULE_H (freetype/ftmodapi.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <a href="ft2-basic_types.html#FT_Error">FT_Error</a> + <b>FT_Property_Get</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library, + <span class="keyword">const</span> <a href="ft2-basic_types.html#FT_String">FT_String</a>* module_name, + <span class="keyword">const</span> <a href="ft2-basic_types.html#FT_String">FT_String</a>* property_name, + <span class="keyword">void</span>* value ); + +</pre></table><br> +<table align=center width="87%"><tr><td> +<p>Get a module's property value.</p> +</td></tr></table><br> +<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td> +<p></p> +<table cellpadding=3 border=0> +<tr valign=top><td><b>library</b></td><td> +<p>A handle to the library the module is part of.</p> +</td></tr> +<tr valign=top><td><b>module_name</b></td><td> +<p>The module name.</p> +</td></tr> +<tr valign=top><td><b>property_name</b></td><td> +<p>The property name. Properties are described in the ‘Synopsis’ subsection of the module's documentation.</p> +</td></tr> +</table> +</td></tr></table> +<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td> +<p></p> +<table cellpadding=3 border=0> +<tr valign=top><td><b>value</b></td><td> +<p>A generic pointer to a variable or structure which 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> +</td></tr> +</table> +</td></tr></table> +<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td> +<p>FreeType error code. 0 means success.</p> +</td></tr></table> +<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td> +<p>If ‘module_name’ isn't a valid module name, or ‘property_name’ doesn't specify a valid property, or if ‘value’ doesn't represent a valid value for the given property, an error is returned.</p> +<p>The following example gets property ‘baz’ (a range) in module ‘foo’.</p> +<pre class="colored"> + typedef range_ + { + FT_Int32 min; + FT_Int32 max; + + } range; + + range baz; + + + FT_Property_Get( library, "foo", "baz", &baz ); +</pre> +<p>It is not possible to retrieve properties of the FreeType Cache sub-system with FT_Property_Get; use ?FTC_Property_Get? instead.</p> +</td></tr></table> +<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>since</b></em></td></tr><tr><td> +<p>2.4.11</p> +</td></tr></table> +</td></tr></table> +<hr width="75%"> +<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td> +<td width="100%"></td> +<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table> + +<table align=center width="75%"><tr><td> <h4><a name="FT_Reference_Library">FT_Reference_Library</a></h4> <table align=center width="87%"><tr><td> Defined in FT_MODULE_H (freetype/ftmodapi.h). |