diff options
Diffstat (limited to 'Build/source/libs/freetype2/freetype-src/docs/reference/ft2-sfnt_names.html')
-rw-r--r-- | Build/source/libs/freetype2/freetype-src/docs/reference/ft2-sfnt_names.html | 304 |
1 files changed, 0 insertions, 304 deletions
diff --git a/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-sfnt_names.html b/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-sfnt_names.html deleted file mode 100644 index 2d3d5533773..00000000000 --- a/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-sfnt_names.html +++ /dev/null @@ -1,304 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"https://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>FreeType-2.9.1 API Reference</title> -<style type="text/css"> - a:link { color: #0000EF; } - a:visited { color: #51188E; } - a:hover { color: #FF0000; } - - body { font-family: Verdana, Geneva, Arial, Helvetica, serif; - color: #000000; - background: #FFFFFF; - width: 87%; - margin: auto; } - - div.section { width: 75%; - margin: auto; } - div.section hr { margin: 4ex 0 1ex 0; } - div.section h4 { background-color: #EEEEFF; - font-size: medium; - font-style: oblique; - font-weight: bold; - margin: 3ex 0 1.5ex 9%; - padding: 0.3ex 0 0.3ex 1%; } - div.section p { margin: 1.5ex 0 1.5ex 10%; } - div.section pre { margin: 3ex 0 3ex 9%; - background-color: #D6E8FF; - padding: 2ex 0 2ex 1%; } - div.section table.fields { width: 90%; - margin: 1.5ex 0 1.5ex 10%; } - div.section table.toc { width: 95%; - margin: 1.5ex 0 1.5ex 5%; } - div.timestamp { text-align: center; - font-size: 69%; - margin: 1.5ex 0 1.5ex 0; } - - h1 { text-align: center; } - h3 { font-size: medium; - margin: 4ex 0 1.5ex 0; } - - p { text-align: justify; } - - pre.colored { color: blue; } - - span.keyword { font-family: monospace; - text-align: left; - white-space: pre; - color: darkblue; } - - table.fields td.val { font-weight: bold; - text-align: right; - width: 30%; - vertical-align: baseline; - padding: 1ex 1em 1ex 0; } - table.fields td.desc { vertical-align: baseline; - padding: 1ex 0 1ex 1em; } - table.fields td.desc p:first-child { margin: 0; } - table.fields td.desc p { margin: 1.5ex 0 0 0; } - table.index { margin: 6ex auto 6ex auto; - border: 0; - border-collapse: separate; - border-spacing: 1em 0.3ex; } - table.index tr { padding: 0; } - table.index td { padding: 0; } - table.index-toc-link { width: 100%; - border: 0; - border-spacing: 0; - margin: 1ex 0 1ex 0; } - table.index-toc-link td.left { padding: 0 0.5em 0 0.5em; - font-size: 83%; - text-align: left; } - table.index-toc-link td.middle { padding: 0 0.5em 0 0.5em; - font-size: 83%; - text-align: center; } - table.index-toc-link td.right { padding: 0 0.5em 0 0.5em; - font-size: 83%; - text-align: right; } - table.synopsis { margin: 6ex auto 6ex auto; - border: 0; - border-collapse: separate; - border-spacing: 2em 0.6ex; } - table.synopsis tr { padding: 0; } - table.synopsis td { padding: 0; } - table.toc td.link { width: 30%; - text-align: right; - vertical-align: baseline; - padding: 1ex 1em 1ex 0; } - table.toc td.desc { vertical-align: baseline; - padding: 1ex 0 1ex 1em; - text-align: left; } - table.toc td.desc p:first-child { margin: 0; - text-align: left; } - table.toc td.desc p { margin: 1.5ex 0 0 0; - text-align: left; } - -</style> -</head> -<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.9.1 API Reference</h1> - -<h1 id="sfnt_names">SFNT Names</h1> -<h2>Synopsis</h2> -<table class="synopsis"> -<tr><td><a href="#FT_SfntName">FT_SfntName</a></td><td><a href="#FT_Get_Sfnt_Name">FT_Get_Sfnt_Name</a></td><td><a href="#FT_Get_Sfnt_LangTag">FT_Get_Sfnt_LangTag</a></td></tr> -<tr><td><a href="#FT_Get_Sfnt_Name_Count">FT_Get_Sfnt_Name_Count</a></td><td><a href="#FT_SfntLangTag">FT_SfntLangTag</a></td><td></td></tr> -</table> - - -<p>The TrueType and OpenType specifications allow the inclusion of a special names table (‘name’) in font files. This table contains textual (and internationalized) information regarding the font, like family name, copyright, version, etc.</p> -<p>The definitions below are used to access them if available.</p> -<p>Note that this has nothing to do with glyph names!</p> - -<div class="section"> -<h3 id="FT_SfntName">FT_SfntName</h3> -<p>Defined in FT_SFNT_NAMES_H (freetype/ftsnames.h).</p> -<pre> - <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_SfntName_ - { - <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a> platform_id; - <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a> encoding_id; - <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a> language_id; - <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a> name_id; - - <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>* string; /* this string is *not* null-terminated! */ - <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> string_len; /* in bytes */ - - } <b>FT_SfntName</b>; -</pre> - -<p>A structure used to model an SFNT ‘name’ table entry.</p> - -<h4>fields</h4> -<table class="fields"> -<tr><td class="val" id="platform_id">platform_id</td><td class="desc"> -<p>The platform ID for ‘string’. See <a href="ft2-truetype_tables.html#TT_PLATFORM_XXX">TT_PLATFORM_XXX</a> for possible values.</p> -</td></tr> -<tr><td class="val" id="encoding_id">encoding_id</td><td class="desc"> -<p>The encoding ID for ‘string’. See <a href="ft2-truetype_tables.html#TT_APPLE_ID_XXX">TT_APPLE_ID_XXX</a>, <a href="ft2-truetype_tables.html#TT_MAC_ID_XXX">TT_MAC_ID_XXX</a>, <a href="ft2-truetype_tables.html#TT_ISO_ID_XXX">TT_ISO_ID_XXX</a>, <a href="ft2-truetype_tables.html#TT_MS_ID_XXX">TT_MS_ID_XXX</a>, and <a href="ft2-truetype_tables.html#TT_ADOBE_ID_XXX">TT_ADOBE_ID_XXX</a> for possible values.</p> -</td></tr> -<tr><td class="val" id="language_id">language_id</td><td class="desc"> -<p>The language ID for ‘string’. See <a href="ft2-truetype_tables.html#TT_MAC_LANGID_XXX">TT_MAC_LANGID_XXX</a> and <a href="ft2-truetype_tables.html#TT_MS_LANGID_XXX">TT_MS_LANGID_XXX</a> for possible values.</p> -<p>Registered OpenType values for ‘language_id’ are always smaller than 0x8000; values equal or larger than 0x8000 usually indicate a language tag string (introduced in OpenType version 1.6). Use function <a href="ft2-sfnt_names.html#FT_Get_Sfnt_LangTag">FT_Get_Sfnt_LangTag</a> with ‘language_id’ as its argument to retrieve the associated language tag.</p> -</td></tr> -<tr><td class="val" id="name_id">name_id</td><td class="desc"> -<p>An identifier for ‘string’. See <a href="ft2-truetype_tables.html#TT_NAME_ID_XXX">TT_NAME_ID_XXX</a> for possible values.</p> -</td></tr> -<tr><td class="val" id="string">string</td><td class="desc"> -<p>The ‘name’ string. Note that its format differs depending on the (platform,encoding) pair, being either a string of bytes (without a terminating NULL byte) or containing UTF-16BE entities.</p> -</td></tr> -<tr><td class="val" id="string_len">string_len</td><td class="desc"> -<p>The length of ‘string’ in bytes.</p> -</td></tr> -</table> - -<h4>note</h4> -<p>Please refer to the TrueType or OpenType specification for more details.</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_Sfnt_Name_Count">FT_Get_Sfnt_Name_Count</h3> -<p>Defined in FT_SFNT_NAMES_H (freetype/ftsnames.h).</p> -<pre> - FT_EXPORT( <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> ) - <b>FT_Get_Sfnt_Name_Count</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a> face ); -</pre> - -<p>Retrieve the number of name strings in the SFNT ‘name’ table.</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> -</table> - -<h4>return</h4> -<p>The number of strings in the ‘name’ table.</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_Sfnt_Name">FT_Get_Sfnt_Name</h3> -<p>Defined in FT_SFNT_NAMES_H (freetype/ftsnames.h).</p> -<pre> - FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) - <b>FT_Get_Sfnt_Name</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a> face, - <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> idx, - <a href="ft2-sfnt_names.html#FT_SfntName">FT_SfntName</a> *aname ); -</pre> - -<p>Retrieve a string of the SFNT ‘name’ table for a given index.</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="idx">idx</td><td class="desc"> -<p>The index of the ‘name’ string.</p> -</td></tr> -</table> - -<h4>output</h4> -<table class="fields"> -<tr><td class="val" id="aname">aname</td><td class="desc"> -<p>The indexed <a href="ft2-sfnt_names.html#FT_SfntName">FT_SfntName</a> structure.</p> -</td></tr> -</table> - -<h4>return</h4> -<p>FreeType error code. 0 means success.</p> - -<h4>note</h4> -<p>The ‘string’ array returned in the ‘aname’ structure is not null-terminated. Note that you don't have to deallocate ‘string’ by yourself; FreeType takes care of it if you call <a href="ft2-base_interface.html#FT_Done_Face">FT_Done_Face</a>.</p> -<p>Use <a href="ft2-sfnt_names.html#FT_Get_Sfnt_Name_Count">FT_Get_Sfnt_Name_Count</a> to get the total number of available ‘name’ table entries, then do a loop until you get the right platform, encoding, and name ID.</p> -<p>‘name’ table format 1 entries can use language tags also, see <a href="ft2-sfnt_names.html#FT_Get_Sfnt_LangTag">FT_Get_Sfnt_LangTag</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> - -<div class="section"> -<h3 id="FT_SfntLangTag">FT_SfntLangTag</h3> -<p>Defined in FT_SFNT_NAMES_H (freetype/ftsnames.h).</p> -<pre> - <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_SfntLangTag_ - { - <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>* string; /* this string is *not* null-terminated! */ - <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> string_len; /* in bytes */ - - } <b>FT_SfntLangTag</b>; -</pre> - -<p>A structure to model a language tag entry from an SFNT ‘name’ table.</p> - -<h4>fields</h4> -<table class="fields"> -<tr><td class="val" id="string">string</td><td class="desc"> -<p>The language tag string, encoded in UTF-16BE (without trailing NULL bytes).</p> -</td></tr> -<tr><td class="val" id="string_len">string_len</td><td class="desc"> -<p>The length of ‘string’ in <b>bytes</b>.</p> -</td></tr> -</table> - -<h4>note</h4> -<p>Please refer to the TrueType or OpenType specification for more details.</p> - -<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_Get_Sfnt_LangTag">FT_Get_Sfnt_LangTag</h3> -<p>Defined in FT_SFNT_NAMES_H (freetype/ftsnames.h).</p> -<pre> - FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) - <b>FT_Get_Sfnt_LangTag</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a> face, - <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a> langID, - <a href="ft2-sfnt_names.html#FT_SfntLangTag">FT_SfntLangTag</a> *alangTag ); -</pre> - -<p>Retrieve the language tag associated with a language ID of an SFNT ‘name’ table entry.</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="langID">langID</td><td class="desc"> -<p>The language ID, as returned by <a href="ft2-sfnt_names.html#FT_Get_Sfnt_Name">FT_Get_Sfnt_Name</a>. This is always a value larger than 0x8000.</p> -</td></tr> -</table> - -<h4>output</h4> -<table class="fields"> -<tr><td class="val" id="alangTag">alangTag</td><td class="desc"> -<p>The language tag associated with the ‘name’ table entry's language ID.</p> -</td></tr> -</table> - -<h4>return</h4> -<p>FreeType error code. 0 means success.</p> - -<h4>note</h4> -<p>The ‘string’ array returned in the ‘alangTag’ structure is not null-terminated. Note that you don't have to deallocate ‘string’ by yourself; FreeType takes care of it if you call <a href="ft2-base_interface.html#FT_Done_Face">FT_Done_Face</a>.</p> -<p>Only ‘name’ table format 1 supports language tags. For format 0 tables, this function always returns FT_Err_Invalid_Table. For invalid format 1 language ID values, FT_Err_Invalid_Argument is returned.</p> - -<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> - -</body> -</html> |