diff options
Diffstat (limited to 'freetype/docs/reference/site/ft2-basic_types.html')
| -rw-r--r-- | freetype/docs/reference/site/ft2-basic_types.html | 2422 |
1 files changed, 2422 insertions, 0 deletions
diff --git a/freetype/docs/reference/site/ft2-basic_types.html b/freetype/docs/reference/site/ft2-basic_types.html new file mode 100644 index 000000000..478a4d37a --- /dev/null +++ b/freetype/docs/reference/site/ft2-basic_types.html @@ -0,0 +1,2422 @@ + + + + +<!doctype html> +<html lang="en" class="no-js"> + <head> + + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width,initial-scale=1"> + <meta http-equiv="x-ua-compatible" content="ie=edge"> + + <meta name="description" content="API Reference Documentation for FreeType-2.10.1"> + + + + <meta name="author" content="FreeType Contributors"> + + + <meta name="lang:clipboard.copy" content="Copy to clipboard"> + + <meta name="lang:clipboard.copied" content="Copied to clipboard"> + + <meta name="lang:search.language" content="en"> + + <meta name="lang:search.pipeline.stopwords" content="True"> + + <meta name="lang:search.pipeline.trimmer" content="True"> + + <meta name="lang:search.result.none" content="No matching documents"> + + <meta name="lang:search.result.one" content="1 matching document"> + + <meta name="lang:search.result.other" content="# matching documents"> + + <meta name="lang:search.tokenizer" content="[\s\-]+"> + + <link rel="shortcut icon" href="images/favico.ico"> + <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.0.2"> + + + + <title>Basic Data Types - FreeType-2.10.1 API Reference</title> + + + + <link rel="stylesheet" href="assets/stylesheets/application.982221ab.css"> + + <link rel="stylesheet" href="assets/stylesheets/application-palette.224b79ff.css"> + + + + + <meta name="theme-color" content="#4caf50"> + + + + <script src="assets/javascripts/modernizr.1f0bcf2b.js"></script> + + + + <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700|Roboto+Mono"> + <style>body,input{font-family:"Noto Serif","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> + + + <link rel="stylesheet" href="assets/fonts/material-icons.css"> + + + <link rel="stylesheet" href="stylesheets/extra.css"> + + + + + + </head> + + + + <body dir="ltr" data-md-color-primary="green" data-md-color-accent="green"> + + <svg class="md-svg"> + <defs> + + + </defs> + </svg> + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> + <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> + + <a href="#basic-data-types" tabindex="1" class="md-skip"> + Skip to content + </a> + + + <header class="md-header" data-md-component="header"> + <nav class="md-header-nav md-grid"> + <div class="md-flex"> + <div class="md-flex__cell md-flex__cell--shrink"> + <a href="index.html" title="FreeType-2.10.1 API Reference" class="md-header-nav__button md-logo"> + + <img src="images/favico.ico" width="24" height="24"> + + </a> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> + </div> + <div class="md-flex__cell md-flex__cell--stretch"> + <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> + + <span class="md-header-nav__topic"> + FreeType-2.10.1 API Reference + </span> + <span class="md-header-nav__topic"> + Basic Data Types + </span> + + </div> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + + <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> + +<div class="md-search" data-md-component="search" role="dialog"> + <label class="md-search__overlay" for="__search"></label> + <div class="md-search__inner" role="search"> + <form class="md-search__form" name="search"> + <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> + <label class="md-icon md-search__icon" for="__search"></label> + <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> +  + </button> + </form> + <div class="md-search__output"> + <div class="md-search__scrollwrap" data-md-scrollfix> + <div class="md-search-result" data-md-component="result"> + <div class="md-search-result__meta"> + Type to start searching + </div> + <ol class="md-search-result__list"></ol> + </div> + </div> + </div> + </div> +</div> + + </div> + + </div> + </nav> +</header> + + <div class="md-container"> + + + + + <main class="md-main"> + <div class="md-main__inner md-grid" data-md-component="container"> + + + <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + <nav class="md-nav md-nav--primary" data-md-level="0"> + <label class="md-nav__title md-nav__title--site" for="__drawer"> + <a href="index.html" title="FreeType-2.10.1 API Reference" class="md-nav__button md-logo"> + + <img src="images/favico.ico" width="48" height="48"> + + </a> + FreeType-2.10.1 API Reference + </label> + + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + <li class="md-nav__item"> + <a href="index.html" title="TOC" class="md-nav__link"> + TOC + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-index.html" title="Index" class="md-nav__link"> + Index + </a> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3"> + + <label class="md-nav__link" for="nav-3"> + General Remarks + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-3"> + General Remarks + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-header_inclusion.html" title="FreeType's header inclusion scheme" class="md-nav__link"> + FreeType's header inclusion scheme + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-user_allocation.html" title="User allocation" class="md-nav__link"> + User allocation + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + + + <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked> + + <label class="md-nav__link" for="nav-4"> + Core API + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-4"> + Core API + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-version.html" title="FreeType Version" class="md-nav__link"> + FreeType Version + </a> + </li> + + + + + + + + + + <li class="md-nav__item md-nav__item--active"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + + + <label class="md-nav__link md-nav__link--active" for="__toc"> + Basic Data Types + </label> + + <a href="ft2-basic_types.html" title="Basic Data Types" class="md-nav__link md-nav__link--active"> + Basic Data Types + </a> + + +<nav class="md-nav md-nav--secondary"> + + + + + + <label class="md-nav__title" for="__toc">Table of contents</label> + <ul class="md-nav__list" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#synopsis" title="Synopsis" class="md-nav__link"> + Synopsis + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_byte" title="FT_Byte" class="md-nav__link"> + FT_Byte + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_bytes" title="FT_Bytes" class="md-nav__link"> + FT_Bytes + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_char" title="FT_Char" class="md-nav__link"> + FT_Char + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_int" title="FT_Int" class="md-nav__link"> + FT_Int + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_uint" title="FT_UInt" class="md-nav__link"> + FT_UInt + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_int16" title="FT_Int16" class="md-nav__link"> + FT_Int16 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_uint16" title="FT_UInt16" class="md-nav__link"> + FT_UInt16 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_int32" title="FT_Int32" class="md-nav__link"> + FT_Int32 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_uint32" title="FT_UInt32" class="md-nav__link"> + FT_UInt32 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_int64" title="FT_Int64" class="md-nav__link"> + FT_Int64 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_uint64" title="FT_UInt64" class="md-nav__link"> + FT_UInt64 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_short" title="FT_Short" class="md-nav__link"> + FT_Short + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_ushort" title="FT_UShort" class="md-nav__link"> + FT_UShort + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_long" title="FT_Long" class="md-nav__link"> + FT_Long + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_ulong" title="FT_ULong" class="md-nav__link"> + FT_ULong + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_bool" title="FT_Bool" class="md-nav__link"> + FT_Bool + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_offset" title="FT_Offset" class="md-nav__link"> + FT_Offset + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_ptrdist" title="FT_PtrDist" class="md-nav__link"> + FT_PtrDist + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_string" title="FT_String" class="md-nav__link"> + FT_String + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_tag" title="FT_Tag" class="md-nav__link"> + FT_Tag + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_error" title="FT_Error" class="md-nav__link"> + FT_Error + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_fixed" title="FT_Fixed" class="md-nav__link"> + FT_Fixed + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_pointer" title="FT_Pointer" class="md-nav__link"> + FT_Pointer + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_pos" title="FT_Pos" class="md-nav__link"> + FT_Pos + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_vector" title="FT_Vector" class="md-nav__link"> + FT_Vector + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_bbox" title="FT_BBox" class="md-nav__link"> + FT_BBox + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_matrix" title="FT_Matrix" class="md-nav__link"> + FT_Matrix + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_fword" title="FT_FWord" class="md-nav__link"> + FT_FWord + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_ufword" title="FT_UFWord" class="md-nav__link"> + FT_UFWord + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_f2dot14" title="FT_F2Dot14" class="md-nav__link"> + FT_F2Dot14 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_unitvector" title="FT_UnitVector" class="md-nav__link"> + FT_UnitVector + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_f26dot6" title="FT_F26Dot6" class="md-nav__link"> + FT_F26Dot6 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_data" title="FT_Data" class="md-nav__link"> + FT_Data + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_make_tag" title="FT_MAKE_TAG" class="md-nav__link"> + FT_MAKE_TAG + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_generic" title="FT_Generic" class="md-nav__link"> + FT_Generic + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_generic_finalizer" title="FT_Generic_Finalizer" class="md-nav__link"> + FT_Generic_Finalizer + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_bitmap" title="FT_Bitmap" class="md-nav__link"> + FT_Bitmap + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_pixel_mode" title="FT_Pixel_Mode" class="md-nav__link"> + FT_Pixel_Mode + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_glyph_format" title="FT_Glyph_Format" class="md-nav__link"> + FT_Glyph_Format + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_image_tag" title="FT_IMAGE_TAG" class="md-nav__link"> + FT_IMAGE_TAG + </a> + +</li> + + + + + + </ul> + +</nav> + + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-base_interface.html" title="Base Interface" class="md-nav__link"> + Base Interface + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-glyph_variants.html" title="Unicode Variation Sequences" class="md-nav__link"> + Unicode Variation Sequences + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-color_management.html" title="Glyph Color Management" class="md-nav__link"> + Glyph Color Management + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-layer_management.html" title="Glyph Layer Management" class="md-nav__link"> + Glyph Layer Management + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-glyph_management.html" title="Glyph Management" class="md-nav__link"> + Glyph Management + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-mac_specific.html" title="Mac Specific Interface" class="md-nav__link"> + Mac Specific Interface + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-sizes_management.html" title="Size Management" class="md-nav__link"> + Size Management + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-header_file_macros.html" title="Header File Macros" class="md-nav__link"> + Header File Macros + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5"> + + <label class="md-nav__link" for="nav-5"> + Format-Specific API + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-5"> + Format-Specific API + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-multiple_masters.html" title="Multiple Masters" class="md-nav__link"> + Multiple Masters + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-truetype_tables.html" title="TrueType Tables" class="md-nav__link"> + TrueType Tables + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-type1_tables.html" title="Type 1 Tables" class="md-nav__link"> + Type 1 Tables + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-sfnt_names.html" title="SFNT Names" class="md-nav__link"> + SFNT Names + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-bdf_fonts.html" title="BDF and PCF Files" class="md-nav__link"> + BDF and PCF Files + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-cid_fonts.html" title="CID Fonts" class="md-nav__link"> + CID Fonts + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-pfr_fonts.html" title="PFR Fonts" class="md-nav__link"> + PFR Fonts + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-winfnt_fonts.html" title="Window FNT Files" class="md-nav__link"> + Window FNT Files + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-font_formats.html" title="Font Formats" class="md-nav__link"> + Font Formats + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-gasp_table.html" title="Gasp Table" class="md-nav__link"> + Gasp Table + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6"> + + <label class="md-nav__link" for="nav-6"> + Controlling FreeType Modules + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-6"> + Controlling FreeType Modules + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-auto_hinter.html" title="The auto-hinter" class="md-nav__link"> + The auto-hinter + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-cff_driver.html" title="The CFF driver" class="md-nav__link"> + The CFF driver + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-t1_cid_driver.html" title="The Type 1 and CID drivers" class="md-nav__link"> + The Type 1 and CID drivers + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-tt_driver.html" title="The TrueType driver" class="md-nav__link"> + The TrueType driver + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-pcf_driver.html" title="The PCF driver" class="md-nav__link"> + The PCF driver + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-properties.html" title="Driver properties" class="md-nav__link"> + Driver properties + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-parameter_tags.html" title="Parameter Tags" class="md-nav__link"> + Parameter Tags + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-lcd_rendering.html" title="Subpixel Rendering" class="md-nav__link"> + Subpixel Rendering + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7"> + + <label class="md-nav__link" for="nav-7"> + Cache Sub-System + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-7"> + Cache Sub-System + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-cache_subsystem.html" title="Cache Sub-System" class="md-nav__link"> + Cache Sub-System + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8"> + + <label class="md-nav__link" for="nav-8"> + Support API + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-8"> + Support API + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-computations.html" title="Computations" class="md-nav__link"> + Computations + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-list_processing.html" title="List Processing" class="md-nav__link"> + List Processing + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-outline_processing.html" title="Outline Processing" class="md-nav__link"> + Outline Processing + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-quick_advance.html" title="Quick retrieval of advance values" class="md-nav__link"> + Quick retrieval of advance values + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-bitmap_handling.html" title="Bitmap Handling" class="md-nav__link"> + Bitmap Handling + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-raster.html" title="Scanline Converter" class="md-nav__link"> + Scanline Converter + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-glyph_stroker.html" title="Glyph Stroker" class="md-nav__link"> + Glyph Stroker + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-system_interface.html" title="System Interface" class="md-nav__link"> + System Interface + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-module_management.html" title="Module Management" class="md-nav__link"> + Module Management + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-gzip.html" title="GZIP Streams" class="md-nav__link"> + GZIP Streams + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-lzw.html" title="LZW Streams" class="md-nav__link"> + LZW Streams + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-bzip2.html" title="BZIP2 Streams" class="md-nav__link"> + BZIP2 Streams + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9"> + + <label class="md-nav__link" for="nav-9"> + Error Codes + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-9"> + Error Codes + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-error_enumerations.html" title="Error Enumerations" class="md-nav__link"> + Error Enumerations + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-error_code_values.html" title="Error Code Values" class="md-nav__link"> + Error Code Values + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10"> + + <label class="md-nav__link" for="nav-10"> + Miscellaneous + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-10"> + Miscellaneous + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-ot_validation.html" title="OpenType Validation" class="md-nav__link"> + OpenType Validation + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-incremental.html" title="Incremental Loading" class="md-nav__link"> + Incremental Loading + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-truetype_engine.html" title="The TrueType Engine" class="md-nav__link"> + The TrueType Engine + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="ft2-gx_validation.html" title="TrueTypeGX/AAT Validation" class="md-nav__link"> + TrueTypeGX/AAT Validation + </a> + </li> + + + </ul> + </nav> + </li> + + + </ul> +</nav> + </div> + </div> + </div> + + + <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + +<nav class="md-nav md-nav--secondary"> + + + + + + <label class="md-nav__title" for="__toc">Table of contents</label> + <ul class="md-nav__list" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#synopsis" title="Synopsis" class="md-nav__link"> + Synopsis + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_byte" title="FT_Byte" class="md-nav__link"> + FT_Byte + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_bytes" title="FT_Bytes" class="md-nav__link"> + FT_Bytes + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_char" title="FT_Char" class="md-nav__link"> + FT_Char + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_int" title="FT_Int" class="md-nav__link"> + FT_Int + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_uint" title="FT_UInt" class="md-nav__link"> + FT_UInt + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_int16" title="FT_Int16" class="md-nav__link"> + FT_Int16 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_uint16" title="FT_UInt16" class="md-nav__link"> + FT_UInt16 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_int32" title="FT_Int32" class="md-nav__link"> + FT_Int32 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_uint32" title="FT_UInt32" class="md-nav__link"> + FT_UInt32 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_int64" title="FT_Int64" class="md-nav__link"> + FT_Int64 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_uint64" title="FT_UInt64" class="md-nav__link"> + FT_UInt64 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_short" title="FT_Short" class="md-nav__link"> + FT_Short + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_ushort" title="FT_UShort" class="md-nav__link"> + FT_UShort + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_long" title="FT_Long" class="md-nav__link"> + FT_Long + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_ulong" title="FT_ULong" class="md-nav__link"> + FT_ULong + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_bool" title="FT_Bool" class="md-nav__link"> + FT_Bool + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_offset" title="FT_Offset" class="md-nav__link"> + FT_Offset + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_ptrdist" title="FT_PtrDist" class="md-nav__link"> + FT_PtrDist + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_string" title="FT_String" class="md-nav__link"> + FT_String + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_tag" title="FT_Tag" class="md-nav__link"> + FT_Tag + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_error" title="FT_Error" class="md-nav__link"> + FT_Error + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_fixed" title="FT_Fixed" class="md-nav__link"> + FT_Fixed + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_pointer" title="FT_Pointer" class="md-nav__link"> + FT_Pointer + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_pos" title="FT_Pos" class="md-nav__link"> + FT_Pos + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_vector" title="FT_Vector" class="md-nav__link"> + FT_Vector + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_bbox" title="FT_BBox" class="md-nav__link"> + FT_BBox + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_matrix" title="FT_Matrix" class="md-nav__link"> + FT_Matrix + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_fword" title="FT_FWord" class="md-nav__link"> + FT_FWord + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_ufword" title="FT_UFWord" class="md-nav__link"> + FT_UFWord + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_f2dot14" title="FT_F2Dot14" class="md-nav__link"> + FT_F2Dot14 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_unitvector" title="FT_UnitVector" class="md-nav__link"> + FT_UnitVector + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_f26dot6" title="FT_F26Dot6" class="md-nav__link"> + FT_F26Dot6 + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_data" title="FT_Data" class="md-nav__link"> + FT_Data + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_make_tag" title="FT_MAKE_TAG" class="md-nav__link"> + FT_MAKE_TAG + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_generic" title="FT_Generic" class="md-nav__link"> + FT_Generic + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_generic_finalizer" title="FT_Generic_Finalizer" class="md-nav__link"> + FT_Generic_Finalizer + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_bitmap" title="FT_Bitmap" class="md-nav__link"> + FT_Bitmap + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_pixel_mode" title="FT_Pixel_Mode" class="md-nav__link"> + FT_Pixel_Mode + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_glyph_format" title="FT_Glyph_Format" class="md-nav__link"> + FT_Glyph_Format + </a> + +</li> + + <li class="md-nav__item"> + <a href="#ft_image_tag" title="FT_IMAGE_TAG" class="md-nav__link"> + FT_IMAGE_TAG + </a> + +</li> + + + + + + </ul> + +</nav> + </div> + </div> + </div> + + + <div class="md-content"> + <article class="md-content__inner md-typeset"> + + + + <p><a href="https://www.freetype.org">FreeType</a> » <a href="../">Docs</a> » <a href="index.html#core-api">Core API</a> » Basic Data Types</p> +<hr /> +<h1 id="basic-data-types">Basic Data Types<a class="headerlink" href="#basic-data-types" title="Permanent link">¶</a></h1> +<h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">¶</a></h2> +<p>This section contains the basic data types defined by FreeType 2, ranging from simple scalar types to bitmap descriptors. More font-specific structures are defined in a different section.</p> +<h2 id="ft_byte">FT_Byte<a class="headerlink" href="#ft_byte" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <b>FT_Byte</b>; +</pre> +</div> + +<p>A simple typedef for the <em>unsigned</em> char type.</p> +<hr> + +<h2 id="ft_bytes">FT_Bytes<a class="headerlink" href="#ft_bytes" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>* <b>FT_Bytes</b>; +</pre> +</div> + +<p>A typedef for constant memory areas.</p> +<hr> + +<h2 id="ft_char">FT_Char<a class="headerlink" href="#ft_char" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">char</span> <b>FT_Char</b>; +</pre> +</div> + +<p>A simple typedef for the <em>signed</em> char type.</p> +<hr> + +<h2 id="ft_int">FT_Int<a class="headerlink" href="#ft_int" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">int</span> <b>FT_Int</b>; +</pre> +</div> + +<p>A typedef for the int type.</p> +<hr> + +<h2 id="ft_uint">FT_UInt<a class="headerlink" href="#ft_uint" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <b>FT_UInt</b>; +</pre> +</div> + +<p>A typedef for the unsigned int type.</p> +<hr> + +<h2 id="ft_int16">FT_Int16<a class="headerlink" href="#ft_int16" title="Permanent link">¶</a></h2> +<p>Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span> <b>FT_Int16</b>; +</pre> +</div> + +<p>A typedef for a 16bit signed integer type.</p> +<hr> + +<h2 id="ft_uint16">FT_UInt16<a class="headerlink" href="#ft_uint16" title="Permanent link">¶</a></h2> +<p>Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">short</span> <b>FT_UInt16</b>; +</pre> +</div> + +<p>A typedef for a 16bit unsigned integer type.</p> +<hr> + +<h2 id="ft_int32">FT_Int32<a class="headerlink" href="#ft_int32" title="Permanent link">¶</a></h2> +<p>Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> XXX <b>FT_Int32</b>; +</pre> +</div> + +<p>A typedef for a 32bit signed integer type. The size depends on the configuration.</p> +<hr> + +<h2 id="ft_uint32">FT_UInt32<a class="headerlink" href="#ft_uint32" title="Permanent link">¶</a></h2> +<p>Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> XXX <b>FT_UInt32</b>; +</pre> +</div> + +<hr> + +<h2 id="ft_int64">FT_Int64<a class="headerlink" href="#ft_int64" title="Permanent link">¶</a></h2> +<p>Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> XXX <b>FT_Int64</b>; +</pre> +</div> + +<hr> + +<h2 id="ft_uint64">FT_UInt64<a class="headerlink" href="#ft_uint64" title="Permanent link">¶</a></h2> +<p>Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> XXX <b>FT_UInt64</b>; +</pre> +</div> + +<hr> + +<h2 id="ft_short">FT_Short<a class="headerlink" href="#ft_short" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span> <b>FT_Short</b>; +</pre> +</div> + +<p>A typedef for signed short.</p> +<hr> + +<h2 id="ft_ushort">FT_UShort<a class="headerlink" href="#ft_ushort" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">short</span> <b>FT_UShort</b>; +</pre> +</div> + +<p>A typedef for unsigned short.</p> +<hr> + +<h2 id="ft_long">FT_Long<a class="headerlink" href="#ft_long" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span> <b>FT_Long</b>; +</pre> +</div> + +<p>A typedef for signed long.</p> +<hr> + +<h2 id="ft_ulong">FT_ULong<a class="headerlink" href="#ft_ulong" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">long</span> <b>FT_ULong</b>; +</pre> +</div> + +<p>A typedef for unsigned long.</p> +<hr> + +<h2 id="ft_bool">FT_Bool<a class="headerlink" href="#ft_bool" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <b>FT_Bool</b>; +</pre> +</div> + +<p>A typedef of unsigned char, used for simple booleans. As usual, values 1 and 0 represent true and false, respectively.</p> +<hr> + +<h2 id="ft_offset">FT_Offset<a class="headerlink" href="#ft_offset" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> size_t <b>FT_Offset</b>; +</pre> +</div> + +<p>This is equivalent to the ANSI C <code>size_t</code> type, i.e., the largest <em>unsigned</em> integer type used to express a file size or position, or a memory block size.</p> +<hr> + +<h2 id="ft_ptrdist">FT_PtrDist<a class="headerlink" href="#ft_ptrdist" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> ft_ptrdiff_t <b>FT_PtrDist</b>; +</pre> +</div> + +<p>This is equivalent to the ANSI C <code>ptrdiff_t</code> type, i.e., the largest <em>signed</em> integer type used to express the distance between two pointers.</p> +<hr> + +<h2 id="ft_string">FT_String<a class="headerlink" href="#ft_string" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">char</span> <b>FT_String</b>; +</pre> +</div> + +<p>A simple typedef for the char type, usually used for strings.</p> +<hr> + +<h2 id="ft_tag">FT_Tag<a class="headerlink" href="#ft_tag" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <a href="ft2-basic_types.html#ft_uint32">FT_UInt32</a> <b>FT_Tag</b>; +</pre> +</div> + +<p>A typedef for 32-bit tags (as used in the SFNT format).</p> +<hr> + +<h2 id="ft_error">FT_Error<a class="headerlink" href="#ft_error" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">int</span> <b>FT_Error</b>; +</pre> +</div> + +<p>The FreeType error code type. A value of 0 is always interpreted as a successful operation.</p> +<hr> + +<h2 id="ft_fixed">FT_Fixed<a class="headerlink" href="#ft_fixed" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span> <b>FT_Fixed</b>; +</pre> +</div> + +<p>This type is used to store 16.16 fixed-point values, like scaling values or matrix coefficients.</p> +<hr> + +<h2 id="ft_pointer">FT_Pointer<a class="headerlink" href="#ft_pointer" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">void</span>* <b>FT_Pointer</b>; +</pre> +</div> + +<p>A simple typedef for a typeless pointer.</p> +<hr> + +<h2 id="ft_pos">FT_Pos<a class="headerlink" href="#ft_pos" title="Permanent link">¶</a></h2> +<p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span> <b>FT_Pos</b>; +</pre> +</div> + +<p>The type FT_Pos is used to store vectorial coordinates. Depending on the context, these can represent distances in integer font units, or 16.16, or 26.6 fixed-point pixel coordinates.</p> +<hr> + +<h2 id="ft_vector">FT_Vector<a class="headerlink" href="#ft_vector" title="Permanent link">¶</a></h2> +<p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Vector_ + { + <a href="ft2-basic_types.html#ft_pos">FT_Pos</a> x; + <a href="ft2-basic_types.html#ft_pos">FT_Pos</a> y; + + } <b>FT_Vector</b>; +</pre> +</div> + +<p>A simple structure used to store a 2D vector; coordinates are of the FT_Pos type.</p> +<h4>fields</h4> + +<table class="fields"> +<tr><td class="val" id="x">x</td><td class="desc"> +<p>The horizontal coordinate.</p> +</td></tr> +<tr><td class="val" id="y">y</td><td class="desc"> +<p>The vertical coordinate.</p> +</td></tr> +</table> + +<hr> + +<h2 id="ft_bbox">FT_BBox<a class="headerlink" href="#ft_bbox" title="Permanent link">¶</a></h2> +<p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_BBox_ + { + <a href="ft2-basic_types.html#ft_pos">FT_Pos</a> xMin, yMin; + <a href="ft2-basic_types.html#ft_pos">FT_Pos</a> xMax, yMax; + + } <b>FT_BBox</b>; +</pre> +</div> + +<p>A structure used to hold an outline's bounding box, i.e., the coordinates of its extrema in the horizontal and vertical directions.</p> +<h4>fields</h4> + +<table class="fields"> +<tr><td class="val" id="xmin">xMin</td><td class="desc"> +<p>The horizontal minimum (left-most).</p> +</td></tr> +<tr><td class="val" id="ymin">yMin</td><td class="desc"> +<p>The vertical minimum (bottom-most).</p> +</td></tr> +<tr><td class="val" id="xmax">xMax</td><td class="desc"> +<p>The horizontal maximum (right-most).</p> +</td></tr> +<tr><td class="val" id="ymax">yMax</td><td class="desc"> +<p>The vertical maximum (top-most).</p> +</td></tr> +</table> + +<h4>note</h4> + +<p>The bounding box is specified with the coordinates of the lower left and the upper right corner. In PostScript, those values are often called (llx,lly) and (urx,ury), respectively.</p> +<p>If <code>yMin</code> is negative, this value gives the glyph's descender. Otherwise, the glyph doesn't descend below the baseline. Similarly, if <code>ymax</code> is positive, this value gives the glyph's ascender.</p> +<p><code>xMin</code> gives the horizontal distance from the glyph's origin to the left edge of the glyph's bounding box. If <code>xMin</code> is negative, the glyph extends to the left of the origin.</p> +<hr> + +<h2 id="ft_matrix">FT_Matrix<a class="headerlink" href="#ft_matrix" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Matrix_ + { + <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a> xx, xy; + <a href="ft2-basic_types.html#ft_fixed">FT_Fixed</a> yx, yy; + + } <b>FT_Matrix</b>; +</pre> +</div> + +<p>A simple structure used to store a 2x2 matrix. Coefficients are in 16.16 fixed-point format. The computation performed is: +<div class="codehilite"><pre><span></span> x' = x*xx + y*xy + y' = x*yx + y*yy +</pre></div></p> +<h4>fields</h4> + +<table class="fields"> +<tr><td class="val" id="xx">xx</td><td class="desc"> +<p>Matrix coefficient.</p> +</td></tr> +<tr><td class="val" id="xy">xy</td><td class="desc"> +<p>Matrix coefficient.</p> +</td></tr> +<tr><td class="val" id="yx">yx</td><td class="desc"> +<p>Matrix coefficient.</p> +</td></tr> +<tr><td class="val" id="yy">yy</td><td class="desc"> +<p>Matrix coefficient.</p> +</td></tr> +</table> + +<hr> + +<h2 id="ft_fword">FT_FWord<a class="headerlink" href="#ft_fword" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span> <b>FT_FWord</b>; /* distance in FUnits */ +</pre> +</div> + +<p>A signed 16-bit integer used to store a distance in original font units.</p> +<hr> + +<h2 id="ft_ufword">FT_UFWord<a class="headerlink" href="#ft_ufword" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">short</span> <b>FT_UFWord</b>; /* <span class="keyword">unsigned</span> distance */ +</pre> +</div> + +<p>An unsigned 16-bit integer used to store a distance in original font units.</p> +<hr> + +<h2 id="ft_f2dot14">FT_F2Dot14<a class="headerlink" href="#ft_f2dot14" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span> <b>FT_F2Dot14</b>; +</pre> +</div> + +<p>A signed 2.14 fixed-point type used for unit vectors.</p> +<hr> + +<h2 id="ft_unitvector">FT_UnitVector<a class="headerlink" href="#ft_unitvector" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_UnitVector_ + { + <a href="ft2-basic_types.html#ft_f2dot14">FT_F2Dot14</a> x; + <a href="ft2-basic_types.html#ft_f2dot14">FT_F2Dot14</a> y; + + } <b>FT_UnitVector</b>; +</pre> +</div> + +<p>A simple structure used to store a 2D vector unit vector. Uses FT_F2Dot14 types.</p> +<h4>fields</h4> + +<table class="fields"> +<tr><td class="val" id="x">x</td><td class="desc"> +<p>Horizontal coordinate.</p> +</td></tr> +<tr><td class="val" id="y">y</td><td class="desc"> +<p>Vertical coordinate.</p> +</td></tr> +</table> + +<hr> + +<h2 id="ft_f26dot6">FT_F26Dot6<a class="headerlink" href="#ft_f26dot6" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span> <b>FT_F26Dot6</b>; +</pre> +</div> + +<p>A signed 26.6 fixed-point type used for vectorial pixel coordinates.</p> +<hr> + +<h2 id="ft_data">FT_Data<a class="headerlink" href="#ft_data" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Data_ + { + <span class="keyword">const</span> <a href="ft2-basic_types.html#ft_byte">FT_Byte</a>* pointer; + <a href="ft2-basic_types.html#ft_int">FT_Int</a> length; + + } <b>FT_Data</b>; +</pre> +</div> + +<p>Read-only binary data represented as a pointer and a length.</p> +<h4>fields</h4> + +<table class="fields"> +<tr><td class="val" id="pointer">pointer</td><td class="desc"> +<p>The data.</p> +</td></tr> +<tr><td class="val" id="length">length</td><td class="desc"> +<p>The length of the data in bytes.</p> +</td></tr> +</table> + +<hr> + +<h2 id="ft_make_tag">FT_MAKE_TAG<a class="headerlink" href="#ft_make_tag" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> +#<span class="keyword">define</span> <b>FT_MAKE_TAG</b>( _x1, _x2, _x3, _x4 ) \ + (<a href="ft2-basic_types.html#ft_tag">FT_Tag</a>) \ + ( ( (<a href="ft2-basic_types.html#ft_ulong">FT_ULong</a>)_x1 << 24 ) | \ + ( (<a href="ft2-basic_types.html#ft_ulong">FT_ULong</a>)_x2 << 16 ) | \ + ( (<a href="ft2-basic_types.html#ft_ulong">FT_ULong</a>)_x3 << 8 ) | \ + (<a href="ft2-basic_types.html#ft_ulong">FT_ULong</a>)_x4 ) +</pre> +</div> + +<p>This macro converts four-letter tags that are used to label TrueType tables into an unsigned long, to be used within FreeType.</p> +<h4>note</h4> + +<p>The produced values <strong>must</strong> be 32-bit integers. Don't redefine this macro.</p> +<hr> + +<h2 id="ft_generic">FT_Generic<a class="headerlink" href="#ft_generic" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Generic_ + { + <span class="keyword">void</span>* data; + <a href="ft2-basic_types.html#ft_generic_finalizer">FT_Generic_Finalizer</a> finalizer; + + } <b>FT_Generic</b>; +</pre> +</div> + +<p>Client applications often need to associate their own data to a variety of FreeType core objects. For example, a text layout API might want to associate a glyph cache to a given size object.</p> +<p>Some FreeType object contains a <code>generic</code> field, of type <code>FT_Generic</code>, which usage is left to client applications and font servers.</p> +<p>It can be used to store a pointer to client-specific data, as well as the address of a ‘finalizer’ function, which will be called by FreeType when the object is destroyed (for example, the previous client example would put the address of the glyph cache destructor in the <code>finalizer</code> field).</p> +<h4>fields</h4> + +<table class="fields"> +<tr><td class="val" id="data">data</td><td class="desc"> +<p>A typeless pointer to any client-specified data. This field is completely ignored by the FreeType library.</p> +</td></tr> +<tr><td class="val" id="finalizer">finalizer</td><td class="desc"> +<p>A pointer to a ‘generic finalizer’ function, which will be called when the object is destroyed. If this field is set to <code>NULL</code>, no code will be called.</p> +</td></tr> +</table> + +<hr> + +<h2 id="ft_generic_finalizer">FT_Generic_Finalizer<a class="headerlink" href="#ft_generic_finalizer" title="Permanent link">¶</a></h2> +<p>Defined in FT_TYPES_H (freetype/fttypes.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">void</span> (*<b>FT_Generic_Finalizer</b>)( <span class="keyword">void</span>* object ); +</pre> +</div> + +<p>Describe a function used to destroy the ‘client’ data of any FreeType object. See the description of the <code><a href="ft2-basic_types.html#ft_generic">FT_Generic</a></code> type for details of usage.</p> +<h4>input</h4> + +<p>The address of the FreeType object that is under finalization. Its client data is accessed through its <code>generic</code> field.</p> +<hr> + +<h2 id="ft_bitmap">FT_Bitmap<a class="headerlink" href="#ft_bitmap" title="Permanent link">¶</a></h2> +<p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_Bitmap_ + { + <span class="keyword">unsigned</span> <span class="keyword">int</span> rows; + <span class="keyword">unsigned</span> <span class="keyword">int</span> width; + <span class="keyword">int</span> pitch; + <span class="keyword">unsigned</span> <span class="keyword">char</span>* buffer; + <span class="keyword">unsigned</span> <span class="keyword">short</span> num_grays; + <span class="keyword">unsigned</span> <span class="keyword">char</span> pixel_mode; + <span class="keyword">unsigned</span> <span class="keyword">char</span> palette_mode; + <span class="keyword">void</span>* palette; + + } <b>FT_Bitmap</b>; +</pre> +</div> + +<p>A structure used to describe a bitmap or pixmap to the raster. Note that we now manage pixmaps of various depths through the <code>pixel_mode</code> field.</p> +<h4>fields</h4> + +<table class="fields"> +<tr><td class="val" id="rows">rows</td><td class="desc"> +<p>The number of bitmap rows.</p> +</td></tr> +<tr><td class="val" id="width">width</td><td class="desc"> +<p>The number of pixels in bitmap row.</p> +</td></tr> +<tr><td class="val" id="pitch">pitch</td><td class="desc"> +<p>The pitch's absolute value is the number of bytes taken by one bitmap row, including padding. However, the pitch is positive when the bitmap has a ‘down’ flow, and negative when it has an ‘up’ flow. In all cases, the pitch is an offset to add to a bitmap pointer in order to go down one row.</p> +<p>Note that ‘padding’ means the alignment of a bitmap to a byte border, and FreeType functions normally align to the smallest possible integer value.</p> +<p>For the B/W rasterizer, <code>pitch</code> is always an even number.</p> +<p>To change the pitch of a bitmap (say, to make it a multiple of 4), use <code><a href="ft2-bitmap_handling.html#ft_bitmap_convert">FT_Bitmap_Convert</a></code>. Alternatively, you might use callback functions to directly render to the application's surface; see the file <code>example2.cpp</code> in the tutorial for a demonstration.</p> +</td></tr> +<tr><td class="val" id="buffer">buffer</td><td class="desc"> +<p>A typeless pointer to the bitmap buffer. This value should be aligned on 32-bit boundaries in most cases.</p> +</td></tr> +<tr><td class="val" id="num_grays">num_grays</td><td class="desc"> +<p>This field is only used with <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_PIXEL_MODE_GRAY</a></code>; it gives the number of gray levels used in the bitmap.</p> +</td></tr> +<tr><td class="val" id="pixel_mode">pixel_mode</td><td class="desc"> +<p>The pixel mode, i.e., how pixel bits are stored. See <code><a href="ft2-basic_types.html#ft_pixel_mode">FT_Pixel_Mode</a></code> for possible values.</p> +</td></tr> +<tr><td class="val" id="palette_mode">palette_mode</td><td class="desc"> +<p>This field is intended for paletted pixel modes; it indicates how the palette is stored. Not used currently.</p> +</td></tr> +<tr><td class="val" id="palette">palette</td><td class="desc"> +<p>A typeless pointer to the bitmap palette; this field is intended for paletted pixel modes. Not used currently.</p> +</td></tr> +</table> + +<hr> + +<h2 id="ft_pixel_mode">FT_Pixel_Mode<a class="headerlink" href="#ft_pixel_mode" title="Permanent link">¶</a></h2> +<p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">enum</span> FT_Pixel_Mode_ + { + <a href="ft2-basic_types.html#ft_pixel_mode_none">FT_PIXEL_MODE_NONE</a> = 0, + <a href="ft2-basic_types.html#ft_pixel_mode_mono">FT_PIXEL_MODE_MONO</a>, + <a href="ft2-basic_types.html#ft_pixel_mode_gray">FT_PIXEL_MODE_GRAY</a>, + <a href="ft2-basic_types.html#ft_pixel_mode_gray2">FT_PIXEL_MODE_GRAY2</a>, + <a href="ft2-basic_types.html#ft_pixel_mode_gray4">FT_PIXEL_MODE_GRAY4</a>, + <a href="ft2-basic_types.html#ft_pixel_mode_lcd">FT_PIXEL_MODE_LCD</a>, + <a href="ft2-basic_types.html#ft_pixel_mode_lcd_v">FT_PIXEL_MODE_LCD_V</a>, + <a href="ft2-basic_types.html#ft_pixel_mode_bgra">FT_PIXEL_MODE_BGRA</a>, + + FT_PIXEL_MODE_MAX /* do not remove */ + + } <b>FT_Pixel_Mode</b>; + + + /* these constants are deprecated; use the corresponding `<b>FT_Pixel_Mode</b>` */ + /* values instead. */ +#<span class="keyword">define</span> ft_pixel_mode_none <a href="ft2-basic_types.html#ft_pixel_mode_none">FT_PIXEL_MODE_NONE</a> +#<span class="keyword">define</span> ft_pixel_mode_mono <a href="ft2-basic_types.html#ft_pixel_mode_mono">FT_PIXEL_MODE_MONO</a> +#<span class="keyword">define</span> ft_pixel_mode_grays <a href="ft2-basic_types.html#ft_pixel_mode_gray">FT_PIXEL_MODE_GRAY</a> +#<span class="keyword">define</span> ft_pixel_mode_pal2 <a href="ft2-basic_types.html#ft_pixel_mode_gray2">FT_PIXEL_MODE_GRAY2</a> +#<span class="keyword">define</span> ft_pixel_mode_pal4 <a href="ft2-basic_types.html#ft_pixel_mode_gray4">FT_PIXEL_MODE_GRAY4</a> +</pre> +</div> + +<p>An enumeration type used to describe the format of pixels in a given bitmap. Note that additional formats may be added in the future.</p> +<h4>values</h4> + +<table class="fields"> +<tr><td class="val" id="ft_pixel_mode_none">FT_PIXEL_MODE_NONE</td><td class="desc"> +<p>Value 0 is reserved.</p> +</td></tr> +<tr><td class="val" id="ft_pixel_mode_mono">FT_PIXEL_MODE_MONO</td><td class="desc"> +<p>A monochrome bitmap, using 1 bit per pixel. Note that pixels are stored in most-significant order (MSB), which means that the left-most pixel in a byte has value 128.</p> +</td></tr> +<tr><td class="val" id="ft_pixel_mode_gray">FT_PIXEL_MODE_GRAY</td><td class="desc"> +<p>An 8-bit bitmap, generally used to represent anti-aliased glyph images. Each pixel is stored in one byte. Note that the number of ‘gray’ levels is stored in the <code>num_grays</code> field of the <code><a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a></code> structure (it generally is 256).</p> +</td></tr> +<tr><td class="val" id="ft_pixel_mode_gray2">FT_PIXEL_MODE_GRAY2</td><td class="desc"> +<p>A 2-bit per pixel bitmap, used to represent embedded anti-aliased bitmaps in font files according to the OpenType specification. We haven't found a single font using this format, however.</p> +</td></tr> +<tr><td class="val" id="ft_pixel_mode_gray4">FT_PIXEL_MODE_GRAY4</td><td class="desc"> +<p>A 4-bit per pixel bitmap, representing embedded anti-aliased bitmaps in font files according to the OpenType specification. We haven't found a single font using this format, however.</p> +</td></tr> +<tr><td class="val" id="ft_pixel_mode_lcd">FT_PIXEL_MODE_LCD</td><td class="desc"> +<p>An 8-bit bitmap, representing RGB or BGR decimated glyph images used for display on LCD displays; the bitmap is three times wider than the original glyph image. See also <code><a href="ft2-base_interface.html#ft_render_mode">FT_RENDER_MODE_LCD</a></code>.</p> +</td></tr> +<tr><td class="val" id="ft_pixel_mode_lcd_v">FT_PIXEL_MODE_LCD_V</td><td class="desc"> +<p>An 8-bit bitmap, representing RGB or BGR decimated glyph images used for display on rotated LCD displays; the bitmap is three times taller than the original glyph image. See also <code><a href="ft2-base_interface.html#ft_render_mode">FT_RENDER_MODE_LCD_V</a></code>.</p> +</td></tr> +<tr><td class="val" id="ft_pixel_mode_bgra">FT_PIXEL_MODE_BGRA</td><td class="desc"> +<p>[Since 2.5] An image with four 8-bit channels per pixel, representing a color image (such as emoticons) with alpha channel. For each pixel, the format is BGRA, which means, the blue channel comes first in memory. The color channels are pre-multiplied and in the sRGB colorspace. For example, full red at half-translucent opacity will be represented as ‘00,00,80,80’, not ‘00,00,FF,80’. See also <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_COLOR</a></code>.</p> +</td></tr> +</table> + +<hr> + +<h2 id="ft_glyph_format">FT_Glyph_Format<a class="headerlink" href="#ft_glyph_format" title="Permanent link">¶</a></h2> +<p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p> +<div class = "codehilite"> +<pre> + <span class="keyword">typedef</span> <span class="keyword">enum</span> FT_Glyph_Format_ + { + <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_none">FT_GLYPH_FORMAT_NONE</a>, 0, 0, 0, 0 ), + + <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_composite">FT_GLYPH_FORMAT_COMPOSITE</a>, 'c', 'o', 'm', 'p' ), + <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_bitmap">FT_GLYPH_FORMAT_BITMAP</a>, 'b', 'i', 't', 's' ), + <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_outline">FT_GLYPH_FORMAT_OUTLINE</a>, 'o', 'u', 't', 'l' ), + <a href="ft2-basic_types.html#ft_image_tag">FT_IMAGE_TAG</a>( <a href="ft2-basic_types.html#ft_glyph_format_plotter">FT_GLYPH_FORMAT_PLOTTER</a>, 'p', 'l', 'o', 't' ) + + } <b>FT_Glyph_Format</b>; + + + /* these constants are deprecated; use the corresponding */ + /* `<b>FT_Glyph_Format</b>` values instead. */ +#<span class="keyword">define</span> ft_glyph_format_none <a href="ft2-basic_types.html#ft_glyph_format_none">FT_GLYPH_FORMAT_NONE</a> +#<span class="keyword">define</span> ft_glyph_format_composite <a href="ft2-basic_types.html#ft_glyph_format_composite">FT_GLYPH_FORMAT_COMPOSITE</a> +#<span class="keyword">define</span> ft_glyph_format_bitmap <a href="ft2-basic_types.html#ft_glyph_format_bitmap">FT_GLYPH_FORMAT_BITMAP</a> +#<span class="keyword">define</span> ft_glyph_format_outline <a href="ft2-basic_types.html#ft_glyph_format_outline">FT_GLYPH_FORMAT_OUTLINE</a> +#<span class="keyword">define</span> ft_glyph_format_plotter <a href="ft2-basic_types.html#ft_glyph_format_plotter">FT_GLYPH_FORMAT_PLOTTER</a> +</pre> +</div> + +<p>An enumeration type used to describe the format of a given glyph image. Note that this version of FreeType only supports two image formats, even though future font drivers will be able to register their own format.</p> +<h4>values</h4> + +<table class="fields"> +<tr><td class="val" id="ft_glyph_format_none">FT_GLYPH_FORMAT_NONE</td><td class="desc"> +<p>The value 0 is reserved.</p> +</td></tr> +<tr><td class="val" id="ft_glyph_format_composite">FT_GLYPH_FORMAT_COMPOSITE</td><td class="desc"> +<p>The glyph image is a composite of several other images. This format is <em>only</em> used with <code><a href="ft2-base_interface.html#ft_load_xxx">FT_LOAD_NO_RECURSE</a></code>, and is used to report compound glyphs (like accented characters).</p> +</td></tr> +<tr><td class="val" id="ft_glyph_format_bitmap">FT_GLYPH_FORMAT_BITMAP</td><td class="desc"> +<p>The glyph image is a bitmap, and can be described as an <code><a href="ft2-basic_types.html#ft_bitmap">FT_Bitmap</a></code>. You generally need to access the <code>bitmap</code> field of the <code><a href="ft2-base_interface.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code> structure to read it.</p> +</td></tr> +<tr><td class="val" id="ft_glyph_format_outline">FT_GLYPH_FORMAT_OUTLINE</td><td class="desc"> +<p>The glyph image is a vectorial outline made of line segments and Bezier arcs; it can be described as an <code><a href="ft2-outline_processing.html#ft_outline">FT_Outline</a></code>; you generally want to access the <code>outline</code> field of the <code><a href="ft2-base_interface.html#ft_glyphslotrec">FT_GlyphSlotRec</a></code> structure to read it.</p> +</td></tr> +<tr><td class="val" id="ft_glyph_format_plotter">FT_GLYPH_FORMAT_PLOTTER</td><td class="desc"> +<p>The glyph image is a vectorial path with no inside and outside contours. Some Type 1 fonts, like those in the Hershey family, contain glyphs in this format. These are described as <code><a href="ft2-outline_processing.html#ft_outline">FT_Outline</a></code>, but FreeType isn't currently capable of rendering them correctly.</p> +</td></tr> +</table> + +<hr> + +<h2 id="ft_image_tag">FT_IMAGE_TAG<a class="headerlink" href="#ft_image_tag" title="Permanent link">¶</a></h2> +<p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p> +<div class = "codehilite"> +<pre> +#<span class="keyword">ifndef</span> <b>FT_IMAGE_TAG</b> +#<span class="keyword">define</span> <b>FT_IMAGE_TAG</b>( value, _x1, _x2, _x3, _x4 ) \ + value = ( ( (<span class="keyword">unsigned</span> <span class="keyword">long</span>)_x1 << 24 ) | \ + ( (<span class="keyword">unsigned</span> <span class="keyword">long</span>)_x2 << 16 ) | \ + ( (<span class="keyword">unsigned</span> <span class="keyword">long</span>)_x3 << 8 ) | \ + (<span class="keyword">unsigned</span> <span class="keyword">long</span>)_x4 ) +#<span class="keyword">endif</span> /* <b>FT_IMAGE_TAG</b> */ +</pre> +</div> + +<p>This macro converts four-letter tags to an unsigned long type.</p> +<h4>note</h4> + +<p>Since many 16-bit compilers don't like 32-bit enumerations, you should redefine this macro in case of problems to something like this: +<div class="codehilite"><pre><span></span> #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) value +</pre></div></p> +<p>to get a simple enumeration without assigning special numbers.</p> +<hr> + + + + + + + + + + </article> + </div> + </div> + </main> + + +<footer class="md-footer"> + + <div class="md-footer-nav"> + <nav class="md-footer-nav__inner md-grid"> + + <a href="ft2-version.html" title="FreeType Version" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> + </div> + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + Previous + </span> + FreeType Version + </span> + </div> + </a> + + + <a href="ft2-base_interface.html" title="Base Interface" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + Next + </span> + Base Interface + </span> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> + </div> + </a> + + </nav> + </div> + + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-footer-copyright"> + + <div class="md-footer-copyright__highlight"> + Copyright 2019 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>. + </div> + + powered by + <a href="https://www.mkdocs.org">MkDocs</a> + and + <a href="https://squidfunk.github.io/mkdocs-material/"> + Material for MkDocs</a> + </div> + + </div> + </div> +</footer> + + </div> + + <script src="assets/javascripts/application.d9aa80ab.js"></script> + + <script>app.initialize({version:"1.0.4",url:{base:"."}})</script> + + <script src="javascripts/extra.js"></script> + + + </body> +</html>
\ No newline at end of file |