<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>FreeType-2.3.5 API Reference</title> <style type="text/css"> body { font-family: Verdana, Geneva, Arial, Helvetica, serif; color: #000000; background: #FFFFFF; } p { text-align: justify; } h1 { text-align: center; } li { text-align: justify; } td { padding: 0 0.5em 0 0.5em } a:link { color: #0000EF; } a:visited { color: #51188E; } a:hover { color: #FF0000; } span.keyword { font-family: monospace; text-align: left; white-space: pre; color: darkblue; } pre.colored { color: blue; } ul.empty { list-style-type: none; } </style> </head> <body> <center><h1>FreeType-2.3.5 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_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_Renderer_Class">FT_Renderer_Class</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_Get_Renderer">FT_Get_Renderer</a></td></tr> <tr><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><td></td><td><a href="#FT_Set_Renderer">FT_Set_Renderer</a></td></tr> <tr><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><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> </td></tr></table><br> <table align=center width="75%"><tr><td> <h4><a name="FT_Module_Class">FT_Module_Class</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Module_Class_ { <a href="ft2-basic_types.html#FT_ULong">FT_ULong</a> module_flags; <a href="ft2-basic_types.html#FT_Long">FT_Long</a> module_size; <span class="keyword">const</span> <a href="ft2-basic_types.html#FT_String">FT_String</a>* module_name; <a href="ft2-basic_types.html#FT_Fixed">FT_Fixed</a> module_version; <a href="ft2-basic_types.html#FT_Fixed">FT_Fixed</a> module_requires; <span class="keyword">const</span> <span class="keyword">void</span>* module_interface; FT_Module_Constructor module_init; FT_Module_Destructor module_done; FT_Module_Requester get_interface; } <b>FT_Module_Class</b>; </pre></table><br> <table align=center width="87%"><tr><td> <p>The module class descriptor.</p> </td></tr></table><br> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>fields</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>module_flags</b></td><td> <p>Bit flags describing the module.</p> </td></tr> <tr valign=top><td><b>module_size</b></td><td> <p>The size of one module object/instance in bytes.</p> </td></tr> <tr valign=top><td><b>module_name</b></td><td> <p>The name of the module.</p> </td></tr> <tr valign=top><td><b>module_version</b></td><td> <p>The version, as a 16.16 fixed number (major.minor).</p> </td></tr> <tr valign=top><td><b>module_requires</b></td><td> <p>The version of FreeType this module requires, as a 16.16 fixed number (major.minor). Starts at version 2.0, i.e., 0x20000.</p> </td></tr> <tr valign=top><td><b>module_init</b></td><td> <p>A function used to initialize (not create) a new module object.</p> </td></tr> <tr valign=top><td><b>module_done</b></td><td> <p>A function used to finalize (not destroy) a given module object</p> </td></tr> <tr valign=top><td><b>get_interface</b></td><td> <p>Queries a given module for a specific interface by name.</p> </td></tr> </table> </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_Add_Module">FT_Add_Module</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) <b>FT_Add_Module</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library, <span class="keyword">const</span> <a href="ft2-module_management.html#FT_Module_Class">FT_Module_Class</a>* clazz ); </pre></table><br> <table align=center width="87%"><tr><td> <p>Adds a new module to a given library instance.</p> </td></tr></table><br> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>library</b></td><td> <p>A handle to the library object.</p> </td></tr> </table> </td></tr></table> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>clazz</b></td><td> <p>A pointer to class descriptor for the module.</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>An error will be returned if a module already exists by that name, or if the module requires a version of FreeType that is too great.</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_Get_Module">FT_Get_Module</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> FT_EXPORT( <a href="ft2-base_interface.html#FT_Module">FT_Module</a> ) <b>FT_Get_Module</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library, <span class="keyword">const</span> <span class="keyword">char</span>* module_name ); </pre></table><br> <table align=center width="87%"><tr><td> <p>Finds a module by its name.</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> <table cellpadding=3 border=0> <tr valign=top><td><b>library</b></td><td> <p>A handle to the library object.</p> </td></tr> <tr valign=top><td><b>module_name</b></td><td> <p>The module's name (as an ASCII string).</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>A module handle. 0 if none was found.</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>FreeType's internal modules aren't documented very well, and you should look up the source code for details.</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_Remove_Module">FT_Remove_Module</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) <b>FT_Remove_Module</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library, <a href="ft2-base_interface.html#FT_Module">FT_Module</a> module ); </pre></table><br> <table align=center width="87%"><tr><td> <p>Removes a given module from a library instance.</p> </td></tr></table><br> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>library</b></td><td> <p>A handle to a library object.</p> </td></tr> </table> </td></tr></table> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>module</b></td><td> <p>A handle to a module object.</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>The module object is destroyed by the function in case of success.</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_New_Library">FT_New_Library</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) <b>FT_New_Library</b>( <a href="ft2-system_interface.html#FT_Memory">FT_Memory</a> memory, <a href="ft2-base_interface.html#FT_Library">FT_Library</a> *alibrary ); </pre></table><br> <table align=center width="87%"><tr><td> <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.</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> <table cellpadding=3 border=0> <tr valign=top><td><b>memory</b></td><td> <p>A handle to the original memory object.</p> </td></tr> </table> </td></tr></table> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>alibrary</b></td><td> <p>A pointer to handle of a new library object.</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> </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_Done_Library">FT_Done_Library</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) <b>FT_Done_Library</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library ); </pre></table><br> <table align=center width="87%"><tr><td> <p>Discards a given library object. This closes all drivers and discards all resource objects.</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> <table cellpadding=3 border=0> <tr valign=top><td><b>library</b></td><td> <p>A handle to the target library.</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> </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_Set_Debug_Hook">FT_Set_Debug_Hook</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> FT_EXPORT( <span class="keyword">void</span> ) <b>FT_Set_Debug_Hook</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library, <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> hook_index, FT_DebugHook_Func debug_hook ); </pre></table><br> <table align=center width="87%"><tr><td> <p>Sets a debug hook function for debugging the interpreter of a font format.</p> </td></tr></table><br> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>library</b></td><td> <p>A handle to the library object.</p> </td></tr> </table> </td></tr></table> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>hook_index</b></td><td> <p>The index of the debug hook. You should use the values defined in ‘ftobjs.h’, e.g., ‘FT_DEBUG_HOOK_TRUETYPE’.</p> </td></tr> <tr valign=top><td><b>debug_hook</b></td><td> <p>The function used to debug the interpreter.</p> </td></tr> </table> </td></tr></table> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td> <p>Currently, four debug hook slots are available, but only two (for the TrueType and the Type 1 interpreter) are defined.</p> <p>Since the internal headers of FreeType are no longer installed, the symbol ‘FT_DEBUG_HOOK_TRUETYPE’ isn't available publicly. This is a bug and will be fixed in a forthcoming release.</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_Add_Default_Modules">FT_Add_Default_Modules</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> FT_EXPORT( <span class="keyword">void</span> ) <b>FT_Add_Default_Modules</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library ); </pre></table><br> <table align=center width="87%"><tr><td> <p>Adds the set of default drivers to a given library object. This is only useful when you create a library object with <a href="ft2-module_management.html#FT_New_Library">FT_New_Library</a> (usually to plug a custom memory manager).</p> </td></tr></table><br> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>library</b></td><td> <p>A handle to a new library object.</p> </td></tr> </table> </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_Renderer_Class">FT_Renderer_Class</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Renderer_Class_ { <a href="ft2-module_management.html#FT_Module_Class">FT_Module_Class</a> root; <a href="ft2-basic_types.html#FT_Glyph_Format">FT_Glyph_Format</a> glyph_format; FT_Renderer_RenderFunc render_glyph; FT_Renderer_TransformFunc transform_glyph; FT_Renderer_GetCBoxFunc get_glyph_cbox; FT_Renderer_SetModeFunc set_mode; <a href="ft2-raster.html#FT_Raster_Funcs">FT_Raster_Funcs</a>* raster_class; } <b>FT_Renderer_Class</b>; </pre></table><br> <table align=center width="87%"><tr><td> <p>The renderer module class descriptor.</p> </td></tr></table><br> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>fields</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>root</b></td><td> <p>The root <a href="ft2-module_management.html#FT_Module_Class">FT_Module_Class</a> fields.</p> </td></tr> <tr valign=top><td><b>glyph_format</b></td><td> <p>The glyph image format this renderer handles.</p> </td></tr> <tr valign=top><td><b>render_glyph</b></td><td> <p>A method used to render the image that is in a given glyph slot into a bitmap.</p> </td></tr> <tr valign=top><td><b>set_mode</b></td><td> <p>A method used to pass additional parameters.</p> </td></tr> <tr valign=top><td><b>raster_class</b></td><td> <p>For <a href="ft2-basic_types.html#FT_Glyph_Format">FT_GLYPH_FORMAT_OUTLINE</a> renderers only. This is a pointer to its raster's class.</p> </td></tr> <tr valign=top><td><b>raster</b></td><td> <p>For <a href="ft2-basic_types.html#FT_Glyph_Format">FT_GLYPH_FORMAT_OUTLINE</a> renderers only. This is a pointer to the corresponding raster object, if any.</p> </td></tr> </table> </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_Get_Renderer">FT_Get_Renderer</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> FT_EXPORT( <a href="ft2-base_interface.html#FT_Renderer">FT_Renderer</a> ) <b>FT_Get_Renderer</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library, <a href="ft2-basic_types.html#FT_Glyph_Format">FT_Glyph_Format</a> format ); </pre></table><br> <table align=center width="87%"><tr><td> <p>Retrieves the current renderer for a given glyph format.</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> <table cellpadding=3 border=0> <tr valign=top><td><b>library</b></td><td> <p>A handle to the library object.</p> </td></tr> <tr valign=top><td><b>format</b></td><td> <p>The glyph format.</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>A renderer handle. 0 if none found.</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>An error will be returned if a module already exists by that name, or if the module requires a version of FreeType that is too great.</p> <p>To add a new renderer, simply use <a href="ft2-module_management.html#FT_Add_Module">FT_Add_Module</a>. To retrieve a renderer by its name, use <a href="ft2-module_management.html#FT_Get_Module">FT_Get_Module</a>.</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_Set_Renderer">FT_Set_Renderer</a></h4> <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) <b>FT_Set_Renderer</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library, <a href="ft2-base_interface.html#FT_Renderer">FT_Renderer</a> renderer, <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> num_params, <a href="ft2-base_interface.html#FT_Parameter">FT_Parameter</a>* parameters ); </pre></table><br> <table align=center width="87%"><tr><td> <p>Sets the current renderer to use, and set additional mode.</p> </td></tr></table><br> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>library</b></td><td> <p>A handle to the library object.</p> </td></tr> </table> </td></tr></table> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td> <table cellpadding=3 border=0> <tr valign=top><td><b>renderer</b></td><td> <p>A handle to the renderer object.</p> </td></tr> <tr valign=top><td><b>num_params</b></td><td> <p>The number of additional parameters.</p> </td></tr> <tr valign=top><td><b>parameters</b></td><td> <p>Additional parameters.</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>In case of success, the renderer will be used to convert glyph images in the renderer's known format into bitmaps.</p> <p>This doesn't change the current renderer for other formats.</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> </body> </html>