diff options
Diffstat (limited to 'Build/source/libs/freetype2/freetype-src/docs/reference/ft2-glyph_management.html')
-rw-r--r-- | Build/source/libs/freetype2/freetype-src/docs/reference/ft2-glyph_management.html | 196 |
1 files changed, 149 insertions, 47 deletions
diff --git a/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-glyph_management.html b/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-glyph_management.html index 824cc20c0f3..cb505621ecc 100644 --- a/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-glyph_management.html +++ b/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-glyph_management.html @@ -6,7 +6,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> - <meta name="description" content="API Reference Documentation for FreeType-2.13.0"> + <meta name="description" content="API Reference Documentation for FreeType-2.13.1"> @@ -14,11 +14,11 @@ <link rel="icon" href="images/favico.ico"> - <meta name="generator" content="mkdocs-1.2.1, mkdocs-material-7.1.9"> + <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-7.1.9"> - <title>Glyph Management - FreeType-2.13.0 API Reference</title> + <title>Glyph Management - FreeType-2.13.1 API Reference</title> @@ -82,7 +82,7 @@ <header class="md-header" data-md-component="header"> <nav class="md-header__inner md-grid" aria-label="Header"> - <a href="index.html" title="FreeType-2.13.0 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.13.0 API Reference" data-md-component="logo"> + <a href="index.html" title="FreeType-2.13.1 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.13.1 API Reference" data-md-component="logo"> <img src="images/favico.ico" alt="logo"> @@ -94,7 +94,7 @@ <div class="md-header__ellipsis"> <div class="md-header__topic"> <span class="md-ellipsis"> - FreeType-2.13.0 API Reference + FreeType-2.13.1 API Reference </span> </div> <div class="md-header__topic" data-md-component="header-topic"> @@ -161,12 +161,12 @@ <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> <label class="md-nav__title" for="__drawer"> - <a href="index.html" title="FreeType-2.13.0 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.13.0 API Reference" data-md-component="logo"> + <a href="index.html" title="FreeType-2.13.1 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.13.1 API Reference" data-md-component="logo"> <img src="images/favico.ico" alt="logo"> </a> - FreeType-2.13.0 API Reference + FreeType-2.13.1 API Reference </label> <ul class="md-nav__list" data-md-scrollfix> @@ -273,14 +273,12 @@ - - - <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked> + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > <label class="md-nav__link" for="__nav_4"> Core API @@ -298,8 +296,8 @@ <li class="md-nav__item"> - <a href="ft2-version.html" class="md-nav__link"> - FreeType Version + <a href="ft2-basic_types.html" class="md-nav__link"> + Basic Data Types </a> </li> @@ -310,8 +308,80 @@ <li class="md-nav__item"> - <a href="ft2-basic_types.html" class="md-nav__link"> - Basic Data Types + <a href="ft2-library_setup.html" class="md-nav__link"> + Library Setup + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-face_creation.html" class="md-nav__link"> + Face Creation + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-font_testing_macros.html" class="md-nav__link"> + Font Testing Macros + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-sizing_and_scaling.html" class="md-nav__link"> + Sizing and Scaling + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-glyph_retrieval.html" class="md-nav__link"> + Glyph Retrieval + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-character_mapping.html" class="md-nav__link"> + Character Mapping + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-information_retrieval.html" class="md-nav__link"> + Information Retrieval </a> </li> @@ -322,13 +392,45 @@ <li class="md-nav__item"> - <a href="ft2-base_interface.html" class="md-nav__link"> - Base Interface + <a href="ft2-other_api_data.html" class="md-nav__link"> + Other API Data </a> </li> + </ul> + </nav> + </li> + + + + + + + + + + + + + + <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked> + + <label class="md-nav__link" for="__nav_5"> + Extended API + <span class="md-nav__icon md-icon"></span> + </label> + <nav class="md-nav" aria-label="Extended API" data-md-level="1"> + <label class="md-nav__title" for="__nav_5"> + <span class="md-nav__icon md-icon"></span> + Extended API + </label> + <ul class="md-nav__list" data-md-scrollfix> + @@ -582,14 +684,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > - <label class="md-nav__link" for="__nav_5"> + <label class="md-nav__link" for="__nav_6"> Format-Specific API <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1"> - <label class="md-nav__title" for="__nav_5"> + <label class="md-nav__title" for="__nav_6"> <span class="md-nav__icon md-icon"></span> Format-Specific API </label> @@ -744,14 +846,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > - <label class="md-nav__link" for="__nav_6"> + <label class="md-nav__link" for="__nav_7"> Controlling FreeType Modules <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1"> - <label class="md-nav__title" for="__nav_6"> + <label class="md-nav__title" for="__nav_7"> <span class="md-nav__icon md-icon"></span> Controlling FreeType Modules </label> @@ -882,14 +984,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" > - <label class="md-nav__link" for="__nav_7"> + <label class="md-nav__link" for="__nav_8"> Cache Sub-System <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1"> - <label class="md-nav__title" for="__nav_7"> + <label class="md-nav__title" for="__nav_8"> <span class="md-nav__icon md-icon"></span> Cache Sub-System </label> @@ -924,14 +1026,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" > - <label class="md-nav__link" for="__nav_8"> + <label class="md-nav__link" for="__nav_9"> Support API <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Support API" data-md-level="1"> - <label class="md-nav__title" for="__nav_8"> + <label class="md-nav__title" for="__nav_9"> <span class="md-nav__icon md-icon"></span> Support API </label> @@ -1110,14 +1212,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" > - <label class="md-nav__link" for="__nav_9"> + <label class="md-nav__link" for="__nav_10"> Error Codes <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Error Codes" data-md-level="1"> - <label class="md-nav__title" for="__nav_9"> + <label class="md-nav__title" for="__nav_10"> <span class="md-nav__icon md-icon"></span> Error Codes </label> @@ -1164,14 +1266,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_11" type="checkbox" id="__nav_11" > - <label class="md-nav__link" for="__nav_10"> + <label class="md-nav__link" for="__nav_11"> Miscellaneous <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1"> - <label class="md-nav__title" for="__nav_10"> + <label class="md-nav__title" for="__nav_11"> <span class="md-nav__icon md-icon"></span> Miscellaneous </label> @@ -1388,11 +1490,11 @@ - <p><a href="https://www.freetype.org">FreeType</a> » <a href="../">Docs</a> » <a href="index.html#core-api">Core API</a> » Glyph Management</p> + <p><a href="https://www.freetype.org">FreeType</a> » <a href="../">Docs</a> » <a href="index.html#extended-api">Extended API</a> » Glyph Management</p> <hr /> <h1 id="glyph-management">Glyph Management<a class="headerlink" href="#glyph-management" title="Permanent link">¶</a></h1> <h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">¶</a></h2> -<p>This section contains definitions used to manage glyph data through generic <code><a href="ft2-glyph_management.html#ft_glyph">FT_Glyph</a></code> objects. Each of them can contain a bitmap, a vector outline, or even images in other formats. These objects are detached from <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code>, contrary to <code><a href="ft2-base_interface.html#ft_glyphslot">FT_GlyphSlot</a></code>.</p> +<p>This section contains definitions used to manage glyph data through generic <code><a href="ft2-glyph_management.html#ft_glyph">FT_Glyph</a></code> objects. Each of them can contain a bitmap, a vector outline, or even images in other formats. These objects are detached from <code><a href="ft2-face_creation.html#ft_face">FT_Face</a></code>, contrary to <code><a href="ft2-glyph_retrieval.html#ft_glyphslot">FT_GlyphSlot</a></code>.</p> <h2 id="ft_glyph">FT_Glyph<a class="headerlink" href="#ft_glyph" title="Permanent link">¶</a></h2> <p>Defined in FT_GLYPH_H (freetype/ftglyph.h).</p> <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_GlyphRec_* <b>FT_Glyph</b>; @@ -1401,14 +1503,14 @@ <p>Handle to an object used to model generic glyph images. It is a pointer to the <code><a href="ft2-glyph_management.html#ft_glyphrec">FT_GlyphRec</a></code> structure and can contain a glyph bitmap or pointer.</p> <h4>note</h4> -<p>Glyph objects are not owned by the library. You must thus release them manually (through <code><a href="ft2-glyph_management.html#ft_done_glyph">FT_Done_Glyph</a></code>) <em>before</em> calling <code><a href="ft2-base_interface.html#ft_done_freetype">FT_Done_FreeType</a></code>.</p> +<p>Glyph objects are not owned by the library. You must thus release them manually (through <code><a href="ft2-glyph_management.html#ft_done_glyph">FT_Done_Glyph</a></code>) <em>before</em> calling <code><a href="ft2-library_setup.html#ft_done_freetype">FT_Done_FreeType</a></code>.</p> <hr> <h2 id="ft_glyphrec">FT_GlyphRec<a class="headerlink" href="#ft_glyphrec" title="Permanent link">¶</a></h2> <p>Defined in FT_GLYPH_H (freetype/ftglyph.h).</p> <div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_GlyphRec_ { - <a href="ft2-base_interface.html#ft_library">FT_Library</a> library; + <a href="ft2-library_setup.html#ft_library">FT_Library</a> library; <span class="keyword">const</span> FT_Glyph_Class* clazz; <a href="ft2-basic_types.html#ft_glyph_format">FT_Glyph_Format</a> format; <a href="ft2-basic_types.html#ft_vector">FT_Vector</a> advance; @@ -1510,7 +1612,7 @@ <h4>note</h4> <p>You can typecast an <code><a href="ft2-glyph_management.html#ft_glyph">FT_Glyph</a></code> to <code><a href="ft2-glyph_management.html#ft_outlineglyph">FT_OutlineGlyph</a></code> if you have <code>glyph->format == FT_GLYPH_FORMAT_OUTLINE</code>. This lets you access the outline's content easily.</p> -<p>As the outline is extracted from a glyph slot, its coordinates are expressed normally in 26.6 pixels, unless the flag <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code> was used in <code><a href="ft2-base_interface.html#ft_load_glyph">FT_Load_Glyph</a></code> or <code><a href="ft2-base_interface.html#ft_load_char">FT_Load_Char</a></code>.</p> +<p>As the outline is extracted from a glyph slot, its coordinates are expressed normally in 26.6 pixels, unless the flag <code><a href="ft2-glyph_retrieval.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code> was used in <code><a href="ft2-glyph_retrieval.html#ft_load_glyph">FT_Load_Glyph</a></code> or <code><a href="ft2-character_mapping.html#ft_load_char">FT_Load_Char</a></code>.</p> <p>The outline's tables are always owned by the object and are destroyed with it.</p> <hr> @@ -1536,7 +1638,7 @@ <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> glyph_index; - <a href="ft2-base_interface.html#ft_size_metrics">FT_Size_Metrics</a> metrics; + <a href="ft2-sizing_and_scaling.html#ft_size_metrics">FT_Size_Metrics</a> metrics; <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a> units_per_EM; <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a> start_glyph_id; @@ -1591,7 +1693,7 @@ <h2 id="ft_new_glyph">FT_New_Glyph<a class="headerlink" href="#ft_new_glyph" title="Permanent link">¶</a></h2> <p>Defined in FT_GLYPH_H (freetype/ftglyph.h).</p> <div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> ) - <b>FT_New_Glyph</b>( <a href="ft2-base_interface.html#ft_library">FT_Library</a> library, + <b>FT_New_Glyph</b>( <a href="ft2-library_setup.html#ft_library">FT_Library</a> library, <a href="ft2-basic_types.html#ft_glyph_format">FT_Glyph_Format</a> format, <a href="ft2-glyph_management.html#ft_glyph">FT_Glyph</a> *aglyph ); </code></pre></div> @@ -1625,7 +1727,7 @@ <h2 id="ft_get_glyph">FT_Get_Glyph<a class="headerlink" href="#ft_get_glyph" title="Permanent link">¶</a></h2> <p>Defined in FT_GLYPH_H (freetype/ftglyph.h).</p> <div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> ) - <b>FT_Get_Glyph</b>( <a href="ft2-base_interface.html#ft_glyphslot">FT_GlyphSlot</a> slot, + <b>FT_Get_Glyph</b>( <a href="ft2-glyph_retrieval.html#ft_glyphslot">FT_GlyphSlot</a> slot, <a href="ft2-glyph_management.html#ft_glyph">FT_Glyph</a> *aglyph ); </code></pre></div> @@ -1787,8 +1889,8 @@ <h4>note</h4> <p>Coordinates are relative to the glyph origin, using the y upwards convention.</p> -<p>If the glyph has been loaded with <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code>, <code>bbox_mode</code> must be set to <code><a href="ft2-glyph_management.html#ft_glyph_bbox_mode">FT_GLYPH_BBOX_UNSCALED</a></code> to get unscaled font units in 26.6 pixel format. The value <code><a href="ft2-glyph_management.html#ft_glyph_bbox_mode">FT_GLYPH_BBOX_SUBPIXELS</a></code> is another name for this constant.</p> -<p>If the font is tricky and the glyph has been loaded with <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code>, the resulting CBox is meaningless. To get reasonable values for the CBox it is necessary to load the glyph at a large ppem value (so that the hinting instructions can properly shift and scale the subglyphs), then extracting the CBox, which can be eventually converted back to font units.</p> +<p>If the glyph has been loaded with <code><a href="ft2-glyph_retrieval.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code>, <code>bbox_mode</code> must be set to <code><a href="ft2-glyph_management.html#ft_glyph_bbox_mode">FT_GLYPH_BBOX_UNSCALED</a></code> to get unscaled font units in 26.6 pixel format. The value <code><a href="ft2-glyph_management.html#ft_glyph_bbox_mode">FT_GLYPH_BBOX_SUBPIXELS</a></code> is another name for this constant.</p> +<p>If the font is tricky and the glyph has been loaded with <code><a href="ft2-glyph_retrieval.html#ft_load_xxx">FT_LOAD_NO_SCALE</a></code>, the resulting CBox is meaningless. To get reasonable values for the CBox it is necessary to load the glyph at a large ppem value (so that the hinting instructions can properly shift and scale the subglyphs), then extracting the CBox, which can be eventually converted back to font units.</p> <p>Note that the maximum coordinates are exclusive, which means that one can compute the width and height of the glyph image (be it in integer or 26.6 pixels) as: <div class="highlight"><pre><span></span><code> width = bbox.xMax - bbox.xMin; height = bbox.yMax - bbox.yMin; @@ -1807,7 +1909,7 @@ <p>Defined in FT_GLYPH_H (freetype/ftglyph.h).</p> <div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> ) <b>FT_Glyph_To_Bitmap</b>( <a href="ft2-glyph_management.html#ft_glyph">FT_Glyph</a>* the_glyph, - <a href="ft2-base_interface.html#ft_render_mode">FT_Render_Mode</a> render_mode, + <a href="ft2-glyph_retrieval.html#ft_render_mode">FT_Render_Mode</a> render_mode, <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_vector">FT_Vector</a>* origin, <a href="ft2-basic_types.html#ft_bool">FT_Bool</a> destroy ); </code></pre></div> @@ -1993,7 +2095,7 @@ <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> - <script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.477d984a.min.js", "version": null}</script> + <script id="__config" type="application/json">{"base": ".", "features": [], "search": "assets/javascripts/workers/search.477d984a.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "version": null}</script> <script src="assets/javascripts/bundle.82b56eb2.min.js"></script> |