diff --git a/android/x86_64/include/freetype/config/ftconfig.h b/android/x86_64/include/freetype/config/ftconfig.h index d5b27acc..0e1945b7 100644 --- a/android/x86_64/include/freetype/config/ftconfig.h +++ b/android/x86_64/include/freetype/config/ftconfig.h @@ -1,42 +1,44 @@ /* ftconfig.h. Generated from ftconfig.in by configure. */ -/**************************************************************************** - * - * ftconfig.in - * - * UNIX-specific configuration file (specification only). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftconfig.in */ +/* */ +/* UNIX-specific configuration file (specification only). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * This header file contains a number of macro definitions that are used by - * the rest of the engine. Most of the macros here are automatically - * determined at compile time, and you should not need to change it to port - * FreeType, except to compile the library with a non-ANSI compiler. - * - * Note however that if some specific modifications are needed, we advise - * you to place a modified copy in your build directory. - * - * The build directory is usually `builds/`, and contains - * system-specific files that are always included first when building the - * library. - * - */ + /*************************************************************************/ + /* */ + /* This header file contains a number of macro definitions that are used */ + /* by the rest of the engine. Most of the macros here are automatically */ + /* determined at compile time, and you should not need to change it to */ + /* port FreeType, except to compile the library with a non-ANSI */ + /* compiler. */ + /* */ + /* Note however that if some specific modifications are needed, we */ + /* advise you to place a modified copy in your build directory. */ + /* */ + /* The build directory is usually `builds/', and contains */ + /* system-specific files that are always included first when building */ + /* the library. */ + /* */ + /*************************************************************************/ + #ifndef FTCONFIG_H_ #define FTCONFIG_H_ -#include "../ft2build.h" +#include #include FT_CONFIG_OPTIONS_H #include FT_CONFIG_STANDARD_LIBRARY_H @@ -44,28 +46,30 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * PLATFORM-SPECIFIC CONFIGURATION MACROS - * - * These macros can be toggled to suit a specific system. The current ones - * are defaults used to compile FreeType in an ANSI C environment (16bit - * compilers are also supported). Copy this file to your own - * `builds/` directory, and edit it to port the engine. - * - */ + /*************************************************************************/ + /* */ + /* PLATFORM-SPECIFIC CONFIGURATION MACROS */ + /* */ + /* These macros can be toggled to suit a specific system. The current */ + /* ones are defaults used to compile FreeType in an ANSI C environment */ + /* (16bit compilers are also supported). Copy this file to your own */ + /* `builds/' directory, and edit it to port the engine. */ + /* */ + /*************************************************************************/ + #define HAVE_UNISTD_H 1 #define HAVE_FCNTL_H 1 #define HAVE_STDINT_H 1 - /* There are systems (like the Texas Instruments 'C54x) where a `char` */ - /* has 16~bits. ANSI~C says that `sizeof(char)` is always~1. Since an */ - /* `int` has 16~bits also for this system, `sizeof(int)` gives~1 which */ - /* is probably unexpected. */ - /* */ - /* `CHAR_BIT` (defined in `limits.h`) gives the number of bits in a */ - /* `char` type. */ + + /* There are systems (like the Texas Instruments 'C54x) where a `char' */ + /* has 16 bits. ANSI C says that sizeof(char) is always 1. Since an */ + /* `int' has 16 bits also for this system, sizeof(int) gives 1 which */ + /* is probably unexpected. */ + /* */ + /* `CHAR_BIT' (defined in limits.h) gives the number of bits in a */ + /* `char' type. */ #ifndef FT_CHAR_BIT #define FT_CHAR_BIT CHAR_BIT @@ -82,66 +86,67 @@ FT_BEGIN_HEADER #else /* !FT_USE_AUTOCONF_SIZEOF_TYPES */ - /* Following cpp computation of the bit length of `int` and `long` */ - /* is copied from default `include/freetype/config/ftconfig.h`. */ - /* If any improvement is required for this file, it should be */ - /* applied to the original header file for the builders that do */ - /* not use configure script. */ + /* Following cpp computation of the bit length of int and long */ + /* is copied from default include/freetype/config/ftconfig.h. */ + /* If any improvement is required for this file, it should be */ + /* applied to the original header file for the builders that */ + /* do not use configure script. */ - /* The size of an `int` type. */ + /* The size of an `int' type. */ #if FT_UINT_MAX == 0xFFFFUL -#define FT_SIZEOF_INT ( 16 / FT_CHAR_BIT ) +#define FT_SIZEOF_INT (16 / FT_CHAR_BIT) #elif FT_UINT_MAX == 0xFFFFFFFFUL -#define FT_SIZEOF_INT ( 32 / FT_CHAR_BIT ) +#define FT_SIZEOF_INT (32 / FT_CHAR_BIT) #elif FT_UINT_MAX > 0xFFFFFFFFUL && FT_UINT_MAX == 0xFFFFFFFFFFFFFFFFUL -#define FT_SIZEOF_INT ( 64 / FT_CHAR_BIT ) +#define FT_SIZEOF_INT (64 / FT_CHAR_BIT) #else #error "Unsupported size of `int' type!" #endif - /* The size of a `long` type. A five-byte `long` (as used e.g. on the */ + /* The size of a `long' type. A five-byte `long' (as used e.g. on the */ /* DM642) is recognized but avoided. */ #if FT_ULONG_MAX == 0xFFFFFFFFUL -#define FT_SIZEOF_LONG ( 32 / FT_CHAR_BIT ) +#define FT_SIZEOF_LONG (32 / FT_CHAR_BIT) #elif FT_ULONG_MAX > 0xFFFFFFFFUL && FT_ULONG_MAX == 0xFFFFFFFFFFUL -#define FT_SIZEOF_LONG ( 32 / FT_CHAR_BIT ) +#define FT_SIZEOF_LONG (32 / FT_CHAR_BIT) #elif FT_ULONG_MAX > 0xFFFFFFFFUL && FT_ULONG_MAX == 0xFFFFFFFFFFFFFFFFUL -#define FT_SIZEOF_LONG ( 64 / FT_CHAR_BIT ) +#define FT_SIZEOF_LONG (64 / FT_CHAR_BIT) #else #error "Unsupported size of `long' type!" #endif #endif /* !FT_USE_AUTOCONF_SIZEOF_TYPES */ - /* `FT_UNUSED` indicates that a given parameter is not used -- */ - /* this is only used to get rid of unpleasant compiler warnings. */ + + /* FT_UNUSED is a macro used to indicate that a given parameter is not */ + /* used -- this is only used to get rid of unpleasant compiler warnings */ #ifndef FT_UNUSED #define FT_UNUSED( arg ) ( (arg) = (arg) ) #endif - /************************************************************************** - * - * AUTOMATIC CONFIGURATION MACROS - * - * These macros are computed from the ones defined above. Don't touch - * their definition, unless you know precisely what you are doing. No - * porter should need to mess with them. - * - */ + /*************************************************************************/ + /* */ + /* AUTOMATIC CONFIGURATION MACROS */ + /* */ + /* These macros are computed from the ones defined above. Don't touch */ + /* their definition, unless you know precisely what you are doing. No */ + /* porter should need to mess with them. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * Mac support - * - * This is the only necessary change, so it is defined here instead - * providing a new configuration file. - */ + /*************************************************************************/ + /* */ + /* Mac support */ + /* */ + /* This is the only necessary change, so it is defined here instead */ + /* providing a new configuration file. */ + /* */ #if defined( __APPLE__ ) || ( defined( __MWERKS__ ) && defined( macintosh ) ) - /* No Carbon frameworks for 64bit 10.4.x. */ - /* `AvailabilityMacros.h` is available since Mac OS X 10.2, */ - /* so guess the system version by maximum errno before inclusion. */ + /* no Carbon frameworks for 64bit 10.4.x */ + /* AvailabilityMacros.h is available since Mac OS X 10.2, */ + /* so guess the system version by maximum errno before inclusion */ #include #ifdef ECANCELED /* defined since 10.2 */ #include "AvailabilityMacros.h" @@ -161,7 +166,7 @@ FT_BEGIN_HEADER #endif - /* Fix compiler warning with sgi compiler. */ + /* Fix compiler warning with sgi compiler */ #if defined( __sgi ) && !defined( __GNUC__ ) #if defined( _COMPILER_VERSION ) && ( _COMPILER_VERSION >= 730 ) #pragma set woff 3505 @@ -169,33 +174,33 @@ FT_BEGIN_HEADER #endif - /************************************************************************** - * - * @section: - * basic_types - * - */ + /*************************************************************************/ + /* */ + /*
*/ + /* basic_types */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @type: - * FT_Int16 - * - * @description: - * A typedef for a 16bit signed integer type. - */ + /*************************************************************************/ + /* */ + /* */ + /* FT_Int16 */ + /* */ + /* */ + /* A typedef for a 16bit signed integer type. */ + /* */ typedef signed short FT_Int16; - /************************************************************************** - * - * @type: - * FT_UInt16 - * - * @description: - * A typedef for a 16bit unsigned integer type. - */ + /*************************************************************************/ + /* */ + /* */ + /* FT_UInt16 */ + /* */ + /* */ + /* A typedef for a 16bit unsigned integer type. */ + /* */ typedef unsigned short FT_UInt16; /* */ @@ -204,50 +209,50 @@ FT_BEGIN_HEADER /* this #if 0 ... #endif clause is for documentation purposes */ #if 0 - /************************************************************************** - * - * @type: - * FT_Int32 - * - * @description: - * A typedef for a 32bit signed integer type. The size depends on the - * configuration. - */ + /*************************************************************************/ + /* */ + /* */ + /* FT_Int32 */ + /* */ + /* */ + /* A typedef for a 32bit signed integer type. The size depends on */ + /* the configuration. */ + /* */ typedef signed XXX FT_Int32; - /************************************************************************** - * - * @type: - * FT_UInt32 - * - * A typedef for a 32bit unsigned integer type. The size depends on the - * configuration. - */ + /*************************************************************************/ + /* */ + /* */ + /* FT_UInt32 */ + /* */ + /* A typedef for a 32bit unsigned integer type. The size depends on */ + /* the configuration. */ + /* */ typedef unsigned XXX FT_UInt32; - /************************************************************************** - * - * @type: - * FT_Int64 - * - * A typedef for a 64bit signed integer type. The size depends on the - * configuration. Only defined if there is real 64bit support; - * otherwise, it gets emulated with a structure (if necessary). - */ + /*************************************************************************/ + /* */ + /* */ + /* FT_Int64 */ + /* */ + /* A typedef for a 64bit signed integer type. The size depends on */ + /* the configuration. Only defined if there is real 64bit support; */ + /* otherwise, it gets emulated with a structure (if necessary). */ + /* */ typedef signed XXX FT_Int64; - /************************************************************************** - * - * @type: - * FT_UInt64 - * - * A typedef for a 64bit unsigned integer type. The size depends on the - * configuration. Only defined if there is real 64bit support; - * otherwise, it gets emulated with a structure (if necessary). - */ + /*************************************************************************/ + /* */ + /* */ + /* FT_UInt64 */ + /* */ + /* A typedef for a 64bit unsigned integer type. The size depends on */ + /* the configuration. Only defined if there is real 64bit support; */ + /* otherwise, it gets emulated with a structure (if necessary). */ + /* */ typedef unsigned XXX FT_UInt64; /* */ @@ -269,7 +274,7 @@ FT_BEGIN_HEADER #endif - /* look up an integer type that is at least 32~bits */ + /* look up an integer type that is at least 32 bits */ #if FT_SIZEOF_INT >= 4 typedef int FT_Fast; @@ -283,32 +288,22 @@ FT_BEGIN_HEADER #endif - /* determine whether we have a 64-bit `int` type for platforms without */ - /* Autoconf */ + /* determine whether we have a 64-bit int type for platforms without */ + /* Autoconf */ #if FT_SIZEOF_LONG == 8 - /* `FT_LONG64` must be defined if a 64-bit type is available */ + /* FT_LONG64 must be defined if a 64-bit type is available */ #define FT_LONG64 #define FT_INT64 long #define FT_UINT64 unsigned long - /* we handle the LLP64 scheme separately for GCC and clang, */ - /* suppressing the `long long` warning */ -#elif ( FT_SIZEOF_LONG == 4 ) && \ - defined( HAVE_LONG_LONG_INT ) && \ - defined( __GNUC__ ) -#pragma GCC diagnostic ignored "-Wlong-long" -#define FT_LONG64 -#define FT_INT64 long long int -#define FT_UINT64 unsigned long long int - - /************************************************************************** - * - * A 64-bit data type may create compilation problems if you compile in - * strict ANSI mode. To avoid them, we disable other 64-bit data types if - * `__STDC__` is defined. You can however ignore this rule by defining the - * `FT_CONFIG_OPTION_FORCE_INT64` configuration macro. - */ + /*************************************************************************/ + /* */ + /* A 64-bit data type may create compilation problems if you compile */ + /* in strict ANSI mode. To avoid them, we disable other 64-bit data */ + /* types if __STDC__ is defined. You can however ignore this rule */ + /* by defining the FT_CONFIG_OPTION_FORCE_INT64 configuration macro. */ + /* */ #elif !defined( __STDC__ ) || defined( FT_CONFIG_OPTION_FORCE_INT64 ) #if defined( __STDC_VERSION__ ) && __STDC_VERSION__ >= 199901L @@ -317,19 +312,19 @@ FT_BEGIN_HEADER #define FT_INT64 long long int #define FT_UINT64 unsigned long long int -#elif defined( _MSC_VER ) && _MSC_VER >= 900 /* Visual C++ (and Intel C++) */ +#elif defined( _MSC_VER ) && _MSC_VER >= 900 /* Visual C++ (and Intel C++) */ - /* this compiler provides the `__int64` type */ + /* this compiler provides the __int64 type */ #define FT_LONG64 #define FT_INT64 __int64 #define FT_UINT64 unsigned __int64 #elif defined( __BORLANDC__ ) /* Borland C++ */ - /* XXXX: We should probably check the value of `__BORLANDC__` in order */ - /* to test the compiler version. */ + /* XXXX: We should probably check the value of __BORLANDC__ in order */ + /* to test the compiler version. */ - /* this compiler provides the `__int64` type */ + /* this compiler provides the __int64 type */ #define FT_LONG64 #define FT_INT64 __int64 #define FT_UINT64 unsigned __int64 @@ -346,7 +341,7 @@ FT_BEGIN_HEADER #elif defined( __GNUC__ ) - /* GCC provides the `long long` type */ + /* GCC provides the `long long' type */ #define FT_LONG64 #define FT_INT64 long long int #define FT_UINT64 unsigned long long int @@ -361,20 +356,11 @@ FT_BEGIN_HEADER #endif -#ifdef _WIN64 - /* only 64bit Windows uses the LLP64 data model, i.e., */ - /* 32bit integers, 64bit pointers */ -#define FT_UINT_TO_POINTER( x ) (void*)(unsigned __int64)(x) -#else -#define FT_UINT_TO_POINTER( x ) (void*)(unsigned long)(x) -#endif - - - /************************************************************************** - * - * miscellaneous - * - */ + /*************************************************************************/ + /* */ + /* miscellaneous */ + /* */ + /*************************************************************************/ #define FT_BEGIN_STMNT do { @@ -382,25 +368,16 @@ FT_BEGIN_HEADER #define FT_DUMMY_STMNT FT_BEGIN_STMNT FT_END_STMNT - /* `typeof` condition taken from gnulib's `intprops.h` header file */ -#if ( ( defined( __GNUC__ ) && __GNUC__ >= 2 ) || \ - ( defined( __IBMC__ ) && __IBMC__ >= 1210 && \ - defined( __IBM__TYPEOF__ ) ) || \ - ( defined( __SUNPRO_C ) && __SUNPRO_C >= 0x5110 && !__STDC__ ) ) -#define FT_TYPEOF( type ) ( __typeof__ ( type ) ) + /* typeof condition taken from gnulib's `intprops.h' header file */ +#if ( __GNUC__ >= 2 || \ + defined( __IBM__TYPEOF__ ) || \ + ( __SUNPRO_C >= 0x5110 && !__STDC__ ) ) +#define FT_TYPEOF( type ) (__typeof__ (type)) #else #define FT_TYPEOF( type ) /* empty */ #endif - /* Use `FT_LOCAL` and `FT_LOCAL_DEF` to declare and define, */ - /* respectively, a function that gets used only within the scope of a */ - /* module. Normally, both the header and source code files for such a */ - /* function are within a single module directory. */ - /* */ - /* Intra-module arrays should be tagged with `FT_LOCAL_ARRAY` and */ - /* `FT_LOCAL_ARRAY_DEF`. */ - /* */ #ifdef FT_MAKE_OPTION_SINGLE_OBJECT #define FT_LOCAL( x ) static x @@ -422,12 +399,6 @@ FT_BEGIN_HEADER #define FT_LOCAL_ARRAY_DEF( x ) const x - /* Use `FT_BASE` and `FT_BASE_DEF` to declare and define, respectively, */ - /* functions that are used in more than a single module. In the */ - /* current setup this implies that the declaration is in a header file */ - /* in the `include/freetype/internal` directory, and the function body */ - /* is in a file in `src/base`. */ - /* */ #ifndef FT_BASE #ifdef __cplusplus @@ -450,68 +421,14 @@ FT_BEGIN_HEADER #endif /* !FT_BASE_DEF */ - /* When compiling FreeType as a DLL or DSO with hidden visibility */ - /* some systems/compilers need a special attribute in front OR after */ - /* the return type of function declarations. */ - /* */ - /* Two macros are used within the FreeType source code to define */ - /* exported library functions: `FT_EXPORT` and `FT_EXPORT_DEF`. */ - /* */ - /* - `FT_EXPORT( return_type )` */ - /* */ - /* is used in a function declaration, as in */ - /* */ - /* ``` */ - /* FT_EXPORT( FT_Error ) */ - /* FT_Init_FreeType( FT_Library* alibrary ); */ - /* ``` */ - /* */ - /* - `FT_EXPORT_DEF( return_type )` */ - /* */ - /* is used in a function definition, as in */ - /* */ - /* ``` */ - /* FT_EXPORT_DEF( FT_Error ) */ - /* FT_Init_FreeType( FT_Library* alibrary ) */ - /* { */ - /* ... some code ... */ - /* return FT_Err_Ok; */ - /* } */ - /* ``` */ - /* */ - /* You can provide your own implementation of `FT_EXPORT` and */ - /* `FT_EXPORT_DEF` here if you want. */ - /* */ - /* To export a variable, use `FT_EXPORT_VAR`. */ - /* */ #ifndef FT_EXPORT -#ifdef FT2_BUILD_LIBRARY - -#if defined( _WIN32 ) && defined( DLL_EXPORT ) -#define FT_EXPORT( x ) __declspec( dllexport ) x -#elif defined( __GNUC__ ) && __GNUC__ >= 4 -#define FT_EXPORT( x ) __attribute__(( visibility( "default" ) )) x -#elif defined( __SUNPRO_C ) && __SUNPRO_C >= 0x550 -#define FT_EXPORT( x ) __global x -#elif defined( __cplusplus ) +#ifdef __cplusplus #define FT_EXPORT( x ) extern "C" x #else #define FT_EXPORT( x ) extern x #endif -#else - -#if defined( _WIN32 ) && defined( DLL_IMPORT ) -#define FT_EXPORT( x ) __declspec( dllimport ) x -#elif defined( __cplusplus ) -#define FT_EXPORT( x ) extern "C" x -#else -#define FT_EXPORT( x ) extern x -#endif - -#endif - #endif /* !FT_EXPORT */ @@ -536,25 +453,18 @@ FT_BEGIN_HEADER #endif /* !FT_EXPORT_VAR */ - /* The following macros are needed to compile the library with a */ /* C++ compiler and with 16bit compilers. */ /* */ - /* This is special. Within C++, you must specify `extern "C"` for */ + /* This is special. Within C++, you must specify `extern "C"' for */ /* functions which are used via function pointers, and you also */ /* must do that for structures which contain function pointers to */ /* assure C linkage -- it's not possible to have (local) anonymous */ /* functions which are accessed by (global) function pointers. */ /* */ /* */ - /* FT_CALLBACK_DEF is used to _define_ a callback function, */ - /* located in the same source code file as the structure that uses */ - /* it. */ - /* */ - /* FT_BASE_CALLBACK and FT_BASE_CALLBACK_DEF are used to declare */ - /* and define a callback function, respectively, in a similar way */ - /* as FT_BASE and FT_BASE_DEF work. */ + /* FT_CALLBACK_DEF is used to _define_ a callback function. */ /* */ /* FT_CALLBACK_TABLE is used to _declare_ a constant variable that */ /* contains pointers to callback functions. */ @@ -564,7 +474,7 @@ FT_BEGIN_HEADER /* */ /* */ /* Some 16bit compilers have to redefine these macros to insert */ - /* the infamous `_cdecl` or `__fastcall` declarations. */ + /* the infamous `_cdecl' or `__fastcall' declarations. */ /* */ #ifndef FT_CALLBACK_DEF #ifdef __cplusplus @@ -574,16 +484,6 @@ FT_BEGIN_HEADER #endif #endif /* FT_CALLBACK_DEF */ -#ifndef FT_BASE_CALLBACK -#ifdef __cplusplus -#define FT_BASE_CALLBACK( x ) extern "C" x -#define FT_BASE_CALLBACK_DEF( x ) extern "C" x -#else -#define FT_BASE_CALLBACK( x ) extern x -#define FT_BASE_CALLBACK_DEF( x ) x -#endif -#endif /* FT_BASE_CALLBACK */ - #ifndef FT_CALLBACK_TABLE #ifdef __cplusplus #define FT_CALLBACK_TABLE extern "C" diff --git a/android/x86_64/include/freetype/config/ftheader.h b/android/x86_64/include/freetype/config/ftheader.h index 696d6ba9..68e14834 100644 --- a/android/x86_64/include/freetype/config/ftheader.h +++ b/android/x86_64/include/freetype/config/ftheader.h @@ -1,19 +1,19 @@ -/**************************************************************************** - * - * ftheader.h - * - * Build macros of the FreeType 2 library. - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftheader.h */ +/* */ +/* Build macros of the FreeType 2 library. */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTHEADER_H_ #define FTHEADER_H_ @@ -27,7 +27,7 @@ /* */ /* This macro is used in association with @FT_END_HEADER in header */ /* files to ensure that the declarations within are properly */ - /* encapsulated in an `extern "C" { .. }` block when included from a */ + /* encapsulated in an `extern "C" { .. }' block when included from a */ /* C++ compiler. */ /* */ #ifdef __cplusplus @@ -45,7 +45,7 @@ /* */ /* This macro is used in association with @FT_BEGIN_HEADER in header */ /* files to ensure that the declarations within are properly */ - /* encapsulated in an `extern "C" { .. }` block when included from a */ + /* encapsulated in an `extern "C" { .. }' block when included from a */ /* C++ compiler. */ /* */ #ifdef __cplusplus @@ -55,54 +55,54 @@ #endif - /************************************************************************** - * - * Aliases for the FreeType 2 public and configuration files. - * - */ + /*************************************************************************/ + /* */ + /* Aliases for the FreeType 2 public and configuration files. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @section: - * header_file_macros - * - * @title: - * Header File Macros - * - * @abstract: - * Macro definitions used to `#include` specific header files. - * - * @description: - * The following macros are defined to the name of specific FreeType~2 - * header files. They can be used directly in `#include` statements as - * in: - * - * ``` - * #include FT_FREETYPE_H - * #include FT_MULTIPLE_MASTERS_H - * #include FT_GLYPH_H - * ``` - * - * There are several reasons why we are now using macros to name public - * header files. The first one is that such macros are not limited to - * the infamous 8.3~naming rule required by DOS (and - * `FT_MULTIPLE_MASTERS_H` is a lot more meaningful than `ftmm.h`). - * - * The second reason is that it allows for more flexibility in the way - * FreeType~2 is installed on a given system. - * - */ + /*************************************************************************/ + /* */ + /*
*/ + /* header_file_macros */ + /* */ + /* */ + /* Header File Macros */ + /* */ + /* <Abstract> */ + /* Macro definitions used to #include specific header files. */ + /* */ + /* <Description> */ + /* The following macros are defined to the name of specific */ + /* FreeType~2 header files. They can be used directly in #include */ + /* statements as in: */ + /* */ + /* { */ + /* #include FT_FREETYPE_H */ + /* #include FT_MULTIPLE_MASTERS_H */ + /* #include FT_GLYPH_H */ + /* } */ + /* */ + /* There are several reasons why we are now using macros to name */ + /* public header files. The first one is that such macros are not */ + /* limited to the infamous 8.3~naming rule required by DOS (and */ + /* `FT_MULTIPLE_MASTERS_H' is a lot more meaningful than `ftmm.h'). */ + /* */ + /* The second reason is that it allows for more flexibility in the */ + /* way FreeType~2 is installed on a given system. */ + /* */ + /*************************************************************************/ /* configuration files */ - /************************************************************************** + /************************************************************************* * * @macro: * FT_CONFIG_CONFIG_H * * @description: - * A macro used in `#include` statements to name the file containing + * A macro used in #include statements to name the file containing * FreeType~2 configuration data. * */ @@ -111,13 +111,13 @@ #endif - /************************************************************************** + /************************************************************************* * * @macro: * FT_CONFIG_STANDARD_LIBRARY_H * * @description: - * A macro used in `#include` statements to name the file containing + * A macro used in #include statements to name the file containing * FreeType~2 interface to the standard C library functions. * */ @@ -126,13 +126,13 @@ #endif - /************************************************************************** + /************************************************************************* * * @macro: * FT_CONFIG_OPTIONS_H * * @description: - * A macro used in `#include` statements to name the file containing + * A macro used in #include statements to name the file containing * FreeType~2 project-specific configuration options. * */ @@ -141,13 +141,13 @@ #endif - /************************************************************************** + /************************************************************************* * * @macro: * FT_CONFIG_MODULES_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * list of FreeType~2 modules that are statically linked to new library * instances in @FT_Init_FreeType. * @@ -160,26 +160,26 @@ /* public headers */ - /************************************************************************** + /************************************************************************* * * @macro: * FT_FREETYPE_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * base FreeType~2 API. * */ #define FT_FREETYPE_H <freetype/freetype.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_ERRORS_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * list of FreeType~2 error codes (and messages). * * It is included by @FT_FREETYPE_H. @@ -188,26 +188,26 @@ #define FT_ERRORS_H <freetype/fterrors.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_MODULE_ERRORS_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * list of FreeType~2 module error offsets (and messages). * */ #define FT_MODULE_ERRORS_H <freetype/ftmoderr.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_SYSTEM_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * FreeType~2 interface to low-level operations (i.e., memory management * and stream i/o). * @@ -217,13 +217,13 @@ #define FT_SYSTEM_H <freetype/ftsystem.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_IMAGE_H * * @description: - * A macro used in `#include` statements to name the file containing type + * A macro used in #include statements to name the file containing type * definitions related to glyph images (i.e., bitmaps, outlines, * scan-converter parameters). * @@ -233,13 +233,13 @@ #define FT_IMAGE_H <freetype/ftimage.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_TYPES_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * basic data types defined by FreeType~2. * * It is included by @FT_FREETYPE_H. @@ -248,13 +248,13 @@ #define FT_TYPES_H <freetype/fttypes.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_LIST_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * list management API of FreeType~2. * * (Most applications will never need to include this file.) @@ -263,151 +263,117 @@ #define FT_LIST_H <freetype/ftlist.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_OUTLINE_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * scalable outline management API of FreeType~2. * */ #define FT_OUTLINE_H <freetype/ftoutln.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_SIZES_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * API which manages multiple @FT_Size objects per face. * */ #define FT_SIZES_H <freetype/ftsizes.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_MODULE_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * module management API of FreeType~2. * */ #define FT_MODULE_H <freetype/ftmodapi.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_RENDER_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * renderer module management API of FreeType~2. * */ #define FT_RENDER_H <freetype/ftrender.h> - /************************************************************************** - * - * @macro: - * FT_DRIVER_H - * - * @description: - * A macro used in `#include` statements to name the file containing - * structures and macros related to the driver modules. - * - */ -#define FT_DRIVER_H <freetype/ftdriver.h> - - - /************************************************************************** + /************************************************************************* * * @macro: * FT_AUTOHINTER_H * * @description: - * A macro used in `#include` statements to name the file containing + * A macro used in #include statements to name the file containing * structures and macros related to the auto-hinting module. * - * Deprecated since version~2.9; use @FT_DRIVER_H instead. - * */ -#define FT_AUTOHINTER_H FT_DRIVER_H +#define FT_AUTOHINTER_H <freetype/ftautoh.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_CFF_DRIVER_H * * @description: - * A macro used in `#include` statements to name the file containing + * A macro used in #include statements to name the file containing * structures and macros related to the CFF driver module. * - * Deprecated since version~2.9; use @FT_DRIVER_H instead. - * */ -#define FT_CFF_DRIVER_H FT_DRIVER_H +#define FT_CFF_DRIVER_H <freetype/ftcffdrv.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_TRUETYPE_DRIVER_H * * @description: - * A macro used in `#include` statements to name the file containing + * A macro used in #include statements to name the file containing * structures and macros related to the TrueType driver module. * - * Deprecated since version~2.9; use @FT_DRIVER_H instead. - * */ -#define FT_TRUETYPE_DRIVER_H FT_DRIVER_H +#define FT_TRUETYPE_DRIVER_H <freetype/ftttdrv.h> - /************************************************************************** - * - * @macro: - * FT_PCF_DRIVER_H - * - * @description: - * A macro used in `#include` statements to name the file containing - * structures and macros related to the PCF driver module. - * - * Deprecated since version~2.9; use @FT_DRIVER_H instead. - * - */ -#define FT_PCF_DRIVER_H FT_DRIVER_H - - - /************************************************************************** + /************************************************************************* * * @macro: * FT_TYPE1_TABLES_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * types and API specific to the Type~1 format. * */ #define FT_TYPE1_TABLES_H <freetype/t1tables.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_TRUETYPE_IDS_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * enumeration values which identify name strings, languages, encodings, * etc. This file really contains a _large_ set of constant macro * definitions, taken from the TrueType and OpenType specifications. @@ -416,172 +382,231 @@ #define FT_TRUETYPE_IDS_H <freetype/ttnameid.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_TRUETYPE_TABLES_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * types and API specific to the TrueType (as well as OpenType) format. * */ #define FT_TRUETYPE_TABLES_H <freetype/tttables.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_TRUETYPE_TAGS_H * * @description: - * A macro used in `#include` statements to name the file containing the - * definitions of TrueType four-byte 'tags' which identify blocks in + * A macro used in #include statements to name the file containing the + * definitions of TrueType four-byte `tags' which identify blocks in * SFNT-based font formats (i.e., TrueType and OpenType). * */ #define FT_TRUETYPE_TAGS_H <freetype/tttags.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_BDF_H * * @description: - * A macro used in `#include` statements to name the file containing the - * definitions of an API which accesses BDF-specific strings from a face. + * A macro used in #include statements to name the file containing the + * definitions of an API which accesses BDF-specific strings from a + * face. * */ #define FT_BDF_H <freetype/ftbdf.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_CID_H * * @description: - * A macro used in `#include` statements to name the file containing the - * definitions of an API which access CID font information from a face. + * A macro used in #include statements to name the file containing the + * definitions of an API which access CID font information from a + * face. * */ #define FT_CID_H <freetype/ftcid.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_GZIP_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * definitions of an API which supports gzip-compressed files. * */ #define FT_GZIP_H <freetype/ftgzip.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_LZW_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * definitions of an API which supports LZW-compressed files. * */ #define FT_LZW_H <freetype/ftlzw.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_BZIP2_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * definitions of an API which supports bzip2-compressed files. * */ #define FT_BZIP2_H <freetype/ftbzip2.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_WINFONTS_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * definitions of an API which supports Windows FNT files. * */ #define FT_WINFONTS_H <freetype/ftwinfnt.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_GLYPH_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * API of the optional glyph management component. * */ #define FT_GLYPH_H <freetype/ftglyph.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_BITMAP_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * API of the optional bitmap conversion component. * */ #define FT_BITMAP_H <freetype/ftbitmap.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_BBOX_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * API of the optional exact bounding box computation routines. * */ #define FT_BBOX_H <freetype/ftbbox.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_CACHE_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * API of the optional FreeType~2 cache sub-system. * */ #define FT_CACHE_H <freetype/ftcache.h> - /************************************************************************** + /************************************************************************* + * + * @macro: + * FT_CACHE_IMAGE_H + * + * @description: + * A macro used in #include statements to name the file containing the + * `glyph image' API of the FreeType~2 cache sub-system. + * + * It is used to define a cache for @FT_Glyph elements. You can also + * use the API defined in @FT_CACHE_SMALL_BITMAPS_H if you only need to + * store small glyph bitmaps, as it will use less memory. + * + * This macro is deprecated. Simply include @FT_CACHE_H to have all + * glyph image-related cache declarations. + * + */ +#define FT_CACHE_IMAGE_H FT_CACHE_H + + + /************************************************************************* + * + * @macro: + * FT_CACHE_SMALL_BITMAPS_H + * + * @description: + * A macro used in #include statements to name the file containing the + * `small bitmaps' API of the FreeType~2 cache sub-system. + * + * It is used to define a cache for small glyph bitmaps in a relatively + * memory-efficient way. You can also use the API defined in + * @FT_CACHE_IMAGE_H if you want to cache arbitrary glyph images, + * including scalable outlines. + * + * This macro is deprecated. Simply include @FT_CACHE_H to have all + * small bitmaps-related cache declarations. + * + */ +#define FT_CACHE_SMALL_BITMAPS_H FT_CACHE_H + + + /************************************************************************* + * + * @macro: + * FT_CACHE_CHARMAP_H + * + * @description: + * A macro used in #include statements to name the file containing the + * `charmap' API of the FreeType~2 cache sub-system. + * + * This macro is deprecated. Simply include @FT_CACHE_H to have all + * charmap-based cache declarations. + * + */ +#define FT_CACHE_CHARMAP_H FT_CACHE_H + + + /************************************************************************* * * @macro: * FT_MAC_H * * @description: - * A macro used in `#include` statements to name the file containing the - * Macintosh-specific FreeType~2 API. The latter is used to access fonts - * embedded in resource forks. + * A macro used in #include statements to name the file containing the + * Macintosh-specific FreeType~2 API. The latter is used to access + * fonts embedded in resource forks. * * This header file must be explicitly included by client applications * compiled on the Mac (note that the base API still works though). @@ -590,105 +615,105 @@ #define FT_MAC_H <freetype/ftmac.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_MULTIPLE_MASTERS_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * optional multiple-masters management API of FreeType~2. * */ #define FT_MULTIPLE_MASTERS_H <freetype/ftmm.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_SFNT_NAMES_H * * @description: - * A macro used in `#include` statements to name the file containing the - * optional FreeType~2 API which accesses embedded 'name' strings in + * A macro used in #include statements to name the file containing the + * optional FreeType~2 API which accesses embedded `name' strings in * SFNT-based font formats (i.e., TrueType and OpenType). * */ #define FT_SFNT_NAMES_H <freetype/ftsnames.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_OPENTYPE_VALIDATE_H * * @description: - * A macro used in `#include` statements to name the file containing the - * optional FreeType~2 API which validates OpenType tables ('BASE', - * 'GDEF', 'GPOS', 'GSUB', 'JSTF'). + * A macro used in #include statements to name the file containing the + * optional FreeType~2 API which validates OpenType tables (BASE, GDEF, + * GPOS, GSUB, JSTF). * */ #define FT_OPENTYPE_VALIDATE_H <freetype/ftotval.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_GX_VALIDATE_H * * @description: - * A macro used in `#include` statements to name the file containing the - * optional FreeType~2 API which validates TrueTypeGX/AAT tables ('feat', - * 'mort', 'morx', 'bsln', 'just', 'kern', 'opbd', 'trak', 'prop'). + * A macro used in #include statements to name the file containing the + * optional FreeType~2 API which validates TrueTypeGX/AAT tables (feat, + * mort, morx, bsln, just, kern, opbd, trak, prop). * */ #define FT_GX_VALIDATE_H <freetype/ftgxval.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_PFR_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * FreeType~2 API which accesses PFR-specific data. * */ #define FT_PFR_H <freetype/ftpfr.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_STROKER_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * FreeType~2 API which provides functions to stroke outline paths. */ #define FT_STROKER_H <freetype/ftstroke.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_SYNTHESIS_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * FreeType~2 API which performs artificial obliquing and emboldening. */ #define FT_SYNTHESIS_H <freetype/ftsynth.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_FONT_FORMATS_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * FreeType~2 API which provides functions specific to font formats. */ #define FT_FONT_FORMATS_H <freetype/ftfntfmt.h> @@ -697,110 +722,104 @@ #define FT_XFREE86_H FT_FONT_FORMATS_H - /************************************************************************** + /************************************************************************* * * @macro: * FT_TRIGONOMETRY_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * FreeType~2 API which performs trigonometric computations (e.g., * cosines and arc tangents). */ #define FT_TRIGONOMETRY_H <freetype/fttrigon.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_LCD_FILTER_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * FreeType~2 API which performs color filtering for subpixel rendering. */ #define FT_LCD_FILTER_H <freetype/ftlcdfil.h> - /************************************************************************** + /************************************************************************* + * + * @macro: + * FT_UNPATENTED_HINTING_H + * + * @description: + * Deprecated. + */ +#define FT_UNPATENTED_HINTING_H <freetype/ttunpat.h> + + + /************************************************************************* * * @macro: * FT_INCREMENTAL_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * FreeType~2 API which performs incremental glyph loading. */ #define FT_INCREMENTAL_H <freetype/ftincrem.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_GASP_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * FreeType~2 API which returns entries from the TrueType GASP table. */ #define FT_GASP_H <freetype/ftgasp.h> - /************************************************************************** + /************************************************************************* * * @macro: * FT_ADVANCES_H * * @description: - * A macro used in `#include` statements to name the file containing the + * A macro used in #include statements to name the file containing the * FreeType~2 API which returns individual and ranged glyph advances. */ #define FT_ADVANCES_H <freetype/ftadvanc.h> - /************************************************************************** - * - * @macro: - * FT_COLOR_H - * - * @description: - * A macro used in `#include` statements to name the file containing the - * FreeType~2 API which handles the OpenType 'CPAL' table. - */ -#define FT_COLOR_H <freetype/ftcolor.h> - - /* */ - /* These header files don't need to be included by the user. */ #define FT_ERROR_DEFINITIONS_H <freetype/fterrdef.h> -#define FT_PARAMETER_TAGS_H <freetype/ftparams.h> - /* Deprecated macros. */ -#define FT_UNPATENTED_HINTING_H <freetype/ftparams.h> -#define FT_TRUETYPE_UNPATENTED_H <freetype/ftparams.h> - - /* `FT_CACHE_H` is the only header file needed for the cache subsystem. */ -#define FT_CACHE_IMAGE_H FT_CACHE_H -#define FT_CACHE_SMALL_BITMAPS_H FT_CACHE_H -#define FT_CACHE_CHARMAP_H FT_CACHE_H /* The internals of the cache sub-system are no longer exposed. We */ - /* default to `FT_CACHE_H` at the moment just in case, but we know */ - /* of no rogue client that uses them. */ + /* default to FT_CACHE_H at the moment just in case, but we know of */ + /* no rogue client that uses them. */ /* */ -#define FT_CACHE_MANAGER_H FT_CACHE_H -#define FT_CACHE_INTERNAL_MRU_H FT_CACHE_H -#define FT_CACHE_INTERNAL_MANAGER_H FT_CACHE_H -#define FT_CACHE_INTERNAL_CACHE_H FT_CACHE_H -#define FT_CACHE_INTERNAL_GLYPH_H FT_CACHE_H -#define FT_CACHE_INTERNAL_IMAGE_H FT_CACHE_H -#define FT_CACHE_INTERNAL_SBITS_H FT_CACHE_H +#define FT_CACHE_MANAGER_H <freetype/ftcache.h> +#define FT_CACHE_INTERNAL_MRU_H <freetype/ftcache.h> +#define FT_CACHE_INTERNAL_MANAGER_H <freetype/ftcache.h> +#define FT_CACHE_INTERNAL_CACHE_H <freetype/ftcache.h> +#define FT_CACHE_INTERNAL_GLYPH_H <freetype/ftcache.h> +#define FT_CACHE_INTERNAL_IMAGE_H <freetype/ftcache.h> +#define FT_CACHE_INTERNAL_SBITS_H <freetype/ftcache.h> + + +#define FT_INCREMENTAL_H <freetype/ftincrem.h> + +#define FT_TRUETYPE_UNPATENTED_H <freetype/ttunpat.h> /* - * Include internal headers definitions from `<internal/...>` only when - * building the library. + * Include internal headers definitions from <internal/...> + * only when building the library. */ #ifdef FT2_BUILD_LIBRARY #define FT_INTERNAL_INTERNAL_H <freetype/internal/internal.h> diff --git a/android/x86_64/include/freetype/config/ftoption.h b/android/x86_64/include/freetype/config/ftoption.h index 5e3e5673..a8097feb 100644 --- a/android/x86_64/include/freetype/config/ftoption.h +++ b/android/x86_64/include/freetype/config/ftoption.h @@ -1,71 +1,69 @@ -/**************************************************************************** - * - * ftoption.h - * - * User-selectable configuration macros (specification only). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftoption.h */ +/* */ +/* User-selectable configuration macros (specification only). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTOPTION_H_ #define FTOPTION_H_ -#include "../ft2build.h" +#include <ft2build.h> FT_BEGIN_HEADER - /************************************************************************** - * - * USER-SELECTABLE CONFIGURATION MACROS - * - * This file contains the default configuration macro definitions for a - * standard build of the FreeType library. There are three ways to use - * this file to build project-specific versions of the library: - * - * - You can modify this file by hand, but this is not recommended in - * cases where you would like to build several versions of the library - * from a single source directory. - * - * - You can put a copy of this file in your build directory, more - * precisely in `$BUILD/freetype/config/ftoption.h`, where `$BUILD` is - * the name of a directory that is included _before_ the FreeType include - * path during compilation. - * - * The default FreeType Makefiles and Jamfiles use the build directory - * `builds/<system>` by default, but you can easily change that for your - * own projects. - * - * - Copy the file "ft2build.h" to `$BUILD/ft2build.h` and modify it - * slightly to pre-define the macro `FT_CONFIG_OPTIONS_H` used to locate - * this file during the build. For example, - * - * ``` - * #define FT_CONFIG_OPTIONS_H <myftoptions.h> - * #include <freetype/config/ftheader.h> - * ``` - * - * will use `$BUILD/myftoptions.h` instead of this file for macro - * definitions. - * - * Note also that you can similarly pre-define the macro - * `FT_CONFIG_MODULES_H` used to locate the file listing of the modules - * that are statically linked to the library at compile time. By - * default, this file is `<freetype/config/ftmodule.h>`. - * - * We highly recommend using the third method whenever possible. - * - */ + /*************************************************************************/ + /* */ + /* USER-SELECTABLE CONFIGURATION MACROS */ + /* */ + /* This file contains the default configuration macro definitions for */ + /* a standard build of the FreeType library. There are three ways to */ + /* use this file to build project-specific versions of the library: */ + /* */ + /* - You can modify this file by hand, but this is not recommended in */ + /* cases where you would like to build several versions of the */ + /* library from a single source directory. */ + /* */ + /* - You can put a copy of this file in your build directory, more */ + /* precisely in `$BUILD/freetype/config/ftoption.h', where `$BUILD' */ + /* is the name of a directory that is included _before_ the FreeType */ + /* include path during compilation. */ + /* */ + /* The default FreeType Makefiles and Jamfiles use the build */ + /* directory `builds/<system>' by default, but you can easily change */ + /* that for your own projects. */ + /* */ + /* - Copy the file <ft2build.h> to `$BUILD/ft2build.h' and modify it */ + /* slightly to pre-define the macro FT_CONFIG_OPTIONS_H used to */ + /* locate this file during the build. For example, */ + /* */ + /* #define FT_CONFIG_OPTIONS_H <myftoptions.h> */ + /* #include <freetype/config/ftheader.h> */ + /* */ + /* will use `$BUILD/myftoptions.h' instead of this file for macro */ + /* definitions. */ + /* */ + /* Note also that you can similarly pre-define the macro */ + /* FT_CONFIG_MODULES_H used to locate the file listing of the modules */ + /* that are statically linked to the library at compile time. By */ + /* default, this file is <freetype/config/ftmodule.h>. */ + /* */ + /* We highly recommend using the third method whenever possible. */ + /* */ + /*************************************************************************/ /*************************************************************************/ @@ -77,433 +75,426 @@ FT_BEGIN_HEADER /*************************************************************************/ - /*#************************************************************************ - * - * If you enable this configuration option, FreeType recognizes an - * environment variable called `FREETYPE_PROPERTIES`, which can be used to - * control the various font drivers and modules. The controllable - * properties are listed in the section @properties. - * - * You have to undefine this configuration option on platforms that lack - * the concept of environment variables (and thus don't have the `getenv` - * function), for example Windows CE. - * - * `FREETYPE_PROPERTIES` has the following syntax form (broken here into - * multiple lines for better readability). - * - * ``` - * <optional whitespace> - * <module-name1> ':' - * <property-name1> '=' <property-value1> - * <whitespace> - * <module-name2> ':' - * <property-name2> '=' <property-value2> - * ... - * ``` - * - * Example: - * - * ``` - * FREETYPE_PROPERTIES=truetype:interpreter-version=35 \ - * cff:no-stem-darkening=1 \ - * autofitter:warping=1 - * ``` - * - */ -#define FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES - - - /************************************************************************** - * - * Uncomment the line below if you want to activate LCD rendering - * technology similar to ClearType in this build of the library. This - * technology triples the resolution in the direction color subpixels. To - * mitigate color fringes inherent to this technology, you also need to - * explicitly set up LCD filtering. - * - * Note that this feature is covered by several Microsoft patents and - * should not be activated in any default build of the library. When this - * macro is not defined, FreeType offers alternative LCD rendering - * technology that produces excellent output without LCD filtering. - */ + /*************************************************************************/ + /* */ + /* Uncomment the line below if you want to activate sub-pixel rendering */ + /* (a.k.a. LCD rendering, or ClearType) in this build of the library. */ + /* */ + /* Note that this feature is covered by several Microsoft patents */ + /* and should not be activated in any default build of the library. */ + /* */ + /* This macro has no impact on the FreeType API, only on its */ + /* _implementation_. For example, using FT_RENDER_MODE_LCD when calling */ + /* FT_Render_Glyph still generates a bitmap that is 3 times wider than */ + /* the original size in case this macro isn't defined; however, each */ + /* triplet of subpixels has R=G=B. */ + /* */ + /* This is done to allow FreeType clients to run unmodified, forcing */ + /* them to display normal gray-level anti-aliased glyphs. */ + /* */ /* #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING */ - /************************************************************************** - * - * Many compilers provide a non-ANSI 64-bit data type that can be used by - * FreeType to speed up some computations. However, this will create some - * problems when compiling the library in strict ANSI mode. - * - * For this reason, the use of 64-bit integers is normally disabled when - * the `__STDC__` macro is defined. You can however disable this by - * defining the macro `FT_CONFIG_OPTION_FORCE_INT64` here. - * - * For most compilers, this will only create compilation warnings when - * building the library. - * - * ObNote: The compiler-specific 64-bit integers are detected in the - * file `ftconfig.h` either statically or through the `configure` - * script on supported platforms. - */ + /*************************************************************************/ + /* */ + /* Many compilers provide a non-ANSI 64-bit data type that can be used */ + /* by FreeType to speed up some computations. However, this will create */ + /* some problems when compiling the library in strict ANSI mode. */ + /* */ + /* For this reason, the use of 64-bit integers is normally disabled when */ + /* the __STDC__ macro is defined. You can however disable this by */ + /* defining the macro FT_CONFIG_OPTION_FORCE_INT64 here. */ + /* */ + /* For most compilers, this will only create compilation warnings when */ + /* building the library. */ + /* */ + /* ObNote: The compiler-specific 64-bit integers are detected in the */ + /* file `ftconfig.h' either statically or through the */ + /* `configure' script on supported platforms. */ + /* */ #undef FT_CONFIG_OPTION_FORCE_INT64 - /************************************************************************** - * - * If this macro is defined, do not try to use an assembler version of - * performance-critical functions (e.g., @FT_MulFix). You should only do - * that to verify that the assembler function works properly, or to execute - * benchmark tests of the various implementations. - */ + /*************************************************************************/ + /* */ + /* If this macro is defined, do not try to use an assembler version of */ + /* performance-critical functions (e.g. FT_MulFix). You should only do */ + /* that to verify that the assembler function works properly, or to */ + /* execute benchmark tests of the various implementations. */ /* #define FT_CONFIG_OPTION_NO_ASSEMBLER */ - /************************************************************************** - * - * If this macro is defined, try to use an inlined assembler version of the - * @FT_MulFix function, which is a 'hotspot' when loading and hinting - * glyphs, and which should be executed as fast as possible. - * - * Note that if your compiler or CPU is not supported, this will default to - * the standard and portable implementation found in `ftcalc.c`. - */ + /*************************************************************************/ + /* */ + /* If this macro is defined, try to use an inlined assembler version of */ + /* the `FT_MulFix' function, which is a `hotspot' when loading and */ + /* hinting glyphs, and which should be executed as fast as possible. */ + /* */ + /* Note that if your compiler or CPU is not supported, this will default */ + /* to the standard and portable implementation found in `ftcalc.c'. */ + /* */ #define FT_CONFIG_OPTION_INLINE_MULFIX - /************************************************************************** - * - * LZW-compressed file support. - * - * FreeType now handles font files that have been compressed with the - * `compress` program. This is mostly used to parse many of the PCF - * files that come with various X11 distributions. The implementation - * uses NetBSD's `zopen` to partially uncompress the file on the fly (see - * `src/lzw/ftgzip.c`). - * - * Define this macro if you want to enable this 'feature'. - */ + /*************************************************************************/ + /* */ + /* LZW-compressed file support. */ + /* */ + /* FreeType now handles font files that have been compressed with the */ + /* `compress' program. This is mostly used to parse many of the PCF */ + /* files that come with various X11 distributions. The implementation */ + /* uses NetBSD's `zopen' to partially uncompress the file on the fly */ + /* (see src/lzw/ftgzip.c). */ + /* */ + /* Define this macro if you want to enable this `feature'. */ + /* */ #define FT_CONFIG_OPTION_USE_LZW - /************************************************************************** - * - * Gzip-compressed file support. - * - * FreeType now handles font files that have been compressed with the - * `gzip` program. This is mostly used to parse many of the PCF files - * that come with XFree86. The implementation uses 'zlib' to partially - * uncompress the file on the fly (see `src/gzip/ftgzip.c`). - * - * Define this macro if you want to enable this 'feature'. See also the - * macro `FT_CONFIG_OPTION_SYSTEM_ZLIB` below. - */ + /*************************************************************************/ + /* */ + /* Gzip-compressed file support. */ + /* */ + /* FreeType now handles font files that have been compressed with the */ + /* `gzip' program. This is mostly used to parse many of the PCF files */ + /* that come with XFree86. The implementation uses `zlib' to */ + /* partially uncompress the file on the fly (see src/gzip/ftgzip.c). */ + /* */ + /* Define this macro if you want to enable this `feature'. See also */ + /* the macro FT_CONFIG_OPTION_SYSTEM_ZLIB below. */ + /* */ #define FT_CONFIG_OPTION_USE_ZLIB - /************************************************************************** - * - * ZLib library selection - * - * This macro is only used when `FT_CONFIG_OPTION_USE_ZLIB` is defined. - * It allows FreeType's 'ftgzip' component to link to the system's - * installation of the ZLib library. This is useful on systems like - * Unix or VMS where it generally is already available. - * - * If you let it undefined, the component will use its own copy of the - * zlib sources instead. These have been modified to be included - * directly within the component and **not** export external function - * names. This allows you to link any program with FreeType _and_ ZLib - * without linking conflicts. - * - * Do not `#undef` this macro here since the build system might define - * it for certain configurations only. - * - * If you use a build system like cmake or the `configure` script, - * options set by those programs have precedence, overwriting the value - * here with the configured one. - */ -#define FT_CONFIG_OPTION_SYSTEM_ZLIB + /*************************************************************************/ + /* */ + /* ZLib library selection */ + /* */ + /* This macro is only used when FT_CONFIG_OPTION_USE_ZLIB is defined. */ + /* It allows FreeType's `ftgzip' component to link to the system's */ + /* installation of the ZLib library. This is useful on systems like */ + /* Unix or VMS where it generally is already available. */ + /* */ + /* If you let it undefined, the component will use its own copy */ + /* of the zlib sources instead. These have been modified to be */ + /* included directly within the component and *not* export external */ + /* function names. This allows you to link any program with FreeType */ + /* _and_ ZLib without linking conflicts. */ + /* */ + /* Do not #undef this macro here since the build system might define */ + /* it for certain configurations only. */ + /* */ +/* #define FT_CONFIG_OPTION_SYSTEM_ZLIB */ - /************************************************************************** - * - * Bzip2-compressed file support. - * - * FreeType now handles font files that have been compressed with the - * `bzip2` program. This is mostly used to parse many of the PCF files - * that come with XFree86. The implementation uses `libbz2` to partially - * uncompress the file on the fly (see `src/bzip2/ftbzip2.c`). Contrary - * to gzip, bzip2 currently is not included and need to use the system - * available bzip2 implementation. - * - * Define this macro if you want to enable this 'feature'. - * - * If you use a build system like cmake or the `configure` script, - * options set by those programs have precedence, overwriting the value - * here with the configured one. - */ -/* #undef FT_CONFIG_OPTION_USE_BZIP2 */ + /*************************************************************************/ + /* */ + /* Bzip2-compressed file support. */ + /* */ + /* FreeType now handles font files that have been compressed with the */ + /* `bzip2' program. This is mostly used to parse many of the PCF */ + /* files that come with XFree86. The implementation uses `libbz2' to */ + /* partially uncompress the file on the fly (see src/bzip2/ftbzip2.c). */ + /* Contrary to gzip, bzip2 currently is not included and need to use */ + /* the system available bzip2 implementation. */ + /* */ + /* Define this macro if you want to enable this `feature'. */ + /* */ +/* #define FT_CONFIG_OPTION_USE_BZIP2 */ - /************************************************************************** - * - * Define to disable the use of file stream functions and types, `FILE`, - * `fopen`, etc. Enables the use of smaller system libraries on embedded - * systems that have multiple system libraries, some with or without file - * stream support, in the cases where file stream support is not necessary - * such as memory loading of font files. - */ + /*************************************************************************/ + /* */ + /* Define to disable the use of file stream functions and types, FILE, */ + /* fopen() etc. Enables the use of smaller system libraries on embedded */ + /* systems that have multiple system libraries, some with or without */ + /* file stream support, in the cases where file stream support is not */ + /* necessary such as memory loading of font files. */ + /* */ /* #define FT_CONFIG_OPTION_DISABLE_STREAM_SUPPORT */ - /************************************************************************** - * - * PNG bitmap support. - * - * FreeType now handles loading color bitmap glyphs in the PNG format. - * This requires help from the external libpng library. Uncompressed - * color bitmaps do not need any external libraries and will be supported - * regardless of this configuration. - * - * Define this macro if you want to enable this 'feature'. - * - * If you use a build system like cmake or the `configure` script, - * options set by those programs have precedence, overwriting the value - * here with the configured one. - */ -/* #undef FT_CONFIG_OPTION_USE_PNG */ + /*************************************************************************/ + /* */ + /* PNG bitmap support. */ + /* */ + /* FreeType now handles loading color bitmap glyphs in the PNG format. */ + /* This requires help from the external libpng library. Uncompressed */ + /* color bitmaps do not need any external libraries and will be */ + /* supported regardless of this configuration. */ + /* */ + /* Define this macro if you want to enable this `feature'. */ + /* */ +/* #define FT_CONFIG_OPTION_USE_PNG */ - /************************************************************************** - * - * HarfBuzz support. - * - * FreeType uses the HarfBuzz library to improve auto-hinting of OpenType - * fonts. If available, many glyphs not directly addressable by a font's - * character map will be hinted also. - * - * Define this macro if you want to enable this 'feature'. - * - * If you use a build system like cmake or the `configure` script, - * options set by those programs have precedence, overwriting the value - * here with the configured one. - */ -/* #undef FT_CONFIG_OPTION_USE_HARFBUZZ */ + /*************************************************************************/ + /* */ + /* HarfBuzz support. */ + /* */ + /* FreeType uses the HarfBuzz library to improve auto-hinting of */ + /* OpenType fonts. If available, many glyphs not directly addressable */ + /* by a font's character map will be hinted also. */ + /* */ + /* Define this macro if you want to enable this `feature'. */ + /* */ +/* #define FT_CONFIG_OPTION_USE_HARFBUZZ */ - /************************************************************************** - * - * Glyph Postscript Names handling - * - * By default, FreeType 2 is compiled with the 'psnames' module. This - * module is in charge of converting a glyph name string into a Unicode - * value, or return a Macintosh standard glyph name for the use with the - * TrueType 'post' table. - * - * Undefine this macro if you do not want 'psnames' compiled in your - * build of FreeType. This has the following effects: - * - * - The TrueType driver will provide its own set of glyph names, if you - * build it to support postscript names in the TrueType 'post' table, - * but will not synthesize a missing Unicode charmap. - * - * - The Type~1 driver will not be able to synthesize a Unicode charmap - * out of the glyphs found in the fonts. - * - * You would normally undefine this configuration macro when building a - * version of FreeType that doesn't contain a Type~1 or CFF driver. - */ + /*************************************************************************/ + /* */ + /* DLL export compilation */ + /* */ + /* When compiling FreeType as a DLL, some systems/compilers need a */ + /* special keyword in front OR after the return type of function */ + /* declarations. */ + /* */ + /* Two macros are used within the FreeType source code to define */ + /* exported library functions: FT_EXPORT and FT_EXPORT_DEF. */ + /* */ + /* FT_EXPORT( return_type ) */ + /* */ + /* is used in a function declaration, as in */ + /* */ + /* FT_EXPORT( FT_Error ) */ + /* FT_Init_FreeType( FT_Library* alibrary ); */ + /* */ + /* */ + /* FT_EXPORT_DEF( return_type ) */ + /* */ + /* is used in a function definition, as in */ + /* */ + /* FT_EXPORT_DEF( FT_Error ) */ + /* FT_Init_FreeType( FT_Library* alibrary ) */ + /* { */ + /* ... some code ... */ + /* return FT_Err_Ok; */ + /* } */ + /* */ + /* You can provide your own implementation of FT_EXPORT and */ + /* FT_EXPORT_DEF here if you want. If you leave them undefined, they */ + /* will be later automatically defined as `extern return_type' to */ + /* allow normal compilation. */ + /* */ + /* Do not #undef these macros here since the build system might define */ + /* them for certain configurations only. */ + /* */ +/* #define FT_EXPORT(x) extern x */ +/* #define FT_EXPORT_DEF(x) x */ + + + /*************************************************************************/ + /* */ + /* Glyph Postscript Names handling */ + /* */ + /* By default, FreeType 2 is compiled with the `psnames' module. This */ + /* module is in charge of converting a glyph name string into a */ + /* Unicode value, or return a Macintosh standard glyph name for the */ + /* use with the TrueType `post' table. */ + /* */ + /* Undefine this macro if you do not want `psnames' compiled in your */ + /* build of FreeType. This has the following effects: */ + /* */ + /* - The TrueType driver will provide its own set of glyph names, */ + /* if you build it to support postscript names in the TrueType */ + /* `post' table. */ + /* */ + /* - The Type 1 driver will not be able to synthesize a Unicode */ + /* charmap out of the glyphs found in the fonts. */ + /* */ + /* You would normally undefine this configuration macro when building */ + /* a version of FreeType that doesn't contain a Type 1 or CFF driver. */ + /* */ #define FT_CONFIG_OPTION_POSTSCRIPT_NAMES - /************************************************************************** - * - * Postscript Names to Unicode Values support - * - * By default, FreeType~2 is built with the 'psnames' module compiled in. - * Among other things, the module is used to convert a glyph name into a - * Unicode value. This is especially useful in order to synthesize on - * the fly a Unicode charmap from the CFF/Type~1 driver through a big - * table named the 'Adobe Glyph List' (AGL). - * - * Undefine this macro if you do not want the Adobe Glyph List compiled - * in your 'psnames' module. The Type~1 driver will not be able to - * synthesize a Unicode charmap out of the glyphs found in the fonts. - */ + /*************************************************************************/ + /* */ + /* Postscript Names to Unicode Values support */ + /* */ + /* By default, FreeType 2 is built with the `PSNames' module compiled */ + /* in. Among other things, the module is used to convert a glyph name */ + /* into a Unicode value. This is especially useful in order to */ + /* synthesize on the fly a Unicode charmap from the CFF/Type 1 driver */ + /* through a big table named the `Adobe Glyph List' (AGL). */ + /* */ + /* Undefine this macro if you do not want the Adobe Glyph List */ + /* compiled in your `PSNames' module. The Type 1 driver will not be */ + /* able to synthesize a Unicode charmap out of the glyphs found in the */ + /* fonts. */ + /* */ #define FT_CONFIG_OPTION_ADOBE_GLYPH_LIST - /************************************************************************** - * - * Support for Mac fonts - * - * Define this macro if you want support for outline fonts in Mac format - * (mac dfont, mac resource, macbinary containing a mac resource) on - * non-Mac platforms. - * - * Note that the 'FOND' resource isn't checked. - */ + /*************************************************************************/ + /* */ + /* Support for Mac fonts */ + /* */ + /* Define this macro if you want support for outline fonts in Mac */ + /* format (mac dfont, mac resource, macbinary containing a mac */ + /* resource) on non-Mac platforms. */ + /* */ + /* Note that the `FOND' resource isn't checked. */ + /* */ #define FT_CONFIG_OPTION_MAC_FONTS - /************************************************************************** - * - * Guessing methods to access embedded resource forks - * - * Enable extra Mac fonts support on non-Mac platforms (e.g., GNU/Linux). - * - * Resource forks which include fonts data are stored sometimes in - * locations which users or developers don't expected. In some cases, - * resource forks start with some offset from the head of a file. In - * other cases, the actual resource fork is stored in file different from - * what the user specifies. If this option is activated, FreeType tries - * to guess whether such offsets or different file names must be used. - * - * Note that normal, direct access of resource forks is controlled via - * the `FT_CONFIG_OPTION_MAC_FONTS` option. - */ + /*************************************************************************/ + /* */ + /* Guessing methods to access embedded resource forks */ + /* */ + /* Enable extra Mac fonts support on non-Mac platforms (e.g. */ + /* GNU/Linux). */ + /* */ + /* Resource forks which include fonts data are stored sometimes in */ + /* locations which users or developers don't expected. In some cases, */ + /* resource forks start with some offset from the head of a file. In */ + /* other cases, the actual resource fork is stored in file different */ + /* from what the user specifies. If this option is activated, */ + /* FreeType tries to guess whether such offsets or different file */ + /* names must be used. */ + /* */ + /* Note that normal, direct access of resource forks is controlled via */ + /* the FT_CONFIG_OPTION_MAC_FONTS option. */ + /* */ #ifdef FT_CONFIG_OPTION_MAC_FONTS #define FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK #endif - /************************************************************************** - * - * Allow the use of `FT_Incremental_Interface` to load typefaces that - * contain no glyph data, but supply it via a callback function. This is - * required by clients supporting document formats which supply font data - * incrementally as the document is parsed, such as the Ghostscript - * interpreter for the PostScript language. - */ + /*************************************************************************/ + /* */ + /* Allow the use of FT_Incremental_Interface to load typefaces that */ + /* contain no glyph data, but supply it via a callback function. */ + /* This is required by clients supporting document formats which */ + /* supply font data incrementally as the document is parsed, such */ + /* as the Ghostscript interpreter for the PostScript language. */ + /* */ #define FT_CONFIG_OPTION_INCREMENTAL - /************************************************************************** - * - * The size in bytes of the render pool used by the scan-line converter to - * do all of its work. - */ + /*************************************************************************/ + /* */ + /* The size in bytes of the render pool used by the scan-line converter */ + /* to do all of its work. */ + /* */ #define FT_RENDER_POOL_SIZE 16384L - /************************************************************************** - * - * FT_MAX_MODULES - * - * The maximum number of modules that can be registered in a single - * FreeType library object. 32~is the default. - */ + /*************************************************************************/ + /* */ + /* FT_MAX_MODULES */ + /* */ + /* The maximum number of modules that can be registered in a single */ + /* FreeType library object. 32 is the default. */ + /* */ #define FT_MAX_MODULES 32 - /************************************************************************** - * - * Debug level - * - * FreeType can be compiled in debug or trace mode. In debug mode, - * errors are reported through the 'ftdebug' component. In trace mode, - * additional messages are sent to the standard output during execution. - * - * Define `FT_DEBUG_LEVEL_ERROR` to build the library in debug mode. - * Define `FT_DEBUG_LEVEL_TRACE` to build it in trace mode. - * - * Don't define any of these macros to compile in 'release' mode! - * - * Do not `#undef` these macros here since the build system might define - * them for certain configurations only. - */ + /*************************************************************************/ + /* */ + /* Debug level */ + /* */ + /* FreeType can be compiled in debug or trace mode. In debug mode, */ + /* errors are reported through the `ftdebug' component. In trace */ + /* mode, additional messages are sent to the standard output during */ + /* execution. */ + /* */ + /* Define FT_DEBUG_LEVEL_ERROR to build the library in debug mode. */ + /* Define FT_DEBUG_LEVEL_TRACE to build it in trace mode. */ + /* */ + /* Don't define any of these macros to compile in `release' mode! */ + /* */ + /* Do not #undef these macros here since the build system might define */ + /* them for certain configurations only. */ + /* */ /* #define FT_DEBUG_LEVEL_ERROR */ /* #define FT_DEBUG_LEVEL_TRACE */ - /************************************************************************** - * - * Autofitter debugging - * - * If `FT_DEBUG_AUTOFIT` is defined, FreeType provides some means to - * control the autofitter behaviour for debugging purposes with global - * boolean variables (consequently, you should **never** enable this - * while compiling in 'release' mode): - * - * ``` - * _af_debug_disable_horz_hints - * _af_debug_disable_vert_hints - * _af_debug_disable_blue_hints - * ``` - * - * Additionally, the following functions provide dumps of various - * internal autofit structures to stdout (using `printf`): - * - * ``` - * af_glyph_hints_dump_points - * af_glyph_hints_dump_segments - * af_glyph_hints_dump_edges - * af_glyph_hints_get_num_segments - * af_glyph_hints_get_segment_offset - * ``` - * - * As an argument, they use another global variable: - * - * ``` - * _af_debug_hints - * ``` - * - * Please have a look at the `ftgrid` demo program to see how those - * variables and macros should be used. - * - * Do not `#undef` these macros here since the build system might define - * them for certain configurations only. - */ + /*************************************************************************/ + /* */ + /* Autofitter debugging */ + /* */ + /* If FT_DEBUG_AUTOFIT is defined, FreeType provides some means to */ + /* control the autofitter behaviour for debugging purposes with global */ + /* boolean variables (consequently, you should *never* enable this */ + /* while compiling in `release' mode): */ + /* */ + /* _af_debug_disable_horz_hints */ + /* _af_debug_disable_vert_hints */ + /* _af_debug_disable_blue_hints */ + /* */ + /* Additionally, the following functions provide dumps of various */ + /* internal autofit structures to stdout (using `printf'): */ + /* */ + /* af_glyph_hints_dump_points */ + /* af_glyph_hints_dump_segments */ + /* af_glyph_hints_dump_edges */ + /* af_glyph_hints_get_num_segments */ + /* af_glyph_hints_get_segment_offset */ + /* */ + /* As an argument, they use another global variable: */ + /* */ + /* _af_debug_hints */ + /* */ + /* Please have a look at the `ftgrid' demo program to see how those */ + /* variables and macros should be used. */ + /* */ + /* Do not #undef these macros here since the build system might define */ + /* them for certain configurations only. */ + /* */ /* #define FT_DEBUG_AUTOFIT */ - /************************************************************************** - * - * Memory Debugging - * - * FreeType now comes with an integrated memory debugger that is capable - * of detecting simple errors like memory leaks or double deletes. To - * compile it within your build of the library, you should define - * `FT_DEBUG_MEMORY` here. - * - * Note that the memory debugger is only activated at runtime when when - * the _environment_ variable `FT2_DEBUG_MEMORY` is defined also! - * - * Do not `#undef` this macro here since the build system might define it - * for certain configurations only. - */ + /*************************************************************************/ + /* */ + /* Memory Debugging */ + /* */ + /* FreeType now comes with an integrated memory debugger that is */ + /* capable of detecting simple errors like memory leaks or double */ + /* deletes. To compile it within your build of the library, you */ + /* should define FT_DEBUG_MEMORY here. */ + /* */ + /* Note that the memory debugger is only activated at runtime when */ + /* when the _environment_ variable `FT2_DEBUG_MEMORY' is defined also! */ + /* */ + /* Do not #undef this macro here since the build system might define */ + /* it for certain configurations only. */ + /* */ /* #define FT_DEBUG_MEMORY */ - /************************************************************************** - * - * Module errors - * - * If this macro is set (which is _not_ the default), the higher byte of - * an error code gives the module in which the error has occurred, while - * the lower byte is the real error code. - * - * Setting this macro makes sense for debugging purposes only, since it - * would break source compatibility of certain programs that use - * FreeType~2. - * - * More details can be found in the files `ftmoderr.h` and `fterrors.h`. - */ + /*************************************************************************/ + /* */ + /* Module errors */ + /* */ + /* If this macro is set (which is _not_ the default), the higher byte */ + /* of an error code gives the module in which the error has occurred, */ + /* while the lower byte is the real error code. */ + /* */ + /* Setting this macro makes sense for debugging purposes only, since */ + /* it would break source compatibility of certain programs that use */ + /* FreeType 2. */ + /* */ + /* More details can be found in the files ftmoderr.h and fterrors.h. */ + /* */ #undef FT_CONFIG_OPTION_USE_MODULE_ERRORS - /************************************************************************** - * - * Error Strings - * - * If this macro is set, `FT_Error_String` will return meaningful - * descriptions. This is not enabled by default to reduce the overall - * size of FreeType. - * - * More details can be found in the file `fterrors.h`. - */ -/* #define FT_CONFIG_OPTION_ERROR_STRINGS */ + /*************************************************************************/ + /* */ + /* Position Independent Code */ + /* */ + /* If this macro is set (which is _not_ the default), FreeType2 will */ + /* avoid creating constants that require address fixups. Instead the */ + /* constants will be moved into a struct and additional intialization */ + /* code will be used. */ + /* */ + /* Setting this macro is needed for systems that prohibit address */ + /* fixups, such as BREW. */ + /* */ +/* #define FT_CONFIG_OPTION_PIC */ /*************************************************************************/ @@ -515,60 +506,50 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** - * - * Define `TT_CONFIG_OPTION_EMBEDDED_BITMAPS` if you want to support - * embedded bitmaps in all formats using the 'sfnt' module (namely - * TrueType~& OpenType). - */ + /*************************************************************************/ + /* */ + /* Define TT_CONFIG_OPTION_EMBEDDED_BITMAPS if you want to support */ + /* embedded bitmaps in all formats using the SFNT module (namely */ + /* TrueType & OpenType). */ + /* */ #define TT_CONFIG_OPTION_EMBEDDED_BITMAPS - /************************************************************************** - * - * Define `TT_CONFIG_OPTION_COLOR_LAYERS` if you want to support coloured - * outlines (from the 'COLR'/'CPAL' tables) in all formats using the 'sfnt' - * module (namely TrueType~& OpenType). - */ -#define TT_CONFIG_OPTION_COLOR_LAYERS - - - /************************************************************************** - * - * Define `TT_CONFIG_OPTION_POSTSCRIPT_NAMES` if you want to be able to - * load and enumerate the glyph Postscript names in a TrueType or OpenType - * file. - * - * Note that when you do not compile the 'psnames' module by undefining the - * above `FT_CONFIG_OPTION_POSTSCRIPT_NAMES`, the 'sfnt' module will - * contain additional code used to read the PS Names table from a font. - * - * (By default, the module uses 'psnames' to extract glyph names.) - */ + /*************************************************************************/ + /* */ + /* Define TT_CONFIG_OPTION_POSTSCRIPT_NAMES if you want to be able to */ + /* load and enumerate the glyph Postscript names in a TrueType or */ + /* OpenType file. */ + /* */ + /* Note that when you do not compile the `PSNames' module by undefining */ + /* the above FT_CONFIG_OPTION_POSTSCRIPT_NAMES, the `sfnt' module will */ + /* contain additional code used to read the PS Names table from a font. */ + /* */ + /* (By default, the module uses `PSNames' to extract glyph names.) */ + /* */ #define TT_CONFIG_OPTION_POSTSCRIPT_NAMES - /************************************************************************** - * - * Define `TT_CONFIG_OPTION_SFNT_NAMES` if your applications need to access - * the internal name table in a SFNT-based format like TrueType or - * OpenType. The name table contains various strings used to describe the - * font, like family name, copyright, version, etc. It does not contain - * any glyph name though. - * - * Accessing SFNT names is done through the functions declared in - * `ftsnames.h`. - */ + /*************************************************************************/ + /* */ + /* Define TT_CONFIG_OPTION_SFNT_NAMES if your applications need to */ + /* access the internal name table in a SFNT-based format like TrueType */ + /* or OpenType. The name table contains various strings used to */ + /* describe the font, like family name, copyright, version, etc. It */ + /* does not contain any glyph name though. */ + /* */ + /* Accessing SFNT names is done through the functions declared in */ + /* `ftsnames.h'. */ + /* */ #define TT_CONFIG_OPTION_SFNT_NAMES - /************************************************************************** - * - * TrueType CMap support - * - * Here you can fine-tune which TrueType CMap table format shall be - * supported. - */ + /*************************************************************************/ + /* */ + /* TrueType CMap support */ + /* */ + /* Here you can fine-tune which TrueType CMap table format shall be */ + /* supported. */ #define TT_CONFIG_CMAP_FORMAT_0 #define TT_CONFIG_CMAP_FORMAT_2 #define TT_CONFIG_CMAP_FORMAT_4 @@ -588,130 +569,92 @@ FT_BEGIN_HEADER /*************************************************************************/ /*************************************************************************/ - /************************************************************************** - * - * Define `TT_CONFIG_OPTION_BYTECODE_INTERPRETER` if you want to compile a - * bytecode interpreter in the TrueType driver. - * - * By undefining this, you will only compile the code necessary to load - * TrueType glyphs without hinting. - * - * Do not `#undef` this macro here, since the build system might define it - * for certain configurations only. - */ + /*************************************************************************/ + /* */ + /* Define TT_CONFIG_OPTION_BYTECODE_INTERPRETER if you want to compile */ + /* a bytecode interpreter in the TrueType driver. */ + /* */ + /* By undefining this, you will only compile the code necessary to load */ + /* TrueType glyphs without hinting. */ + /* */ + /* Do not #undef this macro here, since the build system might */ + /* define it for certain configurations only. */ + /* */ #define TT_CONFIG_OPTION_BYTECODE_INTERPRETER - /************************************************************************** - * - * Define `TT_CONFIG_OPTION_SUBPIXEL_HINTING` if you want to compile - * subpixel hinting support into the TrueType driver. This modifies the - * TrueType hinting mechanism when anything but `FT_RENDER_MODE_MONO` is - * requested. - * - * In particular, it modifies the bytecode interpreter to interpret (or - * not) instructions in a certain way so that all TrueType fonts look like - * they do in a Windows ClearType (DirectWrite) environment. See [1] for a - * technical overview on what this means. See `ttinterp.h` for more - * details on the LEAN option. - * - * There are three possible values. - * - * Value 1: - * This value is associated with the 'Infinality' moniker, contributed by - * an individual nicknamed Infinality with the goal of making TrueType - * fonts render better than on Windows. A high amount of configurability - * and flexibility, down to rules for single glyphs in fonts, but also - * very slow. Its experimental and slow nature and the original - * developer losing interest meant that this option was never enabled in - * default builds. - * - * The corresponding interpreter version is v38. - * - * Value 2: - * The new default mode for the TrueType driver. The Infinality code - * base was stripped to the bare minimum and all configurability removed - * in the name of speed and simplicity. The configurability was mainly - * aimed at legacy fonts like 'Arial', 'Times New Roman', or 'Courier'. - * Legacy fonts are fonts that modify vertical stems to achieve clean - * black-and-white bitmaps. The new mode focuses on applying a minimal - * set of rules to all fonts indiscriminately so that modern and web - * fonts render well while legacy fonts render okay. - * - * The corresponding interpreter version is v40. - * - * Value 3: - * Compile both, making both v38 and v40 available (the latter is the - * default). - * - * By undefining these, you get rendering behavior like on Windows without - * ClearType, i.e., Windows XP without ClearType enabled and Win9x - * (interpreter version v35). Or not, depending on how much hinting blood - * and testing tears the font designer put into a given font. If you - * define one or both subpixel hinting options, you can switch between - * between v35 and the ones you define (using `FT_Property_Set`). - * - * This option requires `TT_CONFIG_OPTION_BYTECODE_INTERPRETER` to be - * defined. - * - * [1] - * https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx - */ -/* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING 1 */ -#define TT_CONFIG_OPTION_SUBPIXEL_HINTING 2 -/* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING ( 1 | 2 ) */ + /*************************************************************************/ + /* */ + /* Define TT_CONFIG_OPTION_SUBPIXEL_HINTING if you want to compile */ + /* EXPERIMENTAL subpixel hinting support into the TrueType driver. This */ + /* replaces the native TrueType hinting mechanism when anything but */ + /* FT_RENDER_MODE_MONO is requested. */ + /* */ + /* Enabling this causes the TrueType driver to ignore instructions under */ + /* certain conditions. This is done in accordance with the guide here, */ + /* with some minor differences: */ + /* */ + /* http://www.microsoft.com/typography/cleartype/truetypecleartype.aspx */ + /* */ + /* By undefining this, you only compile the code necessary to hint */ + /* TrueType glyphs with native TT hinting. */ + /* */ + /* This option requires TT_CONFIG_OPTION_BYTECODE_INTERPRETER to be */ + /* defined. */ + /* */ +/* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING */ - /************************************************************************** - * - * Define `TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED` to compile the - * TrueType glyph loader to use Apple's definition of how to handle - * component offsets in composite glyphs. - * - * Apple and MS disagree on the default behavior of component offsets in - * composites. Apple says that they should be scaled by the scaling - * factors in the transformation matrix (roughly, it's more complex) while - * MS says they should not. OpenType defines two bits in the composite - * flags array which can be used to disambiguate, but old fonts will not - * have them. - * - * https://www.microsoft.com/typography/otspec/glyf.htm - * https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6glyf.html - */ + /*************************************************************************/ + /* */ + /* Define TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED to compile the */ + /* TrueType glyph loader to use Apple's definition of how to handle */ + /* component offsets in composite glyphs. */ + /* */ + /* Apple and MS disagree on the default behavior of component offsets */ + /* in composites. Apple says that they should be scaled by the scaling */ + /* factors in the transformation matrix (roughly, it's more complex) */ + /* while MS says they should not. OpenType defines two bits in the */ + /* composite flags array which can be used to disambiguate, but old */ + /* fonts will not have them. */ + /* */ + /* http://www.microsoft.com/typography/otspec/glyf.htm */ + /* https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6glyf.html */ + /* */ #undef TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED - /************************************************************************** - * - * Define `TT_CONFIG_OPTION_GX_VAR_SUPPORT` if you want to include support - * for Apple's distortable font technology ('fvar', 'gvar', 'cvar', and - * 'avar' tables). Tagged 'Font Variations', this is now part of OpenType - * also. This has many similarities to Type~1 Multiple Masters support. - */ + /*************************************************************************/ + /* */ + /* Define TT_CONFIG_OPTION_GX_VAR_SUPPORT if you want to include */ + /* support for Apple's distortable font technology (fvar, gvar, cvar, */ + /* and avar tables). This has many similarities to Type 1 Multiple */ + /* Masters support. */ + /* */ #define TT_CONFIG_OPTION_GX_VAR_SUPPORT - /************************************************************************** - * - * Define `TT_CONFIG_OPTION_BDF` if you want to include support for an - * embedded 'BDF~' table within SFNT-based bitmap formats. - */ + /*************************************************************************/ + /* */ + /* Define TT_CONFIG_OPTION_BDF if you want to include support for */ + /* an embedded `BDF ' table within SFNT-based bitmap formats. */ + /* */ #define TT_CONFIG_OPTION_BDF - /************************************************************************** - * - * Option `TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES` controls the maximum - * number of bytecode instructions executed for a single run of the - * bytecode interpreter, needed to prevent infinite loops. You don't want - * to change this except for very special situations (e.g., making a - * library fuzzer spend less time to handle broken fonts). - * - * It is not expected that this value is ever modified by a configuring - * script; instead, it gets surrounded with `#ifndef ... #endif` so that - * the value can be set as a preprocessor option on the compiler's command - * line. - */ + /*************************************************************************/ + /* */ + /* Option TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES controls the maximum */ + /* number of bytecode instructions executed for a single run of the */ + /* bytecode interpreter, needed to prevent infinite loops. You don't */ + /* want to change this except for very special situations (e.g., making */ + /* a library fuzzer spend less time to handle broken fonts). */ + /* */ + /* It is not expected that this value is ever modified by a configuring */ + /* script; instead, it gets surrounded with #ifndef ... #endif so that */ + /* the value can be set as a preprocessor option on the compiler's */ + /* command line. */ + /* */ #ifndef TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES #define TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES 1000000L #endif @@ -726,61 +669,52 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** - * - * `T1_MAX_DICT_DEPTH` is the maximum depth of nest dictionaries and arrays - * in the Type~1 stream (see `t1load.c`). A minimum of~4 is required. - */ + /*************************************************************************/ + /* */ + /* T1_MAX_DICT_DEPTH is the maximum depth of nest dictionaries and */ + /* arrays in the Type 1 stream (see t1load.c). A minimum of 4 is */ + /* required. */ + /* */ #define T1_MAX_DICT_DEPTH 5 - /************************************************************************** - * - * `T1_MAX_SUBRS_CALLS` details the maximum number of nested sub-routine - * calls during glyph loading. - */ + /*************************************************************************/ + /* */ + /* T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine */ + /* calls during glyph loading. */ + /* */ #define T1_MAX_SUBRS_CALLS 16 - /************************************************************************** - * - * `T1_MAX_CHARSTRING_OPERANDS` is the charstring stack's capacity. A - * minimum of~16 is required. - * - * The Chinese font 'MingTiEG-Medium' (covering the CNS 11643 character - * set) needs 256. - */ + /*************************************************************************/ + /* */ + /* T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity. A */ + /* minimum of 16 is required. */ + /* */ + /* The Chinese font MingTiEG-Medium (CNS 11643 character set) needs 256. */ + /* */ #define T1_MAX_CHARSTRINGS_OPERANDS 256 - /************************************************************************** - * - * Define this configuration macro if you want to prevent the compilation - * of the 't1afm' module, which is in charge of reading Type~1 AFM files - * into an existing face. Note that if set, the Type~1 driver will be - * unable to produce kerning distances. - */ + /*************************************************************************/ + /* */ + /* Define this configuration macro if you want to prevent the */ + /* compilation of `t1afm', which is in charge of reading Type 1 AFM */ + /* files into an existing face. Note that if set, the T1 driver will be */ + /* unable to produce kerning distances. */ + /* */ #undef T1_CONFIG_OPTION_NO_AFM - /************************************************************************** - * - * Define this configuration macro if you want to prevent the compilation - * of the Multiple Masters font support in the Type~1 driver. - */ + /*************************************************************************/ + /* */ + /* Define this configuration macro if you want to prevent the */ + /* compilation of the Multiple Masters font support in the Type 1 */ + /* driver. */ + /* */ #undef T1_CONFIG_OPTION_NO_MM_SUPPORT - /************************************************************************** - * - * `T1_CONFIG_OPTION_OLD_ENGINE` controls whether the pre-Adobe Type~1 - * engine gets compiled into FreeType. If defined, it is possible to - * switch between the two engines using the `hinting-engine` property of - * the 'type1' driver module. - */ -/* #define T1_CONFIG_OPTION_OLD_ENGINE */ - - /*************************************************************************/ /*************************************************************************/ /**** ****/ @@ -790,16 +724,17 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** - * - * Using `CFF_CONFIG_OPTION_DARKENING_PARAMETER_{X,Y}{1,2,3,4}` it is - * possible to set up the default values of the four control points that - * define the stem darkening behaviour of the (new) CFF engine. For more - * details please read the documentation of the `darkening-parameters` - * property (file `ftdriver.h`), which allows the control at run-time. - * - * Do **not** undefine these macros! - */ + /*************************************************************************/ + /* */ + /* Using CFF_CONFIG_OPTION_DARKENING_PARAMETER_{X,Y}{1,2,3,4} it is */ + /* possible to set up the default values of the four control points that */ + /* define the stem darkening behaviour of the (new) CFF engine. For */ + /* more details please read the documentation of the */ + /* `darkening-parameters' property of the cff driver module (file */ + /* `ftcffdrv.h'), which allows the control at run-time. */ + /* */ + /* Do *not* undefine these macros! */ + /* */ #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 500 #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1 400 @@ -813,43 +748,16 @@ FT_BEGIN_HEADER #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y4 0 - /************************************************************************** - * - * `CFF_CONFIG_OPTION_OLD_ENGINE` controls whether the pre-Adobe CFF engine - * gets compiled into FreeType. If defined, it is possible to switch - * between the two engines using the `hinting-engine` property of the 'cff' - * driver module. - */ + /*************************************************************************/ + /* */ + /* CFF_CONFIG_OPTION_OLD_ENGINE controls whether the pre-Adobe CFF */ + /* engine gets compiled into FreeType. If defined, it is possible to */ + /* switch between the two engines using the `hinting-engine' property of */ + /* the cff driver module. */ + /* */ /* #define CFF_CONFIG_OPTION_OLD_ENGINE */ - /*************************************************************************/ - /*************************************************************************/ - /**** ****/ - /**** P C F D R I V E R C O N F I G U R A T I O N ****/ - /**** ****/ - /*************************************************************************/ - /*************************************************************************/ - - - /************************************************************************** - * - * There are many PCF fonts just called 'Fixed' which look completely - * different, and which have nothing to do with each other. When selecting - * 'Fixed' in KDE or Gnome one gets results that appear rather random, the - * style changes often if one changes the size and one cannot select some - * fonts at all. This option makes the 'pcf' module prepend the foundry - * name (plus a space) to the family name. - * - * We also check whether we have 'wide' characters; all put together, we - * get family names like 'Sony Fixed' or 'Misc Fixed Wide'. - * - * If this option is activated, it can be controlled with the - * `no-long-family-names` property of the 'pcf' driver module. - */ -/* #define PCF_CONFIG_OPTION_LONG_FAMILY_NAMES */ - - /*************************************************************************/ /*************************************************************************/ /**** ****/ @@ -859,95 +767,56 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** - * - * Compile 'autofit' module with CJK (Chinese, Japanese, Korean) script - * support. - */ + /*************************************************************************/ + /* */ + /* Compile autofit module with CJK (Chinese, Japanese, Korean) script */ + /* support. */ + /* */ #define AF_CONFIG_OPTION_CJK - - /************************************************************************** - * - * Compile 'autofit' module with fallback Indic script support, covering - * some scripts that the 'latin' submodule of the 'autofit' module doesn't - * (yet) handle. - */ + /*************************************************************************/ + /* */ + /* Compile autofit module with Indic script support. */ + /* */ #define AF_CONFIG_OPTION_INDIC - - /************************************************************************** - * - * Compile 'autofit' module with warp hinting. The idea of the warping - * code is to slightly scale and shift a glyph within a single dimension so - * that as much of its segments are aligned (more or less) on the grid. To - * find out the optimal scaling and shifting value, various parameter - * combinations are tried and scored. - * - * You can switch warping on and off with the `warping` property of the - * auto-hinter (see file `ftdriver.h` for more information; by default it - * is switched off). - * - * This experimental option is not active if the rendering mode is - * `FT_RENDER_MODE_LIGHT`. - */ + /*************************************************************************/ + /* */ + /* Compile autofit module with warp hinting. The idea of the warping */ + /* code is to slightly scale and shift a glyph within a single dimension */ + /* so that as much of its segments are aligned (more or less) on the */ + /* grid. To find out the optimal scaling and shifting value, various */ + /* parameter combinations are tried and scored. */ + /* */ + /* This experimental option is active only if the rendering mode is */ + /* FT_RENDER_MODE_LIGHT; you can switch warping on and off with the */ + /* `warping' property of the auto-hinter (see file `ftautoh.h' for more */ + /* information; by default it is switched off). */ + /* */ #define AF_CONFIG_OPTION_USE_WARPER - - /************************************************************************** - * - * Use TrueType-like size metrics for 'light' auto-hinting. - * - * It is strongly recommended to avoid this option, which exists only to - * help some legacy applications retain its appearance and behaviour with - * respect to auto-hinted TrueType fonts. - * - * The very reason this option exists at all are GNU/Linux distributions - * like Fedora that did not un-patch the following change (which was - * present in FreeType between versions 2.4.6 and 2.7.1, inclusive). - * - * ``` - * 2011-07-16 Steven Chu <steven.f.chu@gmail.com> - * - * [truetype] Fix metrics on size request for scalable fonts. - * ``` - * - * This problematic commit is now reverted (more or less). - */ -/* #define AF_CONFIG_OPTION_TT_SIZE_METRICS */ - /* */ /* - * This macro is obsolete. Support has been removed in FreeType version - * 2.5. + * This macro is obsolete. Support has been removed in FreeType + * version 2.5. */ /* #define FT_CONFIG_OPTION_OLD_INTERNALS */ /* - * The next three macros are defined if native TrueType hinting is - * requested by the definitions above. Don't change this. + * This macro is defined if native TrueType hinting is requested by the + * definitions above. */ #ifdef TT_CONFIG_OPTION_BYTECODE_INTERPRETER #define TT_USE_BYTECODE_INTERPRETER - -#ifdef TT_CONFIG_OPTION_SUBPIXEL_HINTING -#if TT_CONFIG_OPTION_SUBPIXEL_HINTING & 1 -#define TT_SUPPORT_SUBPIXEL_HINTING_INFINALITY -#endif - -#if TT_CONFIG_OPTION_SUBPIXEL_HINTING & 2 -#define TT_SUPPORT_SUBPIXEL_HINTING_MINIMAL -#endif -#endif #endif /* * Check CFF darkening parameters. The checks are the same as in function - * `cff_property_set` in file `cffdrivr.c`. + * `cff_property_set' in file `cffdrivr.c'. */ #if CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 < 0 || \ CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 < 0 || \ diff --git a/android/x86_64/include/freetype/config/ftstdlib.h b/android/x86_64/include/freetype/config/ftstdlib.h index 438b6145..9daea56f 100644 --- a/android/x86_64/include/freetype/config/ftstdlib.h +++ b/android/x86_64/include/freetype/config/ftstdlib.h @@ -1,31 +1,31 @@ -/**************************************************************************** - * - * ftstdlib.h - * - * ANSI-specific library and header configuration file (specification - * only). - * - * Copyright (C) 2002-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftstdlib.h */ +/* */ +/* ANSI-specific library and header configuration file (specification */ +/* only). */ +/* */ +/* Copyright 2002-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * This file is used to group all `#includes` to the ANSI~C library that - * FreeType normally requires. It also defines macros to rename the - * standard functions within the FreeType source code. - * - * Load a file which defines `FTSTDLIB_H_` before this one to override it. - * - */ + /*************************************************************************/ + /* */ + /* This file is used to group all #includes to the ANSI C library that */ + /* FreeType normally requires. It also defines macros to rename the */ + /* standard functions within the FreeType source code. */ + /* */ + /* Load a file which defines FTSTDLIB_H_ before this one to override it. */ + /* */ + /*************************************************************************/ #ifndef FTSTDLIB_H_ @@ -37,23 +37,23 @@ #define ft_ptrdiff_t ptrdiff_t - /************************************************************************** - * - * integer limits - * - * `UINT_MAX` and `ULONG_MAX` are used to automatically compute the size of - * `int` and `long` in bytes at compile-time. So far, this works for all - * platforms the library has been tested on. - * - * Note that on the extremely rare platforms that do not provide integer - * types that are _exactly_ 16 and 32~bits wide (e.g., some old Crays where - * `int` is 36~bits), we do not make any guarantee about the correct - * behaviour of FreeType~2 with all fonts. - * - * In these cases, `ftconfig.h` will refuse to compile anyway with a - * message like 'couldn't find 32-bit type' or something similar. - * - */ + /**********************************************************************/ + /* */ + /* integer limits */ + /* */ + /* UINT_MAX and ULONG_MAX are used to automatically compute the size */ + /* of `int' and `long' in bytes at compile-time. So far, this works */ + /* for all platforms the library has been tested on. */ + /* */ + /* Note that on the extremely rare platforms that do not provide */ + /* integer types that are _exactly_ 16 and 32 bits wide (e.g. some */ + /* old Crays where `int' is 36 bits), we do not make any guarantee */ + /* about the correct behaviour of FT2 with all fonts. */ + /* */ + /* In these case, `ftconfig.h' will refuse to compile anyway with a */ + /* message like `couldn't find 32-bit type' or something similar. */ + /* */ + /**********************************************************************/ #include <limits.h> @@ -63,16 +63,15 @@ #define FT_INT_MAX INT_MAX #define FT_INT_MIN INT_MIN #define FT_UINT_MAX UINT_MAX -#define FT_LONG_MIN LONG_MIN #define FT_LONG_MAX LONG_MAX #define FT_ULONG_MAX ULONG_MAX - /************************************************************************** - * - * character and string processing - * - */ + /**********************************************************************/ + /* */ + /* character and string processing */ + /* */ + /**********************************************************************/ #include <string.h> @@ -92,11 +91,11 @@ #define ft_strstr strstr - /************************************************************************** - * - * file handling - * - */ + /**********************************************************************/ + /* */ + /* file handling */ + /* */ + /**********************************************************************/ #include <stdio.h> @@ -110,11 +109,11 @@ #define ft_sprintf sprintf - /************************************************************************** - * - * sorting - * - */ + /**********************************************************************/ + /* */ + /* sorting */ + /* */ + /**********************************************************************/ #include <stdlib.h> @@ -122,11 +121,11 @@ #define ft_qsort qsort - /************************************************************************** - * - * memory allocation - * - */ + /**********************************************************************/ + /* */ + /* memory allocation */ + /* */ + /**********************************************************************/ #define ft_scalloc calloc @@ -135,36 +134,35 @@ #define ft_srealloc realloc - /************************************************************************** - * - * miscellaneous - * - */ + /**********************************************************************/ + /* */ + /* miscellaneous */ + /* */ + /**********************************************************************/ -#define ft_strtol strtol -#define ft_getenv getenv +#define ft_atol atol - /************************************************************************** - * - * execution control - * - */ + /**********************************************************************/ + /* */ + /* execution control */ + /* */ + /**********************************************************************/ #include <setjmp.h> -#define ft_jmp_buf jmp_buf /* note: this cannot be a typedef since */ - /* `jmp_buf` is defined as a macro */ - /* on certain platforms */ +#define ft_jmp_buf jmp_buf /* note: this cannot be a typedef since */ + /* jmp_buf is defined as a macro */ + /* on certain platforms */ #define ft_longjmp longjmp #define ft_setjmp( b ) setjmp( *(ft_jmp_buf*) &(b) ) /* same thing here */ - /* The following is only used for debugging purposes, i.e., if */ - /* `FT_DEBUG_LEVEL_ERROR` or `FT_DEBUG_LEVEL_TRACE` are defined. */ + /* the following is only used for debugging purposes, i.e., if */ + /* FT_DEBUG_LEVEL_ERROR or FT_DEBUG_LEVEL_TRACE are defined */ #include <stdarg.h> diff --git a/android/x86_64/include/freetype/freetype.h b/android/x86_64/include/freetype/freetype.h index 82af09e9..4666d489 100644 --- a/android/x86_64/include/freetype/freetype.h +++ b/android/x86_64/include/freetype/freetype.h @@ -1,19 +1,19 @@ -/**************************************************************************** - * - * freetype.h - * - * FreeType high-level API and common types (specification only). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* freetype.h */ +/* */ +/* FreeType high-level API and common types (specification only). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FREETYPE_H_ @@ -24,12 +24,12 @@ #error "`ft2build.h' hasn't been included yet!" #error "Please always use macros to include FreeType header files." #error "Example:" -#error " #include "ft2build.h"" +#error " #include <ft2build.h>" #error " #include FT_FREETYPE_H" #endif -#include "ft2build.h" +#include <ft2build.h> #include FT_CONFIG_CONFIG_H #include FT_TYPES_H #include FT_ERRORS_H @@ -39,55 +39,56 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * header_inclusion - * - * @title: - * FreeType's header inclusion scheme - * - * @abstract: - * How client applications should include FreeType header files. - * - * @description: - * To be as flexible as possible (and for historical reasons), FreeType - * uses a very special inclusion scheme to load header files, for example - * - * ``` - * #include "ft2build.h" - * - * #include FT_FREETYPE_H - * #include FT_OUTLINE_H - * ``` - * - * A compiler and its preprocessor only needs an include path to find the - * file `ft2build.h`; the exact locations and names of the other FreeType - * header files are hidden by @header_file_macros, loaded by - * `ft2build.h`. The API documentation always gives the header macro - * name needed for a particular function. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* header_inclusion */ + /* */ + /* <Title> */ + /* FreeType's header inclusion scheme */ + /* */ + /* <Abstract> */ + /* How client applications should include FreeType header files. */ + /* */ + /* <Description> */ + /* To be as flexible as possible (and for historical reasons), */ + /* FreeType uses a very special inclusion scheme to load header */ + /* files, for example */ + /* */ + /* { */ + /* #include <ft2build.h> */ + /* */ + /* #include FT_FREETYPE_H */ + /* #include FT_OUTLINE_H */ + /* } */ + /* */ + /* A compiler and its preprocessor only needs an include path to find */ + /* the file `ft2build.h'; the exact locations and names of the other */ + /* FreeType header files are hidden by preprocessor macro names, */ + /* loaded by `ft2build.h'. The API documentation always gives the */ + /* header macro name needed for a particular function. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @section: - * user_allocation - * - * @title: - * User allocation - * - * @abstract: - * How client applications should allocate FreeType data structures. - * - * @description: - * FreeType assumes that structures allocated by the user and passed as - * arguments are zeroed out except for the actual data. In other words, - * it is recommended to use `calloc` (or variants of it) instead of - * `malloc` for allocation. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* user_allocation */ + /* */ + /* <Title> */ + /* User allocation */ + /* */ + /* <Abstract> */ + /* How client applications should allocate FreeType data structures. */ + /* */ + /* <Description> */ + /* FreeType assumes that structures allocated by the user and passed */ + /* as arguments are zeroed out except for the actual data. In other */ + /* words, it is recommended to use `calloc' (or variants of it) */ + /* instead of `malloc' for allocation. */ + /* */ + /*************************************************************************/ @@ -100,219 +101,210 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** - * - * @section: - * base_interface - * - * @title: - * Base Interface - * - * @abstract: - * The FreeType~2 base font interface. - * - * @description: - * This section describes the most important public high-level API - * functions of FreeType~2. - * - * @order: - * FT_Library - * FT_Face - * FT_Size - * FT_GlyphSlot - * FT_CharMap - * FT_Encoding - * FT_ENC_TAG - * - * FT_FaceRec - * - * FT_FACE_FLAG_SCALABLE - * FT_FACE_FLAG_FIXED_SIZES - * FT_FACE_FLAG_FIXED_WIDTH - * FT_FACE_FLAG_HORIZONTAL - * FT_FACE_FLAG_VERTICAL - * FT_FACE_FLAG_COLOR - * FT_FACE_FLAG_SFNT - * FT_FACE_FLAG_CID_KEYED - * FT_FACE_FLAG_TRICKY - * FT_FACE_FLAG_KERNING - * FT_FACE_FLAG_MULTIPLE_MASTERS - * FT_FACE_FLAG_VARIATION - * FT_FACE_FLAG_GLYPH_NAMES - * FT_FACE_FLAG_EXTERNAL_STREAM - * FT_FACE_FLAG_HINTER - * - * FT_HAS_HORIZONTAL - * FT_HAS_VERTICAL - * FT_HAS_KERNING - * FT_HAS_FIXED_SIZES - * FT_HAS_GLYPH_NAMES - * FT_HAS_COLOR - * FT_HAS_MULTIPLE_MASTERS - * - * FT_IS_SFNT - * FT_IS_SCALABLE - * FT_IS_FIXED_WIDTH - * FT_IS_CID_KEYED - * FT_IS_TRICKY - * FT_IS_NAMED_INSTANCE - * FT_IS_VARIATION - * - * FT_STYLE_FLAG_BOLD - * FT_STYLE_FLAG_ITALIC - * - * FT_SizeRec - * FT_Size_Metrics - * - * FT_GlyphSlotRec - * FT_Glyph_Metrics - * FT_SubGlyph - * - * FT_Bitmap_Size - * - * FT_Init_FreeType - * FT_Done_FreeType - * - * FT_New_Face - * FT_Done_Face - * FT_Reference_Face - * FT_New_Memory_Face - * FT_Face_Properties - * FT_Open_Face - * FT_Open_Args - * FT_Parameter - * FT_Attach_File - * FT_Attach_Stream - * - * FT_Set_Char_Size - * FT_Set_Pixel_Sizes - * FT_Request_Size - * FT_Select_Size - * FT_Size_Request_Type - * FT_Size_RequestRec - * FT_Size_Request - * FT_Set_Transform - * FT_Load_Glyph - * FT_Get_Char_Index - * FT_Get_First_Char - * FT_Get_Next_Char - * FT_Get_Name_Index - * FT_Load_Char - * - * FT_OPEN_MEMORY - * FT_OPEN_STREAM - * FT_OPEN_PATHNAME - * FT_OPEN_DRIVER - * FT_OPEN_PARAMS - * - * FT_LOAD_DEFAULT - * FT_LOAD_RENDER - * FT_LOAD_MONOCHROME - * FT_LOAD_LINEAR_DESIGN - * FT_LOAD_NO_SCALE - * FT_LOAD_NO_HINTING - * FT_LOAD_NO_BITMAP - * FT_LOAD_NO_AUTOHINT - * FT_LOAD_COLOR - * - * FT_LOAD_VERTICAL_LAYOUT - * FT_LOAD_IGNORE_TRANSFORM - * FT_LOAD_FORCE_AUTOHINT - * FT_LOAD_NO_RECURSE - * FT_LOAD_PEDANTIC - * - * FT_LOAD_TARGET_NORMAL - * FT_LOAD_TARGET_LIGHT - * FT_LOAD_TARGET_MONO - * FT_LOAD_TARGET_LCD - * FT_LOAD_TARGET_LCD_V - * - * FT_LOAD_TARGET_MODE - * - * FT_Render_Glyph - * FT_Render_Mode - * FT_Get_Kerning - * FT_Kerning_Mode - * FT_Get_Track_Kerning - * FT_Get_Glyph_Name - * FT_Get_Postscript_Name - * - * FT_CharMapRec - * FT_Select_Charmap - * FT_Set_Charmap - * FT_Get_Charmap_Index - * - * FT_Get_FSType_Flags - * FT_Get_SubGlyph_Info - * - * FT_Face_Internal - * FT_Size_Internal - * FT_Slot_Internal - * - * FT_FACE_FLAG_XXX - * FT_STYLE_FLAG_XXX - * FT_OPEN_XXX - * FT_LOAD_XXX - * FT_LOAD_TARGET_XXX - * FT_SUBGLYPH_FLAG_XXX - * FT_FSTYPE_XXX - * - * FT_HAS_FAST_GLYPHS - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* base_interface */ + /* */ + /* <Title> */ + /* Base Interface */ + /* */ + /* <Abstract> */ + /* The FreeType~2 base font interface. */ + /* */ + /* <Description> */ + /* This section describes the most important public high-level API */ + /* functions of FreeType~2. */ + /* */ + /* <Order> */ + /* FT_Library */ + /* FT_Face */ + /* FT_Size */ + /* FT_GlyphSlot */ + /* FT_CharMap */ + /* FT_Encoding */ + /* FT_ENC_TAG */ + /* */ + /* FT_FaceRec */ + /* */ + /* FT_FACE_FLAG_SCALABLE */ + /* FT_FACE_FLAG_FIXED_SIZES */ + /* FT_FACE_FLAG_FIXED_WIDTH */ + /* FT_FACE_FLAG_HORIZONTAL */ + /* FT_FACE_FLAG_VERTICAL */ + /* FT_FACE_FLAG_COLOR */ + /* FT_FACE_FLAG_SFNT */ + /* FT_FACE_FLAG_CID_KEYED */ + /* FT_FACE_FLAG_TRICKY */ + /* FT_FACE_FLAG_KERNING */ + /* FT_FACE_FLAG_MULTIPLE_MASTERS */ + /* FT_FACE_FLAG_GLYPH_NAMES */ + /* FT_FACE_FLAG_EXTERNAL_STREAM */ + /* FT_FACE_FLAG_HINTER */ + /* */ + /* FT_HAS_HORIZONTAL */ + /* FT_HAS_VERTICAL */ + /* FT_HAS_KERNING */ + /* FT_HAS_FIXED_SIZES */ + /* FT_HAS_GLYPH_NAMES */ + /* FT_HAS_MULTIPLE_MASTERS */ + /* FT_HAS_COLOR */ + /* */ + /* FT_IS_SFNT */ + /* FT_IS_SCALABLE */ + /* FT_IS_FIXED_WIDTH */ + /* FT_IS_CID_KEYED */ + /* FT_IS_TRICKY */ + /* */ + /* FT_STYLE_FLAG_BOLD */ + /* FT_STYLE_FLAG_ITALIC */ + /* */ + /* FT_SizeRec */ + /* FT_Size_Metrics */ + /* */ + /* FT_GlyphSlotRec */ + /* FT_Glyph_Metrics */ + /* FT_SubGlyph */ + /* */ + /* FT_Bitmap_Size */ + /* */ + /* FT_Init_FreeType */ + /* FT_Done_FreeType */ + /* */ + /* FT_New_Face */ + /* FT_Done_Face */ + /* FT_Reference_Face */ + /* FT_New_Memory_Face */ + /* FT_Open_Face */ + /* FT_Open_Args */ + /* FT_Parameter */ + /* FT_Attach_File */ + /* FT_Attach_Stream */ + /* */ + /* FT_Set_Char_Size */ + /* FT_Set_Pixel_Sizes */ + /* FT_Request_Size */ + /* FT_Select_Size */ + /* FT_Size_Request_Type */ + /* FT_Size_RequestRec */ + /* FT_Size_Request */ + /* FT_Set_Transform */ + /* FT_Load_Glyph */ + /* FT_Get_Char_Index */ + /* FT_Get_First_Char */ + /* FT_Get_Next_Char */ + /* FT_Get_Name_Index */ + /* FT_Load_Char */ + /* */ + /* FT_OPEN_MEMORY */ + /* FT_OPEN_STREAM */ + /* FT_OPEN_PATHNAME */ + /* FT_OPEN_DRIVER */ + /* FT_OPEN_PARAMS */ + /* */ + /* FT_LOAD_DEFAULT */ + /* FT_LOAD_RENDER */ + /* FT_LOAD_MONOCHROME */ + /* FT_LOAD_LINEAR_DESIGN */ + /* FT_LOAD_NO_SCALE */ + /* FT_LOAD_NO_HINTING */ + /* FT_LOAD_NO_BITMAP */ + /* FT_LOAD_NO_AUTOHINT */ + /* FT_LOAD_COLOR */ + /* */ + /* FT_LOAD_VERTICAL_LAYOUT */ + /* FT_LOAD_IGNORE_TRANSFORM */ + /* FT_LOAD_FORCE_AUTOHINT */ + /* FT_LOAD_NO_RECURSE */ + /* FT_LOAD_PEDANTIC */ + /* */ + /* FT_LOAD_TARGET_NORMAL */ + /* FT_LOAD_TARGET_LIGHT */ + /* FT_LOAD_TARGET_MONO */ + /* FT_LOAD_TARGET_LCD */ + /* FT_LOAD_TARGET_LCD_V */ + /* */ + /* FT_LOAD_TARGET_MODE */ + /* */ + /* FT_Render_Glyph */ + /* FT_Render_Mode */ + /* FT_Get_Kerning */ + /* FT_Kerning_Mode */ + /* FT_Get_Track_Kerning */ + /* FT_Get_Glyph_Name */ + /* FT_Get_Postscript_Name */ + /* */ + /* FT_CharMapRec */ + /* FT_Select_Charmap */ + /* FT_Set_Charmap */ + /* FT_Get_Charmap_Index */ + /* */ + /* FT_Get_FSType_Flags */ + /* FT_Get_SubGlyph_Info */ + /* */ + /* FT_Face_Internal */ + /* FT_Size_Internal */ + /* FT_Slot_Internal */ + /* */ + /* FT_FACE_FLAG_XXX */ + /* FT_STYLE_FLAG_XXX */ + /* FT_OPEN_XXX */ + /* FT_LOAD_XXX */ + /* FT_LOAD_TARGET_XXX */ + /* FT_SUBGLYPH_FLAG_XXX */ + /* FT_FSTYPE_XXX */ + /* */ + /* FT_HAS_FAST_GLYPHS */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @struct: - * FT_Glyph_Metrics - * - * @description: - * A structure to model the metrics of a single glyph. The values are - * expressed in 26.6 fractional pixel format; if the flag - * @FT_LOAD_NO_SCALE has been used while loading the glyph, values are - * expressed in font units instead. - * - * @fields: - * width :: - * The glyph's width. - * - * height :: - * The glyph's height. - * - * horiBearingX :: - * Left side bearing for horizontal layout. - * - * horiBearingY :: - * Top side bearing for horizontal layout. - * - * horiAdvance :: - * Advance width for horizontal layout. - * - * vertBearingX :: - * Left side bearing for vertical layout. - * - * vertBearingY :: - * Top side bearing for vertical layout. Larger positive values mean - * further below the vertical glyph origin. - * - * vertAdvance :: - * Advance height for vertical layout. Positive values mean the glyph - * has a positive advance downward. - * - * @note: - * If not disabled with @FT_LOAD_NO_HINTING, the values represent - * dimensions of the hinted glyph (in case hinting is applicable). - * - * Stroking a glyph with an outside border does not increase - * `horiAdvance` or `vertAdvance`; you have to manually adjust these - * values to account for the added width and height. - * - * FreeType doesn't use the 'VORG' table data for CFF fonts because it - * doesn't have an interface to quickly retrieve the glyph height. The - * y~coordinate of the vertical origin can be simply computed as - * `vertBearingY + height` after loading a glyph. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Glyph_Metrics */ + /* */ + /* <Description> */ + /* A structure used to model the metrics of a single glyph. The */ + /* values are expressed in 26.6 fractional pixel format; if the flag */ + /* @FT_LOAD_NO_SCALE has been used while loading the glyph, values */ + /* are expressed in font units instead. */ + /* */ + /* <Fields> */ + /* width :: */ + /* The glyph's width. */ + /* */ + /* height :: */ + /* The glyph's height. */ + /* */ + /* horiBearingX :: */ + /* Left side bearing for horizontal layout. */ + /* */ + /* horiBearingY :: */ + /* Top side bearing for horizontal layout. */ + /* */ + /* horiAdvance :: */ + /* Advance width for horizontal layout. */ + /* */ + /* vertBearingX :: */ + /* Left side bearing for vertical layout. */ + /* */ + /* vertBearingY :: */ + /* Top side bearing for vertical layout. Larger positive values */ + /* mean further below the vertical glyph origin. */ + /* */ + /* vertAdvance :: */ + /* Advance height for vertical layout. Positive values mean the */ + /* glyph has a positive advance downward. */ + /* */ + /* <Note> */ + /* If not disabled with @FT_LOAD_NO_HINTING, the values represent */ + /* dimensions of the hinted glyph (in case hinting is applicable). */ + /* */ + /* Stroking a glyph with an outside border does not increase */ + /* `horiAdvance' or `vertAdvance'; you have to manually adjust these */ + /* values to account for the added width and height. */ + /* */ typedef struct FT_Glyph_Metrics_ { FT_Pos width; @@ -329,45 +321,44 @@ FT_BEGIN_HEADER } FT_Glyph_Metrics; - /************************************************************************** - * - * @struct: - * FT_Bitmap_Size - * - * @description: - * This structure models the metrics of a bitmap strike (i.e., a set of - * glyphs for a given point size and resolution) in a bitmap font. It is - * used for the `available_sizes` field of @FT_Face. - * - * @fields: - * height :: - * The vertical distance, in pixels, between two consecutive baselines. - * It is always positive. - * - * width :: - * The average width, in pixels, of all glyphs in the strike. - * - * size :: - * The nominal size of the strike in 26.6 fractional points. This - * field is not very useful. - * - * x_ppem :: - * The horizontal ppem (nominal width) in 26.6 fractional pixels. - * - * y_ppem :: - * The vertical ppem (nominal height) in 26.6 fractional pixels. - * - * @note: - * Windows FNT: - * The nominal size given in a FNT font is not reliable. If the driver - * finds it incorrect, it sets `size` to some calculated values, and - * `x_ppem` and `y_ppem` to the pixel width and height given in the - * font, respectively. - * - * TrueType embedded bitmaps: - * `size`, `width`, and `height` values are not contained in the bitmap - * strike itself. They are computed from the global font parameters. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Bitmap_Size */ + /* */ + /* <Description> */ + /* This structure models the metrics of a bitmap strike (i.e., a set */ + /* of glyphs for a given point size and resolution) in a bitmap font. */ + /* It is used for the `available_sizes' field of @FT_Face. */ + /* */ + /* <Fields> */ + /* height :: The vertical distance, in pixels, between two */ + /* consecutive baselines. It is always positive. */ + /* */ + /* width :: The average width, in pixels, of all glyphs in the */ + /* strike. */ + /* */ + /* size :: The nominal size of the strike in 26.6 fractional */ + /* points. This field is not very useful. */ + /* */ + /* x_ppem :: The horizontal ppem (nominal width) in 26.6 fractional */ + /* pixels. */ + /* */ + /* y_ppem :: The vertical ppem (nominal height) in 26.6 fractional */ + /* pixels. */ + /* */ + /* <Note> */ + /* Windows FNT: */ + /* The nominal size given in a FNT font is not reliable. Thus when */ + /* the driver finds it incorrect, it sets `size' to some calculated */ + /* values and sets `x_ppem' and `y_ppem' to the pixel width and */ + /* height given in the font, respectively. */ + /* */ + /* TrueType embedded bitmaps: */ + /* `size', `width', and `height' values are not contained in the */ + /* bitmap strike itself. They are computed from the global font */ + /* parameters. */ + /* */ typedef struct FT_Bitmap_Size_ { FT_Short height; @@ -389,218 +380,224 @@ FT_BEGIN_HEADER /*************************************************************************/ /*************************************************************************/ - /************************************************************************** - * - * @type: - * FT_Library - * - * @description: - * A handle to a FreeType library instance. Each 'library' is completely - * independent from the others; it is the 'root' of a set of objects like - * fonts, faces, sizes, etc. - * - * It also embeds a memory manager (see @FT_Memory), as well as a - * scan-line converter object (see @FT_Raster). - * - * [Since 2.5.6] In multi-threaded applications it is easiest to use one - * `FT_Library` object per thread. In case this is too cumbersome, a - * single `FT_Library` object across threads is possible also, as long as - * a mutex lock is used around @FT_New_Face and @FT_Done_Face. - * - * @note: - * Library objects are normally created by @FT_Init_FreeType, and - * destroyed with @FT_Done_FreeType. If you need reference-counting - * (cf. @FT_Reference_Library), use @FT_New_Library and @FT_Done_Library. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Library */ + /* */ + /* <Description> */ + /* A handle to a FreeType library instance. Each `library' is */ + /* completely independent from the others; it is the `root' of a set */ + /* of objects like fonts, faces, sizes, etc. */ + /* */ + /* It also embeds a memory manager (see @FT_Memory), as well as a */ + /* scan-line converter object (see @FT_Raster). */ + /* */ + /* In multi-threaded applications it is easiest to use one */ + /* `FT_Library' object per thread. In case this is too cumbersome, */ + /* a single `FT_Library' object across threads is possible also */ + /* (since FreeType version 2.5.6), as long as a mutex lock is used */ + /* around @FT_New_Face and @FT_Done_Face. */ + /* */ + /* <Note> */ + /* Library objects are normally created by @FT_Init_FreeType, and */ + /* destroyed with @FT_Done_FreeType. If you need reference-counting */ + /* (cf. @FT_Reference_Library), use @FT_New_Library and */ + /* @FT_Done_Library. */ + /* */ typedef struct FT_LibraryRec_ *FT_Library; - /************************************************************************** - * - * @section: - * module_management - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* module_management */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @type: - * FT_Module - * - * @description: - * A handle to a given FreeType module object. A module can be a font - * driver, a renderer, or anything else that provides services to the - * former. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Module */ + /* */ + /* <Description> */ + /* A handle to a given FreeType module object. Each module can be a */ + /* font driver, a renderer, or anything else that provides services */ + /* to the formers. */ + /* */ typedef struct FT_ModuleRec_* FT_Module; - /************************************************************************** - * - * @type: - * FT_Driver - * - * @description: - * A handle to a given FreeType font driver object. A font driver is a - * module capable of creating faces from font files. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Driver */ + /* */ + /* <Description> */ + /* A handle to a given FreeType font driver object. Each font driver */ + /* is a special module capable of creating faces from font files. */ + /* */ typedef struct FT_DriverRec_* FT_Driver; - /************************************************************************** - * - * @type: - * FT_Renderer - * - * @description: - * A handle to a given FreeType renderer. A renderer is a module in - * charge of converting a glyph's outline image to a bitmap. It supports - * a single glyph image format, and one or more target surface depths. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Renderer */ + /* */ + /* <Description> */ + /* A handle to a given FreeType renderer. A renderer is a special */ + /* module in charge of converting a glyph image to a bitmap, when */ + /* necessary. Each renderer supports a given glyph image format, and */ + /* one or more target surface depths. */ + /* */ typedef struct FT_RendererRec_* FT_Renderer; - /************************************************************************** - * - * @section: - * base_interface - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* base_interface */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @type: - * FT_Face - * - * @description: - * A handle to a typographic face object. A face object models a given - * typeface, in a given style. - * - * @note: - * A face object also owns a single @FT_GlyphSlot object, as well as one - * or more @FT_Size objects. - * - * Use @FT_New_Face or @FT_Open_Face to create a new face object from a - * given filepath or a custom input stream. - * - * Use @FT_Done_Face to destroy it (along with its slot and sizes). - * - * An `FT_Face` object can only be safely used from one thread at a time. - * Similarly, creation and destruction of `FT_Face` with the same - * @FT_Library object can only be done from one thread at a time. On the - * other hand, functions like @FT_Load_Glyph and its siblings are - * thread-safe and do not need the lock to be held as long as the same - * `FT_Face` object is not used from multiple threads at the same time. - * - * @also: - * See @FT_FaceRec for the publicly accessible fields of a given face - * object. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Face */ + /* */ + /* <Description> */ + /* A handle to a given typographic face object. A face object models */ + /* a given typeface, in a given style. */ + /* */ + /* <Note> */ + /* Each face object also owns a single @FT_GlyphSlot object, as well */ + /* as one or more @FT_Size objects. */ + /* */ + /* Use @FT_New_Face or @FT_Open_Face to create a new face object from */ + /* a given filepathname or a custom input stream. */ + /* */ + /* Use @FT_Done_Face to destroy it (along with its slot and sizes). */ + /* */ + /* An `FT_Face' object can only be safely used from one thread at a */ + /* time. Similarly, creation and destruction of `FT_Face' with the */ + /* same @FT_Library object can only be done from one thread at a */ + /* time. On the other hand, functions like @FT_Load_Glyph and its */ + /* siblings are thread-safe and do not need the lock to be held as */ + /* long as the same `FT_Face' object is not used from multiple */ + /* threads at the same time. */ + /* */ + /* <Also> */ + /* See @FT_FaceRec for the publicly accessible fields of a given face */ + /* object. */ + /* */ typedef struct FT_FaceRec_* FT_Face; - /************************************************************************** - * - * @type: - * FT_Size - * - * @description: - * A handle to an object that models a face scaled to a given character - * size. - * - * @note: - * An @FT_Face has one _active_ @FT_Size object that is used by functions - * like @FT_Load_Glyph to determine the scaling transformation that in - * turn is used to load and hint glyphs and metrics. - * - * You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, @FT_Request_Size - * or even @FT_Select_Size to change the content (i.e., the scaling - * values) of the active @FT_Size. - * - * You can use @FT_New_Size to create additional size objects for a given - * @FT_Face, but they won't be used by other functions until you activate - * it through @FT_Activate_Size. Only one size can be activated at any - * given time per face. - * - * @also: - * See @FT_SizeRec for the publicly accessible fields of a given size - * object. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Size */ + /* */ + /* <Description> */ + /* A handle to an object used to model a face scaled to a given */ + /* character size. */ + /* */ + /* <Note> */ + /* Each @FT_Face has an _active_ @FT_Size object that is used by */ + /* functions like @FT_Load_Glyph to determine the scaling */ + /* transformation that in turn is used to load and hint glyphs and */ + /* metrics. */ + /* */ + /* You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, */ + /* @FT_Request_Size or even @FT_Select_Size to change the content */ + /* (i.e., the scaling values) of the active @FT_Size. */ + /* */ + /* You can use @FT_New_Size to create additional size objects for a */ + /* given @FT_Face, but they won't be used by other functions until */ + /* you activate it through @FT_Activate_Size. Only one size can be */ + /* activated at any given time per face. */ + /* */ + /* <Also> */ + /* See @FT_SizeRec for the publicly accessible fields of a given size */ + /* object. */ + /* */ typedef struct FT_SizeRec_* FT_Size; - /************************************************************************** - * - * @type: - * FT_GlyphSlot - * - * @description: - * A handle to a given 'glyph slot'. A slot is a container that can hold - * any of the glyphs contained in its parent face. - * - * In other words, each time you call @FT_Load_Glyph or @FT_Load_Char, - * the slot's content is erased by the new glyph data, i.e., the glyph's - * metrics, its image (bitmap or outline), and other control information. - * - * @also: - * See @FT_GlyphSlotRec for the publicly accessible glyph fields. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_GlyphSlot */ + /* */ + /* <Description> */ + /* A handle to a given `glyph slot'. A slot is a container where it */ + /* is possible to load any of the glyphs contained in its parent */ + /* face. */ + /* */ + /* In other words, each time you call @FT_Load_Glyph or */ + /* @FT_Load_Char, the slot's content is erased by the new glyph data, */ + /* i.e., the glyph's metrics, its image (bitmap or outline), and */ + /* other control information. */ + /* */ + /* <Also> */ + /* See @FT_GlyphSlotRec for the publicly accessible glyph fields. */ + /* */ typedef struct FT_GlyphSlotRec_* FT_GlyphSlot; - /************************************************************************** - * - * @type: - * FT_CharMap - * - * @description: - * A handle to a character map (usually abbreviated to 'charmap'). A - * charmap is used to translate character codes in a given encoding into - * glyph indexes for its parent's face. Some font formats may provide - * several charmaps per font. - * - * Each face object owns zero or more charmaps, but only one of them can - * be 'active', providing the data used by @FT_Get_Char_Index or - * @FT_Load_Char. - * - * The list of available charmaps in a face is available through the - * `face->num_charmaps` and `face->charmaps` fields of @FT_FaceRec. - * - * The currently active charmap is available as `face->charmap`. You - * should call @FT_Set_Charmap to change it. - * - * @note: - * When a new face is created (either through @FT_New_Face or - * @FT_Open_Face), the library looks for a Unicode charmap within the - * list and automatically activates it. If there is no Unicode charmap, - * FreeType doesn't set an 'active' charmap. - * - * @also: - * See @FT_CharMapRec for the publicly accessible fields of a given - * character map. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_CharMap */ + /* */ + /* <Description> */ + /* A handle to a given character map. A charmap is used to translate */ + /* character codes in a given encoding into glyph indexes for its */ + /* parent's face. Some font formats may provide several charmaps per */ + /* font. */ + /* */ + /* Each face object owns zero or more charmaps, but only one of them */ + /* can be `active' and used by @FT_Get_Char_Index or @FT_Load_Char. */ + /* */ + /* The list of available charmaps in a face is available through the */ + /* `face->num_charmaps' and `face->charmaps' fields of @FT_FaceRec. */ + /* */ + /* The currently active charmap is available as `face->charmap'. */ + /* You should call @FT_Set_Charmap to change it. */ + /* */ + /* <Note> */ + /* When a new face is created (either through @FT_New_Face or */ + /* @FT_Open_Face), the library looks for a Unicode charmap within */ + /* the list and automatically activates it. */ + /* */ + /* <Also> */ + /* See @FT_CharMapRec for the publicly accessible fields of a given */ + /* character map. */ + /* */ typedef struct FT_CharMapRec_* FT_CharMap; - /************************************************************************** - * - * @macro: - * FT_ENC_TAG - * - * @description: - * This macro converts four-letter tags into an unsigned long. It is - * used to define 'encoding' identifiers (see @FT_Encoding). - * - * @note: - * Since many 16-bit compilers don't like 32-bit enumerations, you should - * redefine this macro in case of problems to something like this: - * - * ``` - * #define FT_ENC_TAG( value, a, b, c, d ) value - * ``` - * - * to get a simple enumeration without assigning special numbers. - */ + /*************************************************************************/ + /* */ + /* <Macro> */ + /* FT_ENC_TAG */ + /* */ + /* <Description> */ + /* This macro converts four-letter tags into an unsigned long. It is */ + /* used to define `encoding' identifiers (see @FT_Encoding). */ + /* */ + /* <Note> */ + /* Since many 16-bit compilers don't like 32-bit enumerations, you */ + /* should redefine this macro in case of problems to something like */ + /* this: */ + /* */ + /* { */ + /* #define FT_ENC_TAG( value, a, b, c, d ) value */ + /* } */ + /* */ + /* to get a simple enumeration without assigning special numbers. */ + /* */ #ifndef FT_ENC_TAG #define FT_ENC_TAG( value, a, b, c, d ) \ @@ -612,147 +609,150 @@ FT_BEGIN_HEADER #endif /* FT_ENC_TAG */ - /************************************************************************** - * - * @enum: - * FT_Encoding - * - * @description: - * An enumeration to specify character sets supported by charmaps. Used - * in the @FT_Select_Charmap API function. - * - * @note: - * Despite the name, this enumeration lists specific character - * repertories (i.e., charsets), and not text encoding methods (e.g., - * UTF-8, UTF-16, etc.). - * - * Other encodings might be defined in the future. - * - * @values: - * FT_ENCODING_NONE :: - * The encoding value~0 is reserved for all formats except BDF, PCF, - * and Windows FNT; see below for more information. - * - * FT_ENCODING_UNICODE :: - * The Unicode character set. This value covers all versions of the - * Unicode repertoire, including ASCII and Latin-1. Most fonts include - * a Unicode charmap, but not all of them. - * - * For example, if you want to access Unicode value U+1F028 (and the - * font contains it), use value 0x1F028 as the input value for - * @FT_Get_Char_Index. - * - * FT_ENCODING_MS_SYMBOL :: - * Microsoft Symbol encoding, used to encode mathematical symbols and - * wingdings. For more information, see - * 'https://www.microsoft.com/typography/otspec/recom.htm', - * 'http://www.kostis.net/charsets/symbol.htm', and - * 'http://www.kostis.net/charsets/wingding.htm'. - * - * This encoding uses character codes from the PUA (Private Unicode - * Area) in the range U+F020-U+F0FF. - * - * FT_ENCODING_SJIS :: - * Shift JIS encoding for Japanese. More info at - * 'https://en.wikipedia.org/wiki/Shift_JIS'. See note on multi-byte - * encodings below. - * - * FT_ENCODING_PRC :: - * Corresponds to encoding systems mainly for Simplified Chinese as - * used in People's Republic of China (PRC). The encoding layout is - * based on GB~2312 and its supersets GBK and GB~18030. - * - * FT_ENCODING_BIG5 :: - * Corresponds to an encoding system for Traditional Chinese as used in - * Taiwan and Hong Kong. - * - * FT_ENCODING_WANSUNG :: - * Corresponds to the Korean encoding system known as Extended Wansung - * (MS Windows code page 949). For more information see - * 'https://www.unicode.org/Public/MAPPINGS/VENDORS/MICSFT/WindowsBestFit/bestfit949.txt'. - * - * FT_ENCODING_JOHAB :: - * The Korean standard character set (KS~C 5601-1992), which - * corresponds to MS Windows code page 1361. This character set - * includes all possible Hangul character combinations. - * - * FT_ENCODING_ADOBE_LATIN_1 :: - * Corresponds to a Latin-1 encoding as defined in a Type~1 PostScript - * font. It is limited to 256 character codes. - * - * FT_ENCODING_ADOBE_STANDARD :: - * Adobe Standard encoding, as found in Type~1, CFF, and OpenType/CFF - * fonts. It is limited to 256 character codes. - * - * FT_ENCODING_ADOBE_EXPERT :: - * Adobe Expert encoding, as found in Type~1, CFF, and OpenType/CFF - * fonts. It is limited to 256 character codes. - * - * FT_ENCODING_ADOBE_CUSTOM :: - * Corresponds to a custom encoding, as found in Type~1, CFF, and - * OpenType/CFF fonts. It is limited to 256 character codes. - * - * FT_ENCODING_APPLE_ROMAN :: - * Apple roman encoding. Many TrueType and OpenType fonts contain a - * charmap for this 8-bit encoding, since older versions of Mac OS are - * able to use it. - * - * FT_ENCODING_OLD_LATIN_2 :: - * This value is deprecated and was neither used nor reported by - * FreeType. Don't use or test for it. - * - * FT_ENCODING_MS_SJIS :: - * Same as FT_ENCODING_SJIS. Deprecated. - * - * FT_ENCODING_MS_GB2312 :: - * Same as FT_ENCODING_PRC. Deprecated. - * - * FT_ENCODING_MS_BIG5 :: - * Same as FT_ENCODING_BIG5. Deprecated. - * - * FT_ENCODING_MS_WANSUNG :: - * Same as FT_ENCODING_WANSUNG. Deprecated. - * - * FT_ENCODING_MS_JOHAB :: - * Same as FT_ENCODING_JOHAB. Deprecated. - * - * @note: - * By default, FreeType enables a Unicode charmap and tags it with - * `FT_ENCODING_UNICODE` when it is either provided or can be generated - * from PostScript glyph name dictionaries in the font file. All other - * encodings are considered legacy and tagged only if explicitly defined - * in the font file. Otherwise, `FT_ENCODING_NONE` is used. - * - * `FT_ENCODING_NONE` is set by the BDF and PCF drivers if the charmap is - * neither Unicode nor ISO-8859-1 (otherwise it is set to - * `FT_ENCODING_UNICODE`). Use @FT_Get_BDF_Charset_ID to find out which - * encoding is really present. If, for example, the `cs_registry` field - * is 'KOI8' and the `cs_encoding` field is 'R', the font is encoded in - * KOI8-R. - * - * `FT_ENCODING_NONE` is always set (with a single exception) by the - * winfonts driver. Use @FT_Get_WinFNT_Header and examine the `charset` - * field of the @FT_WinFNT_HeaderRec structure to find out which encoding - * is really present. For example, @FT_WinFNT_ID_CP1251 (204) means - * Windows code page 1251 (for Russian). - * - * `FT_ENCODING_NONE` is set if `platform_id` is @TT_PLATFORM_MACINTOSH - * and `encoding_id` is not `TT_MAC_ID_ROMAN` (otherwise it is set to - * `FT_ENCODING_APPLE_ROMAN`). - * - * If `platform_id` is @TT_PLATFORM_MACINTOSH, use the function - * @FT_Get_CMap_Language_ID to query the Mac language ID that may be - * needed to be able to distinguish Apple encoding variants. See - * - * https://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/Readme.txt - * - * to get an idea how to do that. Basically, if the language ID is~0, - * don't use it, otherwise subtract 1 from the language ID. Then examine - * `encoding_id`. If, for example, `encoding_id` is `TT_MAC_ID_ROMAN` - * and the language ID (minus~1) is `TT_MAC_LANGID_GREEK`, it is the - * Greek encoding, not Roman. `TT_MAC_ID_ARABIC` with - * `TT_MAC_LANGID_FARSI` means the Farsi variant the Arabic encoding. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_Encoding */ + /* */ + /* <Description> */ + /* An enumeration used to specify character sets supported by */ + /* charmaps. Used in the @FT_Select_Charmap API function. */ + /* */ + /* <Note> */ + /* Despite the name, this enumeration lists specific character */ + /* repertories (i.e., charsets), and not text encoding methods (e.g., */ + /* UTF-8, UTF-16, etc.). */ + /* */ + /* Other encodings might be defined in the future. */ + /* */ + /* <Values> */ + /* FT_ENCODING_NONE :: */ + /* The encoding value~0 is reserved. */ + /* */ + /* FT_ENCODING_UNICODE :: */ + /* Corresponds to the Unicode character set. This value covers */ + /* all versions of the Unicode repertoire, including ASCII and */ + /* Latin-1. Most fonts include a Unicode charmap, but not all */ + /* of them. */ + /* */ + /* For example, if you want to access Unicode value U+1F028 (and */ + /* the font contains it), use value 0x1F028 as the input value for */ + /* @FT_Get_Char_Index. */ + /* */ + /* FT_ENCODING_MS_SYMBOL :: */ + /* Corresponds to the Microsoft Symbol encoding, used to encode */ + /* mathematical symbols and wingdings. For more information, see */ + /* `http://www.microsoft.com/typography/otspec/recom.htm', */ + /* `http://www.kostis.net/charsets/symbol.htm', and */ + /* `http://www.kostis.net/charsets/wingding.htm'. */ + /* */ + /* This encoding uses character codes from the PUA (Private Unicode */ + /* Area) in the range U+F020-U+F0FF. */ + /* */ + /* FT_ENCODING_SJIS :: */ + /* Corresponds to Japanese SJIS encoding. More info at */ + /* at `http://en.wikipedia.org/wiki/Shift_JIS'. */ + /* See note on multi-byte encodings below. */ + /* */ + /* FT_ENCODING_GB2312 :: */ + /* Corresponds to an encoding system for Simplified Chinese as used */ + /* used in mainland China. */ + /* */ + /* FT_ENCODING_BIG5 :: */ + /* Corresponds to an encoding system for Traditional Chinese as */ + /* used in Taiwan and Hong Kong. */ + /* */ + /* FT_ENCODING_WANSUNG :: */ + /* Corresponds to the Korean encoding system known as Wansung. */ + /* For more information see */ + /* `https://msdn.microsoft.com/en-US/goglobal/cc305154'. */ + /* */ + /* FT_ENCODING_JOHAB :: */ + /* The Korean standard character set (KS~C 5601-1992), which */ + /* corresponds to MS Windows code page 1361. This character set */ + /* includes all possible Hangeul character combinations. */ + /* */ + /* FT_ENCODING_ADOBE_LATIN_1 :: */ + /* Corresponds to a Latin-1 encoding as defined in a Type~1 */ + /* PostScript font. It is limited to 256 character codes. */ + /* */ + /* FT_ENCODING_ADOBE_STANDARD :: */ + /* Corresponds to the Adobe Standard encoding, as found in Type~1, */ + /* CFF, and OpenType/CFF fonts. It is limited to 256 character */ + /* codes. */ + /* */ + /* FT_ENCODING_ADOBE_EXPERT :: */ + /* Corresponds to the Adobe Expert encoding, as found in Type~1, */ + /* CFF, and OpenType/CFF fonts. It is limited to 256 character */ + /* codes. */ + /* */ + /* FT_ENCODING_ADOBE_CUSTOM :: */ + /* Corresponds to a custom encoding, as found in Type~1, CFF, and */ + /* OpenType/CFF fonts. It is limited to 256 character codes. */ + /* */ + /* FT_ENCODING_APPLE_ROMAN :: */ + /* Corresponds to the 8-bit Apple roman encoding. Many TrueType */ + /* and OpenType fonts contain a charmap for this encoding, since */ + /* older versions of Mac OS are able to use it. */ + /* */ + /* FT_ENCODING_OLD_LATIN_2 :: */ + /* This value is deprecated and was never used nor reported by */ + /* FreeType. Don't use or test for it. */ + /* */ + /* FT_ENCODING_MS_SJIS :: */ + /* Same as FT_ENCODING_SJIS. Deprecated. */ + /* */ + /* FT_ENCODING_MS_GB2312 :: */ + /* Same as FT_ENCODING_GB2312. Deprecated. */ + /* */ + /* FT_ENCODING_MS_BIG5 :: */ + /* Same as FT_ENCODING_BIG5. Deprecated. */ + /* */ + /* FT_ENCODING_MS_WANSUNG :: */ + /* Same as FT_ENCODING_WANSUNG. Deprecated. */ + /* */ + /* FT_ENCODING_MS_JOHAB :: */ + /* Same as FT_ENCODING_JOHAB. Deprecated. */ + /* */ + /* <Note> */ + /* By default, FreeType automatically synthesizes a Unicode charmap */ + /* for PostScript fonts, using their glyph names dictionaries. */ + /* However, it also reports the encodings defined explicitly in the */ + /* font file, for the cases when they are needed, with the Adobe */ + /* values as well. */ + /* */ + /* FT_ENCODING_NONE is set by the BDF and PCF drivers if the charmap */ + /* is neither Unicode nor ISO-8859-1 (otherwise it is set to */ + /* FT_ENCODING_UNICODE). Use @FT_Get_BDF_Charset_ID to find out */ + /* which encoding is really present. If, for example, the */ + /* `cs_registry' field is `KOI8' and the `cs_encoding' field is `R', */ + /* the font is encoded in KOI8-R. */ + /* */ + /* FT_ENCODING_NONE is always set (with a single exception) by the */ + /* winfonts driver. Use @FT_Get_WinFNT_Header and examine the */ + /* `charset' field of the @FT_WinFNT_HeaderRec structure to find out */ + /* which encoding is really present. For example, */ + /* @FT_WinFNT_ID_CP1251 (204) means Windows code page 1251 (for */ + /* Russian). */ + /* */ + /* FT_ENCODING_NONE is set if `platform_id' is @TT_PLATFORM_MACINTOSH */ + /* and `encoding_id' is not @TT_MAC_ID_ROMAN (otherwise it is set to */ + /* FT_ENCODING_APPLE_ROMAN). */ + /* */ + /* If `platform_id' is @TT_PLATFORM_MACINTOSH, use the function */ + /* @FT_Get_CMap_Language_ID to query the Mac language ID that may */ + /* be needed to be able to distinguish Apple encoding variants. See */ + /* */ + /* http://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/Readme.txt */ + /* */ + /* to get an idea how to do that. Basically, if the language ID */ + /* is~0, don't use it, otherwise subtract 1 from the language ID. */ + /* Then examine `encoding_id'. If, for example, `encoding_id' is */ + /* @TT_MAC_ID_ROMAN and the language ID (minus~1) is */ + /* `TT_MAC_LANGID_GREEK', it is the Greek encoding, not Roman. */ + /* @TT_MAC_ID_ARABIC with `TT_MAC_LANGID_FARSI' means the Farsi */ + /* variant the Arabic encoding. */ + /* */ typedef enum FT_Encoding_ { FT_ENC_TAG( FT_ENCODING_NONE, 0, 0, 0, 0 ), @@ -761,15 +761,14 @@ FT_BEGIN_HEADER FT_ENC_TAG( FT_ENCODING_UNICODE, 'u', 'n', 'i', 'c' ), FT_ENC_TAG( FT_ENCODING_SJIS, 's', 'j', 'i', 's' ), - FT_ENC_TAG( FT_ENCODING_PRC, 'g', 'b', ' ', ' ' ), + FT_ENC_TAG( FT_ENCODING_GB2312, 'g', 'b', ' ', ' ' ), FT_ENC_TAG( FT_ENCODING_BIG5, 'b', 'i', 'g', '5' ), FT_ENC_TAG( FT_ENCODING_WANSUNG, 'w', 'a', 'n', 's' ), FT_ENC_TAG( FT_ENCODING_JOHAB, 'j', 'o', 'h', 'a' ), - /* for backward compatibility */ - FT_ENCODING_GB2312 = FT_ENCODING_PRC, + /* for backwards compatibility */ FT_ENCODING_MS_SJIS = FT_ENCODING_SJIS, - FT_ENCODING_MS_GB2312 = FT_ENCODING_PRC, + FT_ENCODING_MS_GB2312 = FT_ENCODING_GB2312, FT_ENCODING_MS_BIG5 = FT_ENCODING_BIG5, FT_ENCODING_MS_WANSUNG = FT_ENCODING_WANSUNG, FT_ENCODING_MS_JOHAB = FT_ENCODING_JOHAB, @@ -786,7 +785,7 @@ FT_BEGIN_HEADER } FT_Encoding; - /* these constants are deprecated; use the corresponding `FT_Encoding` */ + /* these constants are deprecated; use the corresponding `FT_Encoding' */ /* values instead */ #define ft_encoding_none FT_ENCODING_NONE #define ft_encoding_unicode FT_ENCODING_UNICODE @@ -794,7 +793,7 @@ FT_BEGIN_HEADER #define ft_encoding_latin_1 FT_ENCODING_ADOBE_LATIN_1 #define ft_encoding_latin_2 FT_ENCODING_OLD_LATIN_2 #define ft_encoding_sjis FT_ENCODING_SJIS -#define ft_encoding_gb2312 FT_ENCODING_PRC +#define ft_encoding_gb2312 FT_ENCODING_GB2312 #define ft_encoding_big5 FT_ENCODING_BIG5 #define ft_encoding_wansung FT_ENCODING_WANSUNG #define ft_encoding_johab FT_ENCODING_JOHAB @@ -805,31 +804,29 @@ FT_BEGIN_HEADER #define ft_encoding_apple_roman FT_ENCODING_APPLE_ROMAN - /************************************************************************** - * - * @struct: - * FT_CharMapRec - * - * @description: - * The base charmap structure. - * - * @fields: - * face :: - * A handle to the parent face object. - * - * encoding :: - * An @FT_Encoding tag identifying the charmap. Use this with - * @FT_Select_Charmap. - * - * platform_id :: - * An ID number describing the platform for the following encoding ID. - * This comes directly from the TrueType specification and gets - * emulated for other formats. - * - * encoding_id :: - * A platform-specific encoding number. This also comes from the - * TrueType specification and gets emulated similarly. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_CharMapRec */ + /* */ + /* <Description> */ + /* The base charmap structure. */ + /* */ + /* <Fields> */ + /* face :: A handle to the parent face object. */ + /* */ + /* encoding :: An @FT_Encoding tag identifying the charmap. Use */ + /* this with @FT_Select_Charmap. */ + /* */ + /* platform_id :: An ID number describing the platform for the */ + /* following encoding ID. This comes directly from */ + /* the TrueType specification and should be emulated */ + /* for other formats. */ + /* */ + /* encoding_id :: A platform specific encoding number. This also */ + /* comes from the TrueType specification and should be */ + /* emulated similarly. */ + /* */ typedef struct FT_CharMapRec_ { FT_Face face; @@ -849,195 +846,190 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** - * - * @type: - * FT_Face_Internal - * - * @description: - * An opaque handle to an `FT_Face_InternalRec` structure that models the - * private data of a given @FT_Face object. - * - * This structure might change between releases of FreeType~2 and is not - * generally available to client applications. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Face_Internal */ + /* */ + /* <Description> */ + /* An opaque handle to an `FT_Face_InternalRec' structure, used to */ + /* model private data of a given @FT_Face object. */ + /* */ + /* This structure might change between releases of FreeType~2 and is */ + /* not generally available to client applications. */ + /* */ typedef struct FT_Face_InternalRec_* FT_Face_Internal; - /************************************************************************** - * - * @struct: - * FT_FaceRec - * - * @description: - * FreeType root face class structure. A face object models a typeface - * in a font file. - * - * @fields: - * num_faces :: - * The number of faces in the font file. Some font formats can have - * multiple faces in a single font file. - * - * face_index :: - * This field holds two different values. Bits 0-15 are the index of - * the face in the font file (starting with value~0). They are set - * to~0 if there is only one face in the font file. - * - * [Since 2.6.1] Bits 16-30 are relevant to GX and OpenType variation - * fonts only, holding the named instance index for the current face - * index (starting with value~1; value~0 indicates font access without - * a named instance). For non-variation fonts, bits 16-30 are ignored. - * If we have the third named instance of face~4, say, `face_index` is - * set to 0x00030004. - * - * Bit 31 is always zero (this is, `face_index` is always a positive - * value). - * - * [Since 2.9] Changing the design coordinates with - * @FT_Set_Var_Design_Coordinates or @FT_Set_Var_Blend_Coordinates does - * not influence the named instance index value (only - * @FT_Set_Named_Instance does that). - * - * face_flags :: - * A set of bit flags that give important information about the face; - * see @FT_FACE_FLAG_XXX for the details. - * - * style_flags :: - * The lower 16~bits contain a set of bit flags indicating the style of - * the face; see @FT_STYLE_FLAG_XXX for the details. - * - * [Since 2.6.1] Bits 16-30 hold the number of named instances - * available for the current face if we have a GX or OpenType variation - * (sub)font. Bit 31 is always zero (this is, `style_flags` is always - * a positive value). Note that a variation font has always at least - * one named instance, namely the default instance. - * - * num_glyphs :: - * The number of glyphs in the face. If the face is scalable and has - * sbits (see `num_fixed_sizes`), it is set to the number of outline - * glyphs. - * - * For CID-keyed fonts (not in an SFNT wrapper) this value gives the - * highest CID used in the font. - * - * family_name :: - * The face's family name. This is an ASCII string, usually in - * English, that describes the typeface's family (like 'Times New - * Roman', 'Bodoni', 'Garamond', etc). This is a least common - * denominator used to list fonts. Some formats (TrueType & OpenType) - * provide localized and Unicode versions of this string. Applications - * should use the format-specific interface to access them. Can be - * `NULL` (e.g., in fonts embedded in a PDF file). - * - * In case the font doesn't provide a specific family name entry, - * FreeType tries to synthesize one, deriving it from other name - * entries. - * - * style_name :: - * The face's style name. This is an ASCII string, usually in English, - * that describes the typeface's style (like 'Italic', 'Bold', - * 'Condensed', etc). Not all font formats provide a style name, so - * this field is optional, and can be set to `NULL`. As for - * `family_name`, some formats provide localized and Unicode versions - * of this string. Applications should use the format-specific - * interface to access them. - * - * num_fixed_sizes :: - * The number of bitmap strikes in the face. Even if the face is - * scalable, there might still be bitmap strikes, which are called - * 'sbits' in that case. - * - * available_sizes :: - * An array of @FT_Bitmap_Size for all bitmap strikes in the face. It - * is set to `NULL` if there is no bitmap strike. - * - * Note that FreeType tries to sanitize the strike data since they are - * sometimes sloppy or incorrect, but this can easily fail. - * - * num_charmaps :: - * The number of charmaps in the face. - * - * charmaps :: - * An array of the charmaps of the face. - * - * generic :: - * A field reserved for client uses. See the @FT_Generic type - * description. - * - * bbox :: - * The font bounding box. Coordinates are expressed in font units (see - * `units_per_EM`). The box is large enough to contain any glyph from - * the font. Thus, `bbox.yMax` can be seen as the 'maximum ascender', - * and `bbox.yMin` as the 'minimum descender'. Only relevant for - * scalable formats. - * - * Note that the bounding box might be off by (at least) one pixel for - * hinted fonts. See @FT_Size_Metrics for further discussion. - * - * units_per_EM :: - * The number of font units per EM square for this face. This is - * typically 2048 for TrueType fonts, and 1000 for Type~1 fonts. Only - * relevant for scalable formats. - * - * ascender :: - * The typographic ascender of the face, expressed in font units. For - * font formats not having this information, it is set to `bbox.yMax`. - * Only relevant for scalable formats. - * - * descender :: - * The typographic descender of the face, expressed in font units. For - * font formats not having this information, it is set to `bbox.yMin`. - * Note that this field is negative for values below the baseline. - * Only relevant for scalable formats. - * - * height :: - * This value is the vertical distance between two consecutive - * baselines, expressed in font units. It is always positive. Only - * relevant for scalable formats. - * - * If you want the global glyph height, use `ascender - descender`. - * - * max_advance_width :: - * The maximum advance width, in font units, for all glyphs in this - * face. This can be used to make word wrapping computations faster. - * Only relevant for scalable formats. - * - * max_advance_height :: - * The maximum advance height, in font units, for all glyphs in this - * face. This is only relevant for vertical layouts, and is set to - * `height` for fonts that do not provide vertical metrics. Only - * relevant for scalable formats. - * - * underline_position :: - * The position, in font units, of the underline line for this face. - * It is the center of the underlining stem. Only relevant for - * scalable formats. - * - * underline_thickness :: - * The thickness, in font units, of the underline for this face. Only - * relevant for scalable formats. - * - * glyph :: - * The face's associated glyph slot(s). - * - * size :: - * The current active size for this face. - * - * charmap :: - * The current active charmap for this face. - * - * @note: - * Fields may be changed after a call to @FT_Attach_File or - * @FT_Attach_Stream. - * - * For an OpenType variation font, the values of the following fields can - * change after a call to @FT_Set_Var_Design_Coordinates (and friends) if - * the font contains an 'MVAR' table: `ascender`, `descender`, `height`, - * `underline_position`, and `underline_thickness`. - * - * Especially for TrueType fonts see also the documentation for - * @FT_Size_Metrics. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_FaceRec */ + /* */ + /* <Description> */ + /* FreeType root face class structure. A face object models a */ + /* typeface in a font file. */ + /* */ + /* <Fields> */ + /* num_faces :: The number of faces in the font file. Some */ + /* font formats can have multiple faces in */ + /* a font file. */ + /* */ + /* face_index :: This field holds two different values. */ + /* Bits 0-15 are the index of the face in the */ + /* font file (starting with value~0). They */ + /* are set to~0 if there is only one face in */ + /* the font file. */ + /* */ + /* Bits 16-30 are relevant to GX variation */ + /* fonts only, holding the named instance */ + /* index for the current face index (starting */ + /* with value~1; value~0 indicates font access */ + /* without GX variation data). For non-GX */ + /* fonts, bits 16-30 are ignored. If we have */ + /* the third named instance of face~4, say, */ + /* `face_index' is set to 0x00030004. */ + /* */ + /* Bit 31 is always zero (this is, */ + /* `face_index' is always a positive value). */ + /* */ + /* face_flags :: A set of bit flags that give important */ + /* information about the face; see */ + /* @FT_FACE_FLAG_XXX for the details. */ + /* */ + /* style_flags :: The lower 16~bits contain a set of bit */ + /* flags indicating the style of the face; see */ + /* @FT_STYLE_FLAG_XXX for the details. Bits */ + /* 16-30 hold the number of named instances */ + /* available for the current face if we have a */ + /* GX variation (sub)font. Bit 31 is always */ + /* zero (this is, `style_flags' is always a */ + /* positive value). */ + /* */ + /* num_glyphs :: The number of glyphs in the face. If the */ + /* face is scalable and has sbits (see */ + /* `num_fixed_sizes'), it is set to the number */ + /* of outline glyphs. */ + /* */ + /* For CID-keyed fonts, this value gives the */ + /* highest CID used in the font. */ + /* */ + /* family_name :: The face's family name. This is an ASCII */ + /* string, usually in English, that describes */ + /* the typeface's family (like `Times New */ + /* Roman', `Bodoni', `Garamond', etc). This */ + /* is a least common denominator used to list */ + /* fonts. Some formats (TrueType & OpenType) */ + /* provide localized and Unicode versions of */ + /* this string. Applications should use the */ + /* format specific interface to access them. */ + /* Can be NULL (e.g., in fonts embedded in a */ + /* PDF file). */ + /* */ + /* In case the font doesn't provide a specific */ + /* family name entry, FreeType tries to */ + /* synthesize one, deriving it from other name */ + /* entries. */ + /* */ + /* style_name :: The face's style name. This is an ASCII */ + /* string, usually in English, that describes */ + /* the typeface's style (like `Italic', */ + /* `Bold', `Condensed', etc). Not all font */ + /* formats provide a style name, so this field */ + /* is optional, and can be set to NULL. As */ + /* for `family_name', some formats provide */ + /* localized and Unicode versions of this */ + /* string. Applications should use the format */ + /* specific interface to access them. */ + /* */ + /* num_fixed_sizes :: The number of bitmap strikes in the face. */ + /* Even if the face is scalable, there might */ + /* still be bitmap strikes, which are called */ + /* `sbits' in that case. */ + /* */ + /* available_sizes :: An array of @FT_Bitmap_Size for all bitmap */ + /* strikes in the face. It is set to NULL if */ + /* there is no bitmap strike. */ + /* */ + /* num_charmaps :: The number of charmaps in the face. */ + /* */ + /* charmaps :: An array of the charmaps of the face. */ + /* */ + /* generic :: A field reserved for client uses. See the */ + /* @FT_Generic type description. */ + /* */ + /* bbox :: The font bounding box. Coordinates are */ + /* expressed in font units (see */ + /* `units_per_EM'). The box is large enough */ + /* to contain any glyph from the font. Thus, */ + /* `bbox.yMax' can be seen as the `maximum */ + /* ascender', and `bbox.yMin' as the `minimum */ + /* descender'. Only relevant for scalable */ + /* formats. */ + /* */ + /* Note that the bounding box might be off by */ + /* (at least) one pixel for hinted fonts. See */ + /* @FT_Size_Metrics for further discussion. */ + /* */ + /* units_per_EM :: The number of font units per EM square for */ + /* this face. This is typically 2048 for */ + /* TrueType fonts, and 1000 for Type~1 fonts. */ + /* Only relevant for scalable formats. */ + /* */ + /* ascender :: The typographic ascender of the face, */ + /* expressed in font units. For font formats */ + /* not having this information, it is set to */ + /* `bbox.yMax'. Only relevant for scalable */ + /* formats. */ + /* */ + /* descender :: The typographic descender of the face, */ + /* expressed in font units. For font formats */ + /* not having this information, it is set to */ + /* `bbox.yMin'. Note that this field is */ + /* usually negative. Only relevant for */ + /* scalable formats. */ + /* */ + /* height :: This value is the vertical distance */ + /* between two consecutive baselines, */ + /* expressed in font units. It is always */ + /* positive. Only relevant for scalable */ + /* formats. */ + /* */ + /* If you want the global glyph height, use */ + /* `ascender - descender'. */ + /* */ + /* max_advance_width :: The maximum advance width, in font units, */ + /* for all glyphs in this face. This can be */ + /* used to make word wrapping computations */ + /* faster. Only relevant for scalable */ + /* formats. */ + /* */ + /* max_advance_height :: The maximum advance height, in font units, */ + /* for all glyphs in this face. This is only */ + /* relevant for vertical layouts, and is set */ + /* to `height' for fonts that do not provide */ + /* vertical metrics. Only relevant for */ + /* scalable formats. */ + /* */ + /* underline_position :: The position, in font units, of the */ + /* underline line for this face. It is the */ + /* center of the underlining stem. Only */ + /* relevant for scalable formats. */ + /* */ + /* underline_thickness :: The thickness, in font units, of the */ + /* underline for this face. Only relevant for */ + /* scalable formats. */ + /* */ + /* glyph :: The face's associated glyph slot(s). */ + /* */ + /* size :: The current active size for this face. */ + /* */ + /* charmap :: The current active charmap for this face. */ + /* */ + /* <Note> */ + /* Fields may be changed after a call to @FT_Attach_File or */ + /* @FT_Attach_Stream. */ + /* */ typedef struct FT_FaceRec_ { FT_Long num_faces; @@ -1059,7 +1051,7 @@ FT_BEGIN_HEADER FT_Generic generic; - /*# The following member variables (down to `underline_thickness`) */ + /*# The following member variables (down to `underline_thickness') */ /*# are only relevant to scalable outlines; cf. @FT_Bitmap_Size */ /*# for bitmap fonts. */ FT_BBox bbox; @@ -1097,116 +1089,108 @@ FT_BEGIN_HEADER } FT_FaceRec; - /************************************************************************** - * - * @enum: - * FT_FACE_FLAG_XXX - * - * @description: - * A list of bit flags used in the `face_flags` field of the @FT_FaceRec - * structure. They inform client applications of properties of the - * corresponding face. - * - * @values: - * FT_FACE_FLAG_SCALABLE :: - * The face contains outline glyphs. Note that a face can contain - * bitmap strikes also, i.e., a face can have both this flag and - * @FT_FACE_FLAG_FIXED_SIZES set. - * - * FT_FACE_FLAG_FIXED_SIZES :: - * The face contains bitmap strikes. See also the `num_fixed_sizes` - * and `available_sizes` fields of @FT_FaceRec. - * - * FT_FACE_FLAG_FIXED_WIDTH :: - * The face contains fixed-width characters (like Courier, Lucida, - * MonoType, etc.). - * - * FT_FACE_FLAG_SFNT :: - * The face uses the SFNT storage scheme. For now, this means TrueType - * and OpenType. - * - * FT_FACE_FLAG_HORIZONTAL :: - * The face contains horizontal glyph metrics. This should be set for - * all common formats. - * - * FT_FACE_FLAG_VERTICAL :: - * The face contains vertical glyph metrics. This is only available in - * some formats, not all of them. - * - * FT_FACE_FLAG_KERNING :: - * The face contains kerning information. If set, the kerning distance - * can be retrieved using the function @FT_Get_Kerning. Otherwise the - * function always return the vector (0,0). Note that FreeType doesn't - * handle kerning data from the SFNT 'GPOS' table (as present in many - * OpenType fonts). - * - * FT_FACE_FLAG_FAST_GLYPHS :: - * THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT. - * - * FT_FACE_FLAG_MULTIPLE_MASTERS :: - * The face contains multiple masters and is capable of interpolating - * between them. Supported formats are Adobe MM, TrueType GX, and - * OpenType variation fonts. - * - * See section @multiple_masters for API details. - * - * FT_FACE_FLAG_GLYPH_NAMES :: - * The face contains glyph names, which can be retrieved using - * @FT_Get_Glyph_Name. Note that some TrueType fonts contain broken - * glyph name tables. Use the function @FT_Has_PS_Glyph_Names when - * needed. - * - * FT_FACE_FLAG_EXTERNAL_STREAM :: - * Used internally by FreeType to indicate that a face's stream was - * provided by the client application and should not be destroyed when - * @FT_Done_Face is called. Don't read or test this flag. - * - * FT_FACE_FLAG_HINTER :: - * The font driver has a hinting machine of its own. For example, with - * TrueType fonts, it makes sense to use data from the SFNT 'gasp' - * table only if the native TrueType hinting engine (with the bytecode - * interpreter) is available and active. - * - * FT_FACE_FLAG_CID_KEYED :: - * The face is CID-keyed. In that case, the face is not accessed by - * glyph indices but by CID values. For subsetted CID-keyed fonts this - * has the consequence that not all index values are a valid argument - * to @FT_Load_Glyph. Only the CID values for which corresponding - * glyphs in the subsetted font exist make `FT_Load_Glyph` return - * successfully; in all other cases you get an - * `FT_Err_Invalid_Argument` error. - * - * Note that CID-keyed fonts that are in an SFNT wrapper (this is, all - * OpenType/CFF fonts) don't have this flag set since the glyphs are - * accessed in the normal way (using contiguous indices); the - * 'CID-ness' isn't visible to the application. - * - * FT_FACE_FLAG_TRICKY :: - * The face is 'tricky', this is, it always needs the font format's - * native hinting engine to get a reasonable result. A typical example - * is the old Chinese font `mingli.ttf` (but not `mingliu.ttc`) that - * uses TrueType bytecode instructions to move and scale all of its - * subglyphs. - * - * It is not possible to auto-hint such fonts using - * @FT_LOAD_FORCE_AUTOHINT; it will also ignore @FT_LOAD_NO_HINTING. - * You have to set both @FT_LOAD_NO_HINTING and @FT_LOAD_NO_AUTOHINT to - * really disable hinting; however, you probably never want this except - * for demonstration purposes. - * - * Currently, there are about a dozen TrueType fonts in the list of - * tricky fonts; they are hard-coded in file `ttobjs.c`. - * - * FT_FACE_FLAG_COLOR :: - * [Since 2.5.1] The face has color glyph tables. See @FT_LOAD_COLOR - * for more information. - * - * FT_FACE_FLAG_VARIATION :: - * [Since 2.9] Set if the current face (or named instance) has been - * altered with @FT_Set_MM_Design_Coordinates, - * @FT_Set_Var_Design_Coordinates, or @FT_Set_Var_Blend_Coordinates. - * This flag is unset by a call to @FT_Set_Named_Instance. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_FACE_FLAG_XXX */ + /* */ + /* <Description> */ + /* A list of bit flags used in the `face_flags' field of the */ + /* @FT_FaceRec structure. They inform client applications of */ + /* properties of the corresponding face. */ + /* */ + /* <Values> */ + /* FT_FACE_FLAG_SCALABLE :: */ + /* Indicates that the face contains outline glyphs. This doesn't */ + /* prevent bitmap strikes, i.e., a face can have both this and */ + /* and @FT_FACE_FLAG_FIXED_SIZES set. */ + /* */ + /* FT_FACE_FLAG_FIXED_SIZES :: */ + /* Indicates that the face contains bitmap strikes. See also the */ + /* `num_fixed_sizes' and `available_sizes' fields of @FT_FaceRec. */ + /* */ + /* FT_FACE_FLAG_FIXED_WIDTH :: */ + /* Indicates that the face contains fixed-width characters (like */ + /* Courier, Lucido, MonoType, etc.). */ + /* */ + /* FT_FACE_FLAG_SFNT :: */ + /* Indicates that the face uses the `sfnt' storage scheme. For */ + /* now, this means TrueType and OpenType. */ + /* */ + /* FT_FACE_FLAG_HORIZONTAL :: */ + /* Indicates that the face contains horizontal glyph metrics. This */ + /* should be set for all common formats. */ + /* */ + /* FT_FACE_FLAG_VERTICAL :: */ + /* Indicates that the face contains vertical glyph metrics. This */ + /* is only available in some formats, not all of them. */ + /* */ + /* FT_FACE_FLAG_KERNING :: */ + /* Indicates that the face contains kerning information. If set, */ + /* the kerning distance can be retrieved through the function */ + /* @FT_Get_Kerning. Otherwise the function always return the */ + /* vector (0,0). Note that FreeType doesn't handle kerning data */ + /* from the `GPOS' table (as present in some OpenType fonts). */ + /* */ + /* FT_FACE_FLAG_FAST_GLYPHS :: */ + /* THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT. */ + /* */ + /* FT_FACE_FLAG_MULTIPLE_MASTERS :: */ + /* Indicates that the font contains multiple masters and is capable */ + /* of interpolating between them. See the multiple-masters */ + /* specific API for details. */ + /* */ + /* FT_FACE_FLAG_GLYPH_NAMES :: */ + /* Indicates that the font contains glyph names that can be */ + /* retrieved through @FT_Get_Glyph_Name. Note that some TrueType */ + /* fonts contain broken glyph name tables. Use the function */ + /* @FT_Has_PS_Glyph_Names when needed. */ + /* */ + /* FT_FACE_FLAG_EXTERNAL_STREAM :: */ + /* Used internally by FreeType to indicate that a face's stream was */ + /* provided by the client application and should not be destroyed */ + /* when @FT_Done_Face is called. Don't read or test this flag. */ + /* */ + /* FT_FACE_FLAG_HINTER :: */ + /* Set if the font driver has a hinting machine of its own. For */ + /* example, with TrueType fonts, it makes sense to use data from */ + /* the SFNT `gasp' table only if the native TrueType hinting engine */ + /* (with the bytecode interpreter) is available and active. */ + /* */ + /* FT_FACE_FLAG_CID_KEYED :: */ + /* Set if the font is CID-keyed. In that case, the font is not */ + /* accessed by glyph indices but by CID values. For subsetted */ + /* CID-keyed fonts this has the consequence that not all index */ + /* values are a valid argument to FT_Load_Glyph. Only the CID */ + /* values for which corresponding glyphs in the subsetted font */ + /* exist make FT_Load_Glyph return successfully; in all other cases */ + /* you get an `FT_Err_Invalid_Argument' error. */ + /* */ + /* Note that CID-keyed fonts that are in an SFNT wrapper don't */ + /* have this flag set since the glyphs are accessed in the normal */ + /* way (using contiguous indices); the `CID-ness' isn't visible to */ + /* the application. */ + /* */ + /* FT_FACE_FLAG_TRICKY :: */ + /* Set if the font is `tricky', this is, it always needs the */ + /* font format's native hinting engine to get a reasonable result. */ + /* A typical example is the Chinese font `mingli.ttf' that uses */ + /* TrueType bytecode instructions to move and scale all of its */ + /* subglyphs. */ + /* */ + /* It is not possible to auto-hint such fonts using */ + /* @FT_LOAD_FORCE_AUTOHINT; it will also ignore */ + /* @FT_LOAD_NO_HINTING. You have to set both @FT_LOAD_NO_HINTING */ + /* and @FT_LOAD_NO_AUTOHINT to really disable hinting; however, you */ + /* probably never want this except for demonstration purposes. */ + /* */ + /* Currently, there are about a dozen TrueType fonts in the list of */ + /* tricky fonts; they are hard-coded in file `ttobjs.c'. */ + /* */ + /* FT_FACE_FLAG_COLOR :: */ + /* Set if the font has color glyph tables. To access color glyphs */ + /* use @FT_LOAD_COLOR. */ + /* */ #define FT_FACE_FLAG_SCALABLE ( 1L << 0 ) #define FT_FACE_FLAG_FIXED_SIZES ( 1L << 1 ) #define FT_FACE_FLAG_FIXED_WIDTH ( 1L << 2 ) @@ -1222,30 +1206,29 @@ FT_BEGIN_HEADER #define FT_FACE_FLAG_CID_KEYED ( 1L << 12 ) #define FT_FACE_FLAG_TRICKY ( 1L << 13 ) #define FT_FACE_FLAG_COLOR ( 1L << 14 ) -#define FT_FACE_FLAG_VARIATION ( 1L << 15 ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_HAS_HORIZONTAL + * FT_HAS_HORIZONTAL( face ) * * @description: - * A macro that returns true whenever a face object contains horizontal - * metrics (this is true for all font formats though). + * A macro that returns true whenever a face object contains + * horizontal metrics (this is true for all font formats though). * * @also: * @FT_HAS_VERTICAL can be used to check for vertical metrics. * */ #define FT_HAS_HORIZONTAL( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_HORIZONTAL ) + ( face->face_flags & FT_FACE_FLAG_HORIZONTAL ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_HAS_VERTICAL + * FT_HAS_VERTICAL( face ) * * @description: * A macro that returns true whenever a face object contains real @@ -1253,91 +1236,91 @@ FT_BEGIN_HEADER * */ #define FT_HAS_VERTICAL( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_VERTICAL ) + ( face->face_flags & FT_FACE_FLAG_VERTICAL ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_HAS_KERNING + * FT_HAS_KERNING( face ) * * @description: - * A macro that returns true whenever a face object contains kerning data - * that can be accessed with @FT_Get_Kerning. + * A macro that returns true whenever a face object contains kerning + * data that can be accessed with @FT_Get_Kerning. * */ #define FT_HAS_KERNING( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_KERNING ) + ( face->face_flags & FT_FACE_FLAG_KERNING ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_IS_SCALABLE + * FT_IS_SCALABLE( face ) * * @description: * A macro that returns true whenever a face object contains a scalable - * font face (true for TrueType, Type~1, Type~42, CID, OpenType/CFF, and - * PFR font formats). + * font face (true for TrueType, Type~1, Type~42, CID, OpenType/CFF, + * and PFR font formats. * */ #define FT_IS_SCALABLE( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_SCALABLE ) + ( face->face_flags & FT_FACE_FLAG_SCALABLE ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_IS_SFNT + * FT_IS_SFNT( face ) * * @description: - * A macro that returns true whenever a face object contains a font whose - * format is based on the SFNT storage scheme. This usually means: - * TrueType fonts, OpenType fonts, as well as SFNT-based embedded bitmap - * fonts. + * A macro that returns true whenever a face object contains a font + * whose format is based on the SFNT storage scheme. This usually + * means: TrueType fonts, OpenType fonts, as well as SFNT-based embedded + * bitmap fonts. * * If this macro is true, all functions defined in @FT_SFNT_NAMES_H and * @FT_TRUETYPE_TABLES_H are available. * */ #define FT_IS_SFNT( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_SFNT ) + ( face->face_flags & FT_FACE_FLAG_SFNT ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_IS_FIXED_WIDTH + * FT_IS_FIXED_WIDTH( face ) * * @description: * A macro that returns true whenever a face object contains a font face - * that contains fixed-width (or 'monospace', 'fixed-pitch', etc.) + * that contains fixed-width (or `monospace', `fixed-pitch', etc.) * glyphs. * */ #define FT_IS_FIXED_WIDTH( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_FIXED_WIDTH ) + ( face->face_flags & FT_FACE_FLAG_FIXED_WIDTH ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_HAS_FIXED_SIZES + * FT_HAS_FIXED_SIZES( face ) * * @description: * A macro that returns true whenever a face object contains some - * embedded bitmaps. See the `available_sizes` field of the @FT_FaceRec - * structure. + * embedded bitmaps. See the `available_sizes' field of the + * @FT_FaceRec structure. * */ #define FT_HAS_FIXED_SIZES( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_FIXED_SIZES ) + ( face->face_flags & FT_FACE_FLAG_FIXED_SIZES ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_HAS_FAST_GLYPHS + * FT_HAS_FAST_GLYPHS( face ) * * @description: * Deprecated. @@ -1346,10 +1329,10 @@ FT_BEGIN_HEADER #define FT_HAS_FAST_GLYPHS( face ) 0 - /************************************************************************** + /************************************************************************* * * @macro: - * FT_HAS_GLYPH_NAMES + * FT_HAS_GLYPH_NAMES( face ) * * @description: * A macro that returns true whenever a face object contains some glyph @@ -1357,13 +1340,13 @@ FT_BEGIN_HEADER * */ #define FT_HAS_GLYPH_NAMES( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_GLYPH_NAMES ) + ( face->face_flags & FT_FACE_FLAG_GLYPH_NAMES ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_HAS_MULTIPLE_MASTERS + * FT_HAS_MULTIPLE_MASTERS( face ) * * @description: * A macro that returns true whenever a face object contains some @@ -1372,239 +1355,148 @@ FT_BEGIN_HEADER * */ #define FT_HAS_MULTIPLE_MASTERS( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS ) + ( face->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_IS_NAMED_INSTANCE - * - * @description: - * A macro that returns true whenever a face object is a named instance - * of a GX or OpenType variation font. - * - * [Since 2.9] Changing the design coordinates with - * @FT_Set_Var_Design_Coordinates or @FT_Set_Var_Blend_Coordinates does - * not influence the return value of this macro (only - * @FT_Set_Named_Instance does that). - * - * @since: - * 2.7 - * - */ -#define FT_IS_NAMED_INSTANCE( face ) \ - ( (face)->face_index & 0x7FFF0000L ) - - - /************************************************************************** - * - * @macro: - * FT_IS_VARIATION - * - * @description: - * A macro that returns true whenever a face object has been altered by - * @FT_Set_MM_Design_Coordinates, @FT_Set_Var_Design_Coordinates, or - * @FT_Set_Var_Blend_Coordinates. - * - * @since: - * 2.9 - * - */ -#define FT_IS_VARIATION( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_VARIATION ) - - - /************************************************************************** - * - * @macro: - * FT_IS_CID_KEYED + * FT_IS_CID_KEYED( face ) * * @description: * A macro that returns true whenever a face object contains a CID-keyed - * font. See the discussion of @FT_FACE_FLAG_CID_KEYED for more details. + * font. See the discussion of @FT_FACE_FLAG_CID_KEYED for more + * details. * * If this macro is true, all functions defined in @FT_CID_H are * available. * */ #define FT_IS_CID_KEYED( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_CID_KEYED ) + ( face->face_flags & FT_FACE_FLAG_CID_KEYED ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_IS_TRICKY + * FT_IS_TRICKY( face ) * * @description: - * A macro that returns true whenever a face represents a 'tricky' font. + * A macro that returns true whenever a face represents a `tricky' font. * See the discussion of @FT_FACE_FLAG_TRICKY for more details. * */ #define FT_IS_TRICKY( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_TRICKY ) + ( face->face_flags & FT_FACE_FLAG_TRICKY ) - /************************************************************************** + /************************************************************************* * * @macro: - * FT_HAS_COLOR + * FT_HAS_COLOR( face ) * * @description: - * A macro that returns true whenever a face object contains tables for - * color glyphs. - * - * @since: - * 2.5.1 + * A macro that returns true whenever a face object contains + * tables for color glyphs. * */ #define FT_HAS_COLOR( face ) \ - ( (face)->face_flags & FT_FACE_FLAG_COLOR ) + ( face->face_flags & FT_FACE_FLAG_COLOR ) - /************************************************************************** - * - * @enum: - * FT_STYLE_FLAG_XXX - * - * @description: - * A list of bit flags to indicate the style of a given face. These are - * used in the `style_flags` field of @FT_FaceRec. - * - * @values: - * FT_STYLE_FLAG_ITALIC :: - * The face style is italic or oblique. - * - * FT_STYLE_FLAG_BOLD :: - * The face is bold. - * - * @note: - * The style information as provided by FreeType is very basic. More - * details are beyond the scope and should be done on a higher level (for - * example, by analyzing various fields of the 'OS/2' table in SFNT based - * fonts). - */ + /*************************************************************************/ + /* */ + /* <Const> */ + /* FT_STYLE_FLAG_XXX */ + /* */ + /* <Description> */ + /* A list of bit flags used to indicate the style of a given face. */ + /* These are used in the `style_flags' field of @FT_FaceRec. */ + /* */ + /* <Values> */ + /* FT_STYLE_FLAG_ITALIC :: */ + /* Indicates that a given face style is italic or oblique. */ + /* */ + /* FT_STYLE_FLAG_BOLD :: */ + /* Indicates that a given face is bold. */ + /* */ + /* <Note> */ + /* The style information as provided by FreeType is very basic. More */ + /* details are beyond the scope and should be done on a higher level */ + /* (for example, by analyzing various fields of the `OS/2' table in */ + /* SFNT based fonts). */ + /* */ #define FT_STYLE_FLAG_ITALIC ( 1 << 0 ) #define FT_STYLE_FLAG_BOLD ( 1 << 1 ) - /************************************************************************** - * - * @type: - * FT_Size_Internal - * - * @description: - * An opaque handle to an `FT_Size_InternalRec` structure, used to model - * private data of a given @FT_Size object. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Size_Internal */ + /* */ + /* <Description> */ + /* An opaque handle to an `FT_Size_InternalRec' structure, used to */ + /* model private data of a given @FT_Size object. */ + /* */ typedef struct FT_Size_InternalRec_* FT_Size_Internal; - /************************************************************************** - * - * @struct: - * FT_Size_Metrics - * - * @description: - * The size metrics structure gives the metrics of a size object. - * - * @fields: - * x_ppem :: - * The width of the scaled EM square in pixels, hence the term 'ppem' - * (pixels per EM). It is also referred to as 'nominal width'. - * - * y_ppem :: - * The height of the scaled EM square in pixels, hence the term 'ppem' - * (pixels per EM). It is also referred to as 'nominal height'. - * - * x_scale :: - * A 16.16 fractional scaling value to convert horizontal metrics from - * font units to 26.6 fractional pixels. Only relevant for scalable - * font formats. - * - * y_scale :: - * A 16.16 fractional scaling value to convert vertical metrics from - * font units to 26.6 fractional pixels. Only relevant for scalable - * font formats. - * - * ascender :: - * The ascender in 26.6 fractional pixels, rounded up to an integer - * value. See @FT_FaceRec for the details. - * - * descender :: - * The descender in 26.6 fractional pixels, rounded down to an integer - * value. See @FT_FaceRec for the details. - * - * height :: - * The height in 26.6 fractional pixels, rounded to an integer value. - * See @FT_FaceRec for the details. - * - * max_advance :: - * The maximum advance width in 26.6 fractional pixels, rounded to an - * integer value. See @FT_FaceRec for the details. - * - * @note: - * The scaling values, if relevant, are determined first during a size - * changing operation. The remaining fields are then set by the driver. - * For scalable formats, they are usually set to scaled values of the - * corresponding fields in @FT_FaceRec. Some values like ascender or - * descender are rounded for historical reasons; more precise values (for - * outline fonts) can be derived by scaling the corresponding @FT_FaceRec - * values manually, with code similar to the following. - * - * ``` - * scaled_ascender = FT_MulFix( face->ascender, - * size_metrics->y_scale ); - * ``` - * - * Note that due to glyph hinting and the selected rendering mode these - * values are usually not exact; consequently, they must be treated as - * unreliable with an error margin of at least one pixel! - * - * Indeed, the only way to get the exact metrics is to render _all_ - * glyphs. As this would be a definite performance hit, it is up to - * client applications to perform such computations. - * - * The `FT_Size_Metrics` structure is valid for bitmap fonts also. - * - * - * **TrueType fonts with native bytecode hinting** - * - * All applications that handle TrueType fonts with native hinting must - * be aware that TTFs expect different rounding of vertical font - * dimensions. The application has to cater for this, especially if it - * wants to rely on a TTF's vertical data (for example, to properly align - * box characters vertically). - * - * Only the application knows _in advance_ that it is going to use native - * hinting for TTFs! FreeType, on the other hand, selects the hinting - * mode not at the time of creating an @FT_Size object but much later, - * namely while calling @FT_Load_Glyph. - * - * Here is some pseudo code that illustrates a possible solution. - * - * ``` - * font_format = FT_Get_Font_Format( face ); - * - * if ( !strcmp( font_format, "TrueType" ) && - * do_native_bytecode_hinting ) - * { - * ascender = ROUND( FT_MulFix( face->ascender, - * size_metrics->y_scale ) ); - * descender = ROUND( FT_MulFix( face->descender, - * size_metrics->y_scale ) ); - * } - * else - * { - * ascender = size_metrics->ascender; - * descender = size_metrics->descender; - * } - * - * height = size_metrics->height; - * max_advance = size_metrics->max_advance; - * ``` - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Size_Metrics */ + /* */ + /* <Description> */ + /* The size metrics structure gives the metrics of a size object. */ + /* */ + /* <Fields> */ + /* x_ppem :: The width of the scaled EM square in pixels, hence */ + /* the term `ppem' (pixels per EM). It is also */ + /* referred to as `nominal width'. */ + /* */ + /* y_ppem :: The height of the scaled EM square in pixels, */ + /* hence the term `ppem' (pixels per EM). It is also */ + /* referred to as `nominal height'. */ + /* */ + /* x_scale :: A 16.16 fractional scaling value used to convert */ + /* horizontal metrics from font units to 26.6 */ + /* fractional pixels. Only relevant for scalable */ + /* font formats. */ + /* */ + /* y_scale :: A 16.16 fractional scaling value used to convert */ + /* vertical metrics from font units to 26.6 */ + /* fractional pixels. Only relevant for scalable */ + /* font formats. */ + /* */ + /* ascender :: The ascender in 26.6 fractional pixels. See */ + /* @FT_FaceRec for the details. */ + /* */ + /* descender :: The descender in 26.6 fractional pixels. See */ + /* @FT_FaceRec for the details. */ + /* */ + /* height :: The height in 26.6 fractional pixels. See */ + /* @FT_FaceRec for the details. */ + /* */ + /* max_advance :: The maximum advance width in 26.6 fractional */ + /* pixels. See @FT_FaceRec for the details. */ + /* */ + /* <Note> */ + /* The scaling values, if relevant, are determined first during a */ + /* size changing operation. The remaining fields are then set by the */ + /* driver. For scalable formats, they are usually set to scaled */ + /* values of the corresponding fields in @FT_FaceRec. */ + /* */ + /* Note that due to glyph hinting, these values might not be exact */ + /* for certain fonts. Thus they must be treated as unreliable */ + /* with an error margin of at least one pixel! */ + /* */ + /* Indeed, the only way to get the exact metrics is to render _all_ */ + /* glyphs. As this would be a definite performance hit, it is up to */ + /* client applications to perform such computations. */ + /* */ + /* The FT_Size_Metrics structure is valid for bitmap fonts also. */ + /* */ typedef struct FT_Size_Metrics_ { FT_UShort x_ppem; /* horizontal pixels per EM */ @@ -1621,27 +1513,25 @@ FT_BEGIN_HEADER } FT_Size_Metrics; - /************************************************************************** - * - * @struct: - * FT_SizeRec - * - * @description: - * FreeType root size class structure. A size object models a face - * object at a given size. - * - * @fields: - * face :: - * Handle to the parent face object. - * - * generic :: - * A typeless pointer, unused by the FreeType library or any of its - * drivers. It can be used by client applications to link their own - * data to each size object. - * - * metrics :: - * Metrics for this size object. This field is read-only. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_SizeRec */ + /* */ + /* <Description> */ + /* FreeType root size class structure. A size object models a face */ + /* object at a given size. */ + /* */ + /* <Fields> */ + /* face :: Handle to the parent face object. */ + /* */ + /* generic :: A typeless pointer, unused by the FreeType library or */ + /* any of its drivers. It can be used by client */ + /* applications to link their own data to each size */ + /* object. */ + /* */ + /* metrics :: Metrics for this size object. This field is read-only. */ + /* */ typedef struct FT_SizeRec_ { FT_Face face; /* parent face object */ @@ -1652,234 +1542,211 @@ FT_BEGIN_HEADER } FT_SizeRec; - /************************************************************************** - * - * @struct: - * FT_SubGlyph - * - * @description: - * The subglyph structure is an internal object used to describe - * subglyphs (for example, in the case of composites). - * - * @note: - * The subglyph implementation is not part of the high-level API, hence - * the forward structure declaration. - * - * You can however retrieve subglyph information with - * @FT_Get_SubGlyph_Info. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_SubGlyph */ + /* */ + /* <Description> */ + /* The subglyph structure is an internal object used to describe */ + /* subglyphs (for example, in the case of composites). */ + /* */ + /* <Note> */ + /* The subglyph implementation is not part of the high-level API, */ + /* hence the forward structure declaration. */ + /* */ + /* You can however retrieve subglyph information with */ + /* @FT_Get_SubGlyph_Info. */ + /* */ typedef struct FT_SubGlyphRec_* FT_SubGlyph; - /************************************************************************** - * - * @type: - * FT_Slot_Internal - * - * @description: - * An opaque handle to an `FT_Slot_InternalRec` structure, used to model - * private data of a given @FT_GlyphSlot object. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Slot_Internal */ + /* */ + /* <Description> */ + /* An opaque handle to an `FT_Slot_InternalRec' structure, used to */ + /* model private data of a given @FT_GlyphSlot object. */ + /* */ typedef struct FT_Slot_InternalRec_* FT_Slot_Internal; - /************************************************************************** - * - * @struct: - * FT_GlyphSlotRec - * - * @description: - * FreeType root glyph slot class structure. A glyph slot is a container - * where individual glyphs can be loaded, be they in outline or bitmap - * format. - * - * @fields: - * library :: - * A handle to the FreeType library instance this slot belongs to. - * - * face :: - * A handle to the parent face object. - * - * next :: - * In some cases (like some font tools), several glyph slots per face - * object can be a good thing. As this is rare, the glyph slots are - * listed through a direct, single-linked list using its `next` field. - * - * glyph_index :: - * [Since 2.10] The glyph index passed as an argument to @FT_Load_Glyph - * while initializing the glyph slot. - * - * generic :: - * A typeless pointer unused by the FreeType library or any of its - * drivers. It can be used by client applications to link their own - * data to each glyph slot object. - * - * metrics :: - * The metrics of the last loaded glyph in the slot. The returned - * values depend on the last load flags (see the @FT_Load_Glyph API - * function) and can be expressed either in 26.6 fractional pixels or - * font units. - * - * Note that even when the glyph image is transformed, the metrics are - * not. - * - * linearHoriAdvance :: - * The advance width of the unhinted glyph. Its value is expressed in - * 16.16 fractional pixels, unless @FT_LOAD_LINEAR_DESIGN is set when - * loading the glyph. This field can be important to perform correct - * WYSIWYG layout. Only relevant for outline glyphs. - * - * linearVertAdvance :: - * The advance height of the unhinted glyph. Its value is expressed in - * 16.16 fractional pixels, unless @FT_LOAD_LINEAR_DESIGN is set when - * loading the glyph. This field can be important to perform correct - * WYSIWYG layout. Only relevant for outline glyphs. - * - * advance :: - * This shorthand is, depending on @FT_LOAD_IGNORE_TRANSFORM, the - * transformed (hinted) advance width for the glyph, in 26.6 fractional - * pixel format. As specified with @FT_LOAD_VERTICAL_LAYOUT, it uses - * either the `horiAdvance` or the `vertAdvance` value of `metrics` - * field. - * - * format :: - * This field indicates the format of the image contained in the glyph - * slot. Typically @FT_GLYPH_FORMAT_BITMAP, @FT_GLYPH_FORMAT_OUTLINE, - * or @FT_GLYPH_FORMAT_COMPOSITE, but other values are possible. - * - * bitmap :: - * This field is used as a bitmap descriptor. Note that the address - * and content of the bitmap buffer can change between calls of - * @FT_Load_Glyph and a few other functions. - * - * bitmap_left :: - * The bitmap's left bearing expressed in integer pixels. - * - * bitmap_top :: - * The bitmap's top bearing expressed in integer pixels. This is the - * distance from the baseline to the top-most glyph scanline, upwards - * y~coordinates being **positive**. - * - * outline :: - * The outline descriptor for the current glyph image if its format is - * @FT_GLYPH_FORMAT_OUTLINE. Once a glyph is loaded, `outline` can be - * transformed, distorted, emboldened, etc. However, it must not be - * freed. - * - * num_subglyphs :: - * The number of subglyphs in a composite glyph. This field is only - * valid for the composite glyph format that should normally only be - * loaded with the @FT_LOAD_NO_RECURSE flag. - * - * subglyphs :: - * An array of subglyph descriptors for composite glyphs. There are - * `num_subglyphs` elements in there. Currently internal to FreeType. - * - * control_data :: - * Certain font drivers can also return the control data for a given - * glyph image (e.g. TrueType bytecode, Type~1 charstrings, etc.). - * This field is a pointer to such data; it is currently internal to - * FreeType. - * - * control_len :: - * This is the length in bytes of the control data. Currently internal - * to FreeType. - * - * other :: - * Reserved. - * - * lsb_delta :: - * The difference between hinted and unhinted left side bearing while - * auto-hinting is active. Zero otherwise. - * - * rsb_delta :: - * The difference between hinted and unhinted right side bearing while - * auto-hinting is active. Zero otherwise. - * - * @note: - * If @FT_Load_Glyph is called with default flags (see @FT_LOAD_DEFAULT) - * the glyph image is loaded in the glyph slot in its native format - * (e.g., an outline glyph for TrueType and Type~1 formats). [Since 2.9] - * The prospective bitmap metrics are calculated according to - * @FT_LOAD_TARGET_XXX and other flags even for the outline glyph, even - * if @FT_LOAD_RENDER is not set. - * - * This image can later be converted into a bitmap by calling - * @FT_Render_Glyph. This function searches the current renderer for the - * native image's format, then invokes it. - * - * The renderer is in charge of transforming the native image through the - * slot's face transformation fields, then converting it into a bitmap - * that is returned in `slot->bitmap`. - * - * Note that `slot->bitmap_left` and `slot->bitmap_top` are also used to - * specify the position of the bitmap relative to the current pen - * position (e.g., coordinates (0,0) on the baseline). Of course, - * `slot->format` is also changed to @FT_GLYPH_FORMAT_BITMAP. - * - * Here is a small pseudo code fragment that shows how to use `lsb_delta` - * and `rsb_delta` to do fractional positioning of glyphs: - * - * ``` - * FT_GlyphSlot slot = face->glyph; - * FT_Pos origin_x = 0; - * - * - * for all glyphs do - * <load glyph with `FT_Load_Glyph'> - * - * FT_Outline_Translate( slot->outline, origin_x & 63, 0 ); - * - * <save glyph image, or render glyph, or ...> - * - * <compute kern between current and next glyph - * and add it to `origin_x'> - * - * origin_x += slot->advance.x; - * origin_x += slot->lsb_delta - slot->rsb_delta; - * endfor - * ``` - * - * Here is another small pseudo code fragment that shows how to use - * `lsb_delta` and `rsb_delta` to improve integer positioning of glyphs: - * - * ``` - * FT_GlyphSlot slot = face->glyph; - * FT_Pos origin_x = 0; - * FT_Pos prev_rsb_delta = 0; - * - * - * for all glyphs do - * <compute kern between current and previous glyph - * and add it to `origin_x'> - * - * <load glyph with `FT_Load_Glyph'> - * - * if ( prev_rsb_delta - slot->lsb_delta > 32 ) - * origin_x -= 64; - * else if ( prev_rsb_delta - slot->lsb_delta < -31 ) - * origin_x += 64; - * - * prev_rsb_delta = slot->rsb_delta; - * - * <save glyph image, or render glyph, or ...> - * - * origin_x += slot->advance.x; - * endfor - * ``` - * - * If you use strong auto-hinting, you **must** apply these delta values! - * Otherwise you will experience far too large inter-glyph spacing at - * small rendering sizes in most cases. Note that it doesn't harm to use - * the above code for other hinting modes also, since the delta values - * are zero then. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_GlyphSlotRec */ + /* */ + /* <Description> */ + /* FreeType root glyph slot class structure. A glyph slot is a */ + /* container where individual glyphs can be loaded, be they in */ + /* outline or bitmap format. */ + /* */ + /* <Fields> */ + /* library :: A handle to the FreeType library instance */ + /* this slot belongs to. */ + /* */ + /* face :: A handle to the parent face object. */ + /* */ + /* next :: In some cases (like some font tools), several */ + /* glyph slots per face object can be a good */ + /* thing. As this is rare, the glyph slots are */ + /* listed through a direct, single-linked list */ + /* using its `next' field. */ + /* */ + /* generic :: A typeless pointer unused by the FreeType */ + /* library or any of its drivers. It can be */ + /* used by client applications to link their own */ + /* data to each glyph slot object. */ + /* */ + /* metrics :: The metrics of the last loaded glyph in the */ + /* slot. The returned values depend on the last */ + /* load flags (see the @FT_Load_Glyph API */ + /* function) and can be expressed either in 26.6 */ + /* fractional pixels or font units. */ + /* */ + /* Note that even when the glyph image is */ + /* transformed, the metrics are not. */ + /* */ + /* linearHoriAdvance :: The advance width of the unhinted glyph. */ + /* Its value is expressed in 16.16 fractional */ + /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */ + /* when loading the glyph. This field can be */ + /* important to perform correct WYSIWYG layout. */ + /* Only relevant for outline glyphs. */ + /* */ + /* linearVertAdvance :: The advance height of the unhinted glyph. */ + /* Its value is expressed in 16.16 fractional */ + /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */ + /* when loading the glyph. This field can be */ + /* important to perform correct WYSIWYG layout. */ + /* Only relevant for outline glyphs. */ + /* */ + /* advance :: This shorthand is, depending on */ + /* @FT_LOAD_IGNORE_TRANSFORM, the transformed */ + /* (hinted) advance width for the glyph, in 26.6 */ + /* fractional pixel format. As specified with */ + /* @FT_LOAD_VERTICAL_LAYOUT, it uses either the */ + /* `horiAdvance' or the `vertAdvance' value of */ + /* `metrics' field. */ + /* */ + /* format :: This field indicates the format of the image */ + /* contained in the glyph slot. Typically */ + /* @FT_GLYPH_FORMAT_BITMAP, */ + /* @FT_GLYPH_FORMAT_OUTLINE, or */ + /* @FT_GLYPH_FORMAT_COMPOSITE, but others are */ + /* possible. */ + /* */ + /* bitmap :: This field is used as a bitmap descriptor */ + /* when the slot format is */ + /* @FT_GLYPH_FORMAT_BITMAP. Note that the */ + /* address and content of the bitmap buffer can */ + /* change between calls of @FT_Load_Glyph and a */ + /* few other functions. */ + /* */ + /* bitmap_left :: The bitmap's left bearing expressed in */ + /* integer pixels. Only valid if the format is */ + /* @FT_GLYPH_FORMAT_BITMAP, this is, if the */ + /* glyph slot contains a bitmap. */ + /* */ + /* bitmap_top :: The bitmap's top bearing expressed in integer */ + /* pixels. Remember that this is the distance */ + /* from the baseline to the top-most glyph */ + /* scanline, upwards y~coordinates being */ + /* *positive*. */ + /* */ + /* outline :: The outline descriptor for the current glyph */ + /* image if its format is */ + /* @FT_GLYPH_FORMAT_OUTLINE. Once a glyph is */ + /* loaded, `outline' can be transformed, */ + /* distorted, embolded, etc. However, it must */ + /* not be freed. */ + /* */ + /* num_subglyphs :: The number of subglyphs in a composite glyph. */ + /* This field is only valid for the composite */ + /* glyph format that should normally only be */ + /* loaded with the @FT_LOAD_NO_RECURSE flag. */ + /* */ + /* subglyphs :: An array of subglyph descriptors for */ + /* composite glyphs. There are `num_subglyphs' */ + /* elements in there. Currently internal to */ + /* FreeType. */ + /* */ + /* control_data :: Certain font drivers can also return the */ + /* control data for a given glyph image (e.g. */ + /* TrueType bytecode, Type~1 charstrings, etc.). */ + /* This field is a pointer to such data. */ + /* */ + /* control_len :: This is the length in bytes of the control */ + /* data. */ + /* */ + /* other :: Really wicked formats can use this pointer to */ + /* present their own glyph image to client */ + /* applications. Note that the application */ + /* needs to know about the image format. */ + /* */ + /* lsb_delta :: The difference between hinted and unhinted */ + /* left side bearing while auto-hinting is */ + /* active. Zero otherwise. */ + /* */ + /* rsb_delta :: The difference between hinted and unhinted */ + /* right side bearing while auto-hinting is */ + /* active. Zero otherwise. */ + /* */ + /* <Note> */ + /* If @FT_Load_Glyph is called with default flags (see */ + /* @FT_LOAD_DEFAULT) the glyph image is loaded in the glyph slot in */ + /* its native format (e.g., an outline glyph for TrueType and Type~1 */ + /* formats). */ + /* */ + /* This image can later be converted into a bitmap by calling */ + /* @FT_Render_Glyph. This function finds the current renderer for */ + /* the native image's format, then invokes it. */ + /* */ + /* The renderer is in charge of transforming the native image through */ + /* the slot's face transformation fields, then converting it into a */ + /* bitmap that is returned in `slot->bitmap'. */ + /* */ + /* Note that `slot->bitmap_left' and `slot->bitmap_top' are also used */ + /* to specify the position of the bitmap relative to the current pen */ + /* position (e.g., coordinates (0,0) on the baseline). Of course, */ + /* `slot->format' is also changed to @FT_GLYPH_FORMAT_BITMAP. */ + /* */ + /* <Note> */ + /* Here is a small pseudo code fragment that shows how to use */ + /* `lsb_delta' and `rsb_delta': */ + /* */ + /* { */ + /* FT_Pos origin_x = 0; */ + /* FT_Pos prev_rsb_delta = 0; */ + /* */ + /* */ + /* for all glyphs do */ + /* <compute kern between current and previous glyph and add it to */ + /* `origin_x'> */ + /* */ + /* <load glyph with `FT_Load_Glyph'> */ + /* */ + /* if ( prev_rsb_delta - face->glyph->lsb_delta >= 32 ) */ + /* origin_x -= 64; */ + /* else if ( prev_rsb_delta - face->glyph->lsb_delta < -32 ) */ + /* origin_x += 64; */ + /* */ + /* prev_rsb_delta = face->glyph->rsb_delta; */ + /* */ + /* <save glyph image, or render glyph, or ...> */ + /* */ + /* origin_x += face->glyph->advance.x; */ + /* endfor */ + /* } */ + /* */ typedef struct FT_GlyphSlotRec_ { FT_Library library; FT_Face face; FT_GlyphSlot next; - FT_UInt glyph_index; /* new in 2.10; was reserved previously */ + FT_UInt reserved; /* retained for binary compatibility */ FT_Generic generic; FT_Glyph_Metrics metrics; @@ -1920,92 +1787,80 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Init_FreeType - * - * @description: - * Initialize a new FreeType library object. The set of modules that are - * registered by this function is determined at build time. - * - * @output: - * alibrary :: - * A handle to a new library object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * In case you want to provide your own memory allocating routines, use - * @FT_New_Library instead, followed by a call to @FT_Add_Default_Modules - * (or a series of calls to @FT_Add_Module) and - * @FT_Set_Default_Properties. - * - * See the documentation of @FT_Library and @FT_Face for multi-threading - * issues. - * - * If you need reference-counting (cf. @FT_Reference_Library), use - * @FT_New_Library and @FT_Done_Library. - * - * If compilation option `FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES` is - * set, this function reads the `FREETYPE_PROPERTIES` environment - * variable to control driver properties. See section @properties for - * more. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Init_FreeType */ + /* */ + /* <Description> */ + /* Initialize a new FreeType library object. The set of modules */ + /* that are registered by this function is determined at build time. */ + /* */ + /* <Output> */ + /* alibrary :: A handle to a new library object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* In case you want to provide your own memory allocating routines, */ + /* use @FT_New_Library instead, followed by a call to */ + /* @FT_Add_Default_Modules (or a series of calls to @FT_Add_Module). */ + /* */ + /* See the documentation of @FT_Library and @FT_Face for */ + /* multi-threading issues. */ + /* */ + /* If you need reference-counting (cf. @FT_Reference_Library), use */ + /* @FT_New_Library and @FT_Done_Library. */ + /* */ FT_EXPORT( FT_Error ) FT_Init_FreeType( FT_Library *alibrary ); - /************************************************************************** - * - * @function: - * FT_Done_FreeType - * - * @description: - * Destroy a given FreeType library object and all of its children, - * including resources, drivers, faces, sizes, etc. - * - * @input: - * library :: - * A handle to the target library object. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Done_FreeType */ + /* */ + /* <Description> */ + /* Destroy a given FreeType library object and all of its children, */ + /* including resources, drivers, faces, sizes, etc. */ + /* */ + /* <Input> */ + /* library :: A handle to the target library object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Done_FreeType( FT_Library library ); - /************************************************************************** - * - * @enum: - * FT_OPEN_XXX - * - * @description: - * A list of bit field constants used within the `flags` field of the - * @FT_Open_Args structure. - * - * @values: - * FT_OPEN_MEMORY :: - * This is a memory-based stream. - * - * FT_OPEN_STREAM :: - * Copy the stream from the `stream` field. - * - * FT_OPEN_PATHNAME :: - * Create a new input stream from a C~path name. - * - * FT_OPEN_DRIVER :: - * Use the `driver` field. - * - * FT_OPEN_PARAMS :: - * Use the `num_params` and `params` fields. - * - * @note: - * The `FT_OPEN_MEMORY`, `FT_OPEN_STREAM`, and `FT_OPEN_PATHNAME` flags - * are mutually exclusive. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_OPEN_XXX */ + /* */ + /* <Description> */ + /* A list of bit field constants used within the `flags' field of the */ + /* @FT_Open_Args structure. */ + /* */ + /* <Values> */ + /* FT_OPEN_MEMORY :: This is a memory-based stream. */ + /* */ + /* FT_OPEN_STREAM :: Copy the stream from the `stream' field. */ + /* */ + /* FT_OPEN_PATHNAME :: Create a new input stream from a C~path */ + /* name. */ + /* */ + /* FT_OPEN_DRIVER :: Use the `driver' field. */ + /* */ + /* FT_OPEN_PARAMS :: Use the `num_params' and `params' fields. */ + /* */ + /* <Note> */ + /* The `FT_OPEN_MEMORY', `FT_OPEN_STREAM', and `FT_OPEN_PATHNAME' */ + /* flags are mutually exclusive. */ + /* */ #define FT_OPEN_MEMORY 0x1 #define FT_OPEN_STREAM 0x2 #define FT_OPEN_PATHNAME 0x4 @@ -2013,7 +1868,7 @@ FT_BEGIN_HEADER #define FT_OPEN_PARAMS 0x10 - /* these constants are deprecated; use the corresponding `FT_OPEN_XXX` */ + /* these constants are deprecated; use the corresponding `FT_OPEN_XXX' */ /* values instead */ #define ft_open_memory FT_OPEN_MEMORY #define ft_open_stream FT_OPEN_STREAM @@ -2022,26 +1877,24 @@ FT_BEGIN_HEADER #define ft_open_params FT_OPEN_PARAMS - /************************************************************************** - * - * @struct: - * FT_Parameter - * - * @description: - * A simple structure to pass more or less generic parameters to - * @FT_Open_Face and @FT_Face_Properties. - * - * @fields: - * tag :: - * A four-byte identification tag. - * - * data :: - * A pointer to the parameter data. - * - * @note: - * The ID and function of parameters are driver-specific. See section - * @parameter_tags for more information. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Parameter */ + /* */ + /* <Description> */ + /* A simple structure used to pass more or less generic parameters to */ + /* @FT_Open_Face. */ + /* */ + /* <Fields> */ + /* tag :: A four-byte identification tag. */ + /* */ + /* data :: A pointer to the parameter data. */ + /* */ + /* <Note> */ + /* The ID and function of parameters are driver-specific. See the */ + /* various FT_PARAM_TAG_XXX flags for more information. */ + /* */ typedef struct FT_Parameter_ { FT_ULong tag; @@ -2050,69 +1903,64 @@ FT_BEGIN_HEADER } FT_Parameter; - /************************************************************************** - * - * @struct: - * FT_Open_Args - * - * @description: - * A structure to indicate how to open a new font file or stream. A - * pointer to such a structure can be used as a parameter for the - * functions @FT_Open_Face and @FT_Attach_Stream. - * - * @fields: - * flags :: - * A set of bit flags indicating how to use the structure. - * - * memory_base :: - * The first byte of the file in memory. - * - * memory_size :: - * The size in bytes of the file in memory. - * - * pathname :: - * A pointer to an 8-bit file pathname. - * - * stream :: - * A handle to a source stream object. - * - * driver :: - * This field is exclusively used by @FT_Open_Face; it simply specifies - * the font driver to use for opening the face. If set to `NULL`, - * FreeType tries to load the face with each one of the drivers in its - * list. - * - * num_params :: - * The number of extra parameters. - * - * params :: - * Extra parameters passed to the font driver when opening a new face. - * - * @note: - * The stream type is determined by the contents of `flags` that are - * tested in the following order by @FT_Open_Face: - * - * If the @FT_OPEN_MEMORY bit is set, assume that this is a memory file - * of `memory_size` bytes, located at `memory_address`. The data are not - * copied, and the client is responsible for releasing and destroying - * them _after_ the corresponding call to @FT_Done_Face. - * - * Otherwise, if the @FT_OPEN_STREAM bit is set, assume that a custom - * input stream `stream` is used. - * - * Otherwise, if the @FT_OPEN_PATHNAME bit is set, assume that this is a - * normal file and use `pathname` to open it. - * - * If the @FT_OPEN_DRIVER bit is set, @FT_Open_Face only tries to open - * the file with the driver whose handler is in `driver`. - * - * If the @FT_OPEN_PARAMS bit is set, the parameters given by - * `num_params` and `params` is used. They are ignored otherwise. - * - * Ideally, both the `pathname` and `params` fields should be tagged as - * 'const'; this is missing for API backward compatibility. In other - * words, applications should treat them as read-only. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Open_Args */ + /* */ + /* <Description> */ + /* A structure used to indicate how to open a new font file or */ + /* stream. A pointer to such a structure can be used as a parameter */ + /* for the functions @FT_Open_Face and @FT_Attach_Stream. */ + /* */ + /* <Fields> */ + /* flags :: A set of bit flags indicating how to use the */ + /* structure. */ + /* */ + /* memory_base :: The first byte of the file in memory. */ + /* */ + /* memory_size :: The size in bytes of the file in memory. */ + /* */ + /* pathname :: A pointer to an 8-bit file pathname. */ + /* */ + /* stream :: A handle to a source stream object. */ + /* */ + /* driver :: This field is exclusively used by @FT_Open_Face; */ + /* it simply specifies the font driver to use to open */ + /* the face. If set to~0, FreeType tries to load the */ + /* face with each one of the drivers in its list. */ + /* */ + /* num_params :: The number of extra parameters. */ + /* */ + /* params :: Extra parameters passed to the font driver when */ + /* opening a new face. */ + /* */ + /* <Note> */ + /* The stream type is determined by the contents of `flags' that */ + /* are tested in the following order by @FT_Open_Face: */ + /* */ + /* If the @FT_OPEN_MEMORY bit is set, assume that this is a */ + /* memory file of `memory_size' bytes, located at `memory_address'. */ + /* The data are are not copied, and the client is responsible for */ + /* releasing and destroying them _after_ the corresponding call to */ + /* @FT_Done_Face. */ + /* */ + /* Otherwise, if the @FT_OPEN_STREAM bit is set, assume that a */ + /* custom input stream `stream' is used. */ + /* */ + /* Otherwise, if the @FT_OPEN_PATHNAME bit is set, assume that this */ + /* is a normal file and use `pathname' to open it. */ + /* */ + /* If the @FT_OPEN_DRIVER bit is set, @FT_Open_Face only tries to */ + /* open the file with the driver whose handler is in `driver'. */ + /* */ + /* If the @FT_OPEN_PARAMS bit is set, the parameters given by */ + /* `num_params' and `params' is used. They are ignored otherwise. */ + /* */ + /* Ideally, both the `pathname' and `params' fields should be tagged */ + /* as `const'; this is missing for API backwards compatibility. In */ + /* other words, applications should treat them as read-only. */ + /* */ typedef struct FT_Open_Args_ { FT_UInt flags; @@ -2127,37 +1975,34 @@ FT_BEGIN_HEADER } FT_Open_Args; - /************************************************************************** - * - * @function: - * FT_New_Face - * - * @description: - * Call @FT_Open_Face to open a font by its pathname. - * - * @inout: - * library :: - * A handle to the library resource. - * - * @input: - * pathname :: - * A path to the font file. - * - * face_index :: - * See @FT_Open_Face for a detailed description of this parameter. - * - * @output: - * aface :: - * A handle to a new face object. If `face_index` is greater than or - * equal to zero, it must be non-`NULL`. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * Use @FT_Done_Face to destroy the created @FT_Face object (along with - * its slot and sizes). - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_New_Face */ + /* */ + /* <Description> */ + /* This function calls @FT_Open_Face to open a font by its pathname. */ + /* */ + /* <InOut> */ + /* library :: A handle to the library resource. */ + /* */ + /* <Input> */ + /* pathname :: A path to the font file. */ + /* */ + /* face_index :: See @FT_Open_Face for a detailed description of this */ + /* parameter. */ + /* */ + /* <Output> */ + /* aface :: A handle to a new face object. If `face_index' is */ + /* greater than or equal to zero, it must be non-NULL. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* Use @FT_Done_Face to destroy the created @FT_Face object (along */ + /* with its slot and sizes). */ + /* */ FT_EXPORT( FT_Error ) FT_New_Face( FT_Library library, const char* filepathname, @@ -2165,39 +2010,36 @@ FT_BEGIN_HEADER FT_Face *aface ); - /************************************************************************** - * - * @function: - * FT_New_Memory_Face - * - * @description: - * Call @FT_Open_Face to open a font that has been loaded into memory. - * - * @inout: - * library :: - * A handle to the library resource. - * - * @input: - * file_base :: - * A pointer to the beginning of the font data. - * - * file_size :: - * The size of the memory chunk used by the font data. - * - * face_index :: - * See @FT_Open_Face for a detailed description of this parameter. - * - * @output: - * aface :: - * A handle to a new face object. If `face_index` is greater than or - * equal to zero, it must be non-`NULL`. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * You must not deallocate the memory before calling @FT_Done_Face. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_New_Memory_Face */ + /* */ + /* <Description> */ + /* This function calls @FT_Open_Face to open a font that has been */ + /* loaded into memory. */ + /* */ + /* <InOut> */ + /* library :: A handle to the library resource. */ + /* */ + /* <Input> */ + /* file_base :: A pointer to the beginning of the font data. */ + /* */ + /* file_size :: The size of the memory chunk used by the font data. */ + /* */ + /* face_index :: See @FT_Open_Face for a detailed description of this */ + /* parameter. */ + /* */ + /* <Output> */ + /* aface :: A handle to a new face object. If `face_index' is */ + /* greater than or equal to zero, it must be non-NULL. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* You must not deallocate the memory before calling @FT_Done_Face. */ + /* */ FT_EXPORT( FT_Error ) FT_New_Memory_Face( FT_Library library, const FT_Byte* file_base, @@ -2206,143 +2048,146 @@ FT_BEGIN_HEADER FT_Face *aface ); - /************************************************************************** - * - * @function: - * FT_Open_Face - * - * @description: - * Create a face object from a given resource described by @FT_Open_Args. - * - * @inout: - * library :: - * A handle to the library resource. - * - * @input: - * args :: - * A pointer to an `FT_Open_Args` structure that must be filled by the - * caller. - * - * face_index :: - * This field holds two different values. Bits 0-15 are the index of - * the face in the font file (starting with value~0). Set it to~0 if - * there is only one face in the font file. - * - * [Since 2.6.1] Bits 16-30 are relevant to GX and OpenType variation - * fonts only, specifying the named instance index for the current face - * index (starting with value~1; value~0 makes FreeType ignore named - * instances). For non-variation fonts, bits 16-30 are ignored. - * Assuming that you want to access the third named instance in face~4, - * `face_index` should be set to 0x00030004. If you want to access - * face~4 without variation handling, simply set `face_index` to - * value~4. - * - * `FT_Open_Face` and its siblings can be used to quickly check whether - * the font format of a given font resource is supported by FreeType. - * In general, if the `face_index` argument is negative, the function's - * return value is~0 if the font format is recognized, or non-zero - * otherwise. The function allocates a more or less empty face handle - * in `*aface` (if `aface` isn't `NULL`); the only two useful fields in - * this special case are `face->num_faces` and `face->style_flags`. - * For any negative value of `face_index`, `face->num_faces` gives the - * number of faces within the font file. For the negative value - * '-(N+1)' (with 'N' a non-negative 16-bit value), bits 16-30 in - * `face->style_flags` give the number of named instances in face 'N' - * if we have a variation font (or zero otherwise). After examination, - * the returned @FT_Face structure should be deallocated with a call to - * @FT_Done_Face. - * - * @output: - * aface :: - * A handle to a new face object. If `face_index` is greater than or - * equal to zero, it must be non-`NULL`. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * Unlike FreeType 1.x, this function automatically creates a glyph slot - * for the face object that can be accessed directly through - * `face->glyph`. - * - * Each new face object created with this function also owns a default - * @FT_Size object, accessible as `face->size`. - * - * One @FT_Library instance can have multiple face objects, this is, - * @FT_Open_Face and its siblings can be called multiple times using the - * same `library` argument. - * - * See the discussion of reference counters in the description of - * @FT_Reference_Face. - * - * @example: - * To loop over all faces, use code similar to the following snippet - * (omitting the error handling). - * - * ``` - * ... - * FT_Face face; - * FT_Long i, num_faces; - * - * - * error = FT_Open_Face( library, args, -1, &face ); - * if ( error ) { ... } - * - * num_faces = face->num_faces; - * FT_Done_Face( face ); - * - * for ( i = 0; i < num_faces; i++ ) - * { - * ... - * error = FT_Open_Face( library, args, i, &face ); - * ... - * FT_Done_Face( face ); - * ... - * } - * ``` - * - * To loop over all valid values for `face_index`, use something similar - * to the following snippet, again without error handling. The code - * accesses all faces immediately (thus only a single call of - * `FT_Open_Face` within the do-loop), with and without named instances. - * - * ``` - * ... - * FT_Face face; - * - * FT_Long num_faces = 0; - * FT_Long num_instances = 0; - * - * FT_Long face_idx = 0; - * FT_Long instance_idx = 0; - * - * - * do - * { - * FT_Long id = ( instance_idx << 16 ) + face_idx; - * - * - * error = FT_Open_Face( library, args, id, &face ); - * if ( error ) { ... } - * - * num_faces = face->num_faces; - * num_instances = face->style_flags >> 16; - * - * ... - * - * FT_Done_Face( face ); - * - * if ( instance_idx < num_instances ) - * instance_idx++; - * else - * { - * face_idx++; - * instance_idx = 0; - * } - * - * } while ( face_idx < num_faces ) - * ``` - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Open_Face */ + /* */ + /* <Description> */ + /* Create a face object from a given resource described by */ + /* @FT_Open_Args. */ + /* */ + /* <InOut> */ + /* library :: A handle to the library resource. */ + /* */ + /* <Input> */ + /* args :: A pointer to an `FT_Open_Args' structure that must */ + /* be filled by the caller. */ + /* */ + /* face_index :: This field holds two different values. Bits 0-15 */ + /* are the index of the face in the font file (starting */ + /* with value~0). Set it to~0 if there is only one */ + /* face in the font file. */ + /* */ + /* Bits 16-30 are relevant to GX variation fonts only, */ + /* specifying the named instance index for the current */ + /* face index (starting with value~1; value~0 makes */ + /* FreeType ignore named instances). For non-GX fonts, */ + /* bits 16-30 are ignored. Assuming that you want to */ + /* access the third named instance in face~4, */ + /* `face_index' should be set to 0x00030004. If you */ + /* want to access face~4 without GX variation handling, */ + /* simply set `face_index' to value~4. */ + /* */ + /* FT_Open_Face and its siblings can be used to quickly */ + /* check whether the font format of a given font */ + /* resource is supported by FreeType. In general, if */ + /* the `face_index' argument is negative, the */ + /* function's return value is~0 if the font format is */ + /* recognized, or non-zero otherwise. The function */ + /* allocates a more or less empty face handle in */ + /* `*aface' (if `aface' isn't NULL); the only two */ + /* useful fields in this special case are */ + /* `face->num_faces' and `face->style_flags'. For any */ + /* negative value of `face_index', `face->num_faces' */ + /* gives the number of faces within the font file. For */ + /* the negative value `-(N+1)' (with `N' a 16-bit */ + /* value), bits 16-30 in `face->style_flags' give the */ + /* number of named instances in face `N' if we have a */ + /* GX variation font (or zero otherwise). After */ + /* examination, the returned @FT_Face structure should */ + /* be deallocated with a call to @FT_Done_Face. */ + /* */ + /* <Output> */ + /* aface :: A handle to a new face object. If `face_index' is */ + /* greater than or equal to zero, it must be non-NULL. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* Unlike FreeType 1.x, this function automatically creates a glyph */ + /* slot for the face object that can be accessed directly through */ + /* `face->glyph'. */ + /* */ + /* Each new face object created with this function also owns a */ + /* default @FT_Size object, accessible as `face->size'. */ + /* */ + /* One @FT_Library instance can have multiple face objects, this is, */ + /* @FT_Open_Face and its siblings can be called multiple times using */ + /* the same `library' argument. */ + /* */ + /* See the discussion of reference counters in the description of */ + /* @FT_Reference_Face. */ + /* */ + /* To loop over all faces, use code similar to the following snippet */ + /* (omitting the error handling). */ + /* */ + /* { */ + /* ... */ + /* FT_Face face; */ + /* FT_Long i, num_faces; */ + /* */ + /* */ + /* error = FT_Open_Face( library, args, -1, &face ); */ + /* if ( error ) { ... } */ + /* */ + /* num_faces = face->num_faces; */ + /* FT_Done_Face( face ); */ + /* */ + /* for ( i = 0; i < num_faces; i++ ) */ + /* { */ + /* ... */ + /* error = FT_Open_Face( library, args, i, &face ); */ + /* ... */ + /* FT_Done_Face( face ); */ + /* ... */ + /* } */ + /* } */ + /* */ + /* To loop over all valid values for `face_index', use something */ + /* similar to the following snippet, again without error handling. */ + /* The code accesses all faces immediately (thus only a single call */ + /* of `FT_Open_Face' within the do-loop), with and without named */ + /* instances. */ + /* */ + /* { */ + /* ... */ + /* FT_Face face; */ + /* */ + /* FT_Long num_faces = 0; */ + /* FT_Long num_instances = 0; */ + /* */ + /* FT_Long face_idx = 0; */ + /* FT_Long instance_idx = 0; */ + /* */ + /* */ + /* do */ + /* { */ + /* FT_Long id = ( instance_idx << 16 ) + face_idx; */ + /* */ + /* */ + /* error = FT_Open_Face( library, args, id, &face ); */ + /* if ( error ) { ... } */ + /* */ + /* num_faces = face->num_faces; */ + /* num_instances = face->style_flags >> 16; */ + /* */ + /* ... */ + /* */ + /* FT_Done_Face( face ); */ + /* */ + /* if ( instance_idx < num_instances ) */ + /* instance_idx++; */ + /* else */ + /* { */ + /* face_idx++; */ + /* instance_idx = 0; */ + /* } */ + /* */ + /* } while ( face_idx < num_faces ) */ + /* } */ + /* */ FT_EXPORT( FT_Error ) FT_Open_Face( FT_Library library, const FT_Open_Args* args, @@ -2350,208 +2195,178 @@ FT_BEGIN_HEADER FT_Face *aface ); - /************************************************************************** - * - * @function: - * FT_Attach_File - * - * @description: - * Call @FT_Attach_Stream to attach a file. - * - * @inout: - * face :: - * The target face object. - * - * @input: - * filepathname :: - * The pathname. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Attach_File */ + /* */ + /* <Description> */ + /* This function calls @FT_Attach_Stream to attach a file. */ + /* */ + /* <InOut> */ + /* face :: The target face object. */ + /* */ + /* <Input> */ + /* filepathname :: The pathname. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Attach_File( FT_Face face, const char* filepathname ); - /************************************************************************** - * - * @function: - * FT_Attach_Stream - * - * @description: - * 'Attach' data to a face object. Normally, this is used to read - * additional information for the face object. For example, you can - * attach an AFM file that comes with a Type~1 font to get the kerning - * values and other metrics. - * - * @inout: - * face :: - * The target face object. - * - * @input: - * parameters :: - * A pointer to @FT_Open_Args that must be filled by the caller. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The meaning of the 'attach' (i.e., what really happens when the new - * file is read) is not fixed by FreeType itself. It really depends on - * the font format (and thus the font driver). - * - * Client applications are expected to know what they are doing when - * invoking this function. Most drivers simply do not implement file or - * stream attachments. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Attach_Stream */ + /* */ + /* <Description> */ + /* `Attach' data to a face object. Normally, this is used to read */ + /* additional information for the face object. For example, you can */ + /* attach an AFM file that comes with a Type~1 font to get the */ + /* kerning values and other metrics. */ + /* */ + /* <InOut> */ + /* face :: The target face object. */ + /* */ + /* <Input> */ + /* parameters :: A pointer to @FT_Open_Args that must be filled by */ + /* the caller. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The meaning of the `attach' (i.e., what really happens when the */ + /* new file is read) is not fixed by FreeType itself. It really */ + /* depends on the font format (and thus the font driver). */ + /* */ + /* Client applications are expected to know what they are doing */ + /* when invoking this function. Most drivers simply do not implement */ + /* file attachments. */ + /* */ FT_EXPORT( FT_Error ) FT_Attach_Stream( FT_Face face, FT_Open_Args* parameters ); - /************************************************************************** - * - * @function: - * FT_Reference_Face - * - * @description: - * A counter gets initialized to~1 at the time an @FT_Face structure is - * created. This function increments the counter. @FT_Done_Face then - * only destroys a face if the counter is~1, otherwise it simply - * decrements the counter. - * - * This function helps in managing life-cycles of structures that - * reference @FT_Face objects. - * - * @input: - * face :: - * A handle to a target face object. - * - * @return: - * FreeType error code. 0~means success. - * - * @since: - * 2.4.2 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Reference_Face */ + /* */ + /* <Description> */ + /* A counter gets initialized to~1 at the time an @FT_Face structure */ + /* is created. This function increments the counter. @FT_Done_Face */ + /* then only destroys a face if the counter is~1, otherwise it simply */ + /* decrements the counter. */ + /* */ + /* This function helps in managing life-cycles of structures that */ + /* reference @FT_Face objects. */ + /* */ + /* <Input> */ + /* face :: A handle to a target face object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Since> */ + /* 2.4.2 */ + /* */ FT_EXPORT( FT_Error ) FT_Reference_Face( FT_Face face ); - /************************************************************************** - * - * @function: - * FT_Done_Face - * - * @description: - * Discard a given face object, as well as all of its child slots and - * sizes. - * - * @input: - * face :: - * A handle to a target face object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * See the discussion of reference counters in the description of - * @FT_Reference_Face. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Done_Face */ + /* */ + /* <Description> */ + /* Discard a given face object, as well as all of its child slots and */ + /* sizes. */ + /* */ + /* <Input> */ + /* face :: A handle to a target face object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* See the discussion of reference counters in the description of */ + /* @FT_Reference_Face. */ + /* */ FT_EXPORT( FT_Error ) FT_Done_Face( FT_Face face ); - /************************************************************************** - * - * @function: - * FT_Select_Size - * - * @description: - * Select a bitmap strike. To be more precise, this function sets the - * scaling factors of the active @FT_Size object in a face so that - * bitmaps from this particular strike are taken by @FT_Load_Glyph and - * friends. - * - * @inout: - * face :: - * A handle to a target face object. - * - * @input: - * strike_index :: - * The index of the bitmap strike in the `available_sizes` field of - * @FT_FaceRec structure. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * For bitmaps embedded in outline fonts it is common that only a subset - * of the available glyphs at a given ppem value is available. FreeType - * silently uses outlines if there is no bitmap for a given glyph index. - * - * For GX and OpenType variation fonts, a bitmap strike makes sense only - * if the default instance is active (this is, no glyph variation takes - * place); otherwise, FreeType simply ignores bitmap strikes. The same - * is true for all named instances that are different from the default - * instance. - * - * Don't use this function if you are using the FreeType cache API. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Select_Size */ + /* */ + /* <Description> */ + /* Select a bitmap strike. */ + /* */ + /* <InOut> */ + /* face :: A handle to a target face object. */ + /* */ + /* <Input> */ + /* strike_index :: The index of the bitmap strike in the */ + /* `available_sizes' field of @FT_FaceRec structure. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Select_Size( FT_Face face, FT_Int strike_index ); - /************************************************************************** - * - * @enum: - * FT_Size_Request_Type - * - * @description: - * An enumeration type that lists the supported size request types, i.e., - * what input size (in font units) maps to the requested output size (in - * pixels, as computed from the arguments of @FT_Size_Request). - * - * @values: - * FT_SIZE_REQUEST_TYPE_NOMINAL :: - * The nominal size. The `units_per_EM` field of @FT_FaceRec is used - * to determine both scaling values. - * - * This is the standard scaling found in most applications. In - * particular, use this size request type for TrueType fonts if they - * provide optical scaling or something similar. Note, however, that - * `units_per_EM` is a rather abstract value which bears no relation to - * the actual size of the glyphs in a font. - * - * FT_SIZE_REQUEST_TYPE_REAL_DIM :: - * The real dimension. The sum of the `ascender` and (minus of) the - * `descender` fields of @FT_FaceRec is used to determine both scaling - * values. - * - * FT_SIZE_REQUEST_TYPE_BBOX :: - * The font bounding box. The width and height of the `bbox` field of - * @FT_FaceRec are used to determine the horizontal and vertical - * scaling value, respectively. - * - * FT_SIZE_REQUEST_TYPE_CELL :: - * The `max_advance_width` field of @FT_FaceRec is used to determine - * the horizontal scaling value; the vertical scaling value is - * determined the same way as @FT_SIZE_REQUEST_TYPE_REAL_DIM does. - * Finally, both scaling values are set to the smaller one. This type - * is useful if you want to specify the font size for, say, a window of - * a given dimension and 80x24 cells. - * - * FT_SIZE_REQUEST_TYPE_SCALES :: - * Specify the scaling values directly. - * - * @note: - * The above descriptions only apply to scalable formats. For bitmap - * formats, the behaviour is up to the driver. - * - * See the note section of @FT_Size_Metrics if you wonder how size - * requesting relates to scaling values. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_Size_Request_Type */ + /* */ + /* <Description> */ + /* An enumeration type that lists the supported size request types. */ + /* */ + /* <Values> */ + /* FT_SIZE_REQUEST_TYPE_NOMINAL :: */ + /* The nominal size. The `units_per_EM' field of @FT_FaceRec is */ + /* used to determine both scaling values. */ + /* */ + /* FT_SIZE_REQUEST_TYPE_REAL_DIM :: */ + /* The real dimension. The sum of the the `ascender' and (minus */ + /* of) the `descender' fields of @FT_FaceRec are used to determine */ + /* both scaling values. */ + /* */ + /* FT_SIZE_REQUEST_TYPE_BBOX :: */ + /* The font bounding box. The width and height of the `bbox' field */ + /* of @FT_FaceRec are used to determine the horizontal and vertical */ + /* scaling value, respectively. */ + /* */ + /* FT_SIZE_REQUEST_TYPE_CELL :: */ + /* The `max_advance_width' field of @FT_FaceRec is used to */ + /* determine the horizontal scaling value; the vertical scaling */ + /* value is determined the same way as */ + /* @FT_SIZE_REQUEST_TYPE_REAL_DIM does. Finally, both scaling */ + /* values are set to the smaller one. This type is useful if you */ + /* want to specify the font size for, say, a window of a given */ + /* dimension and 80x24 cells. */ + /* */ + /* FT_SIZE_REQUEST_TYPE_SCALES :: */ + /* Specify the scaling values directly. */ + /* */ + /* <Note> */ + /* The above descriptions only apply to scalable formats. For bitmap */ + /* formats, the behaviour is up to the driver. */ + /* */ + /* See the note section of @FT_Size_Metrics if you wonder how size */ + /* requesting relates to scaling values. */ + /* */ typedef enum FT_Size_Request_Type_ { FT_SIZE_REQUEST_TYPE_NOMINAL, @@ -2565,45 +2380,33 @@ FT_BEGIN_HEADER } FT_Size_Request_Type; - /************************************************************************** - * - * @struct: - * FT_Size_RequestRec - * - * @description: - * A structure to model a size request. - * - * @fields: - * type :: - * See @FT_Size_Request_Type. - * - * width :: - * The desired width, given as a 26.6 fractional point value (with 72pt - * = 1in). - * - * height :: - * The desired height, given as a 26.6 fractional point value (with - * 72pt = 1in). - * - * horiResolution :: - * The horizontal resolution (dpi, i.e., pixels per inch). If set to - * zero, `width` is treated as a 26.6 fractional **pixel** value, which - * gets internally rounded to an integer. - * - * vertResolution :: - * The vertical resolution (dpi, i.e., pixels per inch). If set to - * zero, `height` is treated as a 26.6 fractional **pixel** value, - * which gets internally rounded to an integer. - * - * @note: - * If `width` is zero, the horizontal scaling value is set equal to the - * vertical scaling value, and vice versa. - * - * If `type` is `FT_SIZE_REQUEST_TYPE_SCALES`, `width` and `height` are - * interpreted directly as 16.16 fractional scaling values, without any - * further modification, and both `horiResolution` and `vertResolution` - * are ignored. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Size_RequestRec */ + /* */ + /* <Description> */ + /* A structure used to model a size request. */ + /* */ + /* <Fields> */ + /* type :: See @FT_Size_Request_Type. */ + /* */ + /* width :: The desired width. */ + /* */ + /* height :: The desired height. */ + /* */ + /* horiResolution :: The horizontal resolution. If set to zero, */ + /* `width' is treated as a 26.6 fractional pixel */ + /* value. */ + /* */ + /* vertResolution :: The vertical resolution. If set to zero, */ + /* `height' is treated as a 26.6 fractional pixel */ + /* value. */ + /* */ + /* <Note> */ + /* If `width' is zero, then the horizontal scaling value is set equal */ + /* to the vertical scaling value, and vice versa. */ + /* */ typedef struct FT_Size_RequestRec_ { FT_Size_Request_Type type; @@ -2615,102 +2418,89 @@ FT_BEGIN_HEADER } FT_Size_RequestRec; - /************************************************************************** - * - * @struct: - * FT_Size_Request - * - * @description: - * A handle to a size request structure. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Size_Request */ + /* */ + /* <Description> */ + /* A handle to a size request structure. */ + /* */ typedef struct FT_Size_RequestRec_ *FT_Size_Request; - /************************************************************************** - * - * @function: - * FT_Request_Size - * - * @description: - * Resize the scale of the active @FT_Size object in a face. - * - * @inout: - * face :: - * A handle to a target face object. - * - * @input: - * req :: - * A pointer to a @FT_Size_RequestRec. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * Although drivers may select the bitmap strike matching the request, - * you should not rely on this if you intend to select a particular - * bitmap strike. Use @FT_Select_Size instead in that case. - * - * The relation between the requested size and the resulting glyph size - * is dependent entirely on how the size is defined in the source face. - * The font designer chooses the final size of each glyph relative to - * this size. For more information refer to - * 'https://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html'. - * - * Contrary to @FT_Set_Char_Size, this function doesn't have special code - * to normalize zero-valued widths, heights, or resolutions (which lead - * to errors in most cases). - * - * Don't use this function if you are using the FreeType cache API. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Request_Size */ + /* */ + /* <Description> */ + /* Resize the scale of the active @FT_Size object in a face. */ + /* */ + /* <InOut> */ + /* face :: A handle to a target face object. */ + /* */ + /* <Input> */ + /* req :: A pointer to a @FT_Size_RequestRec. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* Although drivers may select the bitmap strike matching the */ + /* request, you should not rely on this if you intend to select a */ + /* particular bitmap strike. Use @FT_Select_Size instead in that */ + /* case. */ + /* */ + /* The relation between the requested size and the resulting glyph */ + /* size is dependent entirely on how the size is defined in the */ + /* source face. The font designer chooses the final size of each */ + /* glyph relative to this size. For more information refer to */ + /* `http://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html' */ + /* */ + /* Don't use this function if you are using the FreeType cache API. */ + /* */ FT_EXPORT( FT_Error ) FT_Request_Size( FT_Face face, FT_Size_Request req ); - /************************************************************************** - * - * @function: - * FT_Set_Char_Size - * - * @description: - * Call @FT_Request_Size to request the nominal size (in points). - * - * @inout: - * face :: - * A handle to a target face object. - * - * @input: - * char_width :: - * The nominal width, in 26.6 fractional points. - * - * char_height :: - * The nominal height, in 26.6 fractional points. - * - * horz_resolution :: - * The horizontal resolution in dpi. - * - * vert_resolution :: - * The vertical resolution in dpi. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * While this function allows fractional points as input values, the - * resulting ppem value for the given resolution is always rounded to the - * nearest integer. - * - * If either the character width or height is zero, it is set equal to - * the other value. - * - * If either the horizontal or vertical resolution is zero, it is set - * equal to the other value. - * - * A character width or height smaller than 1pt is set to 1pt; if both - * resolution values are zero, they are set to 72dpi. - * - * Don't use this function if you are using the FreeType cache API. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Set_Char_Size */ + /* */ + /* <Description> */ + /* This function calls @FT_Request_Size to request the nominal size */ + /* (in points). */ + /* */ + /* <InOut> */ + /* face :: A handle to a target face object. */ + /* */ + /* <Input> */ + /* char_width :: The nominal width, in 26.6 fractional points. */ + /* */ + /* char_height :: The nominal height, in 26.6 fractional points. */ + /* */ + /* horz_resolution :: The horizontal resolution in dpi. */ + /* */ + /* vert_resolution :: The vertical resolution in dpi. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* If either the character width or height is zero, it is set equal */ + /* to the other value. */ + /* */ + /* If either the horizontal or vertical resolution is zero, it is set */ + /* equal to the other value. */ + /* */ + /* A character width or height smaller than 1pt is set to 1pt; if */ + /* both resolution values are zero, they are set to 72dpi. */ + /* */ + /* Don't use this function if you are using the FreeType cache API. */ + /* */ FT_EXPORT( FT_Error ) FT_Set_Char_Size( FT_Face face, FT_F26Dot6 char_width, @@ -2719,138 +2509,124 @@ FT_BEGIN_HEADER FT_UInt vert_resolution ); - /************************************************************************** - * - * @function: - * FT_Set_Pixel_Sizes - * - * @description: - * Call @FT_Request_Size to request the nominal size (in pixels). - * - * @inout: - * face :: - * A handle to the target face object. - * - * @input: - * pixel_width :: - * The nominal width, in pixels. - * - * pixel_height :: - * The nominal height, in pixels. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * You should not rely on the resulting glyphs matching or being - * constrained to this pixel size. Refer to @FT_Request_Size to - * understand how requested sizes relate to actual sizes. - * - * Don't use this function if you are using the FreeType cache API. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Set_Pixel_Sizes */ + /* */ + /* <Description> */ + /* This function calls @FT_Request_Size to request the nominal size */ + /* (in pixels). */ + /* */ + /* <InOut> */ + /* face :: A handle to the target face object. */ + /* */ + /* <Input> */ + /* pixel_width :: The nominal width, in pixels. */ + /* */ + /* pixel_height :: The nominal height, in pixels. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* You should not rely on the resulting glyphs matching, or being */ + /* constrained, to this pixel size. Refer to @FT_Request_Size to */ + /* understand how requested sizes relate to actual sizes. */ + /* */ + /* Don't use this function if you are using the FreeType cache API. */ + /* */ FT_EXPORT( FT_Error ) FT_Set_Pixel_Sizes( FT_Face face, FT_UInt pixel_width, FT_UInt pixel_height ); - /************************************************************************** - * - * @function: - * FT_Load_Glyph - * - * @description: - * Load a glyph into the glyph slot of a face object. - * - * @inout: - * face :: - * A handle to the target face object where the glyph is loaded. - * - * @input: - * glyph_index :: - * The index of the glyph in the font file. For CID-keyed fonts - * (either in PS or in CFF format) this argument specifies the CID - * value. - * - * load_flags :: - * A flag indicating what to load for this glyph. The @FT_LOAD_XXX - * constants can be used to control the glyph loading process (e.g., - * whether the outline should be scaled, whether to load bitmaps or - * not, whether to hint the outline, etc). - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The loaded glyph may be transformed. See @FT_Set_Transform for the - * details. - * - * For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument` is returned - * for invalid CID values (this is, for CID values that don't have a - * corresponding glyph in the font). See the discussion of the - * @FT_FACE_FLAG_CID_KEYED flag for more details. - * - * If you receive `FT_Err_Glyph_Too_Big`, try getting the glyph outline - * at EM size, then scale it manually and fill it as a graphics - * operation. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Load_Glyph */ + /* */ + /* <Description> */ + /* A function used to load a single glyph into the glyph slot of a */ + /* face object. */ + /* */ + /* <InOut> */ + /* face :: A handle to the target face object where the glyph */ + /* is loaded. */ + /* */ + /* <Input> */ + /* glyph_index :: The index of the glyph in the font file. For */ + /* CID-keyed fonts (either in PS or in CFF format) */ + /* this argument specifies the CID value. */ + /* */ + /* load_flags :: A flag indicating what to load for this glyph. The */ + /* @FT_LOAD_XXX constants can be used to control the */ + /* glyph loading process (e.g., whether the outline */ + /* should be scaled, whether to load bitmaps or not, */ + /* whether to hint the outline, etc). */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The loaded glyph may be transformed. See @FT_Set_Transform for */ + /* the details. */ + /* */ + /* For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument' is */ + /* returned for invalid CID values (this is, for CID values that */ + /* don't have a corresponding glyph in the font). See the discussion */ + /* of the @FT_FACE_FLAG_CID_KEYED flag for more details. */ + /* */ FT_EXPORT( FT_Error ) FT_Load_Glyph( FT_Face face, FT_UInt glyph_index, FT_Int32 load_flags ); - /************************************************************************** - * - * @function: - * FT_Load_Char - * - * @description: - * Load a glyph into the glyph slot of a face object, accessed by its - * character code. - * - * @inout: - * face :: - * A handle to a target face object where the glyph is loaded. - * - * @input: - * char_code :: - * The glyph's character code, according to the current charmap used in - * the face. - * - * load_flags :: - * A flag indicating what to load for this glyph. The @FT_LOAD_XXX - * constants can be used to control the glyph loading process (e.g., - * whether the outline should be scaled, whether to load bitmaps or - * not, whether to hint the outline, etc). - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function simply calls @FT_Get_Char_Index and @FT_Load_Glyph. - * - * Many fonts contain glyphs that can't be loaded by this function since - * its glyph indices are not listed in any of the font's charmaps. - * - * If no active cmap is set up (i.e., `face->charmap` is zero), the call - * to @FT_Get_Char_Index is omitted, and the function behaves identically - * to @FT_Load_Glyph. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Load_Char */ + /* */ + /* <Description> */ + /* A function used to load a single glyph into the glyph slot of a */ + /* face object, according to its character code. */ + /* */ + /* <InOut> */ + /* face :: A handle to a target face object where the glyph */ + /* is loaded. */ + /* */ + /* <Input> */ + /* char_code :: The glyph's character code, according to the */ + /* current charmap used in the face. */ + /* */ + /* load_flags :: A flag indicating what to load for this glyph. The */ + /* @FT_LOAD_XXX constants can be used to control the */ + /* glyph loading process (e.g., whether the outline */ + /* should be scaled, whether to load bitmaps or not, */ + /* whether to hint the outline, etc). */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* This function simply calls @FT_Get_Char_Index and @FT_Load_Glyph. */ + /* */ FT_EXPORT( FT_Error ) FT_Load_Char( FT_Face face, FT_ULong char_code, FT_Int32 load_flags ); - /************************************************************************** + /************************************************************************* * * @enum: * FT_LOAD_XXX * * @description: - * A list of bit field constants for @FT_Load_Glyph to indicate what kind - * of operations to perform during glyph loading. + * A list of bit field constants used with @FT_Load_Glyph to indicate + * what kind of operations to perform during glyph loading. * * @values: * FT_LOAD_DEFAULT :: @@ -2858,16 +2634,17 @@ FT_BEGIN_HEADER * operation. In this case, the following happens: * * 1. FreeType looks for a bitmap for the glyph corresponding to the - * face's current size. If one is found, the function returns. The - * bitmap data can be accessed from the glyph slot (see note below). + * face's current size. If one is found, the function returns. + * The bitmap data can be accessed from the glyph slot (see note + * below). * - * 2. If no embedded bitmap is searched for or found, FreeType looks - * for a scalable outline. If one is found, it is loaded from the font - * file, scaled to device pixels, then 'hinted' to the pixel grid in - * order to optimize it. The outline data can be accessed from the - * glyph slot (see note below). + * 2. If no embedded bitmap is searched or found, FreeType looks for a + * scalable outline. If one is found, it is loaded from the font + * file, scaled to device pixels, then `hinted' to the pixel grid + * in order to optimize it. The outline data can be accessed from + * the glyph slot (see note below). * - * Note that by default the glyph loader doesn't render outlines into + * Note that by default, the glyph loader doesn't render outlines into * bitmaps. The following flags are used to modify this default * behaviour to more specific and useful cases. * @@ -2877,14 +2654,14 @@ FT_BEGIN_HEADER * This flag implies @FT_LOAD_NO_HINTING and @FT_LOAD_NO_BITMAP, and * unsets @FT_LOAD_RENDER. * - * If the font is 'tricky' (see @FT_FACE_FLAG_TRICKY for more), using - * `FT_LOAD_NO_SCALE` usually yields meaningless outlines because the - * subglyphs must be scaled and positioned with hinting instructions. - * This can be solved by loading the font without `FT_LOAD_NO_SCALE` - * and setting the character size to `font->units_per_EM`. + * If the font is `tricky' (see @FT_FACE_FLAG_TRICKY for more), using + * FT_LOAD_NO_SCALE usually yields meaningless outlines because the + * subglyphs must be scaled and positioned with hinting instructions. + * This can be solved by loading the font without FT_LOAD_NO_SCALE and + * setting the character size to `font->units_per_EM'. * * FT_LOAD_NO_HINTING :: - * Disable hinting. This generally generates 'blurrier' bitmap glyphs + * Disable hinting. This generally generates `blurrier' bitmap glyphs * when the glyph are rendered in any of the anti-aliased modes. See * also the note below. * @@ -2905,42 +2682,40 @@ FT_BEGIN_HEADER * * FT_LOAD_VERTICAL_LAYOUT :: * Load the glyph for vertical text layout. In particular, the - * `advance` value in the @FT_GlyphSlotRec structure is set to the - * `vertAdvance` value of the `metrics` field. + * `advance' value in the @FT_GlyphSlotRec structure is set to the + * `vertAdvance' value of the `metrics' field. * - * In case @FT_HAS_VERTICAL doesn't return true, you shouldn't use this - * flag currently. Reason is that in this case vertical metrics get - * synthesized, and those values are not always consistent across + * In case @FT_HAS_VERTICAL doesn't return true, you shouldn't use + * this flag currently. Reason is that in this case vertical metrics + * get synthesized, and those values are not always consistent across * various font formats. * * FT_LOAD_FORCE_AUTOHINT :: - * Prefer the auto-hinter over the font's native hinter. See also the - * note below. + * Indicates that the auto-hinter is preferred over the font's native + * hinter. See also the note below. * * FT_LOAD_PEDANTIC :: - * Make the font driver perform pedantic verifications during glyph - * loading and hinting. This is mostly used to detect broken glyphs in - * fonts. By default, FreeType tries to handle broken fonts also. + * Indicates that the font driver should perform pedantic verifications + * during glyph loading. This is mostly used to detect broken glyphs + * in fonts. By default, FreeType tries to handle broken fonts also. * * In particular, errors from the TrueType bytecode engine are not - * passed to the application if this flag is not set; this might result - * in partially hinted or distorted glyphs in case a glyph's bytecode - * is buggy. + * passed to the application if this flag is not set; this might + * result in partially hinted or distorted glyphs in case a glyph's + * bytecode is buggy. * * FT_LOAD_NO_RECURSE :: - * Don't load composite glyphs recursively. Instead, the font driver - * fills the `num_subglyph` and `subglyphs` values of the glyph slot; - * it also sets `glyph->format` to @FT_GLYPH_FORMAT_COMPOSITE. The - * description of subglyphs can then be accessed with - * @FT_Get_SubGlyph_Info. - * - * Don't use this flag for retrieving metrics information since some - * font drivers only return rudimentary data. + * Indicate that the font driver should not load composite glyphs + * recursively. Instead, it should set the `num_subglyph' and + * `subglyphs' values of the glyph slot accordingly, and set + * `glyph->format' to @FT_GLYPH_FORMAT_COMPOSITE. The description of + * subglyphs can then be accessed with @FT_Get_SubGlyph_Info. * * This flag implies @FT_LOAD_NO_SCALE and @FT_LOAD_IGNORE_TRANSFORM. * * FT_LOAD_IGNORE_TRANSFORM :: - * Ignore the transform matrix set by @FT_Set_Transform. + * Indicates that the transform matrix set by @FT_Set_Transform should + * be ignored. * * FT_LOAD_MONOCHROME :: * This flag is used with @FT_LOAD_RENDER to indicate that you want to @@ -2952,49 +2727,31 @@ FT_BEGIN_HEADER * monochrome-optimized hinting algorithm is used. * * FT_LOAD_LINEAR_DESIGN :: - * Keep `linearHoriAdvance` and `linearVertAdvance` fields of - * @FT_GlyphSlotRec in font units. See @FT_GlyphSlotRec for details. + * Indicates that the `linearHoriAdvance' and `linearVertAdvance' + * fields of @FT_GlyphSlotRec should be kept in font units. See + * @FT_GlyphSlotRec for details. * * FT_LOAD_NO_AUTOHINT :: - * Disable the auto-hinter. See also the note below. + * Disable auto-hinter. See also the note below. * * FT_LOAD_COLOR :: - * Load colored glyphs. There are slight differences depending on the - * font format. - * - * [Since 2.5] Load embedded color bitmap images. The resulting color - * bitmaps, if available, will have the @FT_PIXEL_MODE_BGRA format, - * with pre-multiplied color channels. If the flag is not set and - * color bitmaps are found, they are converted to 256-level gray - * bitmaps, using the @FT_PIXEL_MODE_GRAY format. - * - * [Since 2.10, experimental] If the glyph index contains an entry in - * the face's 'COLR' table with a 'CPAL' palette table (as defined in - * the OpenType specification), make @FT_Render_Glyph provide a default - * blending of the color glyph layers associated with the glyph index, - * using the same bitmap format as embedded color bitmap images. This - * is mainly for convenience; for full control of color layers use - * @FT_Get_Color_Glyph_Layer and FreeType's color functions like - * @FT_Palette_Select instead of setting @FT_LOAD_COLOR for rendering - * so that the client application can handle blending by itself. + * This flag is used to request loading of color embedded-bitmap + * images. The resulting color bitmaps, if available, will have the + * @FT_PIXEL_MODE_BGRA format. When the flag is not used and color + * bitmaps are found, they will be converted to 256-level gray + * bitmaps transparently. Those bitmaps will be in the + * @FT_PIXEL_MODE_GRAY format. * * FT_LOAD_COMPUTE_METRICS :: - * [Since 2.6.1] Compute glyph metrics from the glyph data, without the - * use of bundled metrics tables (for example, the 'hdmx' table in - * TrueType fonts). This flag is mainly used by font validating or - * font editing applications, which need to ignore, verify, or edit - * those tables. + * This flag sets computing glyph metrics without the use of bundled + * metrics tables (for example, the `hdmx' table in TrueType fonts). + * Well-behaving fonts have optimized bundled metrics and these should + * be used. This flag is mainly used by font validating or font + * editing applications, which need to ignore, verify, or edit those + * tables. * * Currently, this flag is only implemented for TrueType fonts. * - * FT_LOAD_BITMAP_METRICS_ONLY :: - * [Since 2.7.1] Request loading of the metrics and bitmap image - * information of a (possibly embedded) bitmap glyph without allocating - * or copying the bitmap image data itself. No effect if the target - * glyph is not a bitmap image. - * - * This flag unsets @FT_LOAD_RENDER. - * * FT_LOAD_CROP_BITMAP :: * Ignored. Deprecated. * @@ -3006,8 +2763,8 @@ FT_BEGIN_HEADER * @FT_FACE_FLAG_HINTER) is preferred over the auto-hinter. You can * disable hinting by setting @FT_LOAD_NO_HINTING or change the * precedence by setting @FT_LOAD_FORCE_AUTOHINT. You can also set - * @FT_LOAD_NO_AUTOHINT in case you don't want the auto-hinter to be used - * at all. + * @FT_LOAD_NO_AUTOHINT in case you don't want the auto-hinter to be + * used at all. * * See the description of @FT_FACE_FLAG_TRICKY for a special exception * (affecting only a handful of Asian fonts). @@ -3018,7 +2775,7 @@ FT_BEGIN_HEADER * Note that the auto-hinter needs a valid Unicode cmap (either a native * one or synthesized by FreeType) for producing correct results. If a * font provides an incorrect mapping (for example, assigning the - * character code U+005A, LATIN CAPITAL LETTER~Z, to a glyph depicting a + * character code U+005A, LATIN CAPITAL LETTER Z, to a glyph depicting a * mathematical integral sign), the auto-hinter might produce useless * results. * @@ -3038,14 +2795,13 @@ FT_BEGIN_HEADER #define FT_LOAD_MONOCHROME ( 1L << 12 ) #define FT_LOAD_LINEAR_DESIGN ( 1L << 13 ) #define FT_LOAD_NO_AUTOHINT ( 1L << 15 ) - /* Bits 16-19 are used by `FT_LOAD_TARGET_` */ + /* Bits 16..19 are used by `FT_LOAD_TARGET_' */ #define FT_LOAD_COLOR ( 1L << 20 ) #define FT_LOAD_COMPUTE_METRICS ( 1L << 21 ) -#define FT_LOAD_BITMAP_METRICS_ONLY ( 1L << 22 ) /* */ - /* used internally only by certain font drivers */ + /* used internally only by certain font drivers! */ #define FT_LOAD_ADVANCE_ONLY ( 1L << 8 ) #define FT_LOAD_SBITS_ONLY ( 1L << 14 ) @@ -3056,52 +2812,37 @@ FT_BEGIN_HEADER * FT_LOAD_TARGET_XXX * * @description: - * A list of values to select a specific hinting algorithm for the - * hinter. You should OR one of these values to your `load_flags` when - * calling @FT_Load_Glyph. + * A list of values that are used to select a specific hinting algorithm + * to use by the hinter. You should OR one of these values to your + * `load_flags' when calling @FT_Load_Glyph. * - * Note that a font's native hinters may ignore the hinting algorithm you + * Note that font's native hinters may ignore the hinting algorithm you * have specified (e.g., the TrueType bytecode interpreter). You can set * @FT_LOAD_FORCE_AUTOHINT to ensure that the auto-hinter is used. * * @values: * FT_LOAD_TARGET_NORMAL :: - * The default hinting algorithm, optimized for standard gray-level - * rendering. For monochrome output, use @FT_LOAD_TARGET_MONO instead. + * This corresponds to the default hinting algorithm, optimized for + * standard gray-level rendering. For monochrome output, use + * @FT_LOAD_TARGET_MONO instead. * * FT_LOAD_TARGET_LIGHT :: * A lighter hinting algorithm for gray-level modes. Many generated * glyphs are fuzzier but better resemble their original shape. This * is achieved by snapping glyphs to the pixel grid only vertically - * (Y-axis), as is done by FreeType's new CFF engine or Microsoft's - * ClearType font renderer. This preserves inter-glyph spacing in + * (Y-axis), as is done by Microsoft's ClearType and Adobe's + * proprietary font renderer. This preserves inter-glyph spacing in * horizontal text. The snapping is done either by the native font - * driver, if the driver itself and the font support it, or by the + * driver if the driver itself and the font support it or by the * auto-hinter. * - * Advance widths are rounded to integer values; however, using the - * `lsb_delta` and `rsb_delta` fields of @FT_GlyphSlotRec, it is - * possible to get fractional advance widths for subpixel positioning - * (which is recommended to use). - * - * If configuration option `AF_CONFIG_OPTION_TT_SIZE_METRICS` is - * active, TrueType-like metrics are used to make this mode behave - * similarly as in unpatched FreeType versions between 2.4.6 and 2.7.1 - * (inclusive). - * * FT_LOAD_TARGET_MONO :: * Strong hinting algorithm that should only be used for monochrome * output. The result is probably unpleasant if the glyph is rendered * in non-monochrome modes. * - * Note that for outline fonts only the TrueType font driver has proper - * monochrome hinting support, provided the TTFs contain hints for B/W - * rendering (which most fonts no longer provide). If these conditions - * are not met it is very likely that you get ugly results at smaller - * sizes. - * * FT_LOAD_TARGET_LCD :: - * A variant of @FT_LOAD_TARGET_LIGHT optimized for horizontally + * A variant of @FT_LOAD_TARGET_NORMAL optimized for horizontally * decimated LCD displays. * * FT_LOAD_TARGET_LCD_V :: @@ -3109,32 +2850,25 @@ FT_BEGIN_HEADER * decimated LCD displays. * * @note: - * You should use only _one_ of the `FT_LOAD_TARGET_XXX` values in your - * `load_flags`. They can't be ORed. + * You should use only _one_ of the FT_LOAD_TARGET_XXX values in your + * `load_flags'. They can't be ORed. * * If @FT_LOAD_RENDER is also set, the glyph is rendered in the * corresponding mode (i.e., the mode that matches the used algorithm - * best). An exception is `FT_LOAD_TARGET_MONO` since it implies + * best). An exeption is FT_LOAD_TARGET_MONO since it implies * @FT_LOAD_MONOCHROME. * * You can use a hinting algorithm that doesn't correspond to the same - * rendering mode. As an example, it is possible to use the 'light' + * rendering mode. As an example, it is possible to use the `light' * hinting algorithm and have the results rendered in horizontal LCD * pixel mode, with code like * - * ``` - * FT_Load_Glyph( face, glyph_index, - * load_flags | FT_LOAD_TARGET_LIGHT ); + * { + * FT_Load_Glyph( face, glyph_index, + * load_flags | FT_LOAD_TARGET_LIGHT ); * - * FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD ); - * ``` - * - * In general, you should stick with one rendering mode. For example, - * switching between @FT_LOAD_TARGET_NORMAL and @FT_LOAD_TARGET_MONO - * enforces a lot of recomputation for TrueType fonts, which is slow. - * Another reason is caching: Selecting a different mode usually causes - * changes in both the outlines and the rasterized bitmaps; it is thus - * necessary to empty the cache after a mode switch to avoid false hits. + * FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD ); + * } * */ #define FT_LOAD_TARGET_( x ) ( (FT_Int32)( (x) & 15 ) << 16 ) @@ -3159,98 +2893,98 @@ FT_BEGIN_HEADER #define FT_LOAD_TARGET_MODE( x ) ( (FT_Render_Mode)( ( (x) >> 16 ) & 15 ) ) - /************************************************************************** - * - * @function: - * FT_Set_Transform - * - * @description: - * Set the transformation that is applied to glyph images when they are - * loaded into a glyph slot through @FT_Load_Glyph. - * - * @inout: - * face :: - * A handle to the source face object. - * - * @input: - * matrix :: - * A pointer to the transformation's 2x2 matrix. Use `NULL` for the - * identity matrix. - * delta :: - * A pointer to the translation vector. Use `NULL` for the null vector. - * - * @note: - * The transformation is only applied to scalable image formats after the - * glyph has been loaded. It means that hinting is unaltered by the - * transformation and is performed on the character size given in the - * last call to @FT_Set_Char_Size or @FT_Set_Pixel_Sizes. - * - * Note that this also transforms the `face.glyph.advance` field, but - * **not** the values in `face.glyph.metrics`. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Set_Transform */ + /* */ + /* <Description> */ + /* A function used to set the transformation that is applied to glyph */ + /* images when they are loaded into a glyph slot through */ + /* @FT_Load_Glyph. */ + /* */ + /* <InOut> */ + /* face :: A handle to the source face object. */ + /* */ + /* <Input> */ + /* matrix :: A pointer to the transformation's 2x2 matrix. Use~0 for */ + /* the identity matrix. */ + /* delta :: A pointer to the translation vector. Use~0 for the null */ + /* vector. */ + /* */ + /* <Note> */ + /* The transformation is only applied to scalable image formats after */ + /* the glyph has been loaded. It means that hinting is unaltered by */ + /* the transformation and is performed on the character size given in */ + /* the last call to @FT_Set_Char_Size or @FT_Set_Pixel_Sizes. */ + /* */ + /* Note that this also transforms the `face.glyph.advance' field, but */ + /* *not* the values in `face.glyph.metrics'. */ + /* */ FT_EXPORT( void ) FT_Set_Transform( FT_Face face, FT_Matrix* matrix, FT_Vector* delta ); - /************************************************************************** - * - * @enum: - * FT_Render_Mode - * - * @description: - * Render modes supported by FreeType~2. Each mode corresponds to a - * specific type of scanline conversion performed on the outline. - * - * For bitmap fonts and embedded bitmaps the `bitmap->pixel_mode` field - * in the @FT_GlyphSlotRec structure gives the format of the returned - * bitmap. - * - * All modes except @FT_RENDER_MODE_MONO use 256 levels of opacity, - * indicating pixel coverage. Use linear alpha blending and gamma - * correction to correctly render non-monochrome glyph bitmaps onto a - * surface; see @FT_Render_Glyph. - * - * @values: - * FT_RENDER_MODE_NORMAL :: - * Default render mode; it corresponds to 8-bit anti-aliased bitmaps. - * - * FT_RENDER_MODE_LIGHT :: - * This is equivalent to @FT_RENDER_MODE_NORMAL. It is only defined as - * a separate value because render modes are also used indirectly to - * define hinting algorithm selectors. See @FT_LOAD_TARGET_XXX for - * details. - * - * FT_RENDER_MODE_MONO :: - * This mode corresponds to 1-bit bitmaps (with 2~levels of opacity). - * - * FT_RENDER_MODE_LCD :: - * This mode corresponds to horizontal RGB and BGR subpixel displays - * like LCD screens. It produces 8-bit bitmaps that are 3~times the - * width of the original glyph outline in pixels, and which use the - * @FT_PIXEL_MODE_LCD mode. - * - * FT_RENDER_MODE_LCD_V :: - * This mode corresponds to vertical RGB and BGR subpixel displays - * (like PDA screens, rotated LCD displays, etc.). It produces 8-bit - * bitmaps that are 3~times the height of the original glyph outline in - * pixels and use the @FT_PIXEL_MODE_LCD_V mode. - * - * @note: - * Should you define `FT_CONFIG_OPTION_SUBPIXEL_RENDERING` in your - * `ftoption.h`, which enables patented ClearType-style rendering, the - * LCD-optimized glyph bitmaps should be filtered to reduce color fringes - * inherent to this technology. You can either set up LCD filtering with - * @FT_Library_SetLcdFilter or @FT_Face_Properties, or do the filtering - * yourself. The default FreeType LCD rendering technology does not - * require filtering. - * - * The selected render mode only affects vector glyphs of a font. - * Embedded bitmaps often have a different pixel mode like - * @FT_PIXEL_MODE_MONO. You can use @FT_Bitmap_Convert to transform them - * into 8-bit pixmaps. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_Render_Mode */ + /* */ + /* <Description> */ + /* An enumeration type that lists the render modes supported by */ + /* FreeType~2. Each mode corresponds to a specific type of scanline */ + /* conversion performed on the outline. */ + /* */ + /* For bitmap fonts and embedded bitmaps the `bitmap->pixel_mode' */ + /* field in the @FT_GlyphSlotRec structure gives the format of the */ + /* returned bitmap. */ + /* */ + /* All modes except @FT_RENDER_MODE_MONO use 256 levels of opacity, */ + /* indicating pixel coverage. Use linear alpha blending and gamma */ + /* correction to correctly render non-monochrome glyph bitmaps onto a */ + /* surface; see @FT_Render_Glyph. */ + /* */ + /* <Values> */ + /* FT_RENDER_MODE_NORMAL :: */ + /* This is the default render mode; it corresponds to 8-bit */ + /* anti-aliased bitmaps. */ + /* */ + /* FT_RENDER_MODE_LIGHT :: */ + /* This is equivalent to @FT_RENDER_MODE_NORMAL. It is only */ + /* defined as a separate value because render modes are also used */ + /* indirectly to define hinting algorithm selectors. See */ + /* @FT_LOAD_TARGET_XXX for details. */ + /* */ + /* FT_RENDER_MODE_MONO :: */ + /* This mode corresponds to 1-bit bitmaps (with 2~levels of */ + /* opacity). */ + /* */ + /* FT_RENDER_MODE_LCD :: */ + /* This mode corresponds to horizontal RGB and BGR sub-pixel */ + /* displays like LCD screens. It produces 8-bit bitmaps that are */ + /* 3~times the width of the original glyph outline in pixels, and */ + /* which use the @FT_PIXEL_MODE_LCD mode. */ + /* */ + /* FT_RENDER_MODE_LCD_V :: */ + /* This mode corresponds to vertical RGB and BGR sub-pixel displays */ + /* (like PDA screens, rotated LCD displays, etc.). It produces */ + /* 8-bit bitmaps that are 3~times the height of the original */ + /* glyph outline in pixels and use the @FT_PIXEL_MODE_LCD_V mode. */ + /* */ + /* <Note> */ + /* The LCD-optimized glyph bitmaps produced by FT_Render_Glyph can be */ + /* filtered to reduce color-fringes by using @FT_Library_SetLcdFilter */ + /* (not active in the default builds). It is up to the caller to */ + /* either call @FT_Library_SetLcdFilter (if available) or do the */ + /* filtering itself. */ + /* */ + /* The selected render mode only affects vector glyphs of a font. */ + /* Embedded bitmaps often have a different pixel mode like */ + /* @FT_PIXEL_MODE_MONO. You can use @FT_Bitmap_Convert to transform */ + /* them into 8-bit pixmaps. */ + /* */ typedef enum FT_Render_Mode_ { FT_RENDER_MODE_NORMAL = 0, @@ -3265,152 +2999,148 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_Render_Mode` values instead */ + /* `FT_Render_Mode' values instead */ #define ft_render_mode_normal FT_RENDER_MODE_NORMAL #define ft_render_mode_mono FT_RENDER_MODE_MONO - /************************************************************************** - * - * @function: - * FT_Render_Glyph - * - * @description: - * Convert a given glyph image to a bitmap. It does so by inspecting the - * glyph image format, finding the relevant renderer, and invoking it. - * - * @inout: - * slot :: - * A handle to the glyph slot containing the image to convert. - * - * @input: - * render_mode :: - * The render mode used to render the glyph image into a bitmap. See - * @FT_Render_Mode for a list of possible values. - * - * If @FT_RENDER_MODE_NORMAL is used, a previous call of @FT_Load_Glyph - * with flag @FT_LOAD_COLOR makes FT_Render_Glyph provide a default - * blending of colored glyph layers associated with the current glyph - * slot (provided the font contains such layers) instead of rendering - * the glyph slot's outline. This is an experimental feature; see - * @FT_LOAD_COLOR for more information. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * To get meaningful results, font scaling values must be set with - * functions like @FT_Set_Char_Size before calling `FT_Render_Glyph`. - * - * When FreeType outputs a bitmap of a glyph, it really outputs an alpha - * coverage map. If a pixel is completely covered by a filled-in - * outline, the bitmap contains 0xFF at that pixel, meaning that - * 0xFF/0xFF fraction of that pixel is covered, meaning the pixel is 100% - * black (or 0% bright). If a pixel is only 50% covered (value 0x80), - * the pixel is made 50% black (50% bright or a middle shade of grey). - * 0% covered means 0% black (100% bright or white). - * - * On high-DPI screens like on smartphones and tablets, the pixels are so - * small that their chance of being completely covered and therefore - * completely black are fairly good. On the low-DPI screens, however, - * the situation is different. The pixels are too large for most of the - * details of a glyph and shades of gray are the norm rather than the - * exception. - * - * This is relevant because all our screens have a second problem: they - * are not linear. 1~+~1 is not~2. Twice the value does not result in - * twice the brightness. When a pixel is only 50% covered, the coverage - * map says 50% black, and this translates to a pixel value of 128 when - * you use 8~bits per channel (0-255). However, this does not translate - * to 50% brightness for that pixel on our sRGB and gamma~2.2 screens. - * Due to their non-linearity, they dwell longer in the darks and only a - * pixel value of about 186 results in 50% brightness -- 128 ends up too - * dark on both bright and dark backgrounds. The net result is that dark - * text looks burnt-out, pixely and blotchy on bright background, bright - * text too frail on dark backgrounds, and colored text on colored - * background (for example, red on green) seems to have dark halos or - * 'dirt' around it. The situation is especially ugly for diagonal stems - * like in 'w' glyph shapes where the quality of FreeType's anti-aliasing - * depends on the correct display of grays. On high-DPI screens where - * smaller, fully black pixels reign supreme, this doesn't matter, but on - * our low-DPI screens with all the gray shades, it does. 0% and 100% - * brightness are the same things in linear and non-linear space, just - * all the shades in-between aren't. - * - * The blending function for placing text over a background is - * - * ``` - * dst = alpha * src + (1 - alpha) * dst , - * ``` - * - * which is known as the OVER operator. - * - * To correctly composite an antialiased pixel of a glyph onto a surface, - * - * 1. take the foreground and background colors (e.g., in sRGB space) - * and apply gamma to get them in a linear space, - * - * 2. use OVER to blend the two linear colors using the glyph pixel - * as the alpha value (remember, the glyph bitmap is an alpha coverage - * bitmap), and - * - * 3. apply inverse gamma to the blended pixel and write it back to - * the image. - * - * Internal testing at Adobe found that a target inverse gamma of~1.8 for - * step~3 gives good results across a wide range of displays with an sRGB - * gamma curve or a similar one. - * - * This process can cost performance. There is an approximation that - * does not need to know about the background color; see - * https://bel.fi/alankila/lcd/ and - * https://bel.fi/alankila/lcd/alpcor.html for details. - * - * **ATTENTION**: Linear blending is even more important when dealing - * with subpixel-rendered glyphs to prevent color-fringing! A - * subpixel-rendered glyph must first be filtered with a filter that - * gives equal weight to the three color primaries and does not exceed a - * sum of 0x100, see section @lcd_rendering. Then the only difference to - * gray linear blending is that subpixel-rendered linear blending is done - * 3~times per pixel: red foreground subpixel to red background subpixel - * and so on for green and blue. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Render_Glyph */ + /* */ + /* <Description> */ + /* Convert a given glyph image to a bitmap. It does so by inspecting */ + /* the glyph image format, finding the relevant renderer, and */ + /* invoking it. */ + /* */ + /* <InOut> */ + /* slot :: A handle to the glyph slot containing the image to */ + /* convert. */ + /* */ + /* <Input> */ + /* render_mode :: This is the render mode used to render the glyph */ + /* image into a bitmap. See @FT_Render_Mode for a */ + /* list of possible values. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* To get meaningful results, font scaling values must be set with */ + /* functions like @FT_Set_Char_Size before calling FT_Render_Glyph. */ + /* */ + /* When FreeType outputs a bitmap of a glyph, it really outputs an */ + /* alpha coverage map. If a pixel is completely covered by a */ + /* filled-in outline, the bitmap contains 0xFF at that pixel, meaning */ + /* that 0xFF/0xFF fraction of that pixel is covered, meaning the */ + /* pixel is 100% black (or 0% bright). If a pixel is only 50% */ + /* covered (value 0x80), the pixel is made 50% black (50% bright or a */ + /* middle shade of grey). 0% covered means 0% black (100% bright or */ + /* white). */ + /* */ + /* On high-DPI screens like on smartphones and tablets, the pixels */ + /* are so small that their chance of being completely covered and */ + /* therefore completely black are fairly good. On the low-DPI */ + /* screens, however, the situation is different. The pixels are too */ + /* large for most of the details of a glyph and shades of gray are */ + /* the norm rather than the exception. */ + /* */ + /* This is relevant because all our screens have a second problem: */ + /* they are not linear. 1~+~1 is not~2. Twice the value does not */ + /* result in twice the brightness. When a pixel is only 50% covered, */ + /* the coverage map says 50% black, and this translates to a pixel */ + /* value of 128 when you use 8~bits per channel (0-255). However, */ + /* this does not translate to 50% brightness for that pixel on our */ + /* sRGB and gamma~2.2 screens. Due to their non-linearity, they */ + /* dwell longer in the darks and only a pixel value of about 186 */ + /* results in 50% brightness – 128 ends up too dark on both bright */ + /* and dark backgrounds. The net result is that dark text looks */ + /* burnt-out, pixely and blotchy on bright background, bright text */ + /* too frail on dark backgrounds, and colored text on colored */ + /* background (for example, red on green) seems to have dark halos or */ + /* `dirt' around it. The situation is especially ugly for diagonal */ + /* stems like in `w' glyph shapes where the quality of FreeType's */ + /* anti-aliasing depends on the correct display of grays. On */ + /* high-DPI screens where smaller, fully black pixels reign supreme, */ + /* this doesn't matter, but on our low-DPI screens with all the gray */ + /* shades, it does. 0% and 100% brightness are the same things in */ + /* linear and non-linear space, just all the shades in-between */ + /* aren't. */ + /* */ + /* The blending function for placing text over a background is */ + /* */ + /* { */ + /* dst = alpha * src + (1 - alpha) * dst , */ + /* } */ + /* */ + /* which is known as the OVER operator. */ + /* */ + /* To correctly composite an antialiased pixel of a glyph onto a */ + /* surface, */ + /* */ + /* 1. take the foreground and background colors (e.g., in sRGB space) */ + /* and apply gamma to get them in a linear space, */ + /* */ + /* 2. use OVER to blend the two linear colors using the glyph pixel */ + /* as the alpha value (remember, the glyph bitmap is an alpha */ + /* coverage bitmap), and */ + /* */ + /* 3. apply inverse gamma to the blended pixel and write it back to */ + /* the image. */ + /* */ + /* Internal testing at Adobe found that a target inverse gamma of~1.8 */ + /* for step~3 gives good results across a wide range of displays with */ + /* an sRGB gamma curve or a similar one. */ + /* */ + /* This process can cost performance. There is an approximation that */ + /* does not need to know about the background color; see */ + /* https://bel.fi/alankila/lcd/ and */ + /* https://bel.fi/alankila/lcd/alpcor.html for details. */ + /* */ + /* *ATTENTION*: Linear blending is even more important when dealing */ + /* with subpixel-rendered glyphs to prevent color-fringing! A */ + /* subpixel-rendered glyph must first be filtered with a filter that */ + /* gives equal weight to the three color primaries and does not */ + /* exceed a sum of 0x100, see section @lcd_filtering. Then the */ + /* only difference to gray linear blending is that subpixel-rendered */ + /* linear blending is done 3~times per pixel: red foreground subpixel */ + /* to red background subpixel and so on for green and blue. */ + /* */ FT_EXPORT( FT_Error ) FT_Render_Glyph( FT_GlyphSlot slot, FT_Render_Mode render_mode ); - /************************************************************************** - * - * @enum: - * FT_Kerning_Mode - * - * @description: - * An enumeration to specify the format of kerning values returned by - * @FT_Get_Kerning. - * - * @values: - * FT_KERNING_DEFAULT :: - * Return grid-fitted kerning distances in 26.6 fractional pixels. - * - * FT_KERNING_UNFITTED :: - * Return un-grid-fitted kerning distances in 26.6 fractional pixels. - * - * FT_KERNING_UNSCALED :: - * Return the kerning vector in original font units. - * - * @note: - * `FT_KERNING_DEFAULT` returns full pixel values; it also makes FreeType - * heuristically scale down kerning distances at small ppem values so - * that they don't become too big. - * - * Both `FT_KERNING_DEFAULT` and `FT_KERNING_UNFITTED` use the current - * horizontal scaling factor (as set e.g. with @FT_Set_Char_Size) to - * convert font units to pixels. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_Kerning_Mode */ + /* */ + /* <Description> */ + /* An enumeration used to specify which kerning values to return in */ + /* @FT_Get_Kerning. */ + /* */ + /* <Values> */ + /* FT_KERNING_DEFAULT :: Return grid-fitted kerning distances in */ + /* pixels (value is~0). Whether they are */ + /* scaled depends on @FT_LOAD_NO_SCALE. */ + /* */ + /* FT_KERNING_UNFITTED :: Return un-grid-fitted kerning distances in */ + /* 26.6 fractional pixels. Whether they are */ + /* scaled depends on @FT_LOAD_NO_SCALE. */ + /* */ + /* FT_KERNING_UNSCALED :: Return the kerning vector in original font */ + /* units. */ + /* */ + /* <Note> */ + /* FT_KERNING_DEFAULT returns full pixel values; it also makes */ + /* FreeType heuristically scale down kerning distances at small ppem */ + /* values so that they don't become too big. */ + /* */ typedef enum FT_Kerning_Mode_ { - FT_KERNING_DEFAULT = 0, + FT_KERNING_DEFAULT = 0, FT_KERNING_UNFITTED, FT_KERNING_UNSCALED @@ -3418,53 +3148,46 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_Kerning_Mode` values instead */ + /* `FT_Kerning_Mode' values instead */ #define ft_kerning_default FT_KERNING_DEFAULT #define ft_kerning_unfitted FT_KERNING_UNFITTED #define ft_kerning_unscaled FT_KERNING_UNSCALED - /************************************************************************** - * - * @function: - * FT_Get_Kerning - * - * @description: - * Return the kerning vector between two glyphs of the same face. - * - * @input: - * face :: - * A handle to a source face object. - * - * left_glyph :: - * The index of the left glyph in the kern pair. - * - * right_glyph :: - * The index of the right glyph in the kern pair. - * - * kern_mode :: - * See @FT_Kerning_Mode for more information. Determines the scale and - * dimension of the returned kerning vector. - * - * @output: - * akerning :: - * The kerning vector. This is either in font units, fractional pixels - * (26.6 format), or pixels for scalable formats, and in pixels for - * fixed-sizes formats. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * Only horizontal layouts (left-to-right & right-to-left) are supported - * by this method. Other layouts, or more sophisticated kernings, are - * out of the scope of this API function -- they can be implemented - * through format-specific interfaces. - * - * Kerning for OpenType fonts implemented in a 'GPOS' table is not - * supported; use @FT_HAS_KERNING to find out whether a font has data - * that can be extracted with `FT_Get_Kerning`. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Kerning */ + /* */ + /* <Description> */ + /* Return the kerning vector between two glyphs of a same face. */ + /* */ + /* <Input> */ + /* face :: A handle to a source face object. */ + /* */ + /* left_glyph :: The index of the left glyph in the kern pair. */ + /* */ + /* right_glyph :: The index of the right glyph in the kern pair. */ + /* */ + /* kern_mode :: See @FT_Kerning_Mode for more information. */ + /* Determines the scale and dimension of the returned */ + /* kerning vector. */ + /* */ + /* <Output> */ + /* akerning :: The kerning vector. This is either in font units, */ + /* fractional pixels (26.6 format), or pixels for */ + /* scalable formats, and in pixels for fixed-sizes */ + /* formats. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* Only horizontal layouts (left-to-right & right-to-left) are */ + /* supported by this method. Other layouts, or more sophisticated */ + /* kernings, are out of the scope of this API function -- they can be */ + /* implemented through format-specific interfaces. */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Kerning( FT_Face face, FT_UInt left_glyph, @@ -3473,42 +3196,39 @@ FT_BEGIN_HEADER FT_Vector *akerning ); - /************************************************************************** - * - * @function: - * FT_Get_Track_Kerning - * - * @description: - * Return the track kerning for a given face object at a given size. - * - * @input: - * face :: - * A handle to a source face object. - * - * point_size :: - * The point size in 16.16 fractional points. - * - * degree :: - * The degree of tightness. Increasingly negative values represent - * tighter track kerning, while increasingly positive values represent - * looser track kerning. Value zero means no track kerning. - * - * @output: - * akerning :: - * The kerning in 16.16 fractional points, to be uniformly applied - * between all glyphs. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * Currently, only the Type~1 font driver supports track kerning, using - * data from AFM files (if attached with @FT_Attach_File or - * @FT_Attach_Stream). - * - * Only very few AFM files come with track kerning data; please refer to - * Adobe's AFM specification for more details. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Track_Kerning */ + /* */ + /* <Description> */ + /* Return the track kerning for a given face object at a given size. */ + /* */ + /* <Input> */ + /* face :: A handle to a source face object. */ + /* */ + /* point_size :: The point size in 16.16 fractional points. */ + /* */ + /* degree :: The degree of tightness. Increasingly negative */ + /* values represent tighter track kerning, while */ + /* increasingly positive values represent looser track */ + /* kerning. Value zero means no track kerning. */ + /* */ + /* <Output> */ + /* akerning :: The kerning in 16.16 fractional points, to be */ + /* uniformly applied between all glyphs. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* Currently, only the Type~1 font driver supports track kerning, */ + /* using data from AFM files (if attached with @FT_Attach_File or */ + /* @FT_Attach_Stream). */ + /* */ + /* Only very few AFM files come with track kerning data; please refer */ + /* to the Adobe's AFM specification for more details. */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Track_Kerning( FT_Face face, FT_Fixed point_size, @@ -3516,46 +3236,45 @@ FT_BEGIN_HEADER FT_Fixed* akerning ); - /************************************************************************** - * - * @function: - * FT_Get_Glyph_Name - * - * @description: - * Retrieve the ASCII name of a given glyph in a face. This only works - * for those faces where @FT_HAS_GLYPH_NAMES(face) returns~1. - * - * @input: - * face :: - * A handle to a source face object. - * - * glyph_index :: - * The glyph index. - * - * buffer_max :: - * The maximum number of bytes available in the buffer. - * - * @output: - * buffer :: - * A pointer to a target buffer where the name is copied to. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * An error is returned if the face doesn't provide glyph names or if the - * glyph index is invalid. In all cases of failure, the first byte of - * `buffer` is set to~0 to indicate an empty name. - * - * The glyph name is truncated to fit within the buffer if it is too - * long. The returned string is always zero-terminated. - * - * Be aware that FreeType reorders glyph indices internally so that glyph - * index~0 always corresponds to the 'missing glyph' (called '.notdef'). - * - * This function always returns an error if the config macro - * `FT_CONFIG_OPTION_NO_GLYPH_NAMES` is not defined in `ftoption.h`. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Glyph_Name */ + /* */ + /* <Description> */ + /* Retrieve the ASCII name of a given glyph in a face. This only */ + /* works for those faces where @FT_HAS_GLYPH_NAMES(face) returns~1. */ + /* */ + /* <Input> */ + /* face :: A handle to a source face object. */ + /* */ + /* glyph_index :: The glyph index. */ + /* */ + /* buffer_max :: The maximum number of bytes available in the */ + /* buffer. */ + /* */ + /* <Output> */ + /* buffer :: A pointer to a target buffer where the name is */ + /* copied to. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* An error is returned if the face doesn't provide glyph names or if */ + /* the glyph index is invalid. In all cases of failure, the first */ + /* byte of `buffer' is set to~0 to indicate an empty name. */ + /* */ + /* The glyph name is truncated to fit within the buffer if it is too */ + /* long. The returned string is always zero-terminated. */ + /* */ + /* Be aware that FreeType reorders glyph indices internally so that */ + /* glyph index~0 always corresponds to the `missing glyph' (called */ + /* `.notdef'). */ + /* */ + /* This function always returns an error if the config macro */ + /* `FT_CONFIG_OPTION_NO_GLYPH_NAMES' is not defined in `ftoptions.h'. */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Glyph_Name( FT_Face face, FT_UInt glyph_index, @@ -3563,109 +3282,92 @@ FT_BEGIN_HEADER FT_UInt buffer_max ); - /************************************************************************** - * - * @function: - * FT_Get_Postscript_Name - * - * @description: - * Retrieve the ASCII PostScript name of a given face, if available. - * This only works with PostScript, TrueType, and OpenType fonts. - * - * @input: - * face :: - * A handle to the source face object. - * - * @return: - * A pointer to the face's PostScript name. `NULL` if unavailable. - * - * @note: - * The returned pointer is owned by the face and is destroyed with it. - * - * For variation fonts, this string changes if you select a different - * instance, and you have to call `FT_Get_PostScript_Name` again to - * retrieve it. FreeType follows Adobe TechNote #5902, 'Generating - * PostScript Names for Fonts Using OpenType Font Variations'. - * - * https://download.macromedia.com/pub/developer/opentype/tech-notes/5902.AdobePSNameGeneration.html - * - * [Since 2.9] Special PostScript names for named instances are only - * returned if the named instance is set with @FT_Set_Named_Instance (and - * the font has corresponding entries in its 'fvar' table). If - * @FT_IS_VARIATION returns true, the algorithmically derived PostScript - * name is provided, not looking up special entries for named instances. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Postscript_Name */ + /* */ + /* <Description> */ + /* Retrieve the ASCII PostScript name of a given face, if available. */ + /* This only works with PostScript and TrueType fonts. */ + /* */ + /* <Input> */ + /* face :: A handle to the source face object. */ + /* */ + /* <Return> */ + /* A pointer to the face's PostScript name. NULL if unavailable. */ + /* */ + /* <Note> */ + /* The returned pointer is owned by the face and is destroyed with */ + /* it. */ + /* */ FT_EXPORT( const char* ) FT_Get_Postscript_Name( FT_Face face ); - /************************************************************************** - * - * @function: - * FT_Select_Charmap - * - * @description: - * Select a given charmap by its encoding tag (as listed in - * `freetype.h`). - * - * @inout: - * face :: - * A handle to the source face object. - * - * @input: - * encoding :: - * A handle to the selected encoding. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function returns an error if no charmap in the face corresponds - * to the encoding queried here. - * - * Because many fonts contain more than a single cmap for Unicode - * encoding, this function has some special code to select the one that - * covers Unicode best ('best' in the sense that a UCS-4 cmap is - * preferred to a UCS-2 cmap). It is thus preferable to @FT_Set_Charmap - * in this case. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Select_Charmap */ + /* */ + /* <Description> */ + /* Select a given charmap by its encoding tag (as listed in */ + /* `freetype.h'). */ + /* */ + /* <InOut> */ + /* face :: A handle to the source face object. */ + /* */ + /* <Input> */ + /* encoding :: A handle to the selected encoding. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* This function returns an error if no charmap in the face */ + /* corresponds to the encoding queried here. */ + /* */ + /* Because many fonts contain more than a single cmap for Unicode */ + /* encoding, this function has some special code to select the one */ + /* that covers Unicode best (`best' in the sense that a UCS-4 cmap is */ + /* preferred to a UCS-2 cmap). It is thus preferable to */ + /* @FT_Set_Charmap in this case. */ + /* */ FT_EXPORT( FT_Error ) FT_Select_Charmap( FT_Face face, FT_Encoding encoding ); - /************************************************************************** - * - * @function: - * FT_Set_Charmap - * - * @description: - * Select a given charmap for character code to glyph index mapping. - * - * @inout: - * face :: - * A handle to the source face object. - * - * @input: - * charmap :: - * A handle to the selected charmap. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function returns an error if the charmap is not part of the face - * (i.e., if it is not listed in the `face->charmaps` table). - * - * It also fails if an OpenType type~14 charmap is selected (which - * doesn't map character codes to glyph indices at all). - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Set_Charmap */ + /* */ + /* <Description> */ + /* Select a given charmap for character code to glyph index mapping. */ + /* */ + /* <InOut> */ + /* face :: A handle to the source face object. */ + /* */ + /* <Input> */ + /* charmap :: A handle to the selected charmap. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* This function returns an error if the charmap is not part of */ + /* the face (i.e., if it is not listed in the `face->charmaps' */ + /* table). */ + /* */ + /* It also fails if a type~14 charmap is selected. */ + /* */ FT_EXPORT( FT_Error ) FT_Set_Charmap( FT_Face face, FT_CharMap charmap ); - /************************************************************************** + /************************************************************************* * * @function: * FT_Get_Charmap_Index @@ -3679,274 +3381,168 @@ FT_BEGIN_HEADER * * @return: * The index into the array of character maps within the face to which - * `charmap` belongs. If an error occurs, -1 is returned. + * `charmap' belongs. If an error occurs, -1 is returned. * */ FT_EXPORT( FT_Int ) FT_Get_Charmap_Index( FT_CharMap charmap ); - /************************************************************************** - * - * @function: - * FT_Get_Char_Index - * - * @description: - * Return the glyph index of a given character code. This function uses - * the currently selected charmap to do the mapping. - * - * @input: - * face :: - * A handle to the source face object. - * - * charcode :: - * The character code. - * - * @return: - * The glyph index. 0~means 'undefined character code'. - * - * @note: - * If you use FreeType to manipulate the contents of font files directly, - * be aware that the glyph index returned by this function doesn't always - * correspond to the internal indices used within the file. This is done - * to ensure that value~0 always corresponds to the 'missing glyph'. If - * the first glyph is not named '.notdef', then for Type~1 and Type~42 - * fonts, '.notdef' will be moved into the glyph ID~0 position, and - * whatever was there will be moved to the position '.notdef' had. For - * Type~1 fonts, if there is no '.notdef' glyph at all, then one will be - * created at index~0 and whatever was there will be moved to the last - * index -- Type~42 fonts are considered invalid under this condition. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Char_Index */ + /* */ + /* <Description> */ + /* Return the glyph index of a given character code. This function */ + /* uses a charmap object to do the mapping. */ + /* */ + /* <Input> */ + /* face :: A handle to the source face object. */ + /* */ + /* charcode :: The character code. */ + /* */ + /* <Return> */ + /* The glyph index. 0~means `undefined character code'. */ + /* */ + /* <Note> */ + /* If you use FreeType to manipulate the contents of font files */ + /* directly, be aware that the glyph index returned by this function */ + /* doesn't always correspond to the internal indices used within the */ + /* file. This is done to ensure that value~0 always corresponds to */ + /* the `missing glyph'. If the first glyph is not named `.notdef', */ + /* then for Type~1 and Type~42 fonts, `.notdef' will be moved into */ + /* the glyph ID~0 position, and whatever was there will be moved to */ + /* the position `.notdef' had. For Type~1 fonts, if there is no */ + /* `.notdef' glyph at all, then one will be created at index~0 and */ + /* whatever was there will be moved to the last index -- Type~42 */ + /* fonts are considered invalid under this condition. */ + /* */ FT_EXPORT( FT_UInt ) FT_Get_Char_Index( FT_Face face, FT_ULong charcode ); - /************************************************************************** - * - * @function: - * FT_Get_First_Char - * - * @description: - * Return the first character code in the current charmap of a given - * face, together with its corresponding glyph index. - * - * @input: - * face :: - * A handle to the source face object. - * - * @output: - * agindex :: - * Glyph index of first character code. 0~if charmap is empty. - * - * @return: - * The charmap's first character code. - * - * @note: - * You should use this function together with @FT_Get_Next_Char to parse - * all character codes available in a given charmap. The code should - * look like this: - * - * ``` - * FT_ULong charcode; - * FT_UInt gindex; - * - * - * charcode = FT_Get_First_Char( face, &gindex ); - * while ( gindex != 0 ) - * { - * ... do something with (charcode,gindex) pair ... - * - * charcode = FT_Get_Next_Char( face, charcode, &gindex ); - * } - * ``` - * - * Be aware that character codes can have values up to 0xFFFFFFFF; this - * might happen for non-Unicode or malformed cmaps. However, even with - * regular Unicode encoding, so-called 'last resort fonts' (using SFNT - * cmap format 13, see function @FT_Get_CMap_Format) normally have - * entries for all Unicode characters up to 0x1FFFFF, which can cause *a - * lot* of iterations. - * - * Note that `*agindex` is set to~0 if the charmap is empty. The result - * itself can be~0 in two cases: if the charmap is empty or if the - * value~0 is the first valid character code. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_First_Char */ + /* */ + /* <Description> */ + /* This function is used to return the first character code in the */ + /* current charmap of a given face. It also returns the */ + /* corresponding glyph index. */ + /* */ + /* <Input> */ + /* face :: A handle to the source face object. */ + /* */ + /* <Output> */ + /* agindex :: Glyph index of first character code. 0~if charmap is */ + /* empty. */ + /* */ + /* <Return> */ + /* The charmap's first character code. */ + /* */ + /* <Note> */ + /* You should use this function with @FT_Get_Next_Char to be able to */ + /* parse all character codes available in a given charmap. The code */ + /* should look like this: */ + /* */ + /* { */ + /* FT_ULong charcode; */ + /* FT_UInt gindex; */ + /* */ + /* */ + /* charcode = FT_Get_First_Char( face, &gindex ); */ + /* while ( gindex != 0 ) */ + /* { */ + /* ... do something with (charcode,gindex) pair ... */ + /* */ + /* charcode = FT_Get_Next_Char( face, charcode, &gindex ); */ + /* } */ + /* } */ + /* */ + /* Be aware that character codes can have values up to 0xFFFFFFFF; */ + /* this might happen for non-Unicode or malformed cmaps. However, */ + /* even with regular Unicode encoding, so-called `last resort fonts' */ + /* (using SFNT cmap format 13, see function @FT_Get_CMap_Format) */ + /* normally have entries for all Unicode characters up to 0x1FFFFF, */ + /* which can cause *a lot* of iterations. */ + /* */ + /* Note that `*agindex' is set to~0 if the charmap is empty. The */ + /* result itself can be~0 in two cases: if the charmap is empty or */ + /* if the value~0 is the first valid character code. */ + /* */ FT_EXPORT( FT_ULong ) FT_Get_First_Char( FT_Face face, FT_UInt *agindex ); - /************************************************************************** - * - * @function: - * FT_Get_Next_Char - * - * @description: - * Return the next character code in the current charmap of a given face - * following the value `char_code`, as well as the corresponding glyph - * index. - * - * @input: - * face :: - * A handle to the source face object. - * - * char_code :: - * The starting character code. - * - * @output: - * agindex :: - * Glyph index of next character code. 0~if charmap is empty. - * - * @return: - * The charmap's next character code. - * - * @note: - * You should use this function with @FT_Get_First_Char to walk over all - * character codes available in a given charmap. See the note for that - * function for a simple code example. - * - * Note that `*agindex` is set to~0 when there are no more codes in the - * charmap. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Next_Char */ + /* */ + /* <Description> */ + /* This function is used to return the next character code in the */ + /* current charmap of a given face following the value `char_code', */ + /* as well as the corresponding glyph index. */ + /* */ + /* <Input> */ + /* face :: A handle to the source face object. */ + /* char_code :: The starting character code. */ + /* */ + /* <Output> */ + /* agindex :: Glyph index of next character code. 0~if charmap */ + /* is empty. */ + /* */ + /* <Return> */ + /* The charmap's next character code. */ + /* */ + /* <Note> */ + /* You should use this function with @FT_Get_First_Char to walk */ + /* over all character codes available in a given charmap. See the */ + /* note for this function for a simple code example. */ + /* */ + /* Note that `*agindex' is set to~0 when there are no more codes in */ + /* the charmap. */ + /* */ FT_EXPORT( FT_ULong ) FT_Get_Next_Char( FT_Face face, FT_ULong char_code, FT_UInt *agindex ); - /************************************************************************** - * - * @function: - * FT_Face_Properties - * - * @description: - * Set or override certain (library or module-wide) properties on a - * face-by-face basis. Useful for finer-grained control and avoiding - * locks on shared structures (threads can modify their own faces as they - * see fit). - * - * Contrary to @FT_Property_Set, this function uses @FT_Parameter so that - * you can pass multiple properties to the target face in one call. Note - * that only a subset of the available properties can be controlled. - * - * * @FT_PARAM_TAG_STEM_DARKENING (stem darkening, corresponding to the - * property `no-stem-darkening` provided by the 'autofit', 'cff', - * 'type1', and 't1cid' modules; see @no-stem-darkening). - * - * * @FT_PARAM_TAG_LCD_FILTER_WEIGHTS (LCD filter weights, corresponding - * to function @FT_Library_SetLcdFilterWeights). - * - * * @FT_PARAM_TAG_RANDOM_SEED (seed value for the CFF, Type~1, and CID - * 'random' operator, corresponding to the `random-seed` property - * provided by the 'cff', 'type1', and 't1cid' modules; see - * @random-seed). - * - * Pass `NULL` as `data` in @FT_Parameter for a given tag to reset the - * option and use the library or module default again. - * - * @input: - * face :: - * A handle to the source face object. - * - * num_properties :: - * The number of properties that follow. - * - * properties :: - * A handle to an @FT_Parameter array with `num_properties` elements. - * - * @return: - * FreeType error code. 0~means success. - * - * @example: - * Here is an example that sets three properties. You must define - * `FT_CONFIG_OPTION_SUBPIXEL_RENDERING` to make the LCD filter examples - * work. - * - * ``` - * FT_Parameter property1; - * FT_Bool darken_stems = 1; - * - * FT_Parameter property2; - * FT_LcdFiveTapFilter custom_weight = - * { 0x11, 0x44, 0x56, 0x44, 0x11 }; - * - * FT_Parameter property3; - * FT_Int32 random_seed = 314159265; - * - * FT_Parameter properties[3] = { property1, - * property2, - * property3 }; - * - * - * property1.tag = FT_PARAM_TAG_STEM_DARKENING; - * property1.data = &darken_stems; - * - * property2.tag = FT_PARAM_TAG_LCD_FILTER_WEIGHTS; - * property2.data = custom_weight; - * - * property3.tag = FT_PARAM_TAG_RANDOM_SEED; - * property3.data = &random_seed; - * - * FT_Face_Properties( face, 3, properties ); - * ``` - * - * The next example resets a single property to its default value. - * - * ``` - * FT_Parameter property; - * - * - * property.tag = FT_PARAM_TAG_LCD_FILTER_WEIGHTS; - * property.data = NULL; - * - * FT_Face_Properties( face, 1, &property ); - * ``` - * - * @since: - * 2.8 - * - */ - FT_EXPORT( FT_Error ) - FT_Face_Properties( FT_Face face, - FT_UInt num_properties, - FT_Parameter* properties ); - - - /************************************************************************** - * - * @function: - * FT_Get_Name_Index - * - * @description: - * Return the glyph index of a given glyph name. - * - * @input: - * face :: - * A handle to the source face object. - * - * glyph_name :: - * The glyph name. - * - * @return: - * The glyph index. 0~means 'undefined character code'. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Name_Index */ + /* */ + /* <Description> */ + /* Return the glyph index of a given glyph name. This function uses */ + /* driver specific objects to do the translation. */ + /* */ + /* <Input> */ + /* face :: A handle to the source face object. */ + /* */ + /* glyph_name :: The glyph name. */ + /* */ + /* <Return> */ + /* The glyph index. 0~means `undefined character code'. */ + /* */ FT_EXPORT( FT_UInt ) FT_Get_Name_Index( FT_Face face, FT_String* glyph_name ); - /************************************************************************** + /************************************************************************* * - * @enum: + * @macro: * FT_SUBGLYPH_FLAG_XXX * * @description: - * A list of constants describing subglyphs. Please refer to the 'glyf' - * table description in the OpenType specification for the meaning of the - * various flags (which get synthesized for non-OpenType subglyphs). - * - * https://docs.microsoft.com/en-us/typography/opentype/spec/glyf#composite-glyph-description + * A list of constants used to describe subglyphs. Please refer to the + * TrueType specification for the meaning of the various flags. * * @values: * FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS :: @@ -3967,15 +3563,15 @@ FT_BEGIN_HEADER #define FT_SUBGLYPH_FLAG_USE_MY_METRICS 0x200 - /************************************************************************** + /************************************************************************* * - * @function: + * @func: * FT_Get_SubGlyph_Info * * @description: * Retrieve a description of a given subglyph. Only use it if - * `glyph->format` is @FT_GLYPH_FORMAT_COMPOSITE; an error is returned - * otherwise. + * `glyph->format' is @FT_GLYPH_FORMAT_COMPOSITE; an error is + * returned otherwise. * * @input: * glyph :: @@ -3983,7 +3579,7 @@ FT_BEGIN_HEADER * * sub_index :: * The index of the subglyph. Must be less than - * `glyph->num_subglyphs`. + * `glyph->num_subglyphs'. * * @output: * p_index :: @@ -4005,11 +3601,9 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * The values of `*p_arg1`, `*p_arg2`, and `*p_transform` must be - * interpreted depending on the flags returned in `*p_flags`. See the - * OpenType specification for details. - * - * https://docs.microsoft.com/en-us/typography/opentype/spec/glyf#composite-glyph-description + * The values of `*p_arg1', `*p_arg2', and `*p_transform' must be + * interpreted depending on the flags returned in `*p_flags'. See the + * TrueType specification for details. * */ FT_EXPORT( FT_Error ) @@ -4022,228 +3616,61 @@ FT_BEGIN_HEADER FT_Matrix *p_transform ); - /************************************************************************** - * - * @section: - * layer_management - * - * @title: - * Glyph Layer Management - * - * @abstract: - * Retrieving and manipulating OpenType's 'COLR' table data. - * - * @description: - * The functions described here allow access of colored glyph layer data - * in OpenType's 'COLR' tables. - */ - - - /************************************************************************** - * - * @struct: - * FT_LayerIterator - * - * @description: - * This iterator object is needed for @FT_Get_Color_Glyph_Layer. - * - * @fields: - * num_layers :: - * The number of glyph layers for the requested glyph index. Will be - * set by @FT_Get_Color_Glyph_Layer. - * - * layer :: - * The current layer. Will be set by @FT_Get_Color_Glyph_Layer. - * - * p :: - * An opaque pointer into 'COLR' table data. The caller must set this - * to `NULL` before the first call of @FT_Get_Color_Glyph_Layer. - */ - typedef struct FT_LayerIterator_ - { - FT_UInt num_layers; - FT_UInt layer; - FT_Byte* p; - - } FT_LayerIterator; - - - /************************************************************************** - * - * @function: - * FT_Get_Color_Glyph_Layer - * - * @description: - * This is an interface to the 'COLR' table in OpenType fonts to - * iteratively retrieve the colored glyph layers associated with the - * current glyph slot. - * - * https://docs.microsoft.com/en-us/typography/opentype/spec/colr - * - * The glyph layer data for a given glyph index, if present, provides an - * alternative, multi-colour glyph representation: Instead of rendering - * the outline or bitmap with the given glyph index, glyphs with the - * indices and colors returned by this function are rendered layer by - * layer. - * - * The returned elements are ordered in the z~direction from bottom to - * top; the 'n'th element should be rendered with the associated palette - * color and blended on top of the already rendered layers (elements 0, - * 1, ..., n-1). - * - * @input: - * face :: - * A handle to the parent face object. - * - * base_glyph :: - * The glyph index the colored glyph layers are associated with. - * - * @inout: - * iterator :: - * An @FT_LayerIterator object. For the first call you should set - * `iterator->p` to `NULL`. For all following calls, simply use the - * same object again. - * - * @output: - * aglyph_index :: - * The glyph index of the current layer. - * - * acolor_index :: - * The color index into the font face's color palette of the current - * layer. The value 0xFFFF is special; it doesn't reference a palette - * entry but indicates that the text foreground color should be used - * instead (to be set up by the application outside of FreeType). - * - * The color palette can be retrieved with @FT_Palette_Select. - * - * @return: - * Value~1 if everything is OK. If there are no more layers (or if there - * are no layers at all), value~0 gets returned. In case of an error, - * value~0 is returned also. - * - * @note: - * This function is necessary if you want to handle glyph layers by - * yourself. In particular, functions that operate with @FT_GlyphRec - * objects (like @FT_Get_Glyph or @FT_Glyph_To_Bitmap) don't have access - * to this information. - * - * Note that @FT_Render_Glyph is able to handle colored glyph layers - * automatically if the @FT_LOAD_COLOR flag is passed to a previous call - * to @FT_Load_Glyph. [This is an experimental feature.] - * - * @example: - * ``` - * FT_Color* palette; - * FT_LayerIterator iterator; - * - * FT_Bool have_layers; - * FT_UInt layer_glyph_index; - * FT_UInt layer_color_index; - * - * - * error = FT_Palette_Select( face, palette_index, &palette ); - * if ( error ) - * palette = NULL; - * - * iterator.p = NULL; - * have_layers = FT_Get_Color_Glyph_Layer( face, - * glyph_index, - * &layer_glyph_index, - * &layer_color_index, - * &iterator ); - * - * if ( palette && have_layers ) - * { - * do - * { - * FT_Color layer_color; - * - * - * if ( layer_color_index == 0xFFFF ) - * layer_color = text_foreground_color; - * else - * layer_color = palette[layer_color_index]; - * - * // Load and render glyph `layer_glyph_index', then - * // blend resulting pixmap (using color `layer_color') - * // with previously created pixmaps. - * - * } while ( FT_Get_Color_Glyph_Layer( face, - * glyph_index, - * &layer_glyph_index, - * &layer_color_index, - * &iterator ) ); - * } - * ``` - */ - FT_EXPORT( FT_Bool ) - FT_Get_Color_Glyph_Layer( FT_Face face, - FT_UInt base_glyph, - FT_UInt *aglyph_index, - FT_UInt *acolor_index, - FT_LayerIterator* iterator ); - - - /************************************************************************** - * - * @section: - * base_interface - * - */ - - /************************************************************************** - * - * @enum: - * FT_FSTYPE_XXX - * - * @description: - * A list of bit flags used in the `fsType` field of the OS/2 table in a - * TrueType or OpenType font and the `FSType` entry in a PostScript font. - * These bit flags are returned by @FT_Get_FSType_Flags; they inform - * client applications of embedding and subsetting restrictions - * associated with a font. - * - * See - * https://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/FontPolicies.pdf - * for more details. - * - * @values: - * FT_FSTYPE_INSTALLABLE_EMBEDDING :: - * Fonts with no fsType bit set may be embedded and permanently - * installed on the remote system by an application. - * - * FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING :: - * Fonts that have only this bit set must not be modified, embedded or - * exchanged in any manner without first obtaining permission of the - * font software copyright owner. - * - * FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING :: - * The font may be embedded and temporarily loaded on the remote - * system. Documents containing Preview & Print fonts must be opened - * 'read-only'; no edits can be applied to the document. - * - * FT_FSTYPE_EDITABLE_EMBEDDING :: - * The font may be embedded but must only be installed temporarily on - * other systems. In contrast to Preview & Print fonts, documents - * containing editable fonts may be opened for reading, editing is - * permitted, and changes may be saved. - * - * FT_FSTYPE_NO_SUBSETTING :: - * The font may not be subsetted prior to embedding. - * - * FT_FSTYPE_BITMAP_EMBEDDING_ONLY :: - * Only bitmaps contained in the font may be embedded; no outline data - * may be embedded. If there are no bitmaps available in the font, - * then the font is unembeddable. - * - * @note: - * The flags are ORed together, thus more than a single value can be - * returned. - * - * While the `fsType` flags can indicate that a font may be embedded, a - * license with the font vendor may be separately required to use the - * font in this way. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_FSTYPE_XXX */ + /* */ + /* <Description> */ + /* A list of bit flags used in the `fsType' field of the OS/2 table */ + /* in a TrueType or OpenType font and the `FSType' entry in a */ + /* PostScript font. These bit flags are returned by */ + /* @FT_Get_FSType_Flags; they inform client applications of embedding */ + /* and subsetting restrictions associated with a font. */ + /* */ + /* See */ + /* http://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/FontPolicies.pdf */ + /* for more details. */ + /* */ + /* <Values> */ + /* FT_FSTYPE_INSTALLABLE_EMBEDDING :: */ + /* Fonts with no fsType bit set may be embedded and permanently */ + /* installed on the remote system by an application. */ + /* */ + /* FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING :: */ + /* Fonts that have only this bit set must not be modified, embedded */ + /* or exchanged in any manner without first obtaining permission of */ + /* the font software copyright owner. */ + /* */ + /* FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING :: */ + /* If this bit is set, the font may be embedded and temporarily */ + /* loaded on the remote system. Documents containing Preview & */ + /* Print fonts must be opened `read-only'; no edits can be applied */ + /* to the document. */ + /* */ + /* FT_FSTYPE_EDITABLE_EMBEDDING :: */ + /* If this bit is set, the font may be embedded but must only be */ + /* installed temporarily on other systems. In contrast to Preview */ + /* & Print fonts, documents containing editable fonts may be opened */ + /* for reading, editing is permitted, and changes may be saved. */ + /* */ + /* FT_FSTYPE_NO_SUBSETTING :: */ + /* If this bit is set, the font may not be subsetted prior to */ + /* embedding. */ + /* */ + /* FT_FSTYPE_BITMAP_EMBEDDING_ONLY :: */ + /* If this bit is set, only bitmaps contained in the font may be */ + /* embedded; no outline data may be embedded. If there are no */ + /* bitmaps available in the font, then the font is unembeddable. */ + /* */ + /* <Note> */ + /* The flags are ORed together, thus more than a single value can be */ + /* returned. */ + /* */ + /* While the fsType flags can indicate that a font may be embedded, a */ + /* license with the font vendor may be separately required to use the */ + /* font in this way. */ + /* */ #define FT_FSTYPE_INSTALLABLE_EMBEDDING 0x0000 #define FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING 0x0002 #define FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING 0x0004 @@ -4252,563 +3679,531 @@ FT_BEGIN_HEADER #define FT_FSTYPE_BITMAP_EMBEDDING_ONLY 0x0200 - /************************************************************************** - * - * @function: - * FT_Get_FSType_Flags - * - * @description: - * Return the `fsType` flags for a font. - * - * @input: - * face :: - * A handle to the source face object. - * - * @return: - * The `fsType` flags, see @FT_FSTYPE_XXX. - * - * @note: - * Use this function rather than directly reading the `fs_type` field in - * the @PS_FontInfoRec structure, which is only guaranteed to return the - * correct results for Type~1 fonts. - * - * @since: - * 2.3.8 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_FSType_Flags */ + /* */ + /* <Description> */ + /* Return the fsType flags for a font. */ + /* */ + /* <Input> */ + /* face :: A handle to the source face object. */ + /* */ + /* <Return> */ + /* The fsType flags, @FT_FSTYPE_XXX. */ + /* */ + /* <Note> */ + /* Use this function rather than directly reading the `fs_type' field */ + /* in the @PS_FontInfoRec structure, which is only guaranteed to */ + /* return the correct results for Type~1 fonts. */ + /* */ + /* <Since> */ + /* 2.3.8 */ + /* */ FT_EXPORT( FT_UShort ) FT_Get_FSType_Flags( FT_Face face ); - /************************************************************************** - * - * @section: - * glyph_variants - * - * @title: - * Unicode Variation Sequences - * - * @abstract: - * The FreeType~2 interface to Unicode Variation Sequences (UVS), using - * the SFNT cmap format~14. - * - * @description: - * Many characters, especially for CJK scripts, have variant forms. They - * are a sort of grey area somewhere between being totally irrelevant and - * semantically distinct; for this reason, the Unicode consortium decided - * to introduce Variation Sequences (VS), consisting of a Unicode base - * character and a variation selector instead of further extending the - * already huge number of characters. - * - * Unicode maintains two different sets, namely 'Standardized Variation - * Sequences' and registered 'Ideographic Variation Sequences' (IVS), - * collected in the 'Ideographic Variation Database' (IVD). - * - * https://unicode.org/Public/UCD/latest/ucd/StandardizedVariants.txt - * https://unicode.org/reports/tr37/ https://unicode.org/ivd/ - * - * To date (January 2017), the character with the most ideographic - * variations is U+9089, having 32 such IVS. - * - * Three Mongolian Variation Selectors have the values U+180B-U+180D; 256 - * generic Variation Selectors are encoded in the ranges U+FE00-U+FE0F - * and U+E0100-U+E01EF. IVS currently use Variation Selectors from the - * range U+E0100-U+E01EF only. - * - * A VS consists of the base character value followed by a single - * Variation Selector. For example, to get the first variation of - * U+9089, you have to write the character sequence `U+9089 U+E0100`. - * - * Adobe and MS decided to support both standardized and ideographic VS - * with a new cmap subtable (format~14). It is an odd subtable because - * it is not a mapping of input code points to glyphs, but contains lists - * of all variations supported by the font. - * - * A variation may be either 'default' or 'non-default' for a given font. - * A default variation is the one you will get for that code point if you - * look it up in the standard Unicode cmap. A non-default variation is a - * different glyph. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* glyph_variants */ + /* */ + /* <Title> */ + /* Glyph Variants */ + /* */ + /* <Abstract> */ + /* The FreeType~2 interface to Unicode Ideographic Variation */ + /* Sequences (IVS), using the SFNT cmap format~14. */ + /* */ + /* <Description> */ + /* Many CJK characters have variant forms. They are a sort of grey */ + /* area somewhere between being totally irrelevant and semantically */ + /* distinct; for this reason, the Unicode consortium decided to */ + /* introduce Ideographic Variation Sequences (IVS), consisting of a */ + /* Unicode base character and one of 240 variant selectors */ + /* (U+E0100-U+E01EF), instead of further extending the already huge */ + /* code range for CJK characters. */ + /* */ + /* An IVS is registered and unique; for further details please refer */ + /* to Unicode Technical Standard #37, the Ideographic Variation */ + /* Database: */ + /* */ + /* http://www.unicode.org/reports/tr37/ */ + /* */ + /* To date (November 2014), the character with the most variants is */ + /* U+9089, having 32 such IVS. */ + /* */ + /* Adobe and MS decided to support IVS with a new cmap subtable */ + /* (format~14). It is an odd subtable because it is not a mapping of */ + /* input code points to glyphs, but contains lists of all variants */ + /* supported by the font. */ + /* */ + /* A variant may be either `default' or `non-default'. A default */ + /* variant is the one you will get for that code point if you look it */ + /* up in the standard Unicode cmap. A non-default variant is a */ + /* different glyph. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Face_GetCharVariantIndex - * - * @description: - * Return the glyph index of a given character code as modified by the - * variation selector. - * - * @input: - * face :: - * A handle to the source face object. - * - * charcode :: - * The character code point in Unicode. - * - * variantSelector :: - * The Unicode code point of the variation selector. - * - * @return: - * The glyph index. 0~means either 'undefined character code', or - * 'undefined selector code', or 'no variation selector cmap subtable', - * or 'current CharMap is not Unicode'. - * - * @note: - * If you use FreeType to manipulate the contents of font files directly, - * be aware that the glyph index returned by this function doesn't always - * correspond to the internal indices used within the file. This is done - * to ensure that value~0 always corresponds to the 'missing glyph'. - * - * This function is only meaningful if - * a) the font has a variation selector cmap sub table, and - * b) the current charmap has a Unicode encoding. - * - * @since: - * 2.3.6 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Face_GetCharVariantIndex */ + /* */ + /* <Description> */ + /* Return the glyph index of a given character code as modified by */ + /* the variation selector. */ + /* */ + /* <Input> */ + /* face :: */ + /* A handle to the source face object. */ + /* */ + /* charcode :: */ + /* The character code point in Unicode. */ + /* */ + /* variantSelector :: */ + /* The Unicode code point of the variation selector. */ + /* */ + /* <Return> */ + /* The glyph index. 0~means either `undefined character code', or */ + /* `undefined selector code', or `no variation selector cmap */ + /* subtable', or `current CharMap is not Unicode'. */ + /* */ + /* <Note> */ + /* If you use FreeType to manipulate the contents of font files */ + /* directly, be aware that the glyph index returned by this function */ + /* doesn't always correspond to the internal indices used within */ + /* the file. This is done to ensure that value~0 always corresponds */ + /* to the `missing glyph'. */ + /* */ + /* This function is only meaningful if */ + /* a) the font has a variation selector cmap sub table, */ + /* and */ + /* b) the current charmap has a Unicode encoding. */ + /* */ + /* <Since> */ + /* 2.3.6 */ + /* */ FT_EXPORT( FT_UInt ) FT_Face_GetCharVariantIndex( FT_Face face, FT_ULong charcode, FT_ULong variantSelector ); - /************************************************************************** - * - * @function: - * FT_Face_GetCharVariantIsDefault - * - * @description: - * Check whether this variation of this Unicode character is the one to - * be found in the charmap. - * - * @input: - * face :: - * A handle to the source face object. - * - * charcode :: - * The character codepoint in Unicode. - * - * variantSelector :: - * The Unicode codepoint of the variation selector. - * - * @return: - * 1~if found in the standard (Unicode) cmap, 0~if found in the variation - * selector cmap, or -1 if it is not a variation. - * - * @note: - * This function is only meaningful if the font has a variation selector - * cmap subtable. - * - * @since: - * 2.3.6 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Face_GetCharVariantIsDefault */ + /* */ + /* <Description> */ + /* Check whether this variant of this Unicode character is the one to */ + /* be found in the `cmap'. */ + /* */ + /* <Input> */ + /* face :: */ + /* A handle to the source face object. */ + /* */ + /* charcode :: */ + /* The character codepoint in Unicode. */ + /* */ + /* variantSelector :: */ + /* The Unicode codepoint of the variation selector. */ + /* */ + /* <Return> */ + /* 1~if found in the standard (Unicode) cmap, 0~if found in the */ + /* variation selector cmap, or -1 if it is not a variant. */ + /* */ + /* <Note> */ + /* This function is only meaningful if the font has a variation */ + /* selector cmap subtable. */ + /* */ + /* <Since> */ + /* 2.3.6 */ + /* */ FT_EXPORT( FT_Int ) FT_Face_GetCharVariantIsDefault( FT_Face face, FT_ULong charcode, FT_ULong variantSelector ); - /************************************************************************** - * - * @function: - * FT_Face_GetVariantSelectors - * - * @description: - * Return a zero-terminated list of Unicode variation selectors found in - * the font. - * - * @input: - * face :: - * A handle to the source face object. - * - * @return: - * A pointer to an array of selector code points, or `NULL` if there is - * no valid variation selector cmap subtable. - * - * @note: - * The last item in the array is~0; the array is owned by the @FT_Face - * object but can be overwritten or released on the next call to a - * FreeType function. - * - * @since: - * 2.3.6 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Face_GetVariantSelectors */ + /* */ + /* <Description> */ + /* Return a zero-terminated list of Unicode variant selectors found */ + /* in the font. */ + /* */ + /* <Input> */ + /* face :: */ + /* A handle to the source face object. */ + /* */ + /* <Return> */ + /* A pointer to an array of selector code points, or NULL if there is */ + /* no valid variant selector cmap subtable. */ + /* */ + /* <Note> */ + /* The last item in the array is~0; the array is owned by the */ + /* @FT_Face object but can be overwritten or released on the next */ + /* call to a FreeType function. */ + /* */ + /* <Since> */ + /* 2.3.6 */ + /* */ FT_EXPORT( FT_UInt32* ) FT_Face_GetVariantSelectors( FT_Face face ); - /************************************************************************** - * - * @function: - * FT_Face_GetVariantsOfChar - * - * @description: - * Return a zero-terminated list of Unicode variation selectors found for - * the specified character code. - * - * @input: - * face :: - * A handle to the source face object. - * - * charcode :: - * The character codepoint in Unicode. - * - * @return: - * A pointer to an array of variation selector code points that are - * active for the given character, or `NULL` if the corresponding list is - * empty. - * - * @note: - * The last item in the array is~0; the array is owned by the @FT_Face - * object but can be overwritten or released on the next call to a - * FreeType function. - * - * @since: - * 2.3.6 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Face_GetVariantsOfChar */ + /* */ + /* <Description> */ + /* Return a zero-terminated list of Unicode variant selectors found */ + /* for the specified character code. */ + /* */ + /* <Input> */ + /* face :: */ + /* A handle to the source face object. */ + /* */ + /* charcode :: */ + /* The character codepoint in Unicode. */ + /* */ + /* <Return> */ + /* A pointer to an array of variant selector code points that are */ + /* active for the given character, or NULL if the corresponding list */ + /* is empty. */ + /* */ + /* <Note> */ + /* The last item in the array is~0; the array is owned by the */ + /* @FT_Face object but can be overwritten or released on the next */ + /* call to a FreeType function. */ + /* */ + /* <Since> */ + /* 2.3.6 */ + /* */ FT_EXPORT( FT_UInt32* ) FT_Face_GetVariantsOfChar( FT_Face face, FT_ULong charcode ); - /************************************************************************** - * - * @function: - * FT_Face_GetCharsOfVariant - * - * @description: - * Return a zero-terminated list of Unicode character codes found for the - * specified variation selector. - * - * @input: - * face :: - * A handle to the source face object. - * - * variantSelector :: - * The variation selector code point in Unicode. - * - * @return: - * A list of all the code points that are specified by this selector - * (both default and non-default codes are returned) or `NULL` if there - * is no valid cmap or the variation selector is invalid. - * - * @note: - * The last item in the array is~0; the array is owned by the @FT_Face - * object but can be overwritten or released on the next call to a - * FreeType function. - * - * @since: - * 2.3.6 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Face_GetCharsOfVariant */ + /* */ + /* <Description> */ + /* Return a zero-terminated list of Unicode character codes found for */ + /* the specified variant selector. */ + /* */ + /* <Input> */ + /* face :: */ + /* A handle to the source face object. */ + /* */ + /* variantSelector :: */ + /* The variant selector code point in Unicode. */ + /* */ + /* <Return> */ + /* A list of all the code points that are specified by this selector */ + /* (both default and non-default codes are returned) or NULL if there */ + /* is no valid cmap or the variant selector is invalid. */ + /* */ + /* <Note> */ + /* The last item in the array is~0; the array is owned by the */ + /* @FT_Face object but can be overwritten or released on the next */ + /* call to a FreeType function. */ + /* */ + /* <Since> */ + /* 2.3.6 */ + /* */ FT_EXPORT( FT_UInt32* ) FT_Face_GetCharsOfVariant( FT_Face face, FT_ULong variantSelector ); - /************************************************************************** - * - * @section: - * computations - * - * @title: - * Computations - * - * @abstract: - * Crunching fixed numbers and vectors. - * - * @description: - * This section contains various functions used to perform computations - * on 16.16 fixed-float numbers or 2d vectors. - * - * **Attention**: Most arithmetic functions take `FT_Long` as arguments. - * For historical reasons, FreeType was designed under the assumption - * that `FT_Long` is a 32-bit integer; results can thus be undefined if - * the arguments don't fit into 32 bits. - * - * @order: - * FT_MulDiv - * FT_MulFix - * FT_DivFix - * FT_RoundFix - * FT_CeilFix - * FT_FloorFix - * FT_Vector_Transform - * FT_Matrix_Multiply - * FT_Matrix_Invert - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* computations */ + /* */ + /* <Title> */ + /* Computations */ + /* */ + /* <Abstract> */ + /* Crunching fixed numbers and vectors. */ + /* */ + /* <Description> */ + /* This section contains various functions used to perform */ + /* computations on 16.16 fixed-float numbers or 2d vectors. */ + /* */ + /* <Order> */ + /* FT_MulDiv */ + /* FT_MulFix */ + /* FT_DivFix */ + /* FT_RoundFix */ + /* FT_CeilFix */ + /* FT_FloorFix */ + /* FT_Vector_Transform */ + /* FT_Matrix_Multiply */ + /* FT_Matrix_Invert */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_MulDiv - * - * @description: - * Compute `(a*b)/c` with maximum accuracy, using a 64-bit intermediate - * integer whenever necessary. - * - * This function isn't necessarily as fast as some processor-specific - * operations, but is at least completely portable. - * - * @input: - * a :: - * The first multiplier. - * - * b :: - * The second multiplier. - * - * c :: - * The divisor. - * - * @return: - * The result of `(a*b)/c`. This function never traps when trying to - * divide by zero; it simply returns 'MaxInt' or 'MinInt' depending on - * the signs of `a` and `b`. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_MulDiv */ + /* */ + /* <Description> */ + /* A very simple function used to perform the computation `(a*b)/c' */ + /* with maximum accuracy (it uses a 64-bit intermediate integer */ + /* whenever necessary). */ + /* */ + /* This function isn't necessarily as fast as some processor specific */ + /* operations, but is at least completely portable. */ + /* */ + /* <Input> */ + /* a :: The first multiplier. */ + /* b :: The second multiplier. */ + /* c :: The divisor. */ + /* */ + /* <Return> */ + /* The result of `(a*b)/c'. This function never traps when trying to */ + /* divide by zero; it simply returns `MaxInt' or `MinInt' depending */ + /* on the signs of `a' and `b'. */ + /* */ FT_EXPORT( FT_Long ) FT_MulDiv( FT_Long a, FT_Long b, FT_Long c ); - /************************************************************************** - * - * @function: - * FT_MulFix - * - * @description: - * Compute `(a*b)/0x10000` with maximum accuracy. Its main use is to - * multiply a given value by a 16.16 fixed-point factor. - * - * @input: - * a :: - * The first multiplier. - * - * b :: - * The second multiplier. Use a 16.16 factor here whenever possible - * (see note below). - * - * @return: - * The result of `(a*b)/0x10000`. - * - * @note: - * This function has been optimized for the case where the absolute value - * of `a` is less than 2048, and `b` is a 16.16 scaling factor. As this - * happens mainly when scaling from notional units to fractional pixels - * in FreeType, it resulted in noticeable speed improvements between - * versions 2.x and 1.x. - * - * As a conclusion, always try to place a 16.16 factor as the _second_ - * argument of this function; this can make a great difference. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_MulFix */ + /* */ + /* <Description> */ + /* A very simple function used to perform the computation */ + /* `(a*b)/0x10000' with maximum accuracy. Most of the time this is */ + /* used to multiply a given value by a 16.16 fixed-point factor. */ + /* */ + /* <Input> */ + /* a :: The first multiplier. */ + /* b :: The second multiplier. Use a 16.16 factor here whenever */ + /* possible (see note below). */ + /* */ + /* <Return> */ + /* The result of `(a*b)/0x10000'. */ + /* */ + /* <Note> */ + /* This function has been optimized for the case where the absolute */ + /* value of `a' is less than 2048, and `b' is a 16.16 scaling factor. */ + /* As this happens mainly when scaling from notional units to */ + /* fractional pixels in FreeType, it resulted in noticeable speed */ + /* improvements between versions 2.x and 1.x. */ + /* */ + /* As a conclusion, always try to place a 16.16 factor as the */ + /* _second_ argument of this function; this can make a great */ + /* difference. */ + /* */ FT_EXPORT( FT_Long ) FT_MulFix( FT_Long a, FT_Long b ); - /************************************************************************** - * - * @function: - * FT_DivFix - * - * @description: - * Compute `(a*0x10000)/b` with maximum accuracy. Its main use is to - * divide a given value by a 16.16 fixed-point factor. - * - * @input: - * a :: - * The numerator. - * - * b :: - * The denominator. Use a 16.16 factor here. - * - * @return: - * The result of `(a*0x10000)/b`. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_DivFix */ + /* */ + /* <Description> */ + /* A very simple function used to perform the computation */ + /* `(a*0x10000)/b' with maximum accuracy. Most of the time, this is */ + /* used to divide a given value by a 16.16 fixed-point factor. */ + /* */ + /* <Input> */ + /* a :: The numerator. */ + /* b :: The denominator. Use a 16.16 factor here. */ + /* */ + /* <Return> */ + /* The result of `(a*0x10000)/b'. */ + /* */ FT_EXPORT( FT_Long ) FT_DivFix( FT_Long a, FT_Long b ); - /************************************************************************** - * - * @function: - * FT_RoundFix - * - * @description: - * Round a 16.16 fixed number. - * - * @input: - * a :: - * The number to be rounded. - * - * @return: - * `a` rounded to the nearest 16.16 fixed integer, halfway cases away - * from zero. - * - * @note: - * The function uses wrap-around arithmetic. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_RoundFix */ + /* */ + /* <Description> */ + /* A very simple function used to round a 16.16 fixed number. */ + /* */ + /* <Input> */ + /* a :: The number to be rounded. */ + /* */ + /* <Return> */ + /* `a' rounded to nearest 16.16 fixed integer, halfway cases away */ + /* from zero. */ + /* */ FT_EXPORT( FT_Fixed ) FT_RoundFix( FT_Fixed a ); - /************************************************************************** - * - * @function: - * FT_CeilFix - * - * @description: - * Compute the smallest following integer of a 16.16 fixed number. - * - * @input: - * a :: - * The number for which the ceiling function is to be computed. - * - * @return: - * `a` rounded towards plus infinity. - * - * @note: - * The function uses wrap-around arithmetic. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_CeilFix */ + /* */ + /* <Description> */ + /* A very simple function used to compute the ceiling function of a */ + /* 16.16 fixed number. */ + /* */ + /* <Input> */ + /* a :: The number for which the ceiling function is to be computed. */ + /* */ + /* <Return> */ + /* `a' rounded towards plus infinity. */ + /* */ FT_EXPORT( FT_Fixed ) FT_CeilFix( FT_Fixed a ); - /************************************************************************** - * - * @function: - * FT_FloorFix - * - * @description: - * Compute the largest previous integer of a 16.16 fixed number. - * - * @input: - * a :: - * The number for which the floor function is to be computed. - * - * @return: - * `a` rounded towards minus infinity. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_FloorFix */ + /* */ + /* <Description> */ + /* A very simple function used to compute the floor function of a */ + /* 16.16 fixed number. */ + /* */ + /* <Input> */ + /* a :: The number for which the floor function is to be computed. */ + /* */ + /* <Return> */ + /* `a' rounded towards minus infinity. */ + /* */ FT_EXPORT( FT_Fixed ) FT_FloorFix( FT_Fixed a ); - /************************************************************************** - * - * @function: - * FT_Vector_Transform - * - * @description: - * Transform a single vector through a 2x2 matrix. - * - * @inout: - * vector :: - * The target vector to transform. - * - * @input: - * matrix :: - * A pointer to the source 2x2 matrix. - * - * @note: - * The result is undefined if either `vector` or `matrix` is invalid. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Vector_Transform */ + /* */ + /* <Description> */ + /* Transform a single vector through a 2x2 matrix. */ + /* */ + /* <InOut> */ + /* vector :: The target vector to transform. */ + /* */ + /* <Input> */ + /* matrix :: A pointer to the source 2x2 matrix. */ + /* */ + /* <Note> */ + /* The result is undefined if either `vector' or `matrix' is invalid. */ + /* */ FT_EXPORT( void ) - FT_Vector_Transform( FT_Vector* vector, + FT_Vector_Transform( FT_Vector* vec, const FT_Matrix* matrix ); - /************************************************************************** - * - * @section: - * version - * - * @title: - * FreeType Version - * - * @abstract: - * Functions and macros related to FreeType versions. - * - * @description: - * Note that those functions and macros are of limited use because even a - * new release of FreeType with only documentation changes increases the - * version number. - * - * @order: - * FT_Library_Version - * - * FREETYPE_MAJOR - * FREETYPE_MINOR - * FREETYPE_PATCH - * - * FT_Face_CheckTrueTypePatents - * FT_Face_SetUnpatentedHinting - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* version */ + /* */ + /* <Title> */ + /* FreeType Version */ + /* */ + /* <Abstract> */ + /* Functions and macros related to FreeType versions. */ + /* */ + /* <Description> */ + /* Note that those functions and macros are of limited use because */ + /* even a new release of FreeType with only documentation changes */ + /* increases the version number. */ + /* */ + /* <Order> */ + /* FT_Library_Version */ + /* */ + /* FREETYPE_MAJOR */ + /* FREETYPE_MINOR */ + /* FREETYPE_PATCH */ + /* */ + /* FT_Face_CheckTrueTypePatents */ + /* FT_Face_SetUnpatentedHinting */ + /* */ + /* FREETYPE_XXX */ + /* */ + /*************************************************************************/ - /************************************************************************** + /************************************************************************* * * @enum: * FREETYPE_XXX * * @description: - * These three macros identify the FreeType source code version. Use - * @FT_Library_Version to access them at runtime. + * These three macros identify the FreeType source code version. + * Use @FT_Library_Version to access them at runtime. * * @values: - * FREETYPE_MAJOR :: - * The major version number. - * FREETYPE_MINOR :: - * The minor version number. - * FREETYPE_PATCH :: - * The patch level. + * FREETYPE_MAJOR :: The major version number. + * FREETYPE_MINOR :: The minor version number. + * FREETYPE_PATCH :: The patch level. * * @note: - * The version number of FreeType if built as a dynamic link library with - * the 'libtool' package is _not_ controlled by these three macros. + * The version number of FreeType if built as a dynamic link library + * with the `libtool' package is _not_ controlled by these three + * macros. * */ #define FREETYPE_MAJOR 2 -#define FREETYPE_MINOR 10 -#define FREETYPE_PATCH 0 +#define FREETYPE_MINOR 6 +#define FREETYPE_PATCH 3 - /************************************************************************** - * - * @function: - * FT_Library_Version - * - * @description: - * Return the version of the FreeType library being used. This is useful - * when dynamically linking to the library, since one cannot use the - * macros @FREETYPE_MAJOR, @FREETYPE_MINOR, and @FREETYPE_PATCH. - * - * @input: - * library :: - * A source library handle. - * - * @output: - * amajor :: - * The major version number. - * - * aminor :: - * The minor version number. - * - * apatch :: - * The patch version number. - * - * @note: - * The reason why this function takes a `library` argument is because - * certain programs implement library initialization in a custom way that - * doesn't use @FT_Init_FreeType. - * - * In such cases, the library version might not be available before the - * library object has been created. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Library_Version */ + /* */ + /* <Description> */ + /* Return the version of the FreeType library being used. This is */ + /* useful when dynamically linking to the library, since one cannot */ + /* use the macros @FREETYPE_MAJOR, @FREETYPE_MINOR, and */ + /* @FREETYPE_PATCH. */ + /* */ + /* <Input> */ + /* library :: A source library handle. */ + /* */ + /* <Output> */ + /* amajor :: The major version number. */ + /* */ + /* aminor :: The minor version number. */ + /* */ + /* apatch :: The patch version number. */ + /* */ + /* <Note> */ + /* The reason why this function takes a `library' argument is because */ + /* certain programs implement library initialization in a custom way */ + /* that doesn't use @FT_Init_FreeType. */ + /* */ + /* In such cases, the library version might not be available before */ + /* the library object has been created. */ + /* */ FT_EXPORT( void ) FT_Library_Version( FT_Library library, FT_Int *amajor, @@ -4816,55 +4211,52 @@ FT_BEGIN_HEADER FT_Int *apatch ); - /************************************************************************** - * - * @function: - * FT_Face_CheckTrueTypePatents - * - * @description: - * Deprecated, does nothing. - * - * @input: - * face :: - * A face handle. - * - * @return: - * Always returns false. - * - * @note: - * Since May 2010, TrueType hinting is no longer patented. - * - * @since: - * 2.3.5 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Face_CheckTrueTypePatents */ + /* */ + /* <Description> */ + /* Deprecated, does nothing. */ + /* */ + /* <Input> */ + /* face :: A face handle. */ + /* */ + /* <Return> */ + /* Always returns false. */ + /* */ + /* <Note> */ + /* Since May 2010, TrueType hinting is no longer patented. */ + /* */ + /* <Since> */ + /* 2.3.5 */ + /* */ FT_EXPORT( FT_Bool ) FT_Face_CheckTrueTypePatents( FT_Face face ); - /************************************************************************** - * - * @function: - * FT_Face_SetUnpatentedHinting - * - * @description: - * Deprecated, does nothing. - * - * @input: - * face :: - * A face handle. - * - * value :: - * New boolean setting. - * - * @return: - * Always returns false. - * - * @note: - * Since May 2010, TrueType hinting is no longer patented. - * - * @since: - * 2.3.5 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Face_SetUnpatentedHinting */ + /* */ + /* <Description> */ + /* Deprecated, does nothing. */ + /* */ + /* <Input> */ + /* face :: A face handle. */ + /* */ + /* value :: New boolean setting. */ + /* */ + /* <Return> */ + /* Always returns false. */ + /* */ + /* <Note> */ + /* Since May 2010, TrueType hinting is no longer patented. */ + /* */ + /* <Since> */ + /* 2.3.5 */ + /* */ FT_EXPORT( FT_Bool ) FT_Face_SetUnpatentedHinting( FT_Face face, FT_Bool value ); diff --git a/android/x86_64/include/freetype/ft2build.h b/android/x86_64/include/freetype/ft2build.h deleted file mode 100644 index 8902236e..00000000 --- a/android/x86_64/include/freetype/ft2build.h +++ /dev/null @@ -1,44 +0,0 @@ -/**************************************************************************** - * - * ft2build.h - * - * FreeType 2 build and setup macros. - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ - - - /************************************************************************** - * - * This is the 'entry point' for FreeType header file inclusions. It is - * the only header file which should be included directly; all other - * FreeType header files should be accessed with macro names (after - * including `ft2build.h`). - * - * A typical example is - * - * ``` - * #include "ft2build.h" - * #include FT_FREETYPE_H - * ``` - * - */ - - -#ifndef FT2BUILD_H_ -#define FT2BUILD_H_ - -#include <freetype/config/ftheader.h> - -#endif /* FT2BUILD_H_ */ - - -/* END */ diff --git a/android/x86_64/include/freetype/ftadvanc.h b/android/x86_64/include/freetype/ftadvanc.h index 196da582..023dd84b 100644 --- a/android/x86_64/include/freetype/ftadvanc.h +++ b/android/x86_64/include/freetype/ftadvanc.h @@ -1,26 +1,26 @@ -/**************************************************************************** - * - * ftadvanc.h - * - * Quick computation of advance widths (specification only). - * - * Copyright (C) 2008-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftadvanc.h */ +/* */ +/* Quick computation of advance widths (specification only). */ +/* */ +/* Copyright 2008-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTADVANC_H_ #define FTADVANC_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -56,67 +56,68 @@ FT_BEGIN_HEADER */ - /************************************************************************** - * - * @enum: - * FT_ADVANCE_FLAG_FAST_ONLY - * - * @description: - * A bit-flag to be OR-ed with the `flags` parameter of the - * @FT_Get_Advance and @FT_Get_Advances functions. - * - * If set, it indicates that you want these functions to fail if the - * corresponding hinting mode or font driver doesn't allow for very quick - * advance computation. - * - * Typically, glyphs that are either unscaled, unhinted, bitmapped, or - * light-hinted can have their advance width computed very quickly. - * - * Normal and bytecode hinted modes that require loading, scaling, and - * hinting of the glyph outline, are extremely slow by comparison. - */ + /*************************************************************************/ + /* */ + /* <Const> */ + /* FT_ADVANCE_FLAG_FAST_ONLY */ + /* */ + /* <Description> */ + /* A bit-flag to be OR-ed with the `flags' parameter of the */ + /* @FT_Get_Advance and @FT_Get_Advances functions. */ + /* */ + /* If set, it indicates that you want these functions to fail if the */ + /* corresponding hinting mode or font driver doesn't allow for very */ + /* quick advance computation. */ + /* */ + /* Typically, glyphs that are either unscaled, unhinted, bitmapped, */ + /* or light-hinted can have their advance width computed very */ + /* quickly. */ + /* */ + /* Normal and bytecode hinted modes that require loading, scaling, */ + /* and hinting of the glyph outline, are extremely slow by */ + /* comparison. */ + /* */ #define FT_ADVANCE_FLAG_FAST_ONLY 0x20000000L - /************************************************************************** - * - * @function: - * FT_Get_Advance - * - * @description: - * Retrieve the advance value of a given glyph outline in an @FT_Face. - * - * @input: - * face :: - * The source @FT_Face handle. - * - * gindex :: - * The glyph index. - * - * load_flags :: - * A set of bit flags similar to those used when calling - * @FT_Load_Glyph, used to determine what kind of advances you need. - * @output: - * padvance :: - * The advance value. If scaling is performed (based on the value of - * `load_flags`), the advance value is in 16.16 format. Otherwise, it - * is in font units. - * - * If @FT_LOAD_VERTICAL_LAYOUT is set, this is the vertical advance - * corresponding to a vertical layout. Otherwise, it is the horizontal - * advance in a horizontal layout. - * - * @return: - * FreeType error code. 0 means success. - * - * @note: - * This function may fail if you use @FT_ADVANCE_FLAG_FAST_ONLY and if - * the corresponding font backend doesn't have a quick way to retrieve - * the advances. - * - * A scaled advance is returned in 16.16 format but isn't transformed by - * the affine transformation specified by @FT_Set_Transform. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Advance */ + /* */ + /* <Description> */ + /* Retrieve the advance value of a given glyph outline in an */ + /* @FT_Face. */ + /* */ + /* <Input> */ + /* face :: The source @FT_Face handle. */ + /* */ + /* gindex :: The glyph index. */ + /* */ + /* load_flags :: A set of bit flags similar to those used when */ + /* calling @FT_Load_Glyph, used to determine what kind */ + /* of advances you need. */ + /* <Output> */ + /* padvance :: The advance value. If scaling is performed (based on */ + /* the value of `load_flags'), the advance value is in */ + /* 16.16 format. Otherwise, it is in font units. */ + /* */ + /* If @FT_LOAD_VERTICAL_LAYOUT is set, this is the */ + /* vertical advance corresponding to a vertical layout. */ + /* Otherwise, it is the horizontal advance in a */ + /* horizontal layout. */ + /* */ + /* <Return> */ + /* FreeType error code. 0 means success. */ + /* */ + /* <Note> */ + /* This function may fail if you use @FT_ADVANCE_FLAG_FAST_ONLY and */ + /* if the corresponding font backend doesn't have a quick way to */ + /* retrieve the advances. */ + /* */ + /* A scaled advance is returned in 16.16 format but isn't transformed */ + /* by the affine transformation specified by @FT_Set_Transform. */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Advance( FT_Face face, FT_UInt gindex, @@ -124,52 +125,50 @@ FT_BEGIN_HEADER FT_Fixed *padvance ); - /************************************************************************** - * - * @function: - * FT_Get_Advances - * - * @description: - * Retrieve the advance values of several glyph outlines in an @FT_Face. - * - * @input: - * face :: - * The source @FT_Face handle. - * - * start :: - * The first glyph index. - * - * count :: - * The number of advance values you want to retrieve. - * - * load_flags :: - * A set of bit flags similar to those used when calling - * @FT_Load_Glyph. - * - * @output: - * padvance :: - * The advance values. This array, to be provided by the caller, must - * contain at least `count` elements. - * - * If scaling is performed (based on the value of `load_flags`), the - * advance values are in 16.16 format. Otherwise, they are in font - * units. - * - * If @FT_LOAD_VERTICAL_LAYOUT is set, these are the vertical advances - * corresponding to a vertical layout. Otherwise, they are the - * horizontal advances in a horizontal layout. - * - * @return: - * FreeType error code. 0 means success. - * - * @note: - * This function may fail if you use @FT_ADVANCE_FLAG_FAST_ONLY and if - * the corresponding font backend doesn't have a quick way to retrieve - * the advances. - * - * Scaled advances are returned in 16.16 format but aren't transformed by - * the affine transformation specified by @FT_Set_Transform. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Advances */ + /* */ + /* <Description> */ + /* Retrieve the advance values of several glyph outlines in an */ + /* @FT_Face. */ + /* */ + /* <Input> */ + /* face :: The source @FT_Face handle. */ + /* */ + /* start :: The first glyph index. */ + /* */ + /* count :: The number of advance values you want to retrieve. */ + /* */ + /* load_flags :: A set of bit flags similar to those used when */ + /* calling @FT_Load_Glyph. */ + /* */ + /* <Output> */ + /* padvance :: The advance values. This array, to be provided by the */ + /* caller, must contain at least `count' elements. */ + /* */ + /* If scaling is performed (based on the value of */ + /* `load_flags'), the advance values are in 16.16 format. */ + /* Otherwise, they are in font units. */ + /* */ + /* If @FT_LOAD_VERTICAL_LAYOUT is set, these are the */ + /* vertical advances corresponding to a vertical layout. */ + /* Otherwise, they are the horizontal advances in a */ + /* horizontal layout. */ + /* */ + /* <Return> */ + /* FreeType error code. 0 means success. */ + /* */ + /* <Note> */ + /* This function may fail if you use @FT_ADVANCE_FLAG_FAST_ONLY and */ + /* if the corresponding font backend doesn't have a quick way to */ + /* retrieve the advances. */ + /* */ + /* Scaled advances are returned in 16.16 format but aren't */ + /* transformed by the affine transformation specified by */ + /* @FT_Set_Transform. */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Advances( FT_Face face, FT_UInt start, diff --git a/android/x86_64/include/freetype/ftautoh.h b/android/x86_64/include/freetype/ftautoh.h new file mode 100644 index 00000000..8052dd23 --- /dev/null +++ b/android/x86_64/include/freetype/ftautoh.h @@ -0,0 +1,503 @@ +/***************************************************************************/ +/* */ +/* ftautoh.h */ +/* */ +/* FreeType API for controlling the auto-hinter (specification only). */ +/* */ +/* Copyright 2012-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ + + +#ifndef FTAUTOH_H_ +#define FTAUTOH_H_ + +#include <ft2build.h> +#include FT_FREETYPE_H + +#ifdef FREETYPE_H +#error "freetype.h of FreeType 1 has been loaded!" +#error "Please fix the directory search order for header files" +#error "so that freetype.h of FreeType 2 is found first." +#endif + + +FT_BEGIN_HEADER + + + /************************************************************************** + * + * @section: + * auto_hinter + * + * @title: + * The auto-hinter + * + * @abstract: + * Controlling the auto-hinting module. + * + * @description: + * While FreeType's auto-hinter doesn't expose API functions by itself, + * it is possible to control its behaviour with @FT_Property_Set and + * @FT_Property_Get. The following lists the available properties + * together with the necessary macros and structures. + * + * Note that the auto-hinter's module name is `autofitter' for + * historical reasons. + * + */ + + + /************************************************************************** + * + * @property: + * glyph-to-script-map + * + * @description: + * *Experimental* *only* + * + * The auto-hinter provides various script modules to hint glyphs. + * Examples of supported scripts are Latin or CJK. Before a glyph is + * auto-hinted, the Unicode character map of the font gets examined, and + * the script is then determined based on Unicode character ranges, see + * below. + * + * OpenType fonts, however, often provide much more glyphs than + * character codes (small caps, superscripts, ligatures, swashes, etc.), + * to be controlled by so-called `features'. Handling OpenType features + * can be quite complicated and thus needs a separate library on top of + * FreeType. + * + * The mapping between glyph indices and scripts (in the auto-hinter + * sense, see the @FT_AUTOHINTER_SCRIPT_XXX values) is stored as an + * array with `num_glyphs' elements, as found in the font's @FT_Face + * structure. The `glyph-to-script-map' property returns a pointer to + * this array, which can be modified as needed. Note that the + * modification should happen before the first glyph gets processed by + * the auto-hinter so that the global analysis of the font shapes + * actually uses the modified mapping. + * + * The following example code demonstrates how to access it (omitting + * the error handling). + * + * { + * FT_Library library; + * FT_Face face; + * FT_Prop_GlyphToScriptMap prop; + * + * + * FT_Init_FreeType( &library ); + * FT_New_Face( library, "foo.ttf", 0, &face ); + * + * prop.face = face; + * + * FT_Property_Get( library, "autofitter", + * "glyph-to-script-map", &prop ); + * + * // adjust `prop.map' as needed right here + * + * FT_Load_Glyph( face, ..., FT_LOAD_FORCE_AUTOHINT ); + * } + * + */ + + + /************************************************************************** + * + * @enum: + * FT_AUTOHINTER_SCRIPT_XXX + * + * @description: + * *Experimental* *only* + * + * A list of constants used for the @glyph-to-script-map property to + * specify the script submodule the auto-hinter should use for hinting a + * particular glyph. + * + * @values: + * FT_AUTOHINTER_SCRIPT_NONE :: + * Don't auto-hint this glyph. + * + * FT_AUTOHINTER_SCRIPT_LATIN :: + * Apply the latin auto-hinter. For the auto-hinter, `latin' is a + * very broad term, including Cyrillic and Greek also since characters + * from those scripts share the same design constraints. + * + * By default, characters from the following Unicode ranges are + * assigned to this submodule. + * + * { + * U+0020 - U+007F // Basic Latin (no control characters) + * U+00A0 - U+00FF // Latin-1 Supplement (no control characters) + * U+0100 - U+017F // Latin Extended-A + * U+0180 - U+024F // Latin Extended-B + * U+0250 - U+02AF // IPA Extensions + * U+02B0 - U+02FF // Spacing Modifier Letters + * U+0300 - U+036F // Combining Diacritical Marks + * U+0370 - U+03FF // Greek and Coptic + * U+0400 - U+04FF // Cyrillic + * U+0500 - U+052F // Cyrillic Supplement + * U+1D00 - U+1D7F // Phonetic Extensions + * U+1D80 - U+1DBF // Phonetic Extensions Supplement + * U+1DC0 - U+1DFF // Combining Diacritical Marks Supplement + * U+1E00 - U+1EFF // Latin Extended Additional + * U+1F00 - U+1FFF // Greek Extended + * U+2000 - U+206F // General Punctuation + * U+2070 - U+209F // Superscripts and Subscripts + * U+20A0 - U+20CF // Currency Symbols + * U+2150 - U+218F // Number Forms + * U+2460 - U+24FF // Enclosed Alphanumerics + * U+2C60 - U+2C7F // Latin Extended-C + * U+2DE0 - U+2DFF // Cyrillic Extended-A + * U+2E00 - U+2E7F // Supplemental Punctuation + * U+A640 - U+A69F // Cyrillic Extended-B + * U+A720 - U+A7FF // Latin Extended-D + * U+FB00 - U+FB06 // Alphab. Present. Forms (Latin Ligatures) + * U+1D400 - U+1D7FF // Mathematical Alphanumeric Symbols + * U+1F100 - U+1F1FF // Enclosed Alphanumeric Supplement + * } + * + * FT_AUTOHINTER_SCRIPT_CJK :: + * Apply the CJK auto-hinter, covering Chinese, Japanese, Korean, old + * Vietnamese, and some other scripts. + * + * By default, characters from the following Unicode ranges are + * assigned to this submodule. + * + * { + * U+1100 - U+11FF // Hangul Jamo + * U+2E80 - U+2EFF // CJK Radicals Supplement + * U+2F00 - U+2FDF // Kangxi Radicals + * U+2FF0 - U+2FFF // Ideographic Description Characters + * U+3000 - U+303F // CJK Symbols and Punctuation + * U+3040 - U+309F // Hiragana + * U+30A0 - U+30FF // Katakana + * U+3100 - U+312F // Bopomofo + * U+3130 - U+318F // Hangul Compatibility Jamo + * U+3190 - U+319F // Kanbun + * U+31A0 - U+31BF // Bopomofo Extended + * U+31C0 - U+31EF // CJK Strokes + * U+31F0 - U+31FF // Katakana Phonetic Extensions + * U+3200 - U+32FF // Enclosed CJK Letters and Months + * U+3300 - U+33FF // CJK Compatibility + * U+3400 - U+4DBF // CJK Unified Ideographs Extension A + * U+4DC0 - U+4DFF // Yijing Hexagram Symbols + * U+4E00 - U+9FFF // CJK Unified Ideographs + * U+A960 - U+A97F // Hangul Jamo Extended-A + * U+AC00 - U+D7AF // Hangul Syllables + * U+D7B0 - U+D7FF // Hangul Jamo Extended-B + * U+F900 - U+FAFF // CJK Compatibility Ideographs + * U+FE10 - U+FE1F // Vertical forms + * U+FE30 - U+FE4F // CJK Compatibility Forms + * U+FF00 - U+FFEF // Halfwidth and Fullwidth Forms + * U+1B000 - U+1B0FF // Kana Supplement + * U+1D300 - U+1D35F // Tai Xuan Hing Symbols + * U+1F200 - U+1F2FF // Enclosed Ideographic Supplement + * U+20000 - U+2A6DF // CJK Unified Ideographs Extension B + * U+2A700 - U+2B73F // CJK Unified Ideographs Extension C + * U+2B740 - U+2B81F // CJK Unified Ideographs Extension D + * U+2F800 - U+2FA1F // CJK Compatibility Ideographs Supplement + * } + * + * FT_AUTOHINTER_SCRIPT_INDIC :: + * Apply the indic auto-hinter, covering all major scripts from the + * Indian sub-continent and some other related scripts like Thai, Lao, + * or Tibetan. + * + * By default, characters from the following Unicode ranges are + * assigned to this submodule. + * + * { + * U+0900 - U+0DFF // Indic Range + * U+0F00 - U+0FFF // Tibetan + * U+1900 - U+194F // Limbu + * U+1B80 - U+1BBF // Sundanese + * U+1C80 - U+1CDF // Meetei Mayak + * U+A800 - U+A82F // Syloti Nagri + * U+11800 - U+118DF // Sharada + * } + * + * Note that currently Indic support is rudimentary only, missing blue + * zone support. + * + */ +#define FT_AUTOHINTER_SCRIPT_NONE 0 +#define FT_AUTOHINTER_SCRIPT_LATIN 1 +#define FT_AUTOHINTER_SCRIPT_CJK 2 +#define FT_AUTOHINTER_SCRIPT_INDIC 3 + + + /************************************************************************** + * + * @struct: + * FT_Prop_GlyphToScriptMap + * + * @description: + * *Experimental* *only* + * + * The data exchange structure for the @glyph-to-script-map property. + * + */ + typedef struct FT_Prop_GlyphToScriptMap_ + { + FT_Face face; + FT_UShort* map; + + } FT_Prop_GlyphToScriptMap; + + + /************************************************************************** + * + * @property: + * fallback-script + * + * @description: + * *Experimental* *only* + * + * If no auto-hinter script module can be assigned to a glyph, a + * fallback script gets assigned to it (see also the + * @glyph-to-script-map property). By default, this is + * @FT_AUTOHINTER_SCRIPT_CJK. Using the `fallback-script' property, + * this fallback value can be changed. + * + * { + * FT_Library library; + * FT_UInt fallback_script = FT_AUTOHINTER_SCRIPT_NONE; + * + * + * FT_Init_FreeType( &library ); + * + * FT_Property_Set( library, "autofitter", + * "fallback-script", &fallback_script ); + * } + * + * @note: + * This property can be used with @FT_Property_Get also. + * + * It's important to use the right timing for changing this value: The + * creation of the glyph-to-script map that eventually uses the + * fallback script value gets triggered either by setting or reading a + * face-specific property like @glyph-to-script-map, or by auto-hinting + * any glyph from that face. In particular, if you have already created + * an @FT_Face structure but not loaded any glyph (using the + * auto-hinter), a change of the fallback script will affect this face. + * + */ + + + /************************************************************************** + * + * @property: + * default-script + * + * @description: + * *Experimental* *only* + * + * If FreeType gets compiled with FT_CONFIG_OPTION_USE_HARFBUZZ to make + * the HarfBuzz library access OpenType features for getting better + * glyph coverages, this property sets the (auto-fitter) script to be + * used for the default (OpenType) script data of a font's GSUB table. + * Features for the default script are intended for all scripts not + * explicitly handled in GSUB; an example is a `dlig' feature, + * containing the combination of the characters `T', `E', and `L' to + * form a `TEL' ligature. + * + * By default, this is @FT_AUTOHINTER_SCRIPT_LATIN. Using the + * `default-script' property, this default value can be changed. + * + * { + * FT_Library library; + * FT_UInt default_script = FT_AUTOHINTER_SCRIPT_NONE; + * + * + * FT_Init_FreeType( &library ); + * + * FT_Property_Set( library, "autofitter", + * "default-script", &default_script ); + * } + * + * @note: + * This property can be used with @FT_Property_Get also. + * + * It's important to use the right timing for changing this value: The + * creation of the glyph-to-script map that eventually uses the + * default script value gets triggered either by setting or reading a + * face-specific property like @glyph-to-script-map, or by auto-hinting + * any glyph from that face. In particular, if you have already created + * an @FT_Face structure but not loaded any glyph (using the + * auto-hinter), a change of the default script will affect this face. + * + */ + + + /************************************************************************** + * + * @property: + * increase-x-height + * + * @description: + * For ppem values in the range 6~<= ppem <= `increase-x-height', round + * up the font's x~height much more often than normally. If the value + * is set to~0, which is the default, this feature is switched off. Use + * this property to improve the legibility of small font sizes if + * necessary. + * + * { + * FT_Library library; + * FT_Face face; + * FT_Prop_IncreaseXHeight prop; + * + * + * FT_Init_FreeType( &library ); + * FT_New_Face( library, "foo.ttf", 0, &face ); + * FT_Set_Char_Size( face, 10 * 64, 0, 72, 0 ); + * + * prop.face = face; + * prop.limit = 14; + * + * FT_Property_Set( library, "autofitter", + * "increase-x-height", &prop ); + * } + * + * @note: + * This property can be used with @FT_Property_Get also. + * + * Set this value right after calling @FT_Set_Char_Size, but before + * loading any glyph (using the auto-hinter). + * + */ + + + /************************************************************************** + * + * @struct: + * FT_Prop_IncreaseXHeight + * + * @description: + * The data exchange structure for the @increase-x-height property. + * + */ + typedef struct FT_Prop_IncreaseXHeight_ + { + FT_Face face; + FT_UInt limit; + + } FT_Prop_IncreaseXHeight; + + + /************************************************************************** + * + * @property: + * warping + * + * @description: + * *Experimental* *only* + * + * If FreeType gets compiled with option AF_CONFIG_OPTION_USE_WARPER to + * activate the warp hinting code in the auto-hinter, this property + * switches warping on and off. + * + * Warping only works in `light' auto-hinting mode. The idea of the + * code is to slightly scale and shift a glyph along the non-hinted + * dimension (which is usually the horizontal axis) so that as much of + * its segments are aligned (more or less) to the grid. To find out a + * glyph's optimal scaling and shifting value, various parameter + * combinations are tried and scored. + * + * By default, warping is off. The example below shows how to switch on + * warping (omitting the error handling). + * + * { + * FT_Library library; + * FT_Bool warping = 1; + * + * + * FT_Init_FreeType( &library ); + * + * FT_Property_Set( library, "autofitter", + * "warping", &warping ); + * } + * + * @note: + * This property can be used with @FT_Property_Get also. + * + * The warping code can also change advance widths. Have a look at the + * `lsb_delta' and `rsb_delta' fields in the @FT_GlyphSlotRec structure + * for details on improving inter-glyph distances while rendering. + * + * Since warping is a global property of the auto-hinter it is best to + * change its value before rendering any face. Otherwise, you should + * reload all faces that get auto-hinted in `light' hinting mode. + * + */ + + + /************************************************************************** + * + * @property: + * no-stem-darkening[autofit] + * + * @description: + * *Experimental* *only,* *requires* *linear* *alpha* *blending* *and* + * *gamma* *correction* + * + * Stem darkening emboldens glyphs at smaller sizes to make them more + * readable on common low-DPI screens when using linear alpha blending + * and gamma correction, see @FT_Render_Glyph. When not using linear + * alpha blending and gamma correction, glyphs will appear heavy and + * fuzzy! + * + * Gamma correction essentially lightens fonts since shades of grey are + * shifted to higher pixel values (=~higher brightness) to match the + * original intention to the reality of our screens. The side-effect is + * that glyphs `thin out'. Mac OS~X and Adobe's proprietary font + * rendering library implement a counter-measure: stem darkening at + * smaller sizes where shades of gray dominate. By emboldening a glyph + * slightly in relation to its pixel size, individual pixels get higher + * coverage of filled-in outlines and are therefore `blacker'. This + * counteracts the `thinning out' of glyphs, making text remain readable + * at smaller sizes. All glyphs that pass through the auto-hinter will + * be emboldened unless this property is set to TRUE. + * + * See the description of the CFF driver for algorithmic details. Total + * consistency with the CFF driver is currently not achieved because the + * emboldening method differs and glyphs must be scaled down on the + * Y-axis to keep outline points inside their precomputed blue zones. + * The smaller the size (especially 9ppem and down), the higher the loss + * of emboldening versus the CFF driver. + * + */ + + + /************************************************************************** + * + * @property: + * darkening-parameters[autofit] + * + * @description: + * *Experimental* *only* + * + * See the description of the CFF driver for details. This + * implementation appropriates the + * CFF_CONFIG_OPTION_DARKENING_PARAMETER_* #defines for consistency. + * Note the differences described in @no-stem-darkening[autofit]. + * + */ + + + /* */ + + +FT_END_HEADER + +#endif /* FTAUTOH_H_ */ + + +/* END */ diff --git a/android/x86_64/include/freetype/ftbbox.h b/android/x86_64/include/freetype/ftbbox.h index 573182a0..2a4d2144 100644 --- a/android/x86_64/include/freetype/ftbbox.h +++ b/android/x86_64/include/freetype/ftbbox.h @@ -1,37 +1,37 @@ -/**************************************************************************** - * - * ftbbox.h - * - * FreeType exact bbox computation (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftbbox.h */ +/* */ +/* FreeType exact bbox computation (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * This component has a _single_ role: to compute exact outline bounding - * boxes. - * - * It is separated from the rest of the engine for various technical - * reasons. It may well be integrated in 'ftoutln' later. - * - */ + /*************************************************************************/ + /* */ + /* This component has a _single_ role: to compute exact outline bounding */ + /* boxes. */ + /* */ + /* It is separated from the rest of the engine for various technical */ + /* reasons. It may well be integrated in `ftoutln' later. */ + /* */ + /*************************************************************************/ #ifndef FTBBOX_H_ #define FTBBOX_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -44,44 +44,43 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * outline_processing - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* outline_processing */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Outline_Get_BBox - * - * @description: - * Compute the exact bounding box of an outline. This is slower than - * computing the control box. However, it uses an advanced algorithm - * that returns _very_ quickly when the two boxes coincide. Otherwise, - * the outline Bezier arcs are traversed to extract their extrema. - * - * @input: - * outline :: - * A pointer to the source outline. - * - * @output: - * abbox :: - * The outline's exact bounding box. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * If the font is tricky and the glyph has been loaded with - * @FT_LOAD_NO_SCALE, the resulting BBox is meaningless. To get - * reasonable values for the BBox 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 BBox, which can be - * eventually converted back to font units. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Get_BBox */ + /* */ + /* <Description> */ + /* Compute the exact bounding box of an outline. This is slower */ + /* than computing the control box. However, it uses an advanced */ + /* algorithm that returns _very_ quickly when the two boxes */ + /* coincide. Otherwise, the outline Bézier arcs are traversed to */ + /* extract their extrema. */ + /* */ + /* <Input> */ + /* outline :: A pointer to the source outline. */ + /* */ + /* <Output> */ + /* abbox :: The outline's exact bounding box. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* If the font is tricky and the glyph has been loaded with */ + /* @FT_LOAD_NO_SCALE, the resulting BBox is meaningless. To get */ + /* reasonable values for the BBox 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 BBox, */ + /* which can be eventually converted back to font units. */ + /* */ FT_EXPORT( FT_Error ) FT_Outline_Get_BBox( FT_Outline* outline, FT_BBox *abbox ); diff --git a/android/x86_64/include/freetype/ftbdf.h b/android/x86_64/include/freetype/ftbdf.h index 755ec935..016dba08 100644 --- a/android/x86_64/include/freetype/ftbdf.h +++ b/android/x86_64/include/freetype/ftbdf.h @@ -1,25 +1,25 @@ -/**************************************************************************** - * - * ftbdf.h - * - * FreeType API for accessing BDF-specific strings (specification). - * - * Copyright (C) 2002-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftbdf.h */ +/* */ +/* FreeType API for accessing BDF-specific strings (specification). */ +/* */ +/* Copyright 2002-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTBDF_H_ #define FTBDF_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -32,25 +32,25 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * bdf_fonts - * - * @title: - * BDF and PCF Files - * - * @abstract: - * BDF and PCF specific API. - * - * @description: - * This section contains the declaration of functions specific to BDF and - * PCF fonts. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* bdf_fonts */ + /* */ + /* <Title> */ + /* BDF and PCF Files */ + /* */ + /* <Abstract> */ + /* BDF and PCF specific API. */ + /* */ + /* <Description> */ + /* This section contains the declaration of functions specific to BDF */ + /* and PCF fonts. */ + /* */ + /*************************************************************************/ - /************************************************************************** + /********************************************************************** * * @enum: * BDF_PropertyType @@ -81,40 +81,40 @@ FT_BEGIN_HEADER } BDF_PropertyType; - /************************************************************************** + /********************************************************************** * * @type: * BDF_Property * * @description: - * A handle to a @BDF_PropertyRec structure to model a given BDF/PCF - * property. + * A handle to a @BDF_PropertyRec structure to model a given + * BDF/PCF property. */ typedef struct BDF_PropertyRec_* BDF_Property; - /************************************************************************** - * - * @struct: - * BDF_PropertyRec - * - * @description: - * This structure models a given BDF/PCF property. - * - * @fields: - * type :: - * The property type. - * - * u.atom :: - * The atom string, if type is @BDF_PROPERTY_TYPE_ATOM. May be - * `NULL`, indicating an empty string. - * - * u.integer :: - * A signed integer, if type is @BDF_PROPERTY_TYPE_INTEGER. - * - * u.cardinal :: - * An unsigned integer, if type is @BDF_PROPERTY_TYPE_CARDINAL. - */ + /********************************************************************** + * + * @struct: + * BDF_PropertyRec + * + * @description: + * This structure models a given BDF/PCF property. + * + * @fields: + * type :: + * The property type. + * + * u.atom :: + * The atom string, if type is @BDF_PROPERTY_TYPE_ATOM. May be + * NULL, indicating an empty string. + * + * u.integer :: + * A signed integer, if type is @BDF_PROPERTY_TYPE_INTEGER. + * + * u.cardinal :: + * An unsigned integer, if type is @BDF_PROPERTY_TYPE_CARDINAL. + */ typedef struct BDF_PropertyRec_ { BDF_PropertyType type; @@ -128,76 +128,73 @@ FT_BEGIN_HEADER } BDF_PropertyRec; - /************************************************************************** - * - * @function: - * FT_Get_BDF_Charset_ID - * - * @description: - * Retrieve a BDF font character set identity, according to the BDF - * specification. - * - * @input: - * face :: - * A handle to the input face. - * - * @output: - * acharset_encoding :: - * Charset encoding, as a C~string, owned by the face. - * - * acharset_registry :: - * Charset registry, as a C~string, owned by the face. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function only works with BDF faces, returning an error otherwise. - */ + /********************************************************************** + * + * @function: + * FT_Get_BDF_Charset_ID + * + * @description: + * Retrieve a BDF font character set identity, according to + * the BDF specification. + * + * @input: + * face :: + * A handle to the input face. + * + * @output: + * acharset_encoding :: + * Charset encoding, as a C~string, owned by the face. + * + * acharset_registry :: + * Charset registry, as a C~string, owned by the face. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * This function only works with BDF faces, returning an error otherwise. + */ FT_EXPORT( FT_Error ) FT_Get_BDF_Charset_ID( FT_Face face, const char* *acharset_encoding, const char* *acharset_registry ); - /************************************************************************** - * - * @function: - * FT_Get_BDF_Property - * - * @description: - * Retrieve a BDF property from a BDF or PCF font file. - * - * @input: - * face :: - * A handle to the input face. - * - * name :: - * The property name. - * - * @output: - * aproperty :: - * The property. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function works with BDF _and_ PCF fonts. It returns an error - * otherwise. It also returns an error if the property is not in the - * font. - * - * A 'property' is a either key-value pair within the STARTPROPERTIES - * ... ENDPROPERTIES block of a BDF font or a key-value pair from the - * `info->props` array within a `FontRec` structure of a PCF font. - * - * Integer properties are always stored as 'signed' within PCF fonts; - * consequently, @BDF_PROPERTY_TYPE_CARDINAL is a possible return value - * for BDF fonts only. - * - * In case of error, `aproperty->type` is always set to - * @BDF_PROPERTY_TYPE_NONE. - */ + /********************************************************************** + * + * @function: + * FT_Get_BDF_Property + * + * @description: + * Retrieve a BDF property from a BDF or PCF font file. + * + * @input: + * face :: A handle to the input face. + * + * name :: The property name. + * + * @output: + * aproperty :: The property. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * This function works with BDF _and_ PCF fonts. It returns an error + * otherwise. It also returns an error if the property is not in the + * font. + * + * A `property' is a either key-value pair within the STARTPROPERTIES + * ... ENDPROPERTIES block of a BDF font or a key-value pair from the + * `info->props' array within a `FontRec' structure of a PCF font. + * + * Integer properties are always stored as `signed' within PCF fonts; + * consequently, @BDF_PROPERTY_TYPE_CARDINAL is a possible return value + * for BDF fonts only. + * + * In case of error, `aproperty->type' is always set to + * @BDF_PROPERTY_TYPE_NONE. + */ FT_EXPORT( FT_Error ) FT_Get_BDF_Property( FT_Face face, const char* prop_name, diff --git a/android/x86_64/include/freetype/ftbitmap.h b/android/x86_64/include/freetype/ftbitmap.h index 83acc5f4..0eac7b9d 100644 --- a/android/x86_64/include/freetype/ftbitmap.h +++ b/android/x86_64/include/freetype/ftbitmap.h @@ -1,28 +1,27 @@ -/**************************************************************************** - * - * ftbitmap.h - * - * FreeType utility functions for bitmaps (specification). - * - * Copyright (C) 2004-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftbitmap.h */ +/* */ +/* FreeType utility functions for bitmaps (specification). */ +/* */ +/* Copyright 2004-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTBITMAP_H_ #define FTBITMAP_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H -#include FT_COLOR_H #ifdef FREETYPE_H #error "freetype.h of FreeType 1 has been loaded!" @@ -34,46 +33,39 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * bitmap_handling - * - * @title: - * Bitmap Handling - * - * @abstract: - * Handling FT_Bitmap objects. - * - * @description: - * This section contains functions for handling @FT_Bitmap objects, - * automatically adjusting the target's bitmap buffer size as needed. - * - * Note that none of the functions changes the bitmap's 'flow' (as - * indicated by the sign of the `pitch` field in @FT_Bitmap). - * - * To set the flow, assign an appropriate positive or negative value to - * the `pitch` field of the target @FT_Bitmap object after calling - * @FT_Bitmap_Init but before calling any of the other functions - * described here. - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* bitmap_handling */ + /* */ + /* <Title> */ + /* Bitmap Handling */ + /* */ + /* <Abstract> */ + /* Handling FT_Bitmap objects. */ + /* */ + /* <Description> */ + /* This section contains functions for handling @FT_Bitmap objects. */ + /* Note that none of the functions changes the bitmap's `flow' (as */ + /* indicated by the sign of the `pitch' field in `FT_Bitmap'). */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Bitmap_Init - * - * @description: - * Initialize a pointer to an @FT_Bitmap structure. - * - * @inout: - * abitmap :: - * A pointer to the bitmap structure. - * - * @note: - * A deprecated name for the same function is `FT_Bitmap_New`. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Bitmap_Init */ + /* */ + /* <Description> */ + /* Initialize a pointer to an @FT_Bitmap structure. */ + /* */ + /* <InOut> */ + /* abitmap :: A pointer to the bitmap structure. */ + /* */ + /* <Note> */ + /* A deprecated name for the same function is `FT_Bitmap_New'. */ + /* */ FT_EXPORT( void ) FT_Bitmap_Init( FT_Bitmap *abitmap ); @@ -83,77 +75,66 @@ FT_BEGIN_HEADER FT_Bitmap_New( FT_Bitmap *abitmap ); - /************************************************************************** - * - * @function: - * FT_Bitmap_Copy - * - * @description: - * Copy a bitmap into another one. - * - * @input: - * library :: - * A handle to a library object. - * - * source :: - * A handle to the source bitmap. - * - * @output: - * target :: - * A handle to the target bitmap. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * `source->buffer` and `target->buffer` must neither be equal nor - * overlap. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Bitmap_Copy */ + /* */ + /* <Description> */ + /* Copy a bitmap into another one. */ + /* */ + /* <Input> */ + /* library :: A handle to a library object. */ + /* */ + /* source :: A handle to the source bitmap. */ + /* */ + /* <Output> */ + /* target :: A handle to the target bitmap. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Bitmap_Copy( FT_Library library, const FT_Bitmap *source, - FT_Bitmap *target ); + FT_Bitmap *target); - /************************************************************************** - * - * @function: - * FT_Bitmap_Embolden - * - * @description: - * Embolden a bitmap. The new bitmap will be about `xStrength` pixels - * wider and `yStrength` pixels higher. The left and bottom borders are - * kept unchanged. - * - * @input: - * library :: - * A handle to a library object. - * - * xStrength :: - * How strong the glyph is emboldened horizontally. Expressed in 26.6 - * pixel format. - * - * yStrength :: - * How strong the glyph is emboldened vertically. Expressed in 26.6 - * pixel format. - * - * @inout: - * bitmap :: - * A handle to the target bitmap. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The current implementation restricts `xStrength` to be less than or - * equal to~8 if bitmap is of pixel_mode @FT_PIXEL_MODE_MONO. - * - * If you want to embolden the bitmap owned by a @FT_GlyphSlotRec, you - * should call @FT_GlyphSlot_Own_Bitmap on the slot first. - * - * Bitmaps in @FT_PIXEL_MODE_GRAY2 and @FT_PIXEL_MODE_GRAY@ format are - * converted to @FT_PIXEL_MODE_GRAY format (i.e., 8bpp). - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Bitmap_Embolden */ + /* */ + /* <Description> */ + /* Embolden a bitmap. The new bitmap will be about `xStrength' */ + /* pixels wider and `yStrength' pixels higher. The left and bottom */ + /* borders are kept unchanged. */ + /* */ + /* <Input> */ + /* library :: A handle to a library object. */ + /* */ + /* xStrength :: How strong the glyph is emboldened horizontally. */ + /* Expressed in 26.6 pixel format. */ + /* */ + /* yStrength :: How strong the glyph is emboldened vertically. */ + /* Expressed in 26.6 pixel format. */ + /* */ + /* <InOut> */ + /* bitmap :: A handle to the target bitmap. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The current implementation restricts `xStrength' to be less than */ + /* or equal to~8 if bitmap is of pixel_mode @FT_PIXEL_MODE_MONO. */ + /* */ + /* If you want to embolden the bitmap owned by a @FT_GlyphSlotRec, */ + /* you should call @FT_GlyphSlot_Own_Bitmap on the slot first. */ + /* */ + /* Bitmaps in @FT_PIXEL_MODE_GRAY2 and @FT_PIXEL_MODE_GRAY@ format */ + /* are converted to @FT_PIXEL_MODE_GRAY format (i.e., 8bpp). */ + /* */ FT_EXPORT( FT_Error ) FT_Bitmap_Embolden( FT_Library library, FT_Bitmap* bitmap, @@ -161,46 +142,39 @@ FT_BEGIN_HEADER FT_Pos yStrength ); - /************************************************************************** - * - * @function: - * FT_Bitmap_Convert - * - * @description: - * Convert a bitmap object with depth 1bpp, 2bpp, 4bpp, 8bpp or 32bpp to - * a bitmap object with depth 8bpp, making the number of used bytes per - * line (a.k.a. the 'pitch') a multiple of `alignment`. - * - * @input: - * library :: - * A handle to a library object. - * - * source :: - * The source bitmap. - * - * alignment :: - * The pitch of the bitmap is a multiple of this argument. Common - * values are 1, 2, or 4. - * - * @output: - * target :: - * The target bitmap. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * It is possible to call @FT_Bitmap_Convert multiple times without - * calling @FT_Bitmap_Done (the memory is simply reallocated). - * - * Use @FT_Bitmap_Done to finally remove the bitmap object. - * - * The `library` argument is taken to have access to FreeType's memory - * handling functions. - * - * `source->buffer` and `target->buffer` must neither be equal nor - * overlap. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Bitmap_Convert */ + /* */ + /* <Description> */ + /* Convert a bitmap object with depth 1bpp, 2bpp, 4bpp, 8bpp or 32bpp */ + /* to a bitmap object with depth 8bpp, making the number of used */ + /* bytes line (a.k.a. the `pitch') a multiple of `alignment'. */ + /* */ + /* <Input> */ + /* library :: A handle to a library object. */ + /* */ + /* source :: The source bitmap. */ + /* */ + /* alignment :: The pitch of the bitmap is a multiple of this */ + /* parameter. Common values are 1, 2, or 4. */ + /* */ + /* <Output> */ + /* target :: The target bitmap. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* It is possible to call @FT_Bitmap_Convert multiple times without */ + /* calling @FT_Bitmap_Done (the memory is simply reallocated). */ + /* */ + /* Use @FT_Bitmap_Done to finally remove the bitmap object. */ + /* */ + /* The `library' argument is taken to have access to FreeType's */ + /* memory handling functions. */ + /* */ FT_EXPORT( FT_Error ) FT_Bitmap_Convert( FT_Library library, const FT_Bitmap *source, @@ -208,112 +182,48 @@ FT_BEGIN_HEADER FT_Int alignment ); - /************************************************************************** - * - * @function: - * FT_Bitmap_Blend - * - * @description: - * Blend a bitmap onto another bitmap, using a given color. - * - * @input: - * library :: - * A handle to a library object. - * - * source :: - * The source bitmap, which can have any @FT_Pixel_Mode format. - * - * source_offset :: - * The offset vector to the upper left corner of the source bitmap in - * 26.6 pixel format. It should represent an integer offset; the - * function will set the lowest six bits to zero to enforce that. - * - * color :: - * The color used to draw `source` onto `target`. - * - * @inout: - * target :: - * A handle to an `FT_Bitmap` object. It should be either initialized - * as empty with a call to @FT_Bitmap_Init, or it should be of type - * @FT_PIXEL_MODE_BGRA. - * - * atarget_offset :: - * The offset vector to the upper left corner of the target bitmap in - * 26.6 pixel format. It should represent an integer offset; the - * function will set the lowest six bits to zero to enforce that. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function doesn't perform clipping. - * - * The bitmap in `target` gets allocated or reallocated as needed; the - * vector `atarget_offset` is updated accordingly. - * - * In case of allocation or reallocation, the bitmap's pitch is set to - * `4 * width`. Both `source` and `target` must have the same bitmap - * flow (as indicated by the sign of the `pitch` field). - * - * `source->buffer` and `target->buffer` must neither be equal nor - * overlap. - * - * @since: - * 2.10 - */ - FT_EXPORT( FT_Error ) - FT_Bitmap_Blend( FT_Library library, - const FT_Bitmap* source, - const FT_Vector source_offset, - FT_Bitmap* target, - FT_Vector *atarget_offset, - FT_Color color ); - - - /************************************************************************** - * - * @function: - * FT_GlyphSlot_Own_Bitmap - * - * @description: - * Make sure that a glyph slot owns `slot->bitmap`. - * - * @input: - * slot :: - * The glyph slot. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function is to be used in combination with @FT_Bitmap_Embolden. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_GlyphSlot_Own_Bitmap */ + /* */ + /* <Description> */ + /* Make sure that a glyph slot owns `slot->bitmap'. */ + /* */ + /* <Input> */ + /* slot :: The glyph slot. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* This function is to be used in combination with */ + /* @FT_Bitmap_Embolden. */ + /* */ FT_EXPORT( FT_Error ) FT_GlyphSlot_Own_Bitmap( FT_GlyphSlot slot ); - /************************************************************************** - * - * @function: - * FT_Bitmap_Done - * - * @description: - * Destroy a bitmap object initialized with @FT_Bitmap_Init. - * - * @input: - * library :: - * A handle to a library object. - * - * bitmap :: - * The bitmap object to be freed. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The `library` argument is taken to have access to FreeType's memory - * handling functions. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Bitmap_Done */ + /* */ + /* <Description> */ + /* Destroy a bitmap object initialized with @FT_Bitmap_Init. */ + /* */ + /* <Input> */ + /* library :: A handle to a library object. */ + /* */ + /* bitmap :: The bitmap object to be freed. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The `library' argument is taken to have access to FreeType's */ + /* memory handling functions. */ + /* */ FT_EXPORT( FT_Error ) FT_Bitmap_Done( FT_Library library, FT_Bitmap *bitmap ); diff --git a/android/x86_64/include/freetype/ftbzip2.h b/android/x86_64/include/freetype/ftbzip2.h index 17252359..b7f2eee8 100644 --- a/android/x86_64/include/freetype/ftbzip2.h +++ b/android/x86_64/include/freetype/ftbzip2.h @@ -1,25 +1,25 @@ -/**************************************************************************** - * - * ftbzip2.h - * - * Bzip2-compressed stream support. - * - * Copyright (C) 2010-2019 by - * Joel Klinghed. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftbzip2.h */ +/* */ +/* Bzip2-compressed stream support. */ +/* */ +/* Copyright 2010-2016 by */ +/* Joel Klinghed. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTBZIP2_H_ #define FTBZIP2_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -31,62 +31,62 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * bzip2 - * - * @title: - * BZIP2 Streams - * - * @abstract: - * Using bzip2-compressed font files. - * - * @description: - * This section contains the declaration of Bzip2-specific functions. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* bzip2 */ + /* */ + /* <Title> */ + /* BZIP2 Streams */ + /* */ + /* <Abstract> */ + /* Using bzip2-compressed font files. */ + /* */ + /* <Description> */ + /* This section contains the declaration of Bzip2-specific functions. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Stream_OpenBzip2 - * - * @description: - * Open a new stream to parse bzip2-compressed font files. This is - * mainly used to support the compressed `*.pcf.bz2` fonts that come with - * XFree86. - * - * @input: - * stream :: - * The target embedding stream. - * - * source :: - * The source stream. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The source stream must be opened _before_ calling this function. - * - * Calling the internal function `FT_Stream_Close` on the new stream will - * **not** call `FT_Stream_Close` on the source stream. None of the - * stream objects will be released to the heap. - * - * The stream implementation is very basic and resets the decompression - * process each time seeking backwards is needed within the stream. - * - * In certain builds of the library, bzip2 compression recognition is - * automatically handled when calling @FT_New_Face or @FT_Open_Face. - * This means that if no font driver is capable of handling the raw - * compressed file, the library will try to open a bzip2 compressed - * stream from it and re-open the face with it. - * - * This function may return `FT_Err_Unimplemented_Feature` if your build - * of FreeType was not compiled with bzip2 support. - */ + /************************************************************************ + * + * @function: + * FT_Stream_OpenBzip2 + * + * @description: + * Open a new stream to parse bzip2-compressed font files. This is + * mainly used to support the compressed `*.pcf.bz2' fonts that come + * with XFree86. + * + * @input: + * stream :: + * The target embedding stream. + * + * source :: + * The source stream. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * The source stream must be opened _before_ calling this function. + * + * Calling the internal function `FT_Stream_Close' on the new stream will + * *not* call `FT_Stream_Close' on the source stream. None of the stream + * objects will be released to the heap. + * + * The stream implementation is very basic and resets the decompression + * process each time seeking backwards is needed within the stream. + * + * In certain builds of the library, bzip2 compression recognition is + * automatically handled when calling @FT_New_Face or @FT_Open_Face. + * This means that if no font driver is capable of handling the raw + * compressed file, the library will try to open a bzip2 compressed stream + * from it and re-open the face with it. + * + * This function may return `FT_Err_Unimplemented_Feature' if your build + * of FreeType was not compiled with bzip2 support. + */ FT_EXPORT( FT_Error ) FT_Stream_OpenBzip2( FT_Stream stream, FT_Stream source ); diff --git a/android/x86_64/include/freetype/ftcache.h b/android/x86_64/include/freetype/ftcache.h index 6a6f8420..6c9f2c42 100644 --- a/android/x86_64/include/freetype/ftcache.h +++ b/android/x86_64/include/freetype/ftcache.h @@ -1,50 +1,50 @@ -/**************************************************************************** - * - * ftcache.h - * - * FreeType Cache subsystem (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftcache.h */ +/* */ +/* FreeType Cache subsystem (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTCACHE_H_ #define FTCACHE_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_GLYPH_H FT_BEGIN_HEADER - /************************************************************************** + /************************************************************************* * - * @section: - * cache_subsystem + * <Section> + * cache_subsystem * - * @title: - * Cache Sub-System + * <Title> + * Cache Sub-System * - * @abstract: - * How to cache face, size, and glyph data with FreeType~2. + * <Abstract> + * How to cache face, size, and glyph data with FreeType~2. * - * @description: + * <Description> * This section describes the FreeType~2 cache sub-system, which is used * to limit the number of concurrently opened @FT_Face and @FT_Size * objects, as well as caching information like character maps and glyph * images while limiting their maximum memory usage. * - * Note that all types and functions begin with the `FTC_` prefix. + * Note that all types and functions begin with the `FTC_' prefix. * * The cache is highly portable and thus doesn't know anything about the * fonts installed on your system, or how to access them. This implies @@ -59,7 +59,7 @@ FT_BEGIN_HEADER * to convert an @FTC_FaceID into a new @FT_Face object. The latter is * then completely managed by the cache, including its termination * through @FT_Done_Face. To monitor termination of face objects, the - * finalizer callback in the `generic` field of the @FT_Face object can + * finalizer callback in the `generic' field of the @FT_Face object can * be used, which might also be used to store the @FTC_FaceID of the * face. * @@ -69,14 +69,14 @@ FT_BEGIN_HEADER * possible. * * Note that for the cache to work correctly, the face ID values must be - * **persistent**, which means that the contents they point to should not + * *persistent*, which means that the contents they point to should not * change at runtime, or that their value should not become invalid. * * If this is unavoidable (e.g., when a font is uninstalled at runtime), * you should call @FTC_Manager_RemoveFaceID as soon as possible, to let - * the cache get rid of any references to the old @FTC_FaceID it may keep - * internally. Failure to do so will lead to incorrect behaviour or even - * crashes. + * the cache get rid of any references to the old @FTC_FaceID it may + * keep internally. Failure to do so will lead to incorrect behaviour + * or even crashes. * * To use the cache, start with calling @FTC_Manager_New to create a new * @FTC_Manager object, which models a single cache instance. You can @@ -91,16 +91,16 @@ FT_BEGIN_HEADER * later use @FTC_ImageCache_Lookup to retrieve the corresponding * @FT_Glyph objects from the cache. * - * If you need lots of small bitmaps, it is much more memory efficient to - * call @FTC_SBitCache_New followed by @FTC_SBitCache_Lookup. This - * returns @FTC_SBitRec structures, which are used to store small bitmaps - * directly. (A small bitmap is one whose metrics and dimensions all fit - * into 8-bit integers). + * If you need lots of small bitmaps, it is much more memory efficient + * to call @FTC_SBitCache_New followed by @FTC_SBitCache_Lookup. This + * returns @FTC_SBitRec structures, which are used to store small + * bitmaps directly. (A small bitmap is one whose metrics and + * dimensions all fit into 8-bit integers). * * We hope to also provide a kerning cache in the near future. * * - * @order: + * <Order> * FTC_Manager * FTC_FaceID * FTC_Face_Requester @@ -142,20 +142,19 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** + /************************************************************************* * - * @type: - * FTC_FaceID + * @type: FTC_FaceID * * @description: * An opaque pointer type that is used to identity face objects. The * contents of such objects is application-dependent. * - * These pointers are typically used to point to a user-defined structure - * containing a font file path, and face index. + * These pointers are typically used to point to a user-defined + * structure containing a font file path, and face index. * * @note: - * Never use `NULL` as a valid @FTC_FaceID. + * Never use NULL as a valid @FTC_FaceID. * * Face IDs are passed by the client to the cache manager that calls, * when needed, the @FTC_Face_Requester to translate them into new @@ -166,13 +165,13 @@ FT_BEGIN_HEADER * immediately call @FTC_Manager_RemoveFaceID before any other cache * function. * - * Failure to do so will result in incorrect behaviour or even memory - * leaks and crashes. + * Failure to do so will result in incorrect behaviour or even + * memory leaks and crashes. */ typedef FT_Pointer FTC_FaceID; - /************************************************************************** + /************************************************************************ * * @functype: * FTC_Face_Requester @@ -182,7 +181,7 @@ FT_BEGIN_HEADER * the cache manager to translate a given @FTC_FaceID into a new valid * @FT_Face object, on demand. * - * @input: + * <Input> * face_id :: * The face ID to resolve. * @@ -192,15 +191,15 @@ FT_BEGIN_HEADER * req_data :: * Application-provided request data (see note below). * - * @output: + * <Output> * aface :: * A new @FT_Face handle. * - * @return: + * <Return> * FreeType error code. 0~means success. * - * @note: - * The third parameter `req_data` is the same as the one passed by the + * <Note> + * The third parameter `req_data' is the same as the one passed by the * client when @FTC_Manager_New is called. * * The face requester should not perform funny things on the returned @@ -227,90 +226,84 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** - * - * @type: - * FTC_Manager - * - * @description: - * This object corresponds to one instance of the cache-subsystem. It is - * used to cache one or more @FT_Face objects, along with corresponding - * @FT_Size objects. - * - * The manager intentionally limits the total number of opened @FT_Face - * and @FT_Size objects to control memory usage. See the `max_faces` and - * `max_sizes` parameters of @FTC_Manager_New. - * - * The manager is also used to cache 'nodes' of various types while - * limiting their total memory usage. - * - * All limitations are enforced by keeping lists of managed objects in - * most-recently-used order, and flushing old nodes to make room for new - * ones. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FTC_Manager */ + /* */ + /* <Description> */ + /* This object corresponds to one instance of the cache-subsystem. */ + /* It is used to cache one or more @FT_Face objects, along with */ + /* corresponding @FT_Size objects. */ + /* */ + /* The manager intentionally limits the total number of opened */ + /* @FT_Face and @FT_Size objects to control memory usage. See the */ + /* `max_faces' and `max_sizes' parameters of @FTC_Manager_New. */ + /* */ + /* The manager is also used to cache `nodes' of various types while */ + /* limiting their total memory usage. */ + /* */ + /* All limitations are enforced by keeping lists of managed objects */ + /* in most-recently-used order, and flushing old nodes to make room */ + /* for new ones. */ + /* */ typedef struct FTC_ManagerRec_* FTC_Manager; - /************************************************************************** - * - * @type: - * FTC_Node - * - * @description: - * An opaque handle to a cache node object. Each cache node is - * reference-counted. A node with a count of~0 might be flushed out of a - * full cache whenever a lookup request is performed. - * - * If you look up nodes, you have the ability to 'acquire' them, i.e., to - * increment their reference count. This will prevent the node from - * being flushed out of the cache until you explicitly 'release' it (see - * @FTC_Node_Unref). - * - * See also @FTC_SBitCache_Lookup and @FTC_ImageCache_Lookup. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FTC_Node */ + /* */ + /* <Description> */ + /* An opaque handle to a cache node object. Each cache node is */ + /* reference-counted. A node with a count of~0 might be flushed */ + /* out of a full cache whenever a lookup request is performed. */ + /* */ + /* If you look up nodes, you have the ability to `acquire' them, */ + /* i.e., to increment their reference count. This will prevent the */ + /* node from being flushed out of the cache until you explicitly */ + /* `release' it (see @FTC_Node_Unref). */ + /* */ + /* See also @FTC_SBitCache_Lookup and @FTC_ImageCache_Lookup. */ + /* */ typedef struct FTC_NodeRec_* FTC_Node; - /************************************************************************** - * - * @function: - * FTC_Manager_New - * - * @description: - * Create a new cache manager. - * - * @input: - * library :: - * The parent FreeType library handle to use. - * - * max_faces :: - * Maximum number of opened @FT_Face objects managed by this cache - * instance. Use~0 for defaults. - * - * max_sizes :: - * Maximum number of opened @FT_Size objects managed by this cache - * instance. Use~0 for defaults. - * - * max_bytes :: - * Maximum number of bytes to use for cached data nodes. Use~0 for - * defaults. Note that this value does not account for managed - * @FT_Face and @FT_Size objects. - * - * requester :: - * An application-provided callback used to translate face IDs into - * real @FT_Face objects. - * - * req_data :: - * A generic pointer that is passed to the requester each time it is - * called (see @FTC_Face_Requester). - * - * @output: - * amanager :: - * A handle to a new manager object. 0~in case of failure. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_Manager_New */ + /* */ + /* <Description> */ + /* Create a new cache manager. */ + /* */ + /* <Input> */ + /* library :: The parent FreeType library handle to use. */ + /* */ + /* max_faces :: Maximum number of opened @FT_Face objects managed by */ + /* this cache instance. Use~0 for defaults. */ + /* */ + /* max_sizes :: Maximum number of opened @FT_Size objects managed by */ + /* this cache instance. Use~0 for defaults. */ + /* */ + /* max_bytes :: Maximum number of bytes to use for cached data nodes. */ + /* Use~0 for defaults. Note that this value does not */ + /* account for managed @FT_Face and @FT_Size objects. */ + /* */ + /* requester :: An application-provided callback used to translate */ + /* face IDs into real @FT_Face objects. */ + /* */ + /* req_data :: A generic pointer that is passed to the requester */ + /* each time it is called (see @FTC_Face_Requester). */ + /* */ + /* <Output> */ + /* amanager :: A handle to a new manager object. 0~in case of */ + /* failure. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FTC_Manager_New( FT_Library library, FT_UInt max_faces, @@ -321,124 +314,114 @@ FT_BEGIN_HEADER FTC_Manager *amanager ); - /************************************************************************** - * - * @function: - * FTC_Manager_Reset - * - * @description: - * Empty a given cache manager. This simply gets rid of all the - * currently cached @FT_Face and @FT_Size objects within the manager. - * - * @inout: - * manager :: - * A handle to the manager. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_Manager_Reset */ + /* */ + /* <Description> */ + /* Empty a given cache manager. This simply gets rid of all the */ + /* currently cached @FT_Face and @FT_Size objects within the manager. */ + /* */ + /* <InOut> */ + /* manager :: A handle to the manager. */ + /* */ FT_EXPORT( void ) FTC_Manager_Reset( FTC_Manager manager ); - /************************************************************************** - * - * @function: - * FTC_Manager_Done - * - * @description: - * Destroy a given manager after emptying it. - * - * @input: - * manager :: - * A handle to the target cache manager object. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_Manager_Done */ + /* */ + /* <Description> */ + /* Destroy a given manager after emptying it. */ + /* */ + /* <Input> */ + /* manager :: A handle to the target cache manager object. */ + /* */ FT_EXPORT( void ) FTC_Manager_Done( FTC_Manager manager ); - /************************************************************************** - * - * @function: - * FTC_Manager_LookupFace - * - * @description: - * Retrieve the @FT_Face object that corresponds to a given face ID - * through a cache manager. - * - * @input: - * manager :: - * A handle to the cache manager. - * - * face_id :: - * The ID of the face object. - * - * @output: - * aface :: - * A handle to the face object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The returned @FT_Face object is always owned by the manager. You - * should never try to discard it yourself. - * - * The @FT_Face object doesn't necessarily have a current size object - * (i.e., face->size can be~0). If you need a specific 'font size', use - * @FTC_Manager_LookupSize instead. - * - * Never change the face's transformation matrix (i.e., never call the - * @FT_Set_Transform function) on a returned face! If you need to - * transform glyphs, do it yourself after glyph loading. - * - * When you perform a lookup, out-of-memory errors are detected _within_ - * the lookup and force incremental flushes of the cache until enough - * memory is released for the lookup to succeed. - * - * If a lookup fails with `FT_Err_Out_Of_Memory` the cache has already - * been completely flushed, and still no memory was available for the - * operation. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_Manager_LookupFace */ + /* */ + /* <Description> */ + /* Retrieve the @FT_Face object that corresponds to a given face ID */ + /* through a cache manager. */ + /* */ + /* <Input> */ + /* manager :: A handle to the cache manager. */ + /* */ + /* face_id :: The ID of the face object. */ + /* */ + /* <Output> */ + /* aface :: A handle to the face object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The returned @FT_Face object is always owned by the manager. You */ + /* should never try to discard it yourself. */ + /* */ + /* The @FT_Face object doesn't necessarily have a current size object */ + /* (i.e., face->size can be~0). If you need a specific `font size', */ + /* use @FTC_Manager_LookupSize instead. */ + /* */ + /* Never change the face's transformation matrix (i.e., never call */ + /* the @FT_Set_Transform function) on a returned face! If you need */ + /* to transform glyphs, do it yourself after glyph loading. */ + /* */ + /* When you perform a lookup, out-of-memory errors are detected */ + /* _within_ the lookup and force incremental flushes of the cache */ + /* until enough memory is released for the lookup to succeed. */ + /* */ + /* If a lookup fails with `FT_Err_Out_Of_Memory' the cache has */ + /* already been completely flushed, and still no memory was available */ + /* for the operation. */ + /* */ FT_EXPORT( FT_Error ) FTC_Manager_LookupFace( FTC_Manager manager, FTC_FaceID face_id, FT_Face *aface ); - /************************************************************************** - * - * @struct: - * FTC_ScalerRec - * - * @description: - * A structure used to describe a given character size in either pixels - * or points to the cache manager. See @FTC_Manager_LookupSize. - * - * @fields: - * face_id :: - * The source face ID. - * - * width :: - * The character width. - * - * height :: - * The character height. - * - * pixel :: - * A Boolean. If 1, the `width` and `height` fields are interpreted as - * integer pixel character sizes. Otherwise, they are expressed as - * 1/64th of points. - * - * x_res :: - * Only used when `pixel` is value~0 to indicate the horizontal - * resolution in dpi. - * - * y_res :: - * Only used when `pixel` is value~0 to indicate the vertical - * resolution in dpi. - * - * @note: - * This type is mainly used to retrieve @FT_Size objects through the - * cache manager. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FTC_ScalerRec */ + /* */ + /* <Description> */ + /* A structure used to describe a given character size in either */ + /* pixels or points to the cache manager. See */ + /* @FTC_Manager_LookupSize. */ + /* */ + /* <Fields> */ + /* face_id :: The source face ID. */ + /* */ + /* width :: The character width. */ + /* */ + /* height :: The character height. */ + /* */ + /* pixel :: A Boolean. If 1, the `width' and `height' fields are */ + /* interpreted as integer pixel character sizes. */ + /* Otherwise, they are expressed as 1/64th of points. */ + /* */ + /* x_res :: Only used when `pixel' is value~0 to indicate the */ + /* horizontal resolution in dpi. */ + /* */ + /* y_res :: Only used when `pixel' is value~0 to indicate the */ + /* vertical resolution in dpi. */ + /* */ + /* <Note> */ + /* This type is mainly used to retrieve @FT_Size objects through the */ + /* cache manager. */ + /* */ typedef struct FTC_ScalerRec_ { FTC_FaceID face_id; @@ -451,93 +434,89 @@ FT_BEGIN_HEADER } FTC_ScalerRec; - /************************************************************************** - * - * @struct: - * FTC_Scaler - * - * @description: - * A handle to an @FTC_ScalerRec structure. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FTC_Scaler */ + /* */ + /* <Description> */ + /* A handle to an @FTC_ScalerRec structure. */ + /* */ typedef struct FTC_ScalerRec_* FTC_Scaler; - /************************************************************************** - * - * @function: - * FTC_Manager_LookupSize - * - * @description: - * Retrieve the @FT_Size object that corresponds to a given - * @FTC_ScalerRec pointer through a cache manager. - * - * @input: - * manager :: - * A handle to the cache manager. - * - * scaler :: - * A scaler handle. - * - * @output: - * asize :: - * A handle to the size object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The returned @FT_Size object is always owned by the manager. You - * should never try to discard it by yourself. - * - * You can access the parent @FT_Face object simply as `size->face` if - * you need it. Note that this object is also owned by the manager. - * - * @note: - * When you perform a lookup, out-of-memory errors are detected _within_ - * the lookup and force incremental flushes of the cache until enough - * memory is released for the lookup to succeed. - * - * If a lookup fails with `FT_Err_Out_Of_Memory` the cache has already - * been completely flushed, and still no memory is available for the - * operation. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_Manager_LookupSize */ + /* */ + /* <Description> */ + /* Retrieve the @FT_Size object that corresponds to a given */ + /* @FTC_ScalerRec pointer through a cache manager. */ + /* */ + /* <Input> */ + /* manager :: A handle to the cache manager. */ + /* */ + /* scaler :: A scaler handle. */ + /* */ + /* <Output> */ + /* asize :: A handle to the size object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The returned @FT_Size object is always owned by the manager. You */ + /* should never try to discard it by yourself. */ + /* */ + /* You can access the parent @FT_Face object simply as `size->face' */ + /* if you need it. Note that this object is also owned by the */ + /* manager. */ + /* */ + /* <Note> */ + /* When you perform a lookup, out-of-memory errors are detected */ + /* _within_ the lookup and force incremental flushes of the cache */ + /* until enough memory is released for the lookup to succeed. */ + /* */ + /* If a lookup fails with `FT_Err_Out_Of_Memory' the cache has */ + /* already been completely flushed, and still no memory is available */ + /* for the operation. */ + /* */ FT_EXPORT( FT_Error ) FTC_Manager_LookupSize( FTC_Manager manager, FTC_Scaler scaler, FT_Size *asize ); - /************************************************************************** - * - * @function: - * FTC_Node_Unref - * - * @description: - * Decrement a cache node's internal reference count. When the count - * reaches 0, it is not destroyed but becomes eligible for subsequent - * cache flushes. - * - * @input: - * node :: - * The cache node handle. - * - * manager :: - * The cache manager handle. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_Node_Unref */ + /* */ + /* <Description> */ + /* Decrement a cache node's internal reference count. When the count */ + /* reaches 0, it is not destroyed but becomes eligible for subsequent */ + /* cache flushes. */ + /* */ + /* <Input> */ + /* node :: The cache node handle. */ + /* */ + /* manager :: The cache manager handle. */ + /* */ FT_EXPORT( void ) FTC_Node_Unref( FTC_Node node, FTC_Manager manager ); - /************************************************************************** + /************************************************************************* * * @function: * FTC_Manager_RemoveFaceID * * @description: - * A special function used to indicate to the cache manager that a given - * @FTC_FaceID is no longer valid, either because its content changed, or - * because it was deallocated or uninstalled. + * A special function used to indicate to the cache manager that + * a given @FTC_FaceID is no longer valid, either because its + * content changed, or because it was deallocated or uninstalled. * * @input: * manager :: @@ -548,11 +527,11 @@ FT_BEGIN_HEADER * * @note: * This function flushes all nodes from the cache corresponding to this - * `face_id`, with the exception of nodes with a non-null reference + * `face_id', with the exception of nodes with a non-null reference * count. * - * Such nodes are however modified internally so as to never appear in - * later lookups with the same `face_id` value, and to be immediately + * Such nodes are however modified internally so as to never appear + * in later lookups with the same `face_id' value, and to be immediately * destroyed when released by all their users. * */ @@ -561,20 +540,27 @@ FT_BEGIN_HEADER FTC_FaceID face_id ); - /************************************************************************** + /*************************************************************************/ + /* */ + /* <Section> */ + /* cache_subsystem */ + /* */ + /*************************************************************************/ + + /************************************************************************* * * @type: * FTC_CMapCache * * @description: - * An opaque handle used to model a charmap cache. This cache is to hold - * character codes -> glyph indices mappings. + * An opaque handle used to model a charmap cache. This cache is to + * hold character codes -> glyph indices mappings. * */ typedef struct FTC_CMapCacheRec_* FTC_CMapCache; - /************************************************************************** + /************************************************************************* * * @function: * FTC_CMapCache_New @@ -588,7 +574,7 @@ FT_BEGIN_HEADER * * @output: * acache :: - * A new cache handle. `NULL` in case of error. + * A new cache handle. NULL in case of error. * * @return: * FreeType error code. 0~means success. @@ -603,7 +589,7 @@ FT_BEGIN_HEADER FTC_CMapCache *acache ); - /************************************************************************** + /************************************************************************ * * @function: * FTC_CMapCache_Lookup @@ -627,7 +613,7 @@ FT_BEGIN_HEADER * The character code (in the corresponding charmap). * * @return: - * Glyph index. 0~means 'no glyph'. + * Glyph index. 0~means `no glyph'. * */ FT_EXPORT( FT_UInt ) @@ -637,6 +623,14 @@ FT_BEGIN_HEADER FT_UInt32 char_code ); + /*************************************************************************/ + /* */ + /* <Section> */ + /* cache_subsystem */ + /* */ + /*************************************************************************/ + + /*************************************************************************/ /*************************************************************************/ /*************************************************************************/ @@ -648,7 +642,7 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** + /************************************************************************* * * @struct: * FTC_ImageTypeRec @@ -680,7 +674,7 @@ FT_BEGIN_HEADER } FTC_ImageTypeRec; - /************************************************************************** + /************************************************************************* * * @type: * FTC_ImageType @@ -701,87 +695,83 @@ FT_BEGIN_HEADER (d1)->flags == (d2)->flags ) - /************************************************************************** - * - * @type: - * FTC_ImageCache - * - * @description: - * A handle to a glyph image cache object. They are designed to hold - * many distinct glyph images while not exceeding a certain memory - * threshold. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FTC_ImageCache */ + /* */ + /* <Description> */ + /* A handle to a glyph image cache object. They are designed to */ + /* hold many distinct glyph images while not exceeding a certain */ + /* memory threshold. */ + /* */ typedef struct FTC_ImageCacheRec_* FTC_ImageCache; - /************************************************************************** - * - * @function: - * FTC_ImageCache_New - * - * @description: - * Create a new glyph image cache. - * - * @input: - * manager :: - * The parent manager for the image cache. - * - * @output: - * acache :: - * A handle to the new glyph image cache object. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_ImageCache_New */ + /* */ + /* <Description> */ + /* Create a new glyph image cache. */ + /* */ + /* <Input> */ + /* manager :: The parent manager for the image cache. */ + /* */ + /* <Output> */ + /* acache :: A handle to the new glyph image cache object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FTC_ImageCache_New( FTC_Manager manager, FTC_ImageCache *acache ); - /************************************************************************** - * - * @function: - * FTC_ImageCache_Lookup - * - * @description: - * Retrieve a given glyph image from a glyph image cache. - * - * @input: - * cache :: - * A handle to the source glyph image cache. - * - * type :: - * A pointer to a glyph image type descriptor. - * - * gindex :: - * The glyph index to retrieve. - * - * @output: - * aglyph :: - * The corresponding @FT_Glyph object. 0~in case of failure. - * - * anode :: - * Used to return the address of the corresponding cache node after - * incrementing its reference count (see note below). - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The returned glyph is owned and managed by the glyph image cache. - * Never try to transform or discard it manually! You can however create - * a copy with @FT_Glyph_Copy and modify the new one. - * - * If `anode` is _not_ `NULL`, it receives the address of the cache node - * containing the glyph image, after increasing its reference count. - * This ensures that the node (as well as the @FT_Glyph) will always be - * kept in the cache until you call @FTC_Node_Unref to 'release' it. - * - * If `anode` is `NULL`, the cache node is left unchanged, which means - * that the @FT_Glyph could be flushed out of the cache on the next call - * to one of the caching sub-system APIs. Don't assume that it is - * persistent! - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_ImageCache_Lookup */ + /* */ + /* <Description> */ + /* Retrieve a given glyph image from a glyph image cache. */ + /* */ + /* <Input> */ + /* cache :: A handle to the source glyph image cache. */ + /* */ + /* type :: A pointer to a glyph image type descriptor. */ + /* */ + /* gindex :: The glyph index to retrieve. */ + /* */ + /* <Output> */ + /* aglyph :: The corresponding @FT_Glyph object. 0~in case of */ + /* failure. */ + /* */ + /* anode :: Used to return the address of of the corresponding cache */ + /* node after incrementing its reference count (see note */ + /* below). */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The returned glyph is owned and managed by the glyph image cache. */ + /* Never try to transform or discard it manually! You can however */ + /* create a copy with @FT_Glyph_Copy and modify the new one. */ + /* */ + /* If `anode' is _not_ NULL, it receives the address of the cache */ + /* node containing the glyph image, after increasing its reference */ + /* count. This ensures that the node (as well as the @FT_Glyph) will */ + /* always be kept in the cache until you call @FTC_Node_Unref to */ + /* `release' it. */ + /* */ + /* If `anode' is NULL, the cache node is left unchanged, which means */ + /* that the @FT_Glyph could be flushed out of the cache on the next */ + /* call to one of the caching sub-system APIs. Don't assume that it */ + /* is persistent! */ + /* */ FT_EXPORT( FT_Error ) FTC_ImageCache_Lookup( FTC_ImageCache cache, FTC_ImageType type, @@ -790,57 +780,54 @@ FT_BEGIN_HEADER FTC_Node *anode ); - /************************************************************************** - * - * @function: - * FTC_ImageCache_LookupScaler - * - * @description: - * A variant of @FTC_ImageCache_Lookup that uses an @FTC_ScalerRec to - * specify the face ID and its size. - * - * @input: - * cache :: - * A handle to the source glyph image cache. - * - * scaler :: - * A pointer to a scaler descriptor. - * - * load_flags :: - * The corresponding load flags. - * - * gindex :: - * The glyph index to retrieve. - * - * @output: - * aglyph :: - * The corresponding @FT_Glyph object. 0~in case of failure. - * - * anode :: - * Used to return the address of the corresponding cache node after - * incrementing its reference count (see note below). - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The returned glyph is owned and managed by the glyph image cache. - * Never try to transform or discard it manually! You can however create - * a copy with @FT_Glyph_Copy and modify the new one. - * - * If `anode` is _not_ `NULL`, it receives the address of the cache node - * containing the glyph image, after increasing its reference count. - * This ensures that the node (as well as the @FT_Glyph) will always be - * kept in the cache until you call @FTC_Node_Unref to 'release' it. - * - * If `anode` is `NULL`, the cache node is left unchanged, which means - * that the @FT_Glyph could be flushed out of the cache on the next call - * to one of the caching sub-system APIs. Don't assume that it is - * persistent! - * - * Calls to @FT_Set_Char_Size and friends have no effect on cached - * glyphs; you should always use the FreeType cache API instead. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_ImageCache_LookupScaler */ + /* */ + /* <Description> */ + /* A variant of @FTC_ImageCache_Lookup that uses an @FTC_ScalerRec */ + /* to specify the face ID and its size. */ + /* */ + /* <Input> */ + /* cache :: A handle to the source glyph image cache. */ + /* */ + /* scaler :: A pointer to a scaler descriptor. */ + /* */ + /* load_flags :: The corresponding load flags. */ + /* */ + /* gindex :: The glyph index to retrieve. */ + /* */ + /* <Output> */ + /* aglyph :: The corresponding @FT_Glyph object. 0~in case of */ + /* failure. */ + /* */ + /* anode :: Used to return the address of of the corresponding */ + /* cache node after incrementing its reference count */ + /* (see note below). */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The returned glyph is owned and managed by the glyph image cache. */ + /* Never try to transform or discard it manually! You can however */ + /* create a copy with @FT_Glyph_Copy and modify the new one. */ + /* */ + /* If `anode' is _not_ NULL, it receives the address of the cache */ + /* node containing the glyph image, after increasing its reference */ + /* count. This ensures that the node (as well as the @FT_Glyph) will */ + /* always be kept in the cache until you call @FTC_Node_Unref to */ + /* `release' it. */ + /* */ + /* If `anode' is NULL, the cache node is left unchanged, which means */ + /* that the @FT_Glyph could be flushed out of the cache on the next */ + /* call to one of the caching sub-system APIs. Don't assume that it */ + /* is persistent! */ + /* */ + /* Calls to @FT_Set_Char_Size and friends have no effect on cached */ + /* glyphs; you should always use the FreeType cache API instead. */ + /* */ FT_EXPORT( FT_Error ) FTC_ImageCache_LookupScaler( FTC_ImageCache cache, FTC_Scaler scaler, @@ -850,60 +837,53 @@ FT_BEGIN_HEADER FTC_Node *anode ); - /************************************************************************** - * - * @type: - * FTC_SBit - * - * @description: - * A handle to a small bitmap descriptor. See the @FTC_SBitRec structure - * for details. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FTC_SBit */ + /* */ + /* <Description> */ + /* A handle to a small bitmap descriptor. See the @FTC_SBitRec */ + /* structure for details. */ + /* */ typedef struct FTC_SBitRec_* FTC_SBit; - /************************************************************************** - * - * @struct: - * FTC_SBitRec - * - * @description: - * A very compact structure used to describe a small glyph bitmap. - * - * @fields: - * width :: - * The bitmap width in pixels. - * - * height :: - * The bitmap height in pixels. - * - * left :: - * The horizontal distance from the pen position to the left bitmap - * border (a.k.a. 'left side bearing', or 'lsb'). - * - * top :: - * The vertical distance from the pen position (on the baseline) to the - * upper bitmap border (a.k.a. 'top side bearing'). The distance is - * positive for upwards y~coordinates. - * - * format :: - * The format of the glyph bitmap (monochrome or gray). - * - * max_grays :: - * Maximum gray level value (in the range 1 to~255). - * - * pitch :: - * The number of bytes per bitmap line. May be positive or negative. - * - * xadvance :: - * The horizontal advance width in pixels. - * - * yadvance :: - * The vertical advance height in pixels. - * - * buffer :: - * A pointer to the bitmap pixels. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FTC_SBitRec */ + /* */ + /* <Description> */ + /* A very compact structure used to describe a small glyph bitmap. */ + /* */ + /* <Fields> */ + /* width :: The bitmap width in pixels. */ + /* */ + /* height :: The bitmap height in pixels. */ + /* */ + /* left :: The horizontal distance from the pen position to the */ + /* left bitmap border (a.k.a. `left side bearing', or */ + /* `lsb'). */ + /* */ + /* top :: The vertical distance from the pen position (on the */ + /* baseline) to the upper bitmap border (a.k.a. `top */ + /* side bearing'). The distance is positive for upwards */ + /* y~coordinates. */ + /* */ + /* format :: The format of the glyph bitmap (monochrome or gray). */ + /* */ + /* max_grays :: Maximum gray level value (in the range 1 to~255). */ + /* */ + /* pitch :: The number of bytes per bitmap line. May be positive */ + /* or negative. */ + /* */ + /* xadvance :: The horizontal advance width in pixels. */ + /* */ + /* yadvance :: The vertical advance height in pixels. */ + /* */ + /* buffer :: A pointer to the bitmap pixels. */ + /* */ typedef struct FTC_SBitRec_ { FT_Byte width; @@ -922,93 +902,87 @@ FT_BEGIN_HEADER } FTC_SBitRec; - /************************************************************************** - * - * @type: - * FTC_SBitCache - * - * @description: - * A handle to a small bitmap cache. These are special cache objects - * used to store small glyph bitmaps (and anti-aliased pixmaps) in a much - * more efficient way than the traditional glyph image cache implemented - * by @FTC_ImageCache. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FTC_SBitCache */ + /* */ + /* <Description> */ + /* A handle to a small bitmap cache. These are special cache objects */ + /* used to store small glyph bitmaps (and anti-aliased pixmaps) in a */ + /* much more efficient way than the traditional glyph image cache */ + /* implemented by @FTC_ImageCache. */ + /* */ typedef struct FTC_SBitCacheRec_* FTC_SBitCache; - /************************************************************************** - * - * @function: - * FTC_SBitCache_New - * - * @description: - * Create a new cache to store small glyph bitmaps. - * - * @input: - * manager :: - * A handle to the source cache manager. - * - * @output: - * acache :: - * A handle to the new sbit cache. `NULL` in case of error. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_SBitCache_New */ + /* */ + /* <Description> */ + /* Create a new cache to store small glyph bitmaps. */ + /* */ + /* <Input> */ + /* manager :: A handle to the source cache manager. */ + /* */ + /* <Output> */ + /* acache :: A handle to the new sbit cache. NULL in case of error. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FTC_SBitCache_New( FTC_Manager manager, FTC_SBitCache *acache ); - /************************************************************************** - * - * @function: - * FTC_SBitCache_Lookup - * - * @description: - * Look up a given small glyph bitmap in a given sbit cache and 'lock' it - * to prevent its flushing from the cache until needed. - * - * @input: - * cache :: - * A handle to the source sbit cache. - * - * type :: - * A pointer to the glyph image type descriptor. - * - * gindex :: - * The glyph index. - * - * @output: - * sbit :: - * A handle to a small bitmap descriptor. - * - * anode :: - * Used to return the address of the corresponding cache node after - * incrementing its reference count (see note below). - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The small bitmap descriptor and its bit buffer are owned by the cache - * and should never be freed by the application. They might as well - * disappear from memory on the next cache lookup, so don't treat them as - * persistent data. - * - * The descriptor's `buffer` field is set to~0 to indicate a missing - * glyph bitmap. - * - * If `anode` is _not_ `NULL`, it receives the address of the cache node - * containing the bitmap, after increasing its reference count. This - * ensures that the node (as well as the image) will always be kept in - * the cache until you call @FTC_Node_Unref to 'release' it. - * - * If `anode` is `NULL`, the cache node is left unchanged, which means - * that the bitmap could be flushed out of the cache on the next call to - * one of the caching sub-system APIs. Don't assume that it is - * persistent! - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_SBitCache_Lookup */ + /* */ + /* <Description> */ + /* Look up a given small glyph bitmap in a given sbit cache and */ + /* `lock' it to prevent its flushing from the cache until needed. */ + /* */ + /* <Input> */ + /* cache :: A handle to the source sbit cache. */ + /* */ + /* type :: A pointer to the glyph image type descriptor. */ + /* */ + /* gindex :: The glyph index. */ + /* */ + /* <Output> */ + /* sbit :: A handle to a small bitmap descriptor. */ + /* */ + /* anode :: Used to return the address of of the corresponding cache */ + /* node after incrementing its reference count (see note */ + /* below). */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The small bitmap descriptor and its bit buffer are owned by the */ + /* cache and should never be freed by the application. They might */ + /* as well disappear from memory on the next cache lookup, so don't */ + /* treat them as persistent data. */ + /* */ + /* The descriptor's `buffer' field is set to~0 to indicate a missing */ + /* glyph bitmap. */ + /* */ + /* If `anode' is _not_ NULL, it receives the address of the cache */ + /* node containing the bitmap, after increasing its reference count. */ + /* This ensures that the node (as well as the image) will always be */ + /* kept in the cache until you call @FTC_Node_Unref to `release' it. */ + /* */ + /* If `anode' is NULL, the cache node is left unchanged, which means */ + /* that the bitmap could be flushed out of the cache on the next */ + /* call to one of the caching sub-system APIs. Don't assume that it */ + /* is persistent! */ + /* */ FT_EXPORT( FT_Error ) FTC_SBitCache_Lookup( FTC_SBitCache cache, FTC_ImageType type, @@ -1017,58 +991,53 @@ FT_BEGIN_HEADER FTC_Node *anode ); - /************************************************************************** - * - * @function: - * FTC_SBitCache_LookupScaler - * - * @description: - * A variant of @FTC_SBitCache_Lookup that uses an @FTC_ScalerRec to - * specify the face ID and its size. - * - * @input: - * cache :: - * A handle to the source sbit cache. - * - * scaler :: - * A pointer to the scaler descriptor. - * - * load_flags :: - * The corresponding load flags. - * - * gindex :: - * The glyph index. - * - * @output: - * sbit :: - * A handle to a small bitmap descriptor. - * - * anode :: - * Used to return the address of the corresponding cache node after - * incrementing its reference count (see note below). - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The small bitmap descriptor and its bit buffer are owned by the cache - * and should never be freed by the application. They might as well - * disappear from memory on the next cache lookup, so don't treat them as - * persistent data. - * - * The descriptor's `buffer` field is set to~0 to indicate a missing - * glyph bitmap. - * - * If `anode` is _not_ `NULL`, it receives the address of the cache node - * containing the bitmap, after increasing its reference count. This - * ensures that the node (as well as the image) will always be kept in - * the cache until you call @FTC_Node_Unref to 'release' it. - * - * If `anode` is `NULL`, the cache node is left unchanged, which means - * that the bitmap could be flushed out of the cache on the next call to - * one of the caching sub-system APIs. Don't assume that it is - * persistent! - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FTC_SBitCache_LookupScaler */ + /* */ + /* <Description> */ + /* A variant of @FTC_SBitCache_Lookup that uses an @FTC_ScalerRec */ + /* to specify the face ID and its size. */ + /* */ + /* <Input> */ + /* cache :: A handle to the source sbit cache. */ + /* */ + /* scaler :: A pointer to the scaler descriptor. */ + /* */ + /* load_flags :: The corresponding load flags. */ + /* */ + /* gindex :: The glyph index. */ + /* */ + /* <Output> */ + /* sbit :: A handle to a small bitmap descriptor. */ + /* */ + /* anode :: Used to return the address of of the corresponding */ + /* cache node after incrementing its reference count */ + /* (see note below). */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The small bitmap descriptor and its bit buffer are owned by the */ + /* cache and should never be freed by the application. They might */ + /* as well disappear from memory on the next cache lookup, so don't */ + /* treat them as persistent data. */ + /* */ + /* The descriptor's `buffer' field is set to~0 to indicate a missing */ + /* glyph bitmap. */ + /* */ + /* If `anode' is _not_ NULL, it receives the address of the cache */ + /* node containing the bitmap, after increasing its reference count. */ + /* This ensures that the node (as well as the image) will always be */ + /* kept in the cache until you call @FTC_Node_Unref to `release' it. */ + /* */ + /* If `anode' is NULL, the cache node is left unchanged, which means */ + /* that the bitmap could be flushed out of the cache on the next */ + /* call to one of the caching sub-system APIs. Don't assume that it */ + /* is persistent! */ + /* */ FT_EXPORT( FT_Error ) FTC_SBitCache_LookupScaler( FTC_SBitCache cache, FTC_Scaler scaler, diff --git a/android/x86_64/include/freetype/ftcffdrv.h b/android/x86_64/include/freetype/ftcffdrv.h new file mode 100644 index 00000000..9dea980a --- /dev/null +++ b/android/x86_64/include/freetype/ftcffdrv.h @@ -0,0 +1,262 @@ +/***************************************************************************/ +/* */ +/* ftcffdrv.h */ +/* */ +/* FreeType API for controlling the CFF driver (specification only). */ +/* */ +/* Copyright 2013-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ + + +#ifndef FTCFFDRV_H_ +#define FTCFFDRV_H_ + +#include <ft2build.h> +#include FT_FREETYPE_H + +#ifdef FREETYPE_H +#error "freetype.h of FreeType 1 has been loaded!" +#error "Please fix the directory search order for header files" +#error "so that freetype.h of FreeType 2 is found first." +#endif + + +FT_BEGIN_HEADER + + + /************************************************************************** + * + * @section: + * cff_driver + * + * @title: + * The CFF driver + * + * @abstract: + * Controlling the CFF driver module. + * + * @description: + * While FreeType's CFF driver doesn't expose API functions by itself, + * it is possible to control its behaviour with @FT_Property_Set and + * @FT_Property_Get. The list below gives the available properties + * together with the necessary macros and structures. + * + * The CFF driver's module name is `cff'. + * + * *Hinting* *and* *antialiasing* *principles* *of* *the* *new* *engine* + * + * The rasterizer is positioning horizontal features (e.g., ascender + * height & x-height, or crossbars) on the pixel grid and minimizing the + * amount of antialiasing applied to them, while placing vertical + * features (vertical stems) on the pixel grid without hinting, thus + * representing the stem position and weight accurately. Sometimes the + * vertical stems may be only partially black. In this context, + * `antialiasing' means that stems are not positioned exactly on pixel + * borders, causing a fuzzy appearance. + * + * There are two principles behind this approach. + * + * 1) No hinting in the horizontal direction: Unlike `superhinted' + * TrueType, which changes glyph widths to accommodate regular + * inter-glyph spacing, Adobe's approach is `faithful to the design' in + * representing both the glyph width and the inter-glyph spacing + * designed for the font. This makes the screen display as close as it + * can be to the result one would get with infinite resolution, while + * preserving what is considered the key characteristics of each glyph. + * Note that the distances between unhinted and grid-fitted positions at + * small sizes are comparable to kerning values and thus would be + * noticeable (and distracting) while reading if hinting were applied. + * + * One of the reasons to not hint horizontally is antialiasing for LCD + * screens: The pixel geometry of modern displays supplies three + * vertical sub-pixels as the eye moves horizontally across each visible + * pixel. On devices where we can be certain this characteristic is + * present a rasterizer can take advantage of the sub-pixels to add + * increments of weight. In Western writing systems this turns out to + * be the more critical direction anyway; the weights and spacing of + * vertical stems (see above) are central to Armenian, Cyrillic, Greek, + * and Latin type designs. Even when the rasterizer uses greyscale + * antialiasing instead of color (a necessary compromise when one + * doesn't know the screen characteristics), the unhinted vertical + * features preserve the design's weight and spacing much better than + * aliased type would. + * + * 2) Aligment in the vertical direction: Weights and spacing along the + * y~axis are less critical; what is much more important is the visual + * alignment of related features (like cap-height and x-height). The + * sense of alignment for these is enhanced by the sharpness of grid-fit + * edges, while the cruder vertical resolution (full pixels instead of + * 1/3 pixels) is less of a problem. + * + * On the technical side, horizontal alignment zones for ascender, + * x-height, and other important height values (traditionally called + * `blue zones') as defined in the font are positioned independently, + * each being rounded to the nearest pixel edge, taking care of + * overshoot suppression at small sizes, stem darkening, and scaling. + * + * Hstems (this is, hint values defined in the font to help align + * horizontal features) that fall within a blue zone are said to be + * `captured' and are aligned to that zone. Uncaptured stems are moved + * in one of four ways, top edge up or down, bottom edge up or down. + * Unless there are conflicting hstems, the smallest movement is taken + * to minimize distortion. + * + * @order: + * hinting-engine + * no-stem-darkening[cff] + * darkening-parameters[cff] + * + */ + + + /************************************************************************** + * + * @property: + * hinting-engine + * + * @description: + * Thanks to Adobe, which contributed a new hinting (and parsing) + * engine, an application can select between `freetype' and `adobe' if + * compiled with CFF_CONFIG_OPTION_OLD_ENGINE. If this configuration + * macro isn't defined, `hinting-engine' does nothing. + * + * The default engine is `freetype' if CFF_CONFIG_OPTION_OLD_ENGINE is + * defined, and `adobe' otherwise. + * + * The following example code demonstrates how to select Adobe's hinting + * engine (omitting the error handling). + * + * { + * FT_Library library; + * FT_UInt hinting_engine = FT_CFF_HINTING_ADOBE; + * + * + * FT_Init_FreeType( &library ); + * + * FT_Property_Set( library, "cff", + * "hinting-engine", &hinting_engine ); + * } + * + * @note: + * This property can be used with @FT_Property_Get also. + * + */ + + + /************************************************************************** + * + * @enum: + * FT_CFF_HINTING_XXX + * + * @description: + * A list of constants used for the @hinting-engine property to select + * the hinting engine for CFF fonts. + * + * @values: + * FT_CFF_HINTING_FREETYPE :: + * Use the old FreeType hinting engine. + * + * FT_CFF_HINTING_ADOBE :: + * Use the hinting engine contributed by Adobe. + * + */ +#define FT_CFF_HINTING_FREETYPE 0 +#define FT_CFF_HINTING_ADOBE 1 + + + /************************************************************************** + * + * @property: + * no-stem-darkening[cff] + * + * @description: + * By default, the Adobe CFF engine darkens stems at smaller sizes, + * regardless of hinting, to enhance contrast. This feature requires + * a rendering system with proper gamma correction. Setting this + * property, stem darkening gets switched off. + * + * Note that stem darkening is never applied if @FT_LOAD_NO_SCALE is set. + * + * { + * FT_Library library; + * FT_Bool no_stem_darkening = TRUE; + * + * + * FT_Init_FreeType( &library ); + * + * FT_Property_Set( library, "cff", + * "no-stem-darkening", &no_stem_darkening ); + * } + * + * @note: + * This property can be used with @FT_Property_Get also. + * + */ + + + /************************************************************************** + * + * @property: + * darkening-parameters[cff] + * + * @description: + * By default, the Adobe CFF engine darkens stems as follows (if the + * `no-stem-darkening' property isn't set): + * + * { + * stem width <= 0.5px: darkening amount = 0.4px + * stem width = 1px: darkening amount = 0.275px + * stem width = 1.667px: darkening amount = 0.275px + * stem width >= 2.333px: darkening amount = 0px + * } + * + * and piecewise linear in-between. At configuration time, these four + * control points can be set with the macro + * `CFF_CONFIG_OPTION_DARKENING_PARAMETERS'. At runtime, the control + * points can be changed using the `darkening-parameters' property, as + * the following example demonstrates. + * + * { + * FT_Library library; + * FT_Int darken_params[8] = { 500, 300, // x1, y1 + * 1000, 200, // x2, y2 + * 1500, 100, // x3, y3 + * 2000, 0 }; // x4, y4 + * + * + * FT_Init_FreeType( &library ); + * + * FT_Property_Set( library, "cff", + * "darkening-parameters", darken_params ); + * } + * + * The x~values give the stem width, and the y~values the darkening + * amount. The unit is 1000th of pixels. All coordinate values must be + * positive; the x~values must be monotonically increasing; the + * y~values must be monotonically decreasing and smaller than or + * equal to 500 (corresponding to half a pixel); the slope of each + * linear piece must be shallower than -1 (e.g., -.4). + * + * @note: + * This property can be used with @FT_Property_Get also. + * + */ + + /* */ + + +FT_END_HEADER + + +#endif /* FTCFFDRV_H_ */ + + +/* END */ diff --git a/android/x86_64/include/freetype/ftchapters.h b/android/x86_64/include/freetype/ftchapters.h index 2ee26973..ab438953 100644 --- a/android/x86_64/include/freetype/ftchapters.h +++ b/android/x86_64/include/freetype/ftchapters.h @@ -1,145 +1,135 @@ -/**************************************************************************** - * - * This file defines the structure of the FreeType reference. - * It is used by the python script that generates the HTML files. - * - */ +/***************************************************************************/ +/* */ +/* This file defines the structure of the FreeType reference. */ +/* It is used by the python script that generates the HTML files. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * @chapter: - * general_remarks - * - * @title: - * General Remarks - * - * @sections: - * header_inclusion - * user_allocation - * - */ +/***************************************************************************/ +/* */ +/* <Chapter> */ +/* general_remarks */ +/* */ +/* <Title> */ +/* General Remarks */ +/* */ +/* <Sections> */ +/* header_inclusion */ +/* user_allocation */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * @chapter: - * core_api - * - * @title: - * Core API - * - * @sections: - * version - * basic_types - * base_interface - * glyph_variants - * color_management - * layer_management - * glyph_management - * mac_specific - * sizes_management - * header_file_macros - * - */ +/***************************************************************************/ +/* */ +/* <Chapter> */ +/* core_api */ +/* */ +/* <Title> */ +/* Core API */ +/* */ +/* <Sections> */ +/* version */ +/* basic_types */ +/* base_interface */ +/* glyph_variants */ +/* glyph_management */ +/* mac_specific */ +/* sizes_management */ +/* header_file_macros */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * @chapter: - * format_specific - * - * @title: - * Format-Specific API - * - * @sections: - * multiple_masters - * truetype_tables - * type1_tables - * sfnt_names - * bdf_fonts - * cid_fonts - * pfr_fonts - * winfnt_fonts - * font_formats - * gasp_table - * - */ +/***************************************************************************/ +/* */ +/* <Chapter> */ +/* format_specific */ +/* */ +/* <Title> */ +/* Format-Specific API */ +/* */ +/* <Sections> */ +/* multiple_masters */ +/* truetype_tables */ +/* type1_tables */ +/* sfnt_names */ +/* bdf_fonts */ +/* cid_fonts */ +/* pfr_fonts */ +/* winfnt_fonts */ +/* font_formats */ +/* gasp_table */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * @chapter: - * module_specific - * - * @title: - * Controlling FreeType Modules - * - * @sections: - * auto_hinter - * cff_driver - * t1_cid_driver - * tt_driver - * pcf_driver - * properties - * parameter_tags - * lcd_rendering - * - */ +/***************************************************************************/ +/* */ +/* <Chapter> */ +/* module_specific */ +/* */ +/* <Title> */ +/* Controlling FreeType Modules */ +/* */ +/* <Sections> */ +/* auto_hinter */ +/* cff_driver */ +/* tt_driver */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * @chapter: - * cache_subsystem - * - * @title: - * Cache Sub-System - * - * @sections: - * cache_subsystem - * - */ +/***************************************************************************/ +/* */ +/* <Chapter> */ +/* cache_subsystem */ +/* */ +/* <Title> */ +/* Cache Sub-System */ +/* */ +/* <Sections> */ +/* cache_subsystem */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * @chapter: - * support_api - * - * @title: - * Support API - * - * @sections: - * computations - * list_processing - * outline_processing - * quick_advance - * bitmap_handling - * raster - * glyph_stroker - * system_interface - * module_management - * gzip - * lzw - * bzip2 - * - */ +/***************************************************************************/ +/* */ +/* <Chapter> */ +/* support_api */ +/* */ +/* <Title> */ +/* Support API */ +/* */ +/* <Sections> */ +/* computations */ +/* list_processing */ +/* outline_processing */ +/* quick_advance */ +/* bitmap_handling */ +/* raster */ +/* glyph_stroker */ +/* system_interface */ +/* module_management */ +/* gzip */ +/* lzw */ +/* bzip2 */ +/* lcd_filtering */ +/* */ +/***************************************************************************/ - - /************************************************************************** - * - * @chapter: - * error_codes - * - * @title: - * Error Codes - * - * @sections: - * error_enumerations - * error_code_values - * - */ - - -/* END */ +/***************************************************************************/ +/* */ +/* <Chapter> */ +/* error_codes */ +/* */ +/* <Title> */ +/* Error Codes */ +/* */ +/* <Sections> */ +/* error_enumerations */ +/* error_code_values */ +/* */ +/***************************************************************************/ diff --git a/android/x86_64/include/freetype/ftcid.h b/android/x86_64/include/freetype/ftcid.h index 2336a570..140f2f87 100644 --- a/android/x86_64/include/freetype/ftcid.h +++ b/android/x86_64/include/freetype/ftcid.h @@ -1,25 +1,25 @@ -/**************************************************************************** - * - * ftcid.h - * - * FreeType API for accessing CID font information (specification). - * - * Copyright (C) 2007-2019 by - * Dereg Clegg and Michael Toftdal. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftcid.h */ +/* */ +/* FreeType API for accessing CID font information (specification). */ +/* */ +/* Copyright 2007-2016 by */ +/* Dereg Clegg and Michael Toftdal. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTCID_H_ #define FTCID_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -32,25 +32,25 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * cid_fonts - * - * @title: - * CID Fonts - * - * @abstract: - * CID-keyed font-specific API. - * - * @description: - * This section contains the declaration of CID-keyed font-specific - * functions. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* cid_fonts */ + /* */ + /* <Title> */ + /* CID Fonts */ + /* */ + /* <Abstract> */ + /* CID-keyed font specific API. */ + /* */ + /* <Description> */ + /* This section contains the declaration of CID-keyed font specific */ + /* functions. */ + /* */ + /*************************************************************************/ - /************************************************************************** + /********************************************************************** * * @function: * FT_Get_CID_Registry_Ordering_Supplement @@ -61,17 +61,17 @@ FT_BEGIN_HEADER * * @input: * face :: - * A handle to the input face. + * A handle to the input face. * * @output: * registry :: - * The registry, as a C~string, owned by the face. + * The registry, as a C~string, owned by the face. * * ordering :: - * The ordering, as a C~string, owned by the face. + * The ordering, as a C~string, owned by the face. * * supplement :: - * The supplement. + * The supplement. * * @return: * FreeType error code. 0~means success. @@ -87,33 +87,33 @@ FT_BEGIN_HEADER FT_Get_CID_Registry_Ordering_Supplement( FT_Face face, const char* *registry, const char* *ordering, - FT_Int *supplement ); + FT_Int *supplement); - /************************************************************************** + /********************************************************************** * * @function: * FT_Get_CID_Is_Internally_CID_Keyed * * @description: - * Retrieve the type of the input face, CID keyed or not. In contrast - * to the @FT_IS_CID_KEYED macro this function returns successfully also - * for CID-keyed fonts in an SFNT wrapper. + * Retrieve the type of the input face, CID keyed or not. In + * constrast to the @FT_IS_CID_KEYED macro this function returns + * successfully also for CID-keyed fonts in an SNFT wrapper. * * @input: * face :: - * A handle to the input face. + * A handle to the input face. * * @output: * is_cid :: - * The type of the face as an @FT_Bool. + * The type of the face as an @FT_Bool. * * @return: * FreeType error code. 0~means success. * * @note: - * This function only works with CID faces and OpenType fonts, returning - * an error otherwise. + * This function only works with CID faces and OpenType fonts, + * returning an error otherwise. * * @since: * 2.3.9 @@ -123,7 +123,7 @@ FT_BEGIN_HEADER FT_Bool *is_cid ); - /************************************************************************** + /********************************************************************** * * @function: * FT_Get_CID_From_Glyph_Index @@ -133,21 +133,21 @@ FT_BEGIN_HEADER * * @input: * face :: - * A handle to the input face. + * A handle to the input face. * * glyph_index :: - * The input glyph index. + * The input glyph index. * * @output: * cid :: - * The CID as an @FT_UInt. + * The CID as an @FT_UInt. * * @return: * FreeType error code. 0~means success. * * @note: - * This function only works with CID faces and OpenType fonts, returning - * an error otherwise. + * This function only works with CID faces and OpenType fonts, + * returning an error otherwise. * * @since: * 2.3.9 diff --git a/android/x86_64/include/freetype/ftcolor.h b/android/x86_64/include/freetype/ftcolor.h deleted file mode 100644 index 6f8b3f9a..00000000 --- a/android/x86_64/include/freetype/ftcolor.h +++ /dev/null @@ -1,311 +0,0 @@ -/**************************************************************************** - * - * ftcolor.h - * - * FreeType's glyph color management (specification). - * - * Copyright (C) 2018-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ - - -#ifndef FTCOLOR_H_ -#define FTCOLOR_H_ - -#include "ft2build.h" -#include FT_FREETYPE_H - -#ifdef FREETYPE_H -#error "freetype.h of FreeType 1 has been loaded!" -#error "Please fix the directory search order for header files" -#error "so that freetype.h of FreeType 2 is found first." -#endif - - -FT_BEGIN_HEADER - - - /************************************************************************** - * - * @section: - * color_management - * - * @title: - * Glyph Color Management - * - * @abstract: - * Retrieving and manipulating OpenType's 'CPAL' table data. - * - * @description: - * The functions described here allow access and manipulation of color - * palette entries in OpenType's 'CPAL' tables. - */ - - - /************************************************************************** - * - * @struct: - * FT_Color - * - * @description: - * This structure models a BGRA color value of a 'CPAL' palette entry. - * - * The used color space is sRGB; the colors are not pre-multiplied, and - * alpha values must be explicitly set. - * - * @fields: - * blue :: - * Blue value. - * - * green :: - * Green value. - * - * red :: - * Red value. - * - * alpha :: - * Alpha value, giving the red, green, and blue color's opacity. - * - * @since: - * 2.10 - */ - typedef struct FT_Color_ - { - FT_Byte blue; - FT_Byte green; - FT_Byte red; - FT_Byte alpha; - - } FT_Color; - - - /************************************************************************** - * - * @enum: - * FT_PALETTE_XXX - * - * @description: - * A list of bit field constants used in the `palette_flags` array of the - * @FT_Palette_Data structure to indicate for which background a palette - * with a given index is usable. - * - * @values: - * FT_PALETTE_FOR_LIGHT_BACKGROUND :: - * The palette is appropriate to use when displaying the font on a - * light background such as white. - * - * FT_PALETTE_FOR_DARK_BACKGROUND :: - * The palette is appropriate to use when displaying the font on a dark - * background such as black. - * - * @since: - * 2.10 - */ -#define FT_PALETTE_FOR_LIGHT_BACKGROUND 0x01 -#define FT_PALETTE_FOR_DARK_BACKGROUND 0x02 - - - /************************************************************************** - * - * @struct: - * FT_Palette_Data - * - * @description: - * This structure holds the data of the 'CPAL' table. - * - * @fields: - * num_palettes :: - * The number of palettes. - * - * palette_name_ids :: - * A read-only array of palette name IDs with `num_palettes` elements, - * corresponding to entries like 'dark' or 'light' in the font's 'name' - * table. - * - * An empty name ID in the 'CPAL' table gets represented as value - * 0xFFFF. - * - * `NULL` if the font's 'CPAL' table doesn't contain appropriate data. - * - * palette_flags :: - * A read-only array of palette flags with `num_palettes` elements. - * Possible values are an ORed combination of - * @FT_PALETTE_FOR_LIGHT_BACKGROUND and - * @FT_PALETTE_FOR_DARK_BACKGROUND. - * - * `NULL` if the font's 'CPAL' table doesn't contain appropriate data. - * - * num_palette_entries :: - * The number of entries in a single palette. All palettes have the - * same size. - * - * palette_entry_name_ids :: - * A read-only array of palette entry name IDs with - * `num_palette_entries`. In each palette, entries with the same index - * have the same function. For example, index~0 might correspond to - * string 'outline' in the font's 'name' table to indicate that this - * palette entry is used for outlines, index~1 might correspond to - * 'fill' to indicate the filling color palette entry, etc. - * - * An empty entry name ID in the 'CPAL' table gets represented as value - * 0xFFFF. - * - * `NULL` if the font's 'CPAL' table doesn't contain appropriate data. - * - * @note: - * Use function @FT_Get_Sfnt_Name to map name IDs and entry name IDs to - * name strings. - * - * @since: - * 2.10 - */ - typedef struct FT_Palette_Data_ { - FT_UShort num_palettes; - const FT_UShort* palette_name_ids; - const FT_UShort* palette_flags; - - FT_UShort num_palette_entries; - const FT_UShort* palette_entry_name_ids; - - } FT_Palette_Data; - - - /************************************************************************** - * - * @function: - * FT_Palette_Data_Get - * - * @description: - * Retrieve the face's color palette data. - * - * @input: - * face :: - * The source face handle. - * - * @output: - * apalette :: - * A pointer to an @FT_Palette_Data structure. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * All arrays in the returned @FT_Palette_Data structure are read-only. - * - * This function always returns an error if the config macro - * `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`. - * - * @since: - * 2.10 - */ - FT_EXPORT( FT_Error ) - FT_Palette_Data_Get( FT_Face face, - FT_Palette_Data *apalette ); - - - /************************************************************************** - * - * @function: - * FT_Palette_Select - * - * @description: - * This function has two purposes. - * - * (1) It activates a palette for rendering color glyphs, and - * - * (2) it retrieves all (unmodified) color entries of this palette. This - * function returns a read-write array, which means that a calling - * application can modify the palette entries on demand. - * - * A corollary of (2) is that calling the function, then modifying some - * values, then calling the function again with the same arguments resets - * all color entries to the original 'CPAL' values; all user modifications - * are lost. - * - * @input: - * face :: - * The source face handle. - * - * palette_index :: - * The palette index. - * - * @output: - * apalette :: - * An array of color entries for a palette with index `palette_index`, - * having `num_palette_entries` elements (as found in the - * `FT_Palette_Data` structure). If `apalette` is set to `NULL`, no - * array gets returned (and no color entries can be modified). - * - * In case the font doesn't support color palettes, `NULL` is returned. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The array pointed to by `apalette_entries` is owned and managed by - * FreeType. - * - * This function always returns an error if the config macro - * `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`. - * - * @since: - * 2.10 - */ - FT_EXPORT( FT_Error ) - FT_Palette_Select( FT_Face face, - FT_UShort palette_index, - FT_Color* *apalette ); - - - /************************************************************************** - * - * @function: - * FT_Palette_Set_Foreground_Color - * - * @description: - * 'COLR' uses palette index 0xFFFF to indicate a 'text foreground - * color'. This function sets this value. - * - * @input: - * face :: - * The source face handle. - * - * foreground_color :: - * An `FT_Color` structure to define the text foreground color. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * If this function isn't called, the text foreground color is set to - * white opaque (BGRA value 0xFFFFFFFF) if - * @FT_PALETTE_FOR_DARK_BACKGROUND is present for the current palette, - * and black opaque (BGRA value 0x000000FF) otherwise, including the case - * that no palette types are available in the 'CPAL' table. - * - * This function always returns an error if the config macro - * `TT_CONFIG_OPTION_COLOR_LAYERS` is not defined in `ftoption.h`. - * - * @since: - * 2.10 - */ - FT_EXPORT( FT_Error ) - FT_Palette_Set_Foreground_Color( FT_Face face, - FT_Color foreground_color ); - - /* */ - - -FT_END_HEADER - -#endif /* FTCOLOR_H_ */ - - -/* END */ diff --git a/android/x86_64/include/freetype/ftdriver.h b/android/x86_64/include/freetype/ftdriver.h deleted file mode 100644 index 260732ed..00000000 --- a/android/x86_64/include/freetype/ftdriver.h +++ /dev/null @@ -1,1232 +0,0 @@ -/**************************************************************************** - * - * ftdriver.h - * - * FreeType API for controlling driver modules (specification only). - * - * Copyright (C) 2017-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ - - -#ifndef FTDRIVER_H_ -#define FTDRIVER_H_ - -#include "ft2build.h" -#include FT_FREETYPE_H -#include FT_PARAMETER_TAGS_H - -#ifdef FREETYPE_H -#error "freetype.h of FreeType 1 has been loaded!" -#error "Please fix the directory search order for header files" -#error "so that freetype.h of FreeType 2 is found first." -#endif - - -FT_BEGIN_HEADER - - - /************************************************************************** - * - * @section: - * auto_hinter - * - * @title: - * The auto-hinter - * - * @abstract: - * Controlling the auto-hinting module. - * - * @description: - * While FreeType's auto-hinter doesn't expose API functions by itself, - * it is possible to control its behaviour with @FT_Property_Set and - * @FT_Property_Get. The following lists the available properties - * together with the necessary macros and structures. - * - * Note that the auto-hinter's module name is 'autofitter' for historical - * reasons. - * - * Available properties are @increase-x-height, @no-stem-darkening - * (experimental), @darkening-parameters (experimental), @warping - * (experimental), @glyph-to-script-map (experimental), @fallback-script - * (experimental), and @default-script (experimental), as documented in - * the @properties section. - * - */ - - - /************************************************************************** - * - * @section: - * cff_driver - * - * @title: - * The CFF driver - * - * @abstract: - * Controlling the CFF driver module. - * - * @description: - * While FreeType's CFF driver doesn't expose API functions by itself, it - * is possible to control its behaviour with @FT_Property_Set and - * @FT_Property_Get. - * - * The CFF driver's module name is 'cff'. - * - * Available properties are @hinting-engine, @no-stem-darkening, - * @darkening-parameters, and @random-seed, as documented in the - * @properties section. - * - * - * **Hinting and antialiasing principles of the new engine** - * - * The rasterizer is positioning horizontal features (e.g., ascender - * height & x-height, or crossbars) on the pixel grid and minimizing the - * amount of antialiasing applied to them, while placing vertical - * features (vertical stems) on the pixel grid without hinting, thus - * representing the stem position and weight accurately. Sometimes the - * vertical stems may be only partially black. In this context, - * 'antialiasing' means that stems are not positioned exactly on pixel - * borders, causing a fuzzy appearance. - * - * There are two principles behind this approach. - * - * 1) No hinting in the horizontal direction: Unlike 'superhinted' - * TrueType, which changes glyph widths to accommodate regular - * inter-glyph spacing, Adobe's approach is 'faithful to the design' in - * representing both the glyph width and the inter-glyph spacing designed - * for the font. This makes the screen display as close as it can be to - * the result one would get with infinite resolution, while preserving - * what is considered the key characteristics of each glyph. Note that - * the distances between unhinted and grid-fitted positions at small - * sizes are comparable to kerning values and thus would be noticeable - * (and distracting) while reading if hinting were applied. - * - * One of the reasons to not hint horizontally is antialiasing for LCD - * screens: The pixel geometry of modern displays supplies three vertical - * subpixels as the eye moves horizontally across each visible pixel. On - * devices where we can be certain this characteristic is present a - * rasterizer can take advantage of the subpixels to add increments of - * weight. In Western writing systems this turns out to be the more - * critical direction anyway; the weights and spacing of vertical stems - * (see above) are central to Armenian, Cyrillic, Greek, and Latin type - * designs. Even when the rasterizer uses greyscale antialiasing instead - * of color (a necessary compromise when one doesn't know the screen - * characteristics), the unhinted vertical features preserve the design's - * weight and spacing much better than aliased type would. - * - * 2) Alignment in the vertical direction: Weights and spacing along the - * y~axis are less critical; what is much more important is the visual - * alignment of related features (like cap-height and x-height). The - * sense of alignment for these is enhanced by the sharpness of grid-fit - * edges, while the cruder vertical resolution (full pixels instead of - * 1/3 pixels) is less of a problem. - * - * On the technical side, horizontal alignment zones for ascender, - * x-height, and other important height values (traditionally called - * 'blue zones') as defined in the font are positioned independently, - * each being rounded to the nearest pixel edge, taking care of overshoot - * suppression at small sizes, stem darkening, and scaling. - * - * Hstems (this is, hint values defined in the font to help align - * horizontal features) that fall within a blue zone are said to be - * 'captured' and are aligned to that zone. Uncaptured stems are moved - * in one of four ways, top edge up or down, bottom edge up or down. - * Unless there are conflicting hstems, the smallest movement is taken to - * minimize distortion. - * - */ - - - /************************************************************************** - * - * @section: - * pcf_driver - * - * @title: - * The PCF driver - * - * @abstract: - * Controlling the PCF driver module. - * - * @description: - * While FreeType's PCF driver doesn't expose API functions by itself, it - * is possible to control its behaviour with @FT_Property_Set and - * @FT_Property_Get. Right now, there is a single property - * @no-long-family-names available if FreeType is compiled with - * PCF_CONFIG_OPTION_LONG_FAMILY_NAMES. - * - * The PCF driver's module name is 'pcf'. - * - */ - - - /************************************************************************** - * - * @section: - * t1_cid_driver - * - * @title: - * The Type 1 and CID drivers - * - * @abstract: - * Controlling the Type~1 and CID driver modules. - * - * @description: - * It is possible to control the behaviour of FreeType's Type~1 and - * Type~1 CID drivers with @FT_Property_Set and @FT_Property_Get. - * - * Behind the scenes, both drivers use the Adobe CFF engine for hinting; - * however, the used properties must be specified separately. - * - * The Type~1 driver's module name is 'type1'; the CID driver's module - * name is 't1cid'. - * - * Available properties are @hinting-engine, @no-stem-darkening, - * @darkening-parameters, and @random-seed, as documented in the - * @properties section. - * - * Please see the @cff_driver section for more details on the new hinting - * engine. - * - */ - - - /************************************************************************** - * - * @section: - * tt_driver - * - * @title: - * The TrueType driver - * - * @abstract: - * Controlling the TrueType driver module. - * - * @description: - * While FreeType's TrueType driver doesn't expose API functions by - * itself, it is possible to control its behaviour with @FT_Property_Set - * and @FT_Property_Get. The following lists the available properties - * together with the necessary macros and structures. - * - * The TrueType driver's module name is 'truetype'. - * - * A single property @interpreter-version is available, as documented in - * the @properties section. - * - * We start with a list of definitions, kindly provided by Greg - * Hitchcock. - * - * _Bi-Level Rendering_ - * - * Monochromatic rendering, exclusively used in the early days of - * TrueType by both Apple and Microsoft. Microsoft's GDI interface - * supported hinting of the right-side bearing point, such that the - * advance width could be non-linear. Most often this was done to - * achieve some level of glyph symmetry. To enable reasonable - * performance (e.g., not having to run hinting on all glyphs just to get - * the widths) there was a bit in the head table indicating if the side - * bearing was hinted, and additional tables, 'hdmx' and 'LTSH', to cache - * hinting widths across multiple sizes and device aspect ratios. - * - * _Font Smoothing_ - * - * Microsoft's GDI implementation of anti-aliasing. Not traditional - * anti-aliasing as the outlines were hinted before the sampling. The - * widths matched the bi-level rendering. - * - * _ClearType Rendering_ - * - * Technique that uses physical subpixels to improve rendering on LCD - * (and other) displays. Because of the higher resolution, many methods - * of improving symmetry in glyphs through hinting the right-side bearing - * were no longer necessary. This lead to what GDI calls 'natural - * widths' ClearType, see - * http://rastertragedy.com/RTRCh4.htm#Sec21. Since hinting - * has extra resolution, most non-linearity went away, but it is still - * possible for hints to change the advance widths in this mode. - * - * _ClearType Compatible Widths_ - * - * One of the earliest challenges with ClearType was allowing the - * implementation in GDI to be selected without requiring all UI and - * documents to reflow. To address this, a compatible method of - * rendering ClearType was added where the font hints are executed once - * to determine the width in bi-level rendering, and then re-run in - * ClearType, with the difference in widths being absorbed in the font - * hints for ClearType (mostly in the white space of hints); see - * http://rastertragedy.com/RTRCh4.htm#Sec20. Somewhat by - * definition, compatible width ClearType allows for non-linear widths, - * but only when the bi-level version has non-linear widths. - * - * _ClearType Subpixel Positioning_ - * - * One of the nice benefits of ClearType is the ability to more crisply - * display fractional widths; unfortunately, the GDI model of integer - * bitmaps did not support this. However, the WPF and Direct Write - * frameworks do support fractional widths. DWrite calls this 'natural - * mode', not to be confused with GDI's 'natural widths'. Subpixel - * positioning, in the current implementation of Direct Write, - * unfortunately does not support hinted advance widths, see - * http://rastertragedy.com/RTRCh4.htm#Sec22. Note that the - * TrueType interpreter fully allows the advance width to be adjusted in - * this mode, just the DWrite client will ignore those changes. - * - * _ClearType Backward Compatibility_ - * - * This is a set of exceptions made in the TrueType interpreter to - * minimize hinting techniques that were problematic with the extra - * resolution of ClearType; see - * http://rastertragedy.com/RTRCh4.htm#Sec1 and - * https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx. - * This technique is not to be confused with ClearType compatible widths. - * ClearType backward compatibility has no direct impact on changing - * advance widths, but there might be an indirect impact on disabling - * some deltas. This could be worked around in backward compatibility - * mode. - * - * _Native ClearType Mode_ - * - * (Not to be confused with 'natural widths'.) This mode removes all the - * exceptions in the TrueType interpreter when running with ClearType. - * Any issues on widths would still apply, though. - * - */ - - - /************************************************************************** - * - * @section: - * properties - * - * @title: - * Driver properties - * - * @abstract: - * Controlling driver modules. - * - * @description: - * Driver modules can be controlled by setting and unsetting properties, - * using the functions @FT_Property_Set and @FT_Property_Get. This - * section documents the available properties, together with auxiliary - * macros and structures. - * - */ - - - /************************************************************************** - * - * @enum: - * FT_HINTING_XXX - * - * @description: - * A list of constants used for the @hinting-engine property to select - * the hinting engine for CFF, Type~1, and CID fonts. - * - * @values: - * FT_HINTING_FREETYPE :: - * Use the old FreeType hinting engine. - * - * FT_HINTING_ADOBE :: - * Use the hinting engine contributed by Adobe. - * - * @since: - * 2.9 - * - */ -#define FT_HINTING_FREETYPE 0 -#define FT_HINTING_ADOBE 1 - - /* these constants (introduced in 2.4.12) are deprecated */ -#define FT_CFF_HINTING_FREETYPE FT_HINTING_FREETYPE -#define FT_CFF_HINTING_ADOBE FT_HINTING_ADOBE - - - /************************************************************************** - * - * @property: - * hinting-engine - * - * @description: - * Thanks to Adobe, which contributed a new hinting (and parsing) engine, - * an application can select between 'freetype' and 'adobe' if compiled - * with `CFF_CONFIG_OPTION_OLD_ENGINE`. If this configuration macro - * isn't defined, 'hinting-engine' does nothing. - * - * The same holds for the Type~1 and CID modules if compiled with - * `T1_CONFIG_OPTION_OLD_ENGINE`. - * - * For the 'cff' module, the default engine is 'freetype' if - * `CFF_CONFIG_OPTION_OLD_ENGINE` is defined, and 'adobe' otherwise. - * - * For both the 'type1' and 't1cid' modules, the default engine is - * 'freetype' if `T1_CONFIG_OPTION_OLD_ENGINE` is defined, and 'adobe' - * otherwise. - * - * @note: - * This property can be used with @FT_Property_Get also. - * - * This property can be set via the `FREETYPE_PROPERTIES` environment - * variable (using values 'adobe' or 'freetype'). - * - * @example: - * The following example code demonstrates how to select Adobe's hinting - * engine for the 'cff' module (omitting the error handling). - * - * ``` - * FT_Library library; - * FT_UInt hinting_engine = FT_HINTING_ADOBE; - * - * - * FT_Init_FreeType( &library ); - * - * FT_Property_Set( library, "cff", - * "hinting-engine", &hinting_engine ); - * ``` - * - * @since: - * 2.4.12 (for 'cff' module) - * - * 2.9 (for 'type1' and 't1cid' modules) - * - */ - - - /************************************************************************** - * - * @property: - * no-stem-darkening - * - * @description: - * All glyphs that pass through the auto-hinter will be emboldened unless - * this property is set to TRUE. The same is true for the CFF, Type~1, - * and CID font modules if the 'Adobe' engine is selected (which is the - * default). - * - * Stem darkening emboldens glyphs at smaller sizes to make them more - * readable on common low-DPI screens when using linear alpha blending - * and gamma correction, see @FT_Render_Glyph. When not using linear - * alpha blending and gamma correction, glyphs will appear heavy and - * fuzzy! - * - * Gamma correction essentially lightens fonts since shades of grey are - * shifted to higher pixel values (=~higher brightness) to match the - * original intention to the reality of our screens. The side-effect is - * that glyphs 'thin out'. Mac OS~X and Adobe's proprietary font - * rendering library implement a counter-measure: stem darkening at - * smaller sizes where shades of gray dominate. By emboldening a glyph - * slightly in relation to its pixel size, individual pixels get higher - * coverage of filled-in outlines and are therefore 'blacker'. This - * counteracts the 'thinning out' of glyphs, making text remain readable - * at smaller sizes. - * - * By default, the Adobe engines for CFF, Type~1, and CID fonts darken - * stems at smaller sizes, regardless of hinting, to enhance contrast. - * Setting this property, stem darkening gets switched off. - * - * For the auto-hinter, stem-darkening is experimental currently and thus - * switched off by default (this is, `no-stem-darkening` is set to TRUE - * by default). Total consistency with the CFF driver is not achieved - * right now because the emboldening method differs and glyphs must be - * scaled down on the Y-axis to keep outline points inside their - * precomputed blue zones. The smaller the size (especially 9ppem and - * down), the higher the loss of emboldening versus the CFF driver. - * - * Note that stem darkening is never applied if @FT_LOAD_NO_SCALE is set. - * - * @note: - * This property can be used with @FT_Property_Get also. - * - * This property can be set via the `FREETYPE_PROPERTIES` environment - * variable (using values 1 and 0 for 'on' and 'off', respectively). It - * can also be set per face using @FT_Face_Properties with - * @FT_PARAM_TAG_STEM_DARKENING. - * - * @example: - * ``` - * FT_Library library; - * FT_Bool no_stem_darkening = TRUE; - * - * - * FT_Init_FreeType( &library ); - * - * FT_Property_Set( library, "cff", - * "no-stem-darkening", &no_stem_darkening ); - * ``` - * - * @since: - * 2.4.12 (for 'cff' module) - * - * 2.6.2 (for 'autofitter' module) - * - * 2.9 (for 'type1' and 't1cid' modules) - * - */ - - - /************************************************************************** - * - * @property: - * darkening-parameters - * - * @description: - * By default, the Adobe hinting engine, as used by the CFF, Type~1, and - * CID font drivers, darkens stems as follows (if the `no-stem-darkening` - * property isn't set): - * - * ``` - * stem width <= 0.5px: darkening amount = 0.4px - * stem width = 1px: darkening amount = 0.275px - * stem width = 1.667px: darkening amount = 0.275px - * stem width >= 2.333px: darkening amount = 0px - * ``` - * - * and piecewise linear in-between. At configuration time, these four - * control points can be set with the macro - * `CFF_CONFIG_OPTION_DARKENING_PARAMETERS`; the CFF, Type~1, and CID - * drivers share these values. At runtime, the control points can be - * changed using the `darkening-parameters` property (see the example - * below that demonstrates this for the Type~1 driver). - * - * The x~values give the stem width, and the y~values the darkening - * amount. The unit is 1000th of pixels. All coordinate values must be - * positive; the x~values must be monotonically increasing; the y~values - * must be monotonically decreasing and smaller than or equal to 500 - * (corresponding to half a pixel); the slope of each linear piece must - * be shallower than -1 (e.g., -.4). - * - * The auto-hinter provides this property, too, as an experimental - * feature. See @no-stem-darkening for more. - * - * @note: - * This property can be used with @FT_Property_Get also. - * - * This property can be set via the `FREETYPE_PROPERTIES` environment - * variable, using eight comma-separated integers without spaces. Here - * the above example, using `\` to break the line for readability. - * - * ``` - * FREETYPE_PROPERTIES=\ - * type1:darkening-parameters=500,300,1000,200,1500,100,2000,0 - * ``` - * - * @example: - * ``` - * FT_Library library; - * FT_Int darken_params[8] = { 500, 300, // x1, y1 - * 1000, 200, // x2, y2 - * 1500, 100, // x3, y3 - * 2000, 0 }; // x4, y4 - * - * - * FT_Init_FreeType( &library ); - * - * FT_Property_Set( library, "type1", - * "darkening-parameters", darken_params ); - * ``` - * - * @since: - * 2.5.1 (for 'cff' module) - * - * 2.6.2 (for 'autofitter' module) - * - * 2.9 (for 'type1' and 't1cid' modules) - * - */ - - - /************************************************************************** - * - * @property: - * random-seed - * - * @description: - * By default, the seed value for the CFF 'random' operator and the - * similar '0 28 callothersubr pop' command for the Type~1 and CID - * drivers is set to a random value. However, mainly for debugging - * purposes, it is often necessary to use a known value as a seed so that - * the pseudo-random number sequences generated by 'random' are - * repeatable. - * - * The `random-seed` property does that. Its argument is a signed 32bit - * integer; if the value is zero or negative, the seed given by the - * `intitialRandomSeed` private DICT operator in a CFF file gets used (or - * a default value if there is no such operator). If the value is - * positive, use it instead of `initialRandomSeed`, which is consequently - * ignored. - * - * @note: - * This property can be set via the `FREETYPE_PROPERTIES` environment - * variable. It can also be set per face using @FT_Face_Properties with - * @FT_PARAM_TAG_RANDOM_SEED. - * - * @since: - * 2.8 (for 'cff' module) - * - * 2.9 (for 'type1' and 't1cid' modules) - * - */ - - - /************************************************************************** - * - * @property: - * no-long-family-names - * - * @description: - * If `PCF_CONFIG_OPTION_LONG_FAMILY_NAMES` is active while compiling - * FreeType, the PCF driver constructs long family names. - * - * There are many PCF fonts just called 'Fixed' which look completely - * different, and which have nothing to do with each other. When - * selecting 'Fixed' in KDE or Gnome one gets results that appear rather - * random, the style changes often if one changes the size and one cannot - * select some fonts at all. The improve this situation, the PCF module - * prepends the foundry name (plus a space) to the family name. It also - * checks whether there are 'wide' characters; all put together, family - * names like 'Sony Fixed' or 'Misc Fixed Wide' are constructed. - * - * If `no-long-family-names` is set, this feature gets switched off. - * - * @note: - * This property can be used with @FT_Property_Get also. - * - * This property can be set via the `FREETYPE_PROPERTIES` environment - * variable (using values 1 and 0 for 'on' and 'off', respectively). - * - * @example: - * ``` - * FT_Library library; - * FT_Bool no_long_family_names = TRUE; - * - * - * FT_Init_FreeType( &library ); - * - * FT_Property_Set( library, "pcf", - * "no-long-family-names", - * &no_long_family_names ); - * ``` - * - * @since: - * 2.8 - */ - - - /************************************************************************** - * - * @enum: - * TT_INTERPRETER_VERSION_XXX - * - * @description: - * A list of constants used for the @interpreter-version property to - * select the hinting engine for Truetype fonts. - * - * The numeric value in the constant names represents the version number - * as returned by the 'GETINFO' bytecode instruction. - * - * @values: - * TT_INTERPRETER_VERSION_35 :: - * Version~35 corresponds to MS rasterizer v.1.7 as used e.g. in - * Windows~98; only grayscale and B/W rasterizing is supported. - * - * TT_INTERPRETER_VERSION_38 :: - * Version~38 corresponds to MS rasterizer v.1.9; it is roughly - * equivalent to the hinting provided by DirectWrite ClearType (as can - * be found, for example, in the Internet Explorer~9 running on - * Windows~7). It is used in FreeType to select the 'Infinality' - * subpixel hinting code. The code may be removed in a future version. - * - * TT_INTERPRETER_VERSION_40 :: - * Version~40 corresponds to MS rasterizer v.2.1; it is roughly - * equivalent to the hinting provided by DirectWrite ClearType (as can - * be found, for example, in Microsoft's Edge Browser on Windows~10). - * It is used in FreeType to select the 'minimal' subpixel hinting - * code, a stripped-down and higher performance version of the - * 'Infinality' code. - * - * @note: - * This property controls the behaviour of the bytecode interpreter and - * thus how outlines get hinted. It does **not** control how glyph get - * rasterized! In particular, it does not control subpixel color - * filtering. - * - * If FreeType has not been compiled with the configuration option - * `TT_CONFIG_OPTION_SUBPIXEL_HINTING`, selecting version~38 or~40 causes - * an `FT_Err_Unimplemented_Feature` error. - * - * Depending on the graphics framework, Microsoft uses different bytecode - * and rendering engines. As a consequence, the version numbers returned - * by a call to the 'GETINFO' bytecode instruction are more convoluted - * than desired. - * - * Here are two tables that try to shed some light on the possible values - * for the MS rasterizer engine, together with the additional features - * introduced by it. - * - * ``` - * GETINFO framework version feature - * ------------------------------------------------------------------- - * 3 GDI (Win 3.1), v1.0 16-bit, first version - * TrueImage - * 33 GDI (Win NT 3.1), v1.5 32-bit - * HP Laserjet - * 34 GDI (Win 95) v1.6 font smoothing, - * new SCANTYPE opcode - * 35 GDI (Win 98/2000) v1.7 (UN)SCALED_COMPONENT_OFFSET - * bits in composite glyphs - * 36 MGDI (Win CE 2) v1.6+ classic ClearType - * 37 GDI (XP and later), v1.8 ClearType - * GDI+ old (before Vista) - * 38 GDI+ old (Vista, Win 7), v1.9 subpixel ClearType, - * WPF Y-direction ClearType, - * additional error checking - * 39 DWrite (before Win 8) v2.0 subpixel ClearType flags - * in GETINFO opcode, - * bug fixes - * 40 GDI+ (after Win 7), v2.1 Y-direction ClearType flag - * DWrite (Win 8) in GETINFO opcode, - * Gray ClearType - * ``` - * - * The 'version' field gives a rough orientation only, since some - * applications provided certain features much earlier (as an example, - * Microsoft Reader used subpixel and Y-direction ClearType already in - * Windows 2000). Similarly, updates to a given framework might include - * improved hinting support. - * - * ``` - * version sampling rendering comment - * x y x y - * -------------------------------------------------------------- - * v1.0 normal normal B/W B/W bi-level - * v1.6 high high gray gray grayscale - * v1.8 high normal color-filter B/W (GDI) ClearType - * v1.9 high high color-filter gray Color ClearType - * v2.1 high normal gray B/W Gray ClearType - * v2.1 high high gray gray Gray ClearType - * ``` - * - * Color and Gray ClearType are the two available variants of - * 'Y-direction ClearType', meaning grayscale rasterization along the - * Y-direction; the name used in the TrueType specification for this - * feature is 'symmetric smoothing'. 'Classic ClearType' is the original - * algorithm used before introducing a modified version in Win~XP. - * Another name for v1.6's grayscale rendering is 'font smoothing', and - * 'Color ClearType' is sometimes also called 'DWrite ClearType'. To - * differentiate between today's Color ClearType and the earlier - * ClearType variant with B/W rendering along the vertical axis, the - * latter is sometimes called 'GDI ClearType'. - * - * 'Normal' and 'high' sampling describe the (virtual) resolution to - * access the rasterized outline after the hinting process. 'Normal' - * means 1 sample per grid line (i.e., B/W). In the current Microsoft - * implementation, 'high' means an extra virtual resolution of 16x16 (or - * 16x1) grid lines per pixel for bytecode instructions like 'MIRP'. - * After hinting, these 16 grid lines are mapped to 6x5 (or 6x1) grid - * lines for color filtering if Color ClearType is activated. - * - * Note that 'Gray ClearType' is essentially the same as v1.6's grayscale - * rendering. However, the GETINFO instruction handles it differently: - * v1.6 returns bit~12 (hinting for grayscale), while v2.1 returns - * bits~13 (hinting for ClearType), 18 (symmetrical smoothing), and~19 - * (Gray ClearType). Also, this mode respects bits 2 and~3 for the - * version~1 gasp table exclusively (like Color ClearType), while v1.6 - * only respects the values of version~0 (bits 0 and~1). - * - * Keep in mind that the features of the above interpreter versions might - * not map exactly to FreeType features or behavior because it is a - * fundamentally different library with different internals. - * - */ -#define TT_INTERPRETER_VERSION_35 35 -#define TT_INTERPRETER_VERSION_38 38 -#define TT_INTERPRETER_VERSION_40 40 - - - /************************************************************************** - * - * @property: - * interpreter-version - * - * @description: - * Currently, three versions are available, two representing the bytecode - * interpreter with subpixel hinting support (old 'Infinality' code and - * new stripped-down and higher performance 'minimal' code) and one - * without, respectively. The default is subpixel support if - * `TT_CONFIG_OPTION_SUBPIXEL_HINTING` is defined, and no subpixel - * support otherwise (since it isn't available then). - * - * If subpixel hinting is on, many TrueType bytecode instructions behave - * differently compared to B/W or grayscale rendering (except if 'native - * ClearType' is selected by the font). Microsoft's main idea is to - * render at a much increased horizontal resolution, then sampling down - * the created output to subpixel precision. However, many older fonts - * are not suited to this and must be specially taken care of by applying - * (hardcoded) tweaks in Microsoft's interpreter. - * - * Details on subpixel hinting and some of the necessary tweaks can be - * found in Greg Hitchcock's whitepaper at - * 'https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx'. - * Note that FreeType currently doesn't really 'subpixel hint' (6x1, 6x2, - * or 6x5 supersampling) like discussed in the paper. Depending on the - * chosen interpreter, it simply ignores instructions on vertical stems - * to arrive at very similar results. - * - * @note: - * This property can be used with @FT_Property_Get also. - * - * This property can be set via the `FREETYPE_PROPERTIES` environment - * variable (using values '35', '38', or '40'). - * - * @example: - * The following example code demonstrates how to deactivate subpixel - * hinting (omitting the error handling). - * - * ``` - * FT_Library library; - * FT_Face face; - * FT_UInt interpreter_version = TT_INTERPRETER_VERSION_35; - * - * - * FT_Init_FreeType( &library ); - * - * FT_Property_Set( library, "truetype", - * "interpreter-version", - * &interpreter_version ); - * ``` - * - * @since: - * 2.5 - */ - - - /************************************************************************** - * - * @property: - * glyph-to-script-map - * - * @description: - * **Experimental only** - * - * The auto-hinter provides various script modules to hint glyphs. - * Examples of supported scripts are Latin or CJK. Before a glyph is - * auto-hinted, the Unicode character map of the font gets examined, and - * the script is then determined based on Unicode character ranges, see - * below. - * - * OpenType fonts, however, often provide much more glyphs than character - * codes (small caps, superscripts, ligatures, swashes, etc.), to be - * controlled by so-called 'features'. Handling OpenType features can be - * quite complicated and thus needs a separate library on top of - * FreeType. - * - * The mapping between glyph indices and scripts (in the auto-hinter - * sense, see the @FT_AUTOHINTER_SCRIPT_XXX values) is stored as an array - * with `num_glyphs` elements, as found in the font's @FT_Face structure. - * The `glyph-to-script-map` property returns a pointer to this array, - * which can be modified as needed. Note that the modification should - * happen before the first glyph gets processed by the auto-hinter so - * that the global analysis of the font shapes actually uses the modified - * mapping. - * - * @example: - * The following example code demonstrates how to access it (omitting the - * error handling). - * - * ``` - * FT_Library library; - * FT_Face face; - * FT_Prop_GlyphToScriptMap prop; - * - * - * FT_Init_FreeType( &library ); - * FT_New_Face( library, "foo.ttf", 0, &face ); - * - * prop.face = face; - * - * FT_Property_Get( library, "autofitter", - * "glyph-to-script-map", &prop ); - * - * // adjust `prop.map' as needed right here - * - * FT_Load_Glyph( face, ..., FT_LOAD_FORCE_AUTOHINT ); - * ``` - * - * @since: - * 2.4.11 - * - */ - - - /************************************************************************** - * - * @enum: - * FT_AUTOHINTER_SCRIPT_XXX - * - * @description: - * **Experimental only** - * - * A list of constants used for the @glyph-to-script-map property to - * specify the script submodule the auto-hinter should use for hinting a - * particular glyph. - * - * @values: - * FT_AUTOHINTER_SCRIPT_NONE :: - * Don't auto-hint this glyph. - * - * FT_AUTOHINTER_SCRIPT_LATIN :: - * Apply the latin auto-hinter. For the auto-hinter, 'latin' is a very - * broad term, including Cyrillic and Greek also since characters from - * those scripts share the same design constraints. - * - * By default, characters from the following Unicode ranges are - * assigned to this submodule. - * - * ``` - * U+0020 - U+007F // Basic Latin (no control characters) - * U+00A0 - U+00FF // Latin-1 Supplement (no control characters) - * U+0100 - U+017F // Latin Extended-A - * U+0180 - U+024F // Latin Extended-B - * U+0250 - U+02AF // IPA Extensions - * U+02B0 - U+02FF // Spacing Modifier Letters - * U+0300 - U+036F // Combining Diacritical Marks - * U+0370 - U+03FF // Greek and Coptic - * U+0400 - U+04FF // Cyrillic - * U+0500 - U+052F // Cyrillic Supplement - * U+1D00 - U+1D7F // Phonetic Extensions - * U+1D80 - U+1DBF // Phonetic Extensions Supplement - * U+1DC0 - U+1DFF // Combining Diacritical Marks Supplement - * U+1E00 - U+1EFF // Latin Extended Additional - * U+1F00 - U+1FFF // Greek Extended - * U+2000 - U+206F // General Punctuation - * U+2070 - U+209F // Superscripts and Subscripts - * U+20A0 - U+20CF // Currency Symbols - * U+2150 - U+218F // Number Forms - * U+2460 - U+24FF // Enclosed Alphanumerics - * U+2C60 - U+2C7F // Latin Extended-C - * U+2DE0 - U+2DFF // Cyrillic Extended-A - * U+2E00 - U+2E7F // Supplemental Punctuation - * U+A640 - U+A69F // Cyrillic Extended-B - * U+A720 - U+A7FF // Latin Extended-D - * U+FB00 - U+FB06 // Alphab. Present. Forms (Latin Ligatures) - * U+1D400 - U+1D7FF // Mathematical Alphanumeric Symbols - * U+1F100 - U+1F1FF // Enclosed Alphanumeric Supplement - * ``` - * - * FT_AUTOHINTER_SCRIPT_CJK :: - * Apply the CJK auto-hinter, covering Chinese, Japanese, Korean, old - * Vietnamese, and some other scripts. - * - * By default, characters from the following Unicode ranges are - * assigned to this submodule. - * - * ``` - * U+1100 - U+11FF // Hangul Jamo - * U+2E80 - U+2EFF // CJK Radicals Supplement - * U+2F00 - U+2FDF // Kangxi Radicals - * U+2FF0 - U+2FFF // Ideographic Description Characters - * U+3000 - U+303F // CJK Symbols and Punctuation - * U+3040 - U+309F // Hiragana - * U+30A0 - U+30FF // Katakana - * U+3100 - U+312F // Bopomofo - * U+3130 - U+318F // Hangul Compatibility Jamo - * U+3190 - U+319F // Kanbun - * U+31A0 - U+31BF // Bopomofo Extended - * U+31C0 - U+31EF // CJK Strokes - * U+31F0 - U+31FF // Katakana Phonetic Extensions - * U+3200 - U+32FF // Enclosed CJK Letters and Months - * U+3300 - U+33FF // CJK Compatibility - * U+3400 - U+4DBF // CJK Unified Ideographs Extension A - * U+4DC0 - U+4DFF // Yijing Hexagram Symbols - * U+4E00 - U+9FFF // CJK Unified Ideographs - * U+A960 - U+A97F // Hangul Jamo Extended-A - * U+AC00 - U+D7AF // Hangul Syllables - * U+D7B0 - U+D7FF // Hangul Jamo Extended-B - * U+F900 - U+FAFF // CJK Compatibility Ideographs - * U+FE10 - U+FE1F // Vertical forms - * U+FE30 - U+FE4F // CJK Compatibility Forms - * U+FF00 - U+FFEF // Halfwidth and Fullwidth Forms - * U+1B000 - U+1B0FF // Kana Supplement - * U+1D300 - U+1D35F // Tai Xuan Hing Symbols - * U+1F200 - U+1F2FF // Enclosed Ideographic Supplement - * U+20000 - U+2A6DF // CJK Unified Ideographs Extension B - * U+2A700 - U+2B73F // CJK Unified Ideographs Extension C - * U+2B740 - U+2B81F // CJK Unified Ideographs Extension D - * U+2F800 - U+2FA1F // CJK Compatibility Ideographs Supplement - * ``` - * - * FT_AUTOHINTER_SCRIPT_INDIC :: - * Apply the indic auto-hinter, covering all major scripts from the - * Indian sub-continent and some other related scripts like Thai, Lao, - * or Tibetan. - * - * By default, characters from the following Unicode ranges are - * assigned to this submodule. - * - * ``` - * U+0900 - U+0DFF // Indic Range - * U+0F00 - U+0FFF // Tibetan - * U+1900 - U+194F // Limbu - * U+1B80 - U+1BBF // Sundanese - * U+A800 - U+A82F // Syloti Nagri - * U+ABC0 - U+ABFF // Meetei Mayek - * U+11800 - U+118DF // Sharada - * ``` - * - * Note that currently Indic support is rudimentary only, missing blue - * zone support. - * - * @since: - * 2.4.11 - * - */ -#define FT_AUTOHINTER_SCRIPT_NONE 0 -#define FT_AUTOHINTER_SCRIPT_LATIN 1 -#define FT_AUTOHINTER_SCRIPT_CJK 2 -#define FT_AUTOHINTER_SCRIPT_INDIC 3 - - - /************************************************************************** - * - * @struct: - * FT_Prop_GlyphToScriptMap - * - * @description: - * **Experimental only** - * - * The data exchange structure for the @glyph-to-script-map property. - * - * @since: - * 2.4.11 - * - */ - typedef struct FT_Prop_GlyphToScriptMap_ - { - FT_Face face; - FT_UShort* map; - - } FT_Prop_GlyphToScriptMap; - - - /************************************************************************** - * - * @property: - * fallback-script - * - * @description: - * **Experimental only** - * - * If no auto-hinter script module can be assigned to a glyph, a fallback - * script gets assigned to it (see also the @glyph-to-script-map - * property). By default, this is @FT_AUTOHINTER_SCRIPT_CJK. Using the - * `fallback-script` property, this fallback value can be changed. - * - * @note: - * This property can be used with @FT_Property_Get also. - * - * It's important to use the right timing for changing this value: The - * creation of the glyph-to-script map that eventually uses the fallback - * script value gets triggered either by setting or reading a - * face-specific property like @glyph-to-script-map, or by auto-hinting - * any glyph from that face. In particular, if you have already created - * an @FT_Face structure but not loaded any glyph (using the - * auto-hinter), a change of the fallback script will affect this face. - * - * @example: - * ``` - * FT_Library library; - * FT_UInt fallback_script = FT_AUTOHINTER_SCRIPT_NONE; - * - * - * FT_Init_FreeType( &library ); - * - * FT_Property_Set( library, "autofitter", - * "fallback-script", &fallback_script ); - * ``` - * - * @since: - * 2.4.11 - * - */ - - - /************************************************************************** - * - * @property: - * default-script - * - * @description: - * **Experimental only** - * - * If FreeType gets compiled with `FT_CONFIG_OPTION_USE_HARFBUZZ` to make - * the HarfBuzz library access OpenType features for getting better glyph - * coverages, this property sets the (auto-fitter) script to be used for - * the default (OpenType) script data of a font's GSUB table. Features - * for the default script are intended for all scripts not explicitly - * handled in GSUB; an example is a 'dlig' feature, containing the - * combination of the characters 'T', 'E', and 'L' to form a 'TEL' - * ligature. - * - * By default, this is @FT_AUTOHINTER_SCRIPT_LATIN. Using the - * `default-script` property, this default value can be changed. - * - * @note: - * This property can be used with @FT_Property_Get also. - * - * It's important to use the right timing for changing this value: The - * creation of the glyph-to-script map that eventually uses the default - * script value gets triggered either by setting or reading a - * face-specific property like @glyph-to-script-map, or by auto-hinting - * any glyph from that face. In particular, if you have already created - * an @FT_Face structure but not loaded any glyph (using the - * auto-hinter), a change of the default script will affect this face. - * - * @example: - * ``` - * FT_Library library; - * FT_UInt default_script = FT_AUTOHINTER_SCRIPT_NONE; - * - * - * FT_Init_FreeType( &library ); - * - * FT_Property_Set( library, "autofitter", - * "default-script", &default_script ); - * ``` - * - * @since: - * 2.5.3 - * - */ - - - /************************************************************************** - * - * @property: - * increase-x-height - * - * @description: - * For ppem values in the range 6~<= ppem <= `increase-x-height`, round - * up the font's x~height much more often than normally. If the value is - * set to~0, which is the default, this feature is switched off. Use - * this property to improve the legibility of small font sizes if - * necessary. - * - * @note: - * This property can be used with @FT_Property_Get also. - * - * Set this value right after calling @FT_Set_Char_Size, but before - * loading any glyph (using the auto-hinter). - * - * @example: - * ``` - * FT_Library library; - * FT_Face face; - * FT_Prop_IncreaseXHeight prop; - * - * - * FT_Init_FreeType( &library ); - * FT_New_Face( library, "foo.ttf", 0, &face ); - * FT_Set_Char_Size( face, 10 * 64, 0, 72, 0 ); - * - * prop.face = face; - * prop.limit = 14; - * - * FT_Property_Set( library, "autofitter", - * "increase-x-height", &prop ); - * ``` - * - * @since: - * 2.4.11 - * - */ - - - /************************************************************************** - * - * @struct: - * FT_Prop_IncreaseXHeight - * - * @description: - * The data exchange structure for the @increase-x-height property. - * - */ - typedef struct FT_Prop_IncreaseXHeight_ - { - FT_Face face; - FT_UInt limit; - - } FT_Prop_IncreaseXHeight; - - - /************************************************************************** - * - * @property: - * warping - * - * @description: - * **Experimental only** - * - * If FreeType gets compiled with option `AF_CONFIG_OPTION_USE_WARPER` to - * activate the warp hinting code in the auto-hinter, this property - * switches warping on and off. - * - * Warping only works in 'normal' auto-hinting mode replacing it. The - * idea of the code is to slightly scale and shift a glyph along the - * non-hinted dimension (which is usually the horizontal axis) so that as - * much of its segments are aligned (more or less) to the grid. To find - * out a glyph's optimal scaling and shifting value, various parameter - * combinations are tried and scored. - * - * By default, warping is off. - * - * @note: - * This property can be used with @FT_Property_Get also. - * - * This property can be set via the `FREETYPE_PROPERTIES` environment - * variable (using values 1 and 0 for 'on' and 'off', respectively). - * - * The warping code can also change advance widths. Have a look at the - * `lsb_delta` and `rsb_delta` fields in the @FT_GlyphSlotRec structure - * for details on improving inter-glyph distances while rendering. - * - * Since warping is a global property of the auto-hinter it is best to - * change its value before rendering any face. Otherwise, you should - * reload all faces that get auto-hinted in 'normal' hinting mode. - * - * @example: - * This example shows how to switch on warping (omitting the error - * handling). - * - * ``` - * FT_Library library; - * FT_Bool warping = 1; - * - * - * FT_Init_FreeType( &library ); - * - * FT_Property_Set( library, "autofitter", "warping", &warping ); - * ``` - * - * @since: - * 2.6 - * - */ - - - /* */ - - -FT_END_HEADER - - -#endif /* FTDRIVER_H_ */ - - -/* END */ diff --git a/android/x86_64/include/freetype/fterrdef.h b/android/x86_64/include/freetype/fterrdef.h index 9bc7dc65..3f53dd58 100644 --- a/android/x86_64/include/freetype/fterrdef.h +++ b/android/x86_64/include/freetype/fterrdef.h @@ -1,57 +1,58 @@ -/**************************************************************************** - * - * fterrdef.h - * - * FreeType error codes (specification). - * - * Copyright (C) 2002-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* fterrdef.h */ +/* */ +/* FreeType error codes (specification). */ +/* */ +/* Copyright 2002-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * @section: - * error_code_values - * - * @title: - * Error Code Values - * - * @abstract: - * All possible error codes returned by FreeType functions. - * - * @description: - * The list below is taken verbatim from the file `fterrdef.h` (loaded - * automatically by including `FT_FREETYPE_H`). The first argument of the - * `FT_ERROR_DEF_` macro is the error label; by default, the prefix - * `FT_Err_` gets added so that you get error names like - * `FT_Err_Cannot_Open_Resource`. The second argument is the error code, - * and the last argument an error string, which is not used by FreeType. - * - * Within your application you should **only** use error names and - * **never** its numeric values! The latter might (and actually do) - * change in forthcoming FreeType versions. - * - * Macro `FT_NOERRORDEF_` defines `FT_Err_Ok`, which is always zero. See - * the 'Error Enumerations' subsection how to automatically generate a - * list of error strings. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* error_code_values */ + /* */ + /* <Title> */ + /* Error Code Values */ + /* */ + /* <Abstract> */ + /* All possible error codes returned by FreeType functions. */ + /* */ + /* <Description> */ + /* The list below is taken verbatim from the file `fterrdef.h' */ + /* (loaded automatically by including `FT_FREETYPE_H'). The first */ + /* argument of the `FT_ERROR_DEF_' macro is the error label; by */ + /* default, the prefix `FT_Err_' gets added so that you get error */ + /* names like `FT_Err_Cannot_Open_Resource'. The second argument is */ + /* the error code, and the last argument an error string, which is not */ + /* used by FreeType. */ + /* */ + /* Within your application you should *only* use error names and */ + /* *never* its numeric values! The latter might (and actually do) */ + /* change in forthcoming FreeType versions. */ + /* */ + /* Macro `FT_NOERRORDEF_' defines `FT_Err_Ok', which is always zero. */ + /* See the `Error Enumerations' subsection how to automatically */ + /* generate a list of error strings. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @enum: - * FT_Err_XXX - * - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_Err_XXX */ + /* */ + /*************************************************************************/ /* generic errors */ @@ -230,10 +231,6 @@ "invalid PostScript (post) table format" ) FT_ERRORDEF_( Invalid_Post_Table, 0x9B, "invalid PostScript (post) table" ) - FT_ERRORDEF_( DEF_In_Glyf_Bytecode, 0x9C, - "found FDEF or IDEF opcode in glyf bytecode" ) - FT_ERRORDEF_( Missing_Bitmap, 0x9D, - "missing bitmap in strike" ) /* CFF, CID, and Type 1 errors */ diff --git a/android/x86_64/include/freetype/fterrors.h b/android/x86_64/include/freetype/fterrors.h index 58f5a3ea..e15bfb00 100644 --- a/android/x86_64/include/freetype/fterrors.h +++ b/android/x86_64/include/freetype/fterrors.h @@ -1,122 +1,112 @@ -/**************************************************************************** - * - * fterrors.h - * - * FreeType error code handling (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* fterrors.h */ +/* */ +/* FreeType error code handling (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * @section: - * error_enumerations - * - * @title: - * Error Enumerations - * - * @abstract: - * How to handle errors and error strings. - * - * @description: - * The header file `fterrors.h` (which is automatically included by - * `freetype.h` defines the handling of FreeType's enumeration - * constants. It can also be used to generate error message strings - * with a small macro trick explained below. - * - * **Error Formats** - * - * The configuration macro `FT_CONFIG_OPTION_USE_MODULE_ERRORS` can be - * defined in `ftoption.h` in order to make the higher byte indicate the - * module where the error has happened (this is not compatible with - * standard builds of FreeType~2, however). See the file `ftmoderr.h` - * for more details. - * - * **Error Message Strings** - * - * Error definitions are set up with special macros that allow client - * applications to build a table of error message strings. The strings - * are not included in a normal build of FreeType~2 to save space (most - * client applications do not use them). - * - * To do so, you have to define the following macros before including - * this file. - * - * ``` - * FT_ERROR_START_LIST - * ``` - * - * This macro is called before anything else to define the start of the - * error list. It is followed by several `FT_ERROR_DEF` calls. - * - * ``` - * FT_ERROR_DEF( e, v, s ) - * ``` - * - * This macro is called to define one single error. 'e' is the error - * code identifier (e.g., `Invalid_Argument`), 'v' is the error's - * numerical value, and 's' is the corresponding error string. - * - * ``` - * FT_ERROR_END_LIST - * ``` - * - * This macro ends the list. - * - * Additionally, you have to undefine `FTERRORS_H_` before #including - * this file. - * - * Here is a simple example. - * - * ``` - * #undef FTERRORS_H_ - * #define FT_ERRORDEF( e, v, s ) { e, s }, - * #define FT_ERROR_START_LIST { - * #define FT_ERROR_END_LIST { 0, NULL } }; - * - * const struct - * { - * int err_code; - * const char* err_msg; - * } ft_errors[] = - * - * #include FT_ERRORS_H - * ``` - * - * An alternative to using an array is a switch statement. - * - * ``` - * #undef FTERRORS_H_ - * #define FT_ERROR_START_LIST switch ( error_code ) { - * #define FT_ERRORDEF( e, v, s ) case v: return s; - * #define FT_ERROR_END_LIST } - * ``` - * - * If you use `FT_CONFIG_OPTION_USE_MODULE_ERRORS`, `error_code` should - * be replaced with `FT_ERROR_BASE(error_code)` in the last example. - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* error_enumerations */ + /* */ + /* <Title> */ + /* Error Enumerations */ + /* */ + /* <Abstract> */ + /* How to handle errors and error strings. */ + /* */ + /* <Description> */ + /* The header file `fterrors.h' (which is automatically included by */ + /* `freetype.h' defines the handling of FreeType's enumeration */ + /* constants. It can also be used to generate error message strings */ + /* with a small macro trick explained below. */ + /* */ + /* *Error* *Formats* */ + /* */ + /* The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be */ + /* defined in `ftoption.h' in order to make the higher byte indicate */ + /* the module where the error has happened (this is not compatible */ + /* with standard builds of FreeType 2, however). See the file */ + /* `ftmoderr.h' for more details. */ + /* */ + /* *Error* *Message* *Strings* */ + /* */ + /* Error definitions are set up with special macros that allow client */ + /* applications to build a table of error message strings. The */ + /* strings are not included in a normal build of FreeType 2 to */ + /* save space (most client applications do not use them). */ + /* */ + /* To do so, you have to define the following macros before including */ + /* this file. */ + /* */ + /* { */ + /* FT_ERROR_START_LIST */ + /* } */ + /* */ + /* This macro is called before anything else to define the start of */ + /* the error list. It is followed by several FT_ERROR_DEF calls. */ + /* */ + /* { */ + /* FT_ERROR_DEF( e, v, s ) */ + /* } */ + /* */ + /* This macro is called to define one single error. `e' is the error */ + /* code identifier (e.g., `Invalid_Argument'), `v' is the error's */ + /* numerical value, and `s' is the corresponding error string. */ + /* */ + /* { */ + /* FT_ERROR_END_LIST */ + /* } */ + /* */ + /* This macro ends the list. */ + /* */ + /* Additionally, you have to undefine `FTERRORS_H_' before #including */ + /* this file. */ + /* */ + /* Here is a simple example. */ + /* */ + /* { */ + /* #undef FTERRORS_H_ */ + /* #define FT_ERRORDEF( e, v, s ) { e, s }, */ + /* #define FT_ERROR_START_LIST { */ + /* #define FT_ERROR_END_LIST { 0, NULL } }; */ + /* */ + /* const struct */ + /* { */ + /* int err_code; */ + /* const char* err_msg; */ + /* } ft_errors[] = */ + /* */ + /* #include FT_ERRORS_H */ + /* } */ + /* */ + /* Note that `FT_Err_Ok' is _not_ defined with `FT_ERRORDEF' but with */ + /* `FT_NOERRORDEF'; it is always zero. */ + /* */ + /*************************************************************************/ /* */ - /* In previous FreeType versions we used `__FTERRORS_H__`. However, */ + /* In previous FreeType versions we used `__FTERRORS_H__'. However, */ /* using two successive underscores in a non-system symbol name */ /* violates the C (and C++) standard, so it was changed to the */ /* current form. In spite of this, we have to make */ /* */ - /* ``` */ /* #undefine __FTERRORS_H__ */ - /* ``` */ /* */ - /* work for backward compatibility. */ + /* work for backwards compatibility. */ /* */ #if !( defined( FTERRORS_H_ ) && defined ( __FTERRORS_H__ ) ) #define FTERRORS_H_ @@ -140,7 +130,7 @@ /* FT_ERR_PREFIX is used as a prefix for error identifiers. */ - /* By default, we use `FT_Err_`. */ + /* By default, we use `FT_Err_'. */ /* */ #ifndef FT_ERR_PREFIX #define FT_ERR_PREFIX FT_Err_ @@ -168,8 +158,6 @@ /* */ #ifndef FT_ERRORDEF -#define FT_INCLUDE_ERR_PROTOS - #define FT_ERRORDEF( e, v, s ) e = v, #define FT_ERROR_START_LIST enum { #define FT_ERROR_END_LIST FT_ERR_CAT( FT_ERR_PREFIX, Max ) }; @@ -232,53 +220,6 @@ #undef FT_ERR_PREFIX #endif - /* FT_INCLUDE_ERR_PROTOS: Control if function prototypes should be */ - /* included with `#include FT_ERRORS_H'. This is */ - /* only true where `FT_ERRORDEF` is undefined. */ - /* FT_ERR_PROTOS_DEFINED: Actual multiple-inclusion protection of */ - /* `fterrors.h`. */ -#ifdef FT_INCLUDE_ERR_PROTOS -#undef FT_INCLUDE_ERR_PROTOS - -#ifndef FT_ERR_PROTOS_DEFINED -#define FT_ERR_PROTOS_DEFINED - - - /************************************************************************** - * - * @function: - * FT_Error_String - * - * @description: - * Retrieve the description of a valid FreeType error code. - * - * @input: - * error_code :: - * A valid FreeType error code. - * - * @return: - * A C~string or `NULL`, if any error occurred. - * - * @note: - * FreeType has to be compiled with `FT_CONFIG_OPTION_ERROR_STRINGS` or - * `FT_DEBUG_LEVEL_ERROR` to get meaningful descriptions. - * 'error_string' will be `NULL` otherwise. - * - * Module identification will be ignored: - * - * ```c - * strcmp( FT_Error_String( FT_Err_Unknown_File_Format ), - * FT_Error_String( BDF_Err_Unknown_File_Format ) ) == 0; - * ``` - */ - FT_EXPORT( const char* ) - FT_Error_String( FT_Error error_code ); - - -#endif /* FT_ERR_PROTOS_DEFINED */ - -#endif /* FT_INCLUDE_ERR_PROTOS */ - #endif /* !(FTERRORS_H_ && __FTERRORS_H__) */ diff --git a/android/x86_64/include/freetype/ftfntfmt.h b/android/x86_64/include/freetype/ftfntfmt.h index 76479f5d..bd423247 100644 --- a/android/x86_64/include/freetype/ftfntfmt.h +++ b/android/x86_64/include/freetype/ftfntfmt.h @@ -1,25 +1,25 @@ -/**************************************************************************** - * - * ftfntfmt.h - * - * Support functions for font formats. - * - * Copyright (C) 2002-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftfntfmt.h */ +/* */ +/* Support functions for font formats. */ +/* */ +/* Copyright 2002-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTFNTFMT_H_ #define FTFNTFMT_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -32,48 +32,49 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * font_formats - * - * @title: - * Font Formats - * - * @abstract: - * Getting the font format. - * - * @description: - * The single function in this section can be used to get the font format. - * Note that this information is not needed normally; however, there are - * special cases (like in PDF devices) where it is important to - * differentiate, in spite of FreeType's uniform API. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* font_formats */ + /* */ + /* <Title> */ + /* Font Formats */ + /* */ + /* <Abstract> */ + /* Getting the font format. */ + /* */ + /* <Description> */ + /* The single function in this section can be used to get the font */ + /* format. Note that this information is not needed normally; */ + /* however, there are special cases (like in PDF devices) where it is */ + /* important to differentiate, in spite of FreeType's uniform API. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Get_Font_Format - * - * @description: - * Return a string describing the format of a given face. Possible values - * are 'TrueType', 'Type~1', 'BDF', 'PCF', 'Type~42', 'CID~Type~1', 'CFF', - * 'PFR', and 'Windows~FNT'. - * - * The return value is suitable to be used as an X11 FONT_PROPERTY. - * - * @input: - * face :: - * Input face handle. - * - * @return: - * Font format string. `NULL` in case of error. - * - * @note: - * A deprecated name for the same function is `FT_Get_X11_Font_Format`. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Font_Format */ + /* */ + /* <Description> */ + /* Return a string describing the format of a given face. Possible */ + /* values are `TrueType', `Type~1', `BDF', `PCF', `Type~42', */ + /* `CID~Type~1', `CFF', `PFR', and `Windows~FNT'. */ + /* */ + /* The return value is suitable to be used as an X11 FONT_PROPERTY. */ + /* */ + /* <Input> */ + /* face :: */ + /* Input face handle. */ + /* */ + /* <Return> */ + /* Font format string. NULL in case of error. */ + /* */ + /* <Note> */ + /* A deprecated name for the same function is */ + /* `FT_Get_X11_Font_Format'. */ + /* */ FT_EXPORT( const char* ) FT_Get_Font_Format( FT_Face face ); diff --git a/android/x86_64/include/freetype/ftgasp.h b/android/x86_64/include/freetype/ftgasp.h index 81c76f90..3f5b3bc6 100644 --- a/android/x86_64/include/freetype/ftgasp.h +++ b/android/x86_64/include/freetype/ftgasp.h @@ -1,25 +1,25 @@ -/**************************************************************************** - * - * ftgasp.h - * - * Access of TrueType's 'gasp' table (specification). - * - * Copyright (C) 2007-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftgasp.h */ +/* */ +/* Access of TrueType's `gasp' table (specification). */ +/* */ +/* Copyright 2007-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTGASP_H_ #define FTGASP_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -29,10 +29,7 @@ #endif -FT_BEGIN_HEADER - - - /************************************************************************** + /*************************************************************************** * * @section: * gasp_table @@ -41,16 +38,16 @@ FT_BEGIN_HEADER * Gasp Table * * @abstract: - * Retrieving TrueType 'gasp' table entries. + * Retrieving TrueType `gasp' table entries. * * @description: * The function @FT_Get_Gasp can be used to query a TrueType or OpenType - * font for specific entries in its 'gasp' table, if any. This is mainly - * useful when implementing native TrueType hinting with the bytecode - * interpreter to duplicate the Windows text rendering results. + * font for specific entries in its `gasp' table, if any. This is + * mainly useful when implementing native TrueType hinting with the + * bytecode interpreter to duplicate the Windows text rendering results. */ - /************************************************************************** + /************************************************************************* * * @enum: * FT_GASP_XXX @@ -66,7 +63,7 @@ FT_BEGIN_HEADER * * FT_GASP_DO_GRIDFIT :: * Grid-fitting and hinting should be performed at the specified ppem. - * This **really** means TrueType bytecode interpretation. If this bit + * This *really* means TrueType bytecode interpretation. If this bit * is not set, no hinting gets applied. * * FT_GASP_DO_GRAY :: @@ -80,13 +77,13 @@ FT_BEGIN_HEADER * Grid-fitting must be used with ClearType's symmetric smoothing. * * @note: - * The bit-flags `FT_GASP_DO_GRIDFIT` and `FT_GASP_DO_GRAY` are to be + * The bit-flags `FT_GASP_DO_GRIDFIT' and `FT_GASP_DO_GRAY' are to be * used for standard font rasterization only. Independently of that, - * `FT_GASP_SYMMETRIC_SMOOTHING` and `FT_GASP_SYMMETRIC_GRIDFIT` are to - * be used if ClearType is enabled (and `FT_GASP_DO_GRIDFIT` and - * `FT_GASP_DO_GRAY` are consequently ignored). + * `FT_GASP_SYMMETRIC_SMOOTHING' and `FT_GASP_SYMMETRIC_GRIDFIT' are to + * be used if ClearType is enabled (and `FT_GASP_DO_GRIDFIT' and + * `FT_GASP_DO_GRAY' are consequently ignored). * - * 'ClearType' is Microsoft's implementation of LCD rendering, partly + * `ClearType' is Microsoft's implementation of LCD rendering, partly * protected by patents. * * @since: @@ -95,36 +92,26 @@ FT_BEGIN_HEADER #define FT_GASP_NO_TABLE -1 #define FT_GASP_DO_GRIDFIT 0x01 #define FT_GASP_DO_GRAY 0x02 -#define FT_GASP_SYMMETRIC_GRIDFIT 0x04 #define FT_GASP_SYMMETRIC_SMOOTHING 0x08 +#define FT_GASP_SYMMETRIC_GRIDFIT 0x10 - /************************************************************************** + /************************************************************************* * - * @function: + * @func: * FT_Get_Gasp * * @description: - * For a TrueType or OpenType font file, return the rasterizer behaviour - * flags from the font's 'gasp' table corresponding to a given character - * pixel size. + * Read the `gasp' table from a TrueType or OpenType font file and + * return the entry corresponding to a given character pixel size. * * @input: - * face :: - * The source face handle. - * - * ppem :: - * The vertical character pixel size. + * face :: The source face handle. + * ppem :: The vertical character pixel size. * * @return: * Bit flags (see @FT_GASP_XXX), or @FT_GASP_NO_TABLE if there is no - * 'gasp' table in the face. - * - * @note: - * If you want to use the MM functionality of OpenType variation fonts - * (i.e., using @FT_Set_Var_Design_Coordinates and friends), call this - * function **after** setting an instance since the return values can - * change. + * `gasp' table in the face. * * @since: * 2.3.0 @@ -136,8 +123,6 @@ FT_BEGIN_HEADER /* */ -FT_END_HEADER - #endif /* FTGASP_H_ */ diff --git a/android/x86_64/include/freetype/ftglyph.h b/android/x86_64/include/freetype/ftglyph.h index a22e0589..d9840a81 100644 --- a/android/x86_64/include/freetype/ftglyph.h +++ b/android/x86_64/include/freetype/ftglyph.h @@ -1,39 +1,39 @@ -/**************************************************************************** - * - * ftglyph.h - * - * FreeType convenience functions to handle glyphs (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftglyph.h */ +/* */ +/* FreeType convenience functions to handle glyphs (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * This file contains the definition of several convenience functions that - * can be used by client applications to easily retrieve glyph bitmaps and - * outlines from a given face. - * - * These functions should be optional if you are writing a font server or - * text layout engine on top of FreeType. However, they are pretty handy - * for many other simple uses of the library. - * - */ + /*************************************************************************/ + /* */ + /* This file contains the definition of several convenience functions */ + /* that can be used by client applications to easily retrieve glyph */ + /* bitmaps and outlines from a given face. */ + /* */ + /* These functions should be optional if you are writing a font server */ + /* or text layout engine on top of FreeType. However, they are pretty */ + /* handy for many other simple uses of the library. */ + /* */ + /*************************************************************************/ #ifndef FTGLYPH_H_ #define FTGLYPH_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -46,70 +46,65 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * glyph_management - * - * @title: - * Glyph Management - * - * @abstract: - * Generic interface to manage individual glyph data. - * - * @description: - * This section contains definitions used to manage glyph data through - * generic @FT_Glyph objects. Each of them can contain a bitmap, - * a vector outline, or even images in other formats. These objects are - * detached from @FT_Face, contrary to @FT_GlyphSlot. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* glyph_management */ + /* */ + /* <Title> */ + /* Glyph Management */ + /* */ + /* <Abstract> */ + /* Generic interface to manage individual glyph data. */ + /* */ + /* <Description> */ + /* This section contains definitions used to manage glyph data */ + /* through generic FT_Glyph objects. Each of them can contain a */ + /* bitmap, a vector outline, or even images in other formats. */ + /* */ + /*************************************************************************/ /* forward declaration to a private type */ typedef struct FT_Glyph_Class_ FT_Glyph_Class; - /************************************************************************** - * - * @type: - * FT_Glyph - * - * @description: - * Handle to an object used to model generic glyph images. It is a - * pointer to the @FT_GlyphRec structure and can contain a glyph bitmap - * or pointer. - * - * @note: - * Glyph objects are not owned by the library. You must thus release - * them manually (through @FT_Done_Glyph) _before_ calling - * @FT_Done_FreeType. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Glyph */ + /* */ + /* <Description> */ + /* Handle to an object used to model generic glyph images. It is a */ + /* pointer to the @FT_GlyphRec structure and can contain a glyph */ + /* bitmap or pointer. */ + /* */ + /* <Note> */ + /* Glyph objects are not owned by the library. You must thus release */ + /* them manually (through @FT_Done_Glyph) _before_ calling */ + /* @FT_Done_FreeType. */ + /* */ typedef struct FT_GlyphRec_* FT_Glyph; - /************************************************************************** - * - * @struct: - * FT_GlyphRec - * - * @description: - * The root glyph structure contains a given glyph image plus its advance - * width in 16.16 fixed-point format. - * - * @fields: - * library :: - * A handle to the FreeType library object. - * - * clazz :: - * A pointer to the glyph's class. Private. - * - * format :: - * The format of the glyph's image. - * - * advance :: - * A 16.16 vector that gives the glyph's advance width. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_GlyphRec */ + /* */ + /* <Description> */ + /* The root glyph structure contains a given glyph image plus its */ + /* advance width in 16.16 fixed-point format. */ + /* */ + /* <Fields> */ + /* library :: A handle to the FreeType library object. */ + /* */ + /* clazz :: A pointer to the glyph's class. Private. */ + /* */ + /* format :: The format of the glyph's image. */ + /* */ + /* advance :: A 16.16 vector that gives the glyph's advance width. */ + /* */ typedef struct FT_GlyphRec_ { FT_Library library; @@ -120,51 +115,48 @@ FT_BEGIN_HEADER } FT_GlyphRec; - /************************************************************************** - * - * @type: - * FT_BitmapGlyph - * - * @description: - * A handle to an object used to model a bitmap glyph image. This is a - * sub-class of @FT_Glyph, and a pointer to @FT_BitmapGlyphRec. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_BitmapGlyph */ + /* */ + /* <Description> */ + /* A handle to an object used to model a bitmap glyph image. This is */ + /* a sub-class of @FT_Glyph, and a pointer to @FT_BitmapGlyphRec. */ + /* */ typedef struct FT_BitmapGlyphRec_* FT_BitmapGlyph; - /************************************************************************** - * - * @struct: - * FT_BitmapGlyphRec - * - * @description: - * A structure used for bitmap glyph images. This really is a - * 'sub-class' of @FT_GlyphRec. - * - * @fields: - * root :: - * The root @FT_Glyph fields. - * - * left :: - * The left-side bearing, i.e., the horizontal distance from the - * current pen position to the left border of the glyph bitmap. - * - * top :: - * The top-side bearing, i.e., the vertical distance from the current - * pen position to the top border of the glyph bitmap. This distance - * is positive for upwards~y! - * - * bitmap :: - * A descriptor for the bitmap. - * - * @note: - * You can typecast an @FT_Glyph to @FT_BitmapGlyph if you have - * `glyph->format == FT_GLYPH_FORMAT_BITMAP`. This lets you access the - * bitmap's contents easily. - * - * The corresponding pixel buffer is always owned by @FT_BitmapGlyph and - * is thus created and destroyed with it. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_BitmapGlyphRec */ + /* */ + /* <Description> */ + /* A structure used for bitmap glyph images. This really is a */ + /* `sub-class' of @FT_GlyphRec. */ + /* */ + /* <Fields> */ + /* root :: The root @FT_Glyph fields. */ + /* */ + /* left :: The left-side bearing, i.e., the horizontal distance */ + /* from the current pen position to the left border of the */ + /* glyph bitmap. */ + /* */ + /* top :: The top-side bearing, i.e., the vertical distance from */ + /* the current pen position to the top border of the glyph */ + /* bitmap. This distance is positive for upwards~y! */ + /* */ + /* bitmap :: A descriptor for the bitmap. */ + /* */ + /* <Note> */ + /* You can typecast an @FT_Glyph to @FT_BitmapGlyph if you have */ + /* `glyph->format == FT_GLYPH_FORMAT_BITMAP'. This lets you access */ + /* the bitmap's contents easily. */ + /* */ + /* The corresponding pixel buffer is always owned by @FT_BitmapGlyph */ + /* and is thus created and destroyed with it. */ + /* */ typedef struct FT_BitmapGlyphRec_ { FT_GlyphRec root; @@ -175,46 +167,44 @@ FT_BEGIN_HEADER } FT_BitmapGlyphRec; - /************************************************************************** - * - * @type: - * FT_OutlineGlyph - * - * @description: - * A handle to an object used to model an outline glyph image. This is a - * sub-class of @FT_Glyph, and a pointer to @FT_OutlineGlyphRec. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_OutlineGlyph */ + /* */ + /* <Description> */ + /* A handle to an object used to model an outline glyph image. This */ + /* is a sub-class of @FT_Glyph, and a pointer to @FT_OutlineGlyphRec. */ + /* */ typedef struct FT_OutlineGlyphRec_* FT_OutlineGlyph; - /************************************************************************** - * - * @struct: - * FT_OutlineGlyphRec - * - * @description: - * A structure used for outline (vectorial) glyph images. This really is - * a 'sub-class' of @FT_GlyphRec. - * - * @fields: - * root :: - * The root @FT_Glyph fields. - * - * outline :: - * A descriptor for the outline. - * - * @note: - * You can typecast an @FT_Glyph to @FT_OutlineGlyph if you have - * `glyph->format == FT_GLYPH_FORMAT_OUTLINE`. This lets you access the - * outline's content easily. - * - * As the outline is extracted from a glyph slot, its coordinates are - * expressed normally in 26.6 pixels, unless the flag @FT_LOAD_NO_SCALE - * was used in @FT_Load_Glyph() or @FT_Load_Char(). - * - * The outline's tables are always owned by the object and are destroyed - * with it. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_OutlineGlyphRec */ + /* */ + /* <Description> */ + /* A structure used for outline (vectorial) glyph images. This */ + /* really is a `sub-class' of @FT_GlyphRec. */ + /* */ + /* <Fields> */ + /* root :: The root @FT_Glyph fields. */ + /* */ + /* outline :: A descriptor for the outline. */ + /* */ + /* <Note> */ + /* You can typecast an @FT_Glyph to @FT_OutlineGlyph if you have */ + /* `glyph->format == FT_GLYPH_FORMAT_OUTLINE'. This lets you access */ + /* the outline's content easily. */ + /* */ + /* As the outline is extracted from a glyph slot, its coordinates are */ + /* expressed normally in 26.6 pixels, unless the flag */ + /* @FT_LOAD_NO_SCALE was used in @FT_Load_Glyph() or @FT_Load_Char(). */ + /* */ + /* The outline's tables are always owned by the object and are */ + /* destroyed with it. */ + /* */ typedef struct FT_OutlineGlyphRec_ { FT_GlyphRec root; @@ -223,150 +213,107 @@ FT_BEGIN_HEADER } FT_OutlineGlyphRec; - /************************************************************************** - * - * @function: - * FT_New_Glyph - * - * @description: - * A function used to create a new empty glyph image. Note that the - * created @FT_Glyph object must be released with @FT_Done_Glyph. - * - * @input: - * library :: - * A handle to the FreeType library object. - * - * format :: - * The format of the glyph's image. - * - * @output: - * aglyph :: - * A handle to the glyph object. - * - * @return: - * FreeType error code. 0~means success. - * - * @since: - * 2.10 - */ - FT_EXPORT( FT_Error ) - FT_New_Glyph( FT_Library library, - FT_Glyph_Format format, - FT_Glyph *aglyph ); - - - /************************************************************************** - * - * @function: - * FT_Get_Glyph - * - * @description: - * A function used to extract a glyph image from a slot. Note that the - * created @FT_Glyph object must be released with @FT_Done_Glyph. - * - * @input: - * slot :: - * A handle to the source glyph slot. - * - * @output: - * aglyph :: - * A handle to the glyph object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * Because `*aglyph->advance.x` and `*aglyph->advance.y` are 16.16 - * fixed-point numbers, `slot->advance.x` and `slot->advance.y` (which - * are in 26.6 fixed-point format) must be in the range ]-32768;32768[. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Glyph */ + /* */ + /* <Description> */ + /* A function used to extract a glyph image from a slot. Note that */ + /* the created @FT_Glyph object must be released with @FT_Done_Glyph. */ + /* */ + /* <Input> */ + /* slot :: A handle to the source glyph slot. */ + /* */ + /* <Output> */ + /* aglyph :: A handle to the glyph object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Glyph( FT_GlyphSlot slot, FT_Glyph *aglyph ); - /************************************************************************** - * - * @function: - * FT_Glyph_Copy - * - * @description: - * A function used to copy a glyph image. Note that the created - * @FT_Glyph object must be released with @FT_Done_Glyph. - * - * @input: - * source :: - * A handle to the source glyph object. - * - * @output: - * target :: - * A handle to the target glyph object. 0~in case of error. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Glyph_Copy */ + /* */ + /* <Description> */ + /* A function used to copy a glyph image. Note that the created */ + /* @FT_Glyph object must be released with @FT_Done_Glyph. */ + /* */ + /* <Input> */ + /* source :: A handle to the source glyph object. */ + /* */ + /* <Output> */ + /* target :: A handle to the target glyph object. 0~in case of */ + /* error. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Glyph_Copy( FT_Glyph source, FT_Glyph *target ); - /************************************************************************** - * - * @function: - * FT_Glyph_Transform - * - * @description: - * Transform a glyph image if its format is scalable. - * - * @inout: - * glyph :: - * A handle to the target glyph object. - * - * @input: - * matrix :: - * A pointer to a 2x2 matrix to apply. - * - * delta :: - * A pointer to a 2d vector to apply. Coordinates are expressed in - * 1/64th of a pixel. - * - * @return: - * FreeType error code (if not 0, the glyph format is not scalable). - * - * @note: - * The 2x2 transformation matrix is also applied to the glyph's advance - * vector. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Glyph_Transform */ + /* */ + /* <Description> */ + /* Transform a glyph image if its format is scalable. */ + /* */ + /* <InOut> */ + /* glyph :: A handle to the target glyph object. */ + /* */ + /* <Input> */ + /* matrix :: A pointer to a 2x2 matrix to apply. */ + /* */ + /* delta :: A pointer to a 2d vector to apply. Coordinates are */ + /* expressed in 1/64th of a pixel. */ + /* */ + /* <Return> */ + /* FreeType error code (if not 0, the glyph format is not scalable). */ + /* */ + /* <Note> */ + /* The 2x2 transformation matrix is also applied to the glyph's */ + /* advance vector. */ + /* */ FT_EXPORT( FT_Error ) FT_Glyph_Transform( FT_Glyph glyph, FT_Matrix* matrix, FT_Vector* delta ); - /************************************************************************** - * - * @enum: - * FT_Glyph_BBox_Mode - * - * @description: - * The mode how the values of @FT_Glyph_Get_CBox are returned. - * - * @values: - * FT_GLYPH_BBOX_UNSCALED :: - * Return unscaled font units. - * - * FT_GLYPH_BBOX_SUBPIXELS :: - * Return unfitted 26.6 coordinates. - * - * FT_GLYPH_BBOX_GRIDFIT :: - * Return grid-fitted 26.6 coordinates. - * - * FT_GLYPH_BBOX_TRUNCATE :: - * Return coordinates in integer pixels. - * - * FT_GLYPH_BBOX_PIXELS :: - * Return grid-fitted pixel coordinates. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_Glyph_BBox_Mode */ + /* */ + /* <Description> */ + /* The mode how the values of @FT_Glyph_Get_CBox are returned. */ + /* */ + /* <Values> */ + /* FT_GLYPH_BBOX_UNSCALED :: */ + /* Return unscaled font units. */ + /* */ + /* FT_GLYPH_BBOX_SUBPIXELS :: */ + /* Return unfitted 26.6 coordinates. */ + /* */ + /* FT_GLYPH_BBOX_GRIDFIT :: */ + /* Return grid-fitted 26.6 coordinates. */ + /* */ + /* FT_GLYPH_BBOX_TRUNCATE :: */ + /* Return coordinates in integer pixels. */ + /* */ + /* FT_GLYPH_BBOX_PIXELS :: */ + /* Return grid-fitted pixel coordinates. */ + /* */ typedef enum FT_Glyph_BBox_Mode_ { FT_GLYPH_BBOX_UNSCALED = 0, @@ -379,7 +326,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_Glyph_BBox_Mode` values instead */ + /* `FT_Glyph_BBox_Mode' values instead */ #define ft_glyph_bbox_unscaled FT_GLYPH_BBOX_UNSCALED #define ft_glyph_bbox_subpixels FT_GLYPH_BBOX_SUBPIXELS #define ft_glyph_bbox_gridfit FT_GLYPH_BBOX_GRIDFIT @@ -387,188 +334,187 @@ FT_BEGIN_HEADER #define ft_glyph_bbox_pixels FT_GLYPH_BBOX_PIXELS - /************************************************************************** - * - * @function: - * FT_Glyph_Get_CBox - * - * @description: - * Return a glyph's 'control box'. The control box encloses all the - * outline's points, including Bezier control points. Though it - * coincides with the exact bounding box for most glyphs, it can be - * slightly larger in some situations (like when rotating an outline that - * contains Bezier outside arcs). - * - * Computing the control box is very fast, while getting the bounding box - * can take much more time as it needs to walk over all segments and arcs - * in the outline. To get the latter, you can use the 'ftbbox' - * component, which is dedicated to this single task. - * - * @input: - * glyph :: - * A handle to the source glyph object. - * - * mode :: - * The mode that indicates how to interpret the returned bounding box - * values. - * - * @output: - * acbox :: - * The glyph coordinate bounding box. Coordinates are expressed in - * 1/64th of pixels if it is grid-fitted. - * - * @note: - * Coordinates are relative to the glyph origin, using the y~upwards - * convention. - * - * If the glyph has been loaded with @FT_LOAD_NO_SCALE, `bbox_mode` must - * be set to @FT_GLYPH_BBOX_UNSCALED to get unscaled font units in 26.6 - * pixel format. The value @FT_GLYPH_BBOX_SUBPIXELS is another name for - * this constant. - * - * If the font is tricky and the glyph has been loaded with - * @FT_LOAD_NO_SCALE, 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. - * - * 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: - * - * ``` - * width = bbox.xMax - bbox.xMin; - * height = bbox.yMax - bbox.yMin; - * ``` - * - * Note also that for 26.6 coordinates, if `bbox_mode` is set to - * @FT_GLYPH_BBOX_GRIDFIT, the coordinates will also be grid-fitted, - * which corresponds to: - * - * ``` - * bbox.xMin = FLOOR(bbox.xMin); - * bbox.yMin = FLOOR(bbox.yMin); - * bbox.xMax = CEILING(bbox.xMax); - * bbox.yMax = CEILING(bbox.yMax); - * ``` - * - * To get the bbox in pixel coordinates, set `bbox_mode` to - * @FT_GLYPH_BBOX_TRUNCATE. - * - * To get the bbox in grid-fitted pixel coordinates, set `bbox_mode` to - * @FT_GLYPH_BBOX_PIXELS. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Glyph_Get_CBox */ + /* */ + /* <Description> */ + /* Return a glyph's `control box'. The control box encloses all the */ + /* outline's points, including Bézier control points. Though it */ + /* coincides with the exact bounding box for most glyphs, it can be */ + /* slightly larger in some situations (like when rotating an outline */ + /* that contains Bézier outside arcs). */ + /* */ + /* Computing the control box is very fast, while getting the bounding */ + /* box can take much more time as it needs to walk over all segments */ + /* and arcs in the outline. To get the latter, you can use the */ + /* `ftbbox' component, which is dedicated to this single task. */ + /* */ + /* <Input> */ + /* glyph :: A handle to the source glyph object. */ + /* */ + /* mode :: The mode that indicates how to interpret the returned */ + /* bounding box values. */ + /* */ + /* <Output> */ + /* acbox :: The glyph coordinate bounding box. Coordinates are */ + /* expressed in 1/64th of pixels if it is grid-fitted. */ + /* */ + /* <Note> */ + /* Coordinates are relative to the glyph origin, using the y~upwards */ + /* convention. */ + /* */ + /* If the glyph has been loaded with @FT_LOAD_NO_SCALE, `bbox_mode' */ + /* must be set to @FT_GLYPH_BBOX_UNSCALED to get unscaled font */ + /* units in 26.6 pixel format. The value @FT_GLYPH_BBOX_SUBPIXELS */ + /* is another name for this constant. */ + /* */ + /* If the font is tricky and the glyph has been loaded with */ + /* @FT_LOAD_NO_SCALE, 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. */ + /* */ + /* 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: */ + /* */ + /* { */ + /* width = bbox.xMax - bbox.xMin; */ + /* height = bbox.yMax - bbox.yMin; */ + /* } */ + /* */ + /* Note also that for 26.6 coordinates, if `bbox_mode' is set to */ + /* @FT_GLYPH_BBOX_GRIDFIT, the coordinates will also be grid-fitted, */ + /* which corresponds to: */ + /* */ + /* { */ + /* bbox.xMin = FLOOR(bbox.xMin); */ + /* bbox.yMin = FLOOR(bbox.yMin); */ + /* bbox.xMax = CEILING(bbox.xMax); */ + /* bbox.yMax = CEILING(bbox.yMax); */ + /* } */ + /* */ + /* To get the bbox in pixel coordinates, set `bbox_mode' to */ + /* @FT_GLYPH_BBOX_TRUNCATE. */ + /* */ + /* To get the bbox in grid-fitted pixel coordinates, set `bbox_mode' */ + /* to @FT_GLYPH_BBOX_PIXELS. */ + /* */ FT_EXPORT( void ) FT_Glyph_Get_CBox( FT_Glyph glyph, FT_UInt bbox_mode, FT_BBox *acbox ); - /************************************************************************** - * - * @function: - * FT_Glyph_To_Bitmap - * - * @description: - * Convert a given glyph object to a bitmap glyph object. - * - * @inout: - * the_glyph :: - * A pointer to a handle to the target glyph. - * - * @input: - * render_mode :: - * An enumeration that describes how the data is rendered. - * - * origin :: - * A pointer to a vector used to translate the glyph image before - * rendering. Can be~0 (if no translation). The origin is expressed - * in 26.6 pixels. - * - * destroy :: - * A boolean that indicates that the original glyph image should be - * destroyed by this function. It is never destroyed in case of error. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function does nothing if the glyph format isn't scalable. - * - * The glyph image is translated with the `origin` vector before - * rendering. - * - * The first parameter is a pointer to an @FT_Glyph handle, that will be - * _replaced_ by this function (with newly allocated data). Typically, - * you would use (omitting error handling): - * - * ``` - * FT_Glyph glyph; - * FT_BitmapGlyph glyph_bitmap; - * - * - * // load glyph - * error = FT_Load_Char( face, glyph_index, FT_LOAD_DEFAULT ); - * - * // extract glyph image - * error = FT_Get_Glyph( face->glyph, &glyph ); - * - * // convert to a bitmap (default render mode + destroying old) - * if ( glyph->format != FT_GLYPH_FORMAT_BITMAP ) - * { - * error = FT_Glyph_To_Bitmap( &glyph, FT_RENDER_MODE_NORMAL, - * 0, 1 ); - * if ( error ) // `glyph' unchanged - * ... - * } - * - * // access bitmap content by typecasting - * glyph_bitmap = (FT_BitmapGlyph)glyph; - * - * // do funny stuff with it, like blitting/drawing - * ... - * - * // discard glyph image (bitmap or not) - * FT_Done_Glyph( glyph ); - * ``` - * - * Here is another example, again without error handling: - * - * ``` - * FT_Glyph glyphs[MAX_GLYPHS] - * - * - * ... - * - * for ( idx = 0; i < MAX_GLYPHS; i++ ) - * error = FT_Load_Glyph( face, idx, FT_LOAD_DEFAULT ) || - * FT_Get_Glyph ( face->glyph, &glyphs[idx] ); - * - * ... - * - * for ( idx = 0; i < MAX_GLYPHS; i++ ) - * { - * FT_Glyph bitmap = glyphs[idx]; - * - * - * ... - * - * // after this call, `bitmap' no longer points into - * // the `glyphs' array (and the old value isn't destroyed) - * FT_Glyph_To_Bitmap( &bitmap, FT_RENDER_MODE_MONO, 0, 0 ); - * - * ... - * - * FT_Done_Glyph( bitmap ); - * } - * - * ... - * - * for ( idx = 0; i < MAX_GLYPHS; i++ ) - * FT_Done_Glyph( glyphs[idx] ); - * ``` - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Glyph_To_Bitmap */ + /* */ + /* <Description> */ + /* Convert a given glyph object to a bitmap glyph object. */ + /* */ + /* <InOut> */ + /* the_glyph :: A pointer to a handle to the target glyph. */ + /* */ + /* <Input> */ + /* render_mode :: An enumeration that describes how the data is */ + /* rendered. */ + /* */ + /* origin :: A pointer to a vector used to translate the glyph */ + /* image before rendering. Can be~0 (if no */ + /* translation). The origin is expressed in */ + /* 26.6 pixels. */ + /* */ + /* destroy :: A boolean that indicates that the original glyph */ + /* image should be destroyed by this function. It is */ + /* never destroyed in case of error. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* This function does nothing if the glyph format isn't scalable. */ + /* */ + /* The glyph image is translated with the `origin' vector before */ + /* rendering. */ + /* */ + /* The first parameter is a pointer to an @FT_Glyph handle, that will */ + /* be _replaced_ by this function (with newly allocated data). */ + /* Typically, you would use (omitting error handling): */ + /* */ + /* */ + /* { */ + /* FT_Glyph glyph; */ + /* FT_BitmapGlyph glyph_bitmap; */ + /* */ + /* */ + /* // load glyph */ + /* error = FT_Load_Char( face, glyph_index, FT_LOAD_DEFAUT ); */ + /* */ + /* // extract glyph image */ + /* error = FT_Get_Glyph( face->glyph, &glyph ); */ + /* */ + /* // convert to a bitmap (default render mode + destroying old) */ + /* if ( glyph->format != FT_GLYPH_FORMAT_BITMAP ) */ + /* { */ + /* error = FT_Glyph_To_Bitmap( &glyph, FT_RENDER_MODE_NORMAL, */ + /* 0, 1 ); */ + /* if ( error ) // `glyph' unchanged */ + /* ... */ + /* } */ + /* */ + /* // access bitmap content by typecasting */ + /* glyph_bitmap = (FT_BitmapGlyph)glyph; */ + /* */ + /* // do funny stuff with it, like blitting/drawing */ + /* ... */ + /* */ + /* // discard glyph image (bitmap or not) */ + /* FT_Done_Glyph( glyph ); */ + /* } */ + /* */ + /* */ + /* Here another example, again without error handling: */ + /* */ + /* */ + /* { */ + /* FT_Glyph glyphs[MAX_GLYPHS] */ + /* */ + /* */ + /* ... */ + /* */ + /* for ( idx = 0; i < MAX_GLYPHS; i++ ) */ + /* error = FT_Load_Glyph( face, idx, FT_LOAD_DEFAULT ) || */ + /* FT_Get_Glyph ( face->glyph, &glyph[idx] ); */ + /* */ + /* ... */ + /* */ + /* for ( idx = 0; i < MAX_GLYPHS; i++ ) */ + /* { */ + /* FT_Glyph bitmap = glyphs[idx]; */ + /* */ + /* */ + /* ... */ + /* */ + /* // after this call, `bitmap' no longer points into */ + /* // the `glyphs' array (and the old value isn't destroyed) */ + /* FT_Glyph_To_Bitmap( &bitmap, FT_RENDER_MODE_MONO, 0, 0 ); */ + /* */ + /* ... */ + /* */ + /* FT_Done_Glyph( bitmap ); */ + /* } */ + /* */ + /* ... */ + /* */ + /* for ( idx = 0; i < MAX_GLYPHS; i++ ) */ + /* FT_Done_Glyph( glyphs[idx] ); */ + /* } */ + /* */ FT_EXPORT( FT_Error ) FT_Glyph_To_Bitmap( FT_Glyph* the_glyph, FT_Render_Mode render_mode, @@ -576,18 +522,17 @@ FT_BEGIN_HEADER FT_Bool destroy ); - /************************************************************************** - * - * @function: - * FT_Done_Glyph - * - * @description: - * Destroy a given glyph. - * - * @input: - * glyph :: - * A handle to the target glyph object. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Done_Glyph */ + /* */ + /* <Description> */ + /* Destroy a given glyph. */ + /* */ + /* <Input> */ + /* glyph :: A handle to the target glyph object. */ + /* */ FT_EXPORT( void ) FT_Done_Glyph( FT_Glyph glyph ); @@ -596,56 +541,51 @@ FT_BEGIN_HEADER /* other helpful functions */ - /************************************************************************** - * - * @section: - * computations - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* computations */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Matrix_Multiply - * - * @description: - * Perform the matrix operation `b = a*b`. - * - * @input: - * a :: - * A pointer to matrix `a`. - * - * @inout: - * b :: - * A pointer to matrix `b`. - * - * @note: - * The result is undefined if either `a` or `b` is zero. - * - * Since the function uses wrap-around arithmetic, results become - * meaningless if the arguments are very large. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Matrix_Multiply */ + /* */ + /* <Description> */ + /* Perform the matrix operation `b = a*b'. */ + /* */ + /* <Input> */ + /* a :: A pointer to matrix `a'. */ + /* */ + /* <InOut> */ + /* b :: A pointer to matrix `b'. */ + /* */ + /* <Note> */ + /* The result is undefined if either `a' or `b' is zero. */ + /* */ FT_EXPORT( void ) FT_Matrix_Multiply( const FT_Matrix* a, FT_Matrix* b ); - /************************************************************************** - * - * @function: - * FT_Matrix_Invert - * - * @description: - * Invert a 2x2 matrix. Return an error if it can't be inverted. - * - * @inout: - * matrix :: - * A pointer to the target matrix. Remains untouched in case of error. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Matrix_Invert */ + /* */ + /* <Description> */ + /* Invert a 2x2 matrix. Return an error if it can't be inverted. */ + /* */ + /* <InOut> */ + /* matrix :: A pointer to the target matrix. Remains untouched in */ + /* case of error. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Matrix_Invert( FT_Matrix* matrix ); diff --git a/android/x86_64/include/freetype/ftgxval.h b/android/x86_64/include/freetype/ftgxval.h index 8faa8ffc..a58e86a0 100644 --- a/android/x86_64/include/freetype/ftgxval.h +++ b/android/x86_64/include/freetype/ftgxval.h @@ -1,34 +1,34 @@ -/**************************************************************************** - * - * ftgxval.h - * - * FreeType API for validating TrueTypeGX/AAT tables (specification). - * - * Copyright (C) 2004-2019 by - * Masatake YAMATO, Redhat K.K, - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftgxval.h */ +/* */ +/* FreeType API for validating TrueTypeGX/AAT tables (specification). */ +/* */ +/* Copyright 2004-2016 by */ +/* Masatake YAMATO, Redhat K.K, */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ -/**************************************************************************** - * - * gxvalid is derived from both gxlayout module and otvalid module. - * Development of gxlayout is supported by the Information-technology - * Promotion Agency(IPA), Japan. - * - */ +/***************************************************************************/ +/* */ +/* gxvalid is derived from both gxlayout module and otvalid module. */ +/* Development of gxlayout is supported by the Information-technology */ +/* Promotion Agency(IPA), Japan. */ +/* */ +/***************************************************************************/ #ifndef FTGXVAL_H_ #define FTGXVAL_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -41,43 +41,43 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * gx_validation - * - * @title: - * TrueTypeGX/AAT Validation - * - * @abstract: - * An API to validate TrueTypeGX/AAT tables. - * - * @description: - * This section contains the declaration of functions to validate some - * TrueTypeGX tables (feat, mort, morx, bsln, just, kern, opbd, trak, - * prop, lcar). - * - * @order: - * FT_TrueTypeGX_Validate - * FT_TrueTypeGX_Free - * - * FT_ClassicKern_Validate - * FT_ClassicKern_Free - * - * FT_VALIDATE_GX_LENGTH - * FT_VALIDATE_GXXXX - * FT_VALIDATE_CKERNXXX - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* gx_validation */ + /* */ + /* <Title> */ + /* TrueTypeGX/AAT Validation */ + /* */ + /* <Abstract> */ + /* An API to validate TrueTypeGX/AAT tables. */ + /* */ + /* <Description> */ + /* This section contains the declaration of functions to validate */ + /* some TrueTypeGX tables (feat, mort, morx, bsln, just, kern, opbd, */ + /* trak, prop, lcar). */ + /* */ + /* <Order> */ + /* FT_TrueTypeGX_Validate */ + /* FT_TrueTypeGX_Free */ + /* */ + /* FT_ClassicKern_Validate */ + /* FT_ClassicKern_Free */ + /* */ + /* FT_VALIDATE_GX_LENGTH */ + /* FT_VALIDATE_GXXXX */ + /* FT_VALIDATE_CKERNXXX */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * - * Warning: Use `FT_VALIDATE_XXX` to validate a table. - * Following definitions are for gxvalid developers. - * - * - */ + /*************************************************************************/ + /* */ + /* */ + /* Warning: Use FT_VALIDATE_XXX to validate a table. */ + /* Following definitions are for gxvalid developers. */ + /* */ + /* */ + /*************************************************************************/ #define FT_VALIDATE_feat_INDEX 0 #define FT_VALIDATE_mort_INDEX 1 @@ -92,71 +92,71 @@ FT_BEGIN_HEADER #define FT_VALIDATE_GX_LAST_INDEX FT_VALIDATE_lcar_INDEX - /************************************************************************** + /************************************************************************* * * @macro: * FT_VALIDATE_GX_LENGTH * * @description: * The number of tables checked in this module. Use it as a parameter - * for the `table-length` argument of function @FT_TrueTypeGX_Validate. + * for the `table-length' argument of function @FT_TrueTypeGX_Validate. */ -#define FT_VALIDATE_GX_LENGTH ( FT_VALIDATE_GX_LAST_INDEX + 1 ) +#define FT_VALIDATE_GX_LENGTH (FT_VALIDATE_GX_LAST_INDEX + 1) /* */ /* Up to 0x1000 is used by otvalid. Ox2xxx is reserved for feature OT extension. */ -#define FT_VALIDATE_GX_START 0x4000 -#define FT_VALIDATE_GX_BITFIELD( tag ) \ - ( FT_VALIDATE_GX_START << FT_VALIDATE_##tag##_INDEX ) +#define FT_VALIDATE_GX_START 0x4000 +#define FT_VALIDATE_GX_BITFIELD( tag ) \ + ( FT_VALIDATE_GX_START << FT_VALIDATE_##tag##_INDEX ) - /************************************************************************** - * - * @enum: - * FT_VALIDATE_GXXXX - * - * @description: - * A list of bit-field constants used with @FT_TrueTypeGX_Validate to - * indicate which TrueTypeGX/AAT Type tables should be validated. - * - * @values: - * FT_VALIDATE_feat :: - * Validate 'feat' table. - * - * FT_VALIDATE_mort :: - * Validate 'mort' table. - * - * FT_VALIDATE_morx :: - * Validate 'morx' table. - * - * FT_VALIDATE_bsln :: - * Validate 'bsln' table. - * - * FT_VALIDATE_just :: - * Validate 'just' table. - * - * FT_VALIDATE_kern :: - * Validate 'kern' table. - * - * FT_VALIDATE_opbd :: - * Validate 'opbd' table. - * - * FT_VALIDATE_trak :: - * Validate 'trak' table. - * - * FT_VALIDATE_prop :: - * Validate 'prop' table. - * - * FT_VALIDATE_lcar :: - * Validate 'lcar' table. - * - * FT_VALIDATE_GX :: - * Validate all TrueTypeGX tables (feat, mort, morx, bsln, just, kern, - * opbd, trak, prop and lcar). - * - */ + /********************************************************************** + * + * @enum: + * FT_VALIDATE_GXXXX + * + * @description: + * A list of bit-field constants used with @FT_TrueTypeGX_Validate to + * indicate which TrueTypeGX/AAT Type tables should be validated. + * + * @values: + * FT_VALIDATE_feat :: + * Validate `feat' table. + * + * FT_VALIDATE_mort :: + * Validate `mort' table. + * + * FT_VALIDATE_morx :: + * Validate `morx' table. + * + * FT_VALIDATE_bsln :: + * Validate `bsln' table. + * + * FT_VALIDATE_just :: + * Validate `just' table. + * + * FT_VALIDATE_kern :: + * Validate `kern' table. + * + * FT_VALIDATE_opbd :: + * Validate `opbd' table. + * + * FT_VALIDATE_trak :: + * Validate `trak' table. + * + * FT_VALIDATE_prop :: + * Validate `prop' table. + * + * FT_VALIDATE_lcar :: + * Validate `lcar' table. + * + * FT_VALIDATE_GX :: + * Validate all TrueTypeGX tables (feat, mort, morx, bsln, just, kern, + * opbd, trak, prop and lcar). + * + */ #define FT_VALIDATE_feat FT_VALIDATE_GX_BITFIELD( feat ) #define FT_VALIDATE_mort FT_VALIDATE_GX_BITFIELD( mort ) @@ -181,47 +181,47 @@ FT_BEGIN_HEADER FT_VALIDATE_lcar ) - /************************************************************************** - * - * @function: - * FT_TrueTypeGX_Validate - * - * @description: - * Validate various TrueTypeGX tables to assure that all offsets and - * indices are valid. The idea is that a higher-level library that - * actually does the text layout can access those tables without error - * checking (which can be quite time consuming). - * - * @input: - * face :: - * A handle to the input face. - * - * validation_flags :: - * A bit field that specifies the tables to be validated. See - * @FT_VALIDATE_GXXXX for possible values. - * - * table_length :: - * The size of the `tables` array. Normally, @FT_VALIDATE_GX_LENGTH - * should be passed. - * - * @output: - * tables :: - * The array where all validated sfnt tables are stored. The array - * itself must be allocated by a client. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function only works with TrueTypeGX fonts, returning an error - * otherwise. - * - * After use, the application should deallocate the buffers pointed to by - * each `tables` element, by calling @FT_TrueTypeGX_Free. A `NULL` value - * indicates that the table either doesn't exist in the font, the - * application hasn't asked for validation, or the validator doesn't have - * the ability to validate the sfnt table. - */ + /********************************************************************** + * + * @function: + * FT_TrueTypeGX_Validate + * + * @description: + * Validate various TrueTypeGX tables to assure that all offsets and + * indices are valid. The idea is that a higher-level library that + * actually does the text layout can access those tables without + * error checking (which can be quite time consuming). + * + * @input: + * face :: + * A handle to the input face. + * + * validation_flags :: + * A bit field that specifies the tables to be validated. See + * @FT_VALIDATE_GXXXX for possible values. + * + * table_length :: + * The size of the `tables' array. Normally, @FT_VALIDATE_GX_LENGTH + * should be passed. + * + * @output: + * tables :: + * The array where all validated sfnt tables are stored. + * The array itself must be allocated by a client. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * This function only works with TrueTypeGX fonts, returning an error + * otherwise. + * + * After use, the application should deallocate the buffers pointed to by + * each `tables' element, by calling @FT_TrueTypeGX_Free. A NULL value + * indicates that the table either doesn't exist in the font, the + * application hasn't asked for validation, or the validator doesn't have + * the ability to validate the sfnt table. + */ FT_EXPORT( FT_Error ) FT_TrueTypeGX_Validate( FT_Face face, FT_UInt validation_flags, @@ -229,117 +229,119 @@ FT_BEGIN_HEADER FT_UInt table_length ); - /************************************************************************** - * - * @function: - * FT_TrueTypeGX_Free - * - * @description: - * Free the buffer allocated by TrueTypeGX validator. - * - * @input: - * face :: - * A handle to the input face. - * - * table :: - * The pointer to the buffer allocated by @FT_TrueTypeGX_Validate. - * - * @note: - * This function must be used to free the buffer allocated by - * @FT_TrueTypeGX_Validate only. - */ + /********************************************************************** + * + * @function: + * FT_TrueTypeGX_Free + * + * @description: + * Free the buffer allocated by TrueTypeGX validator. + * + * @input: + * face :: + * A handle to the input face. + * + * table :: + * The pointer to the buffer allocated by + * @FT_TrueTypeGX_Validate. + * + * @note: + * This function must be used to free the buffer allocated by + * @FT_TrueTypeGX_Validate only. + */ FT_EXPORT( void ) FT_TrueTypeGX_Free( FT_Face face, FT_Bytes table ); - /************************************************************************** - * - * @enum: - * FT_VALIDATE_CKERNXXX - * - * @description: - * A list of bit-field constants used with @FT_ClassicKern_Validate to - * indicate the classic kern dialect or dialects. If the selected type - * doesn't fit, @FT_ClassicKern_Validate regards the table as invalid. - * - * @values: - * FT_VALIDATE_MS :: - * Handle the 'kern' table as a classic Microsoft kern table. - * - * FT_VALIDATE_APPLE :: - * Handle the 'kern' table as a classic Apple kern table. - * - * FT_VALIDATE_CKERN :: - * Handle the 'kern' as either classic Apple or Microsoft kern table. - */ + /********************************************************************** + * + * @enum: + * FT_VALIDATE_CKERNXXX + * + * @description: + * A list of bit-field constants used with @FT_ClassicKern_Validate + * to indicate the classic kern dialect or dialects. If the selected + * type doesn't fit, @FT_ClassicKern_Validate regards the table as + * invalid. + * + * @values: + * FT_VALIDATE_MS :: + * Handle the `kern' table as a classic Microsoft kern table. + * + * FT_VALIDATE_APPLE :: + * Handle the `kern' table as a classic Apple kern table. + * + * FT_VALIDATE_CKERN :: + * Handle the `kern' as either classic Apple or Microsoft kern table. + */ #define FT_VALIDATE_MS ( FT_VALIDATE_GX_START << 0 ) #define FT_VALIDATE_APPLE ( FT_VALIDATE_GX_START << 1 ) #define FT_VALIDATE_CKERN ( FT_VALIDATE_MS | FT_VALIDATE_APPLE ) - /************************************************************************** - * - * @function: - * FT_ClassicKern_Validate - * - * @description: - * Validate classic (16-bit format) kern table to assure that the - * offsets and indices are valid. The idea is that a higher-level - * library that actually does the text layout can access those tables - * without error checking (which can be quite time consuming). - * - * The 'kern' table validator in @FT_TrueTypeGX_Validate deals with both - * the new 32-bit format and the classic 16-bit format, while - * FT_ClassicKern_Validate only supports the classic 16-bit format. - * - * @input: - * face :: - * A handle to the input face. - * - * validation_flags :: - * A bit field that specifies the dialect to be validated. See - * @FT_VALIDATE_CKERNXXX for possible values. - * - * @output: - * ckern_table :: - * A pointer to the kern table. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * After use, the application should deallocate the buffers pointed to by - * `ckern_table`, by calling @FT_ClassicKern_Free. A `NULL` value - * indicates that the table doesn't exist in the font. - */ + /********************************************************************** + * + * @function: + * FT_ClassicKern_Validate + * + * @description: + * Validate classic (16-bit format) kern table to assure that the offsets + * and indices are valid. The idea is that a higher-level library that + * actually does the text layout can access those tables without error + * checking (which can be quite time consuming). + * + * The `kern' table validator in @FT_TrueTypeGX_Validate deals with both + * the new 32-bit format and the classic 16-bit format, while + * FT_ClassicKern_Validate only supports the classic 16-bit format. + * + * @input: + * face :: + * A handle to the input face. + * + * validation_flags :: + * A bit field that specifies the dialect to be validated. See + * @FT_VALIDATE_CKERNXXX for possible values. + * + * @output: + * ckern_table :: + * A pointer to the kern table. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * After use, the application should deallocate the buffers pointed to by + * `ckern_table', by calling @FT_ClassicKern_Free. A NULL value + * indicates that the table doesn't exist in the font. + */ FT_EXPORT( FT_Error ) FT_ClassicKern_Validate( FT_Face face, FT_UInt validation_flags, FT_Bytes *ckern_table ); - /************************************************************************** - * - * @function: - * FT_ClassicKern_Free - * - * @description: - * Free the buffer allocated by classic Kern validator. - * - * @input: - * face :: - * A handle to the input face. - * - * table :: - * The pointer to the buffer that is allocated by - * @FT_ClassicKern_Validate. - * - * @note: - * This function must be used to free the buffer allocated by - * @FT_ClassicKern_Validate only. - */ + /********************************************************************** + * + * @function: + * FT_ClassicKern_Free + * + * @description: + * Free the buffer allocated by classic Kern validator. + * + * @input: + * face :: + * A handle to the input face. + * + * table :: + * The pointer to the buffer that is allocated by + * @FT_ClassicKern_Validate. + * + * @note: + * This function must be used to free the buffer allocated by + * @FT_ClassicKern_Validate only. + */ FT_EXPORT( void ) FT_ClassicKern_Free( FT_Face face, FT_Bytes table ); diff --git a/android/x86_64/include/freetype/ftgzip.h b/android/x86_64/include/freetype/ftgzip.h index 0899940d..9e658b0d 100644 --- a/android/x86_64/include/freetype/ftgzip.h +++ b/android/x86_64/include/freetype/ftgzip.h @@ -1,25 +1,25 @@ -/**************************************************************************** - * - * ftgzip.h - * - * Gzip-compressed stream support. - * - * Copyright (C) 2002-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftgzip.h */ +/* */ +/* Gzip-compressed stream support. */ +/* */ +/* Copyright 2002-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTGZIP_H_ #define FTGZIP_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -31,108 +31,105 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * gzip - * - * @title: - * GZIP Streams - * - * @abstract: - * Using gzip-compressed font files. - * - * @description: - * This section contains the declaration of Gzip-specific functions. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* gzip */ + /* */ + /* <Title> */ + /* GZIP Streams */ + /* */ + /* <Abstract> */ + /* Using gzip-compressed font files. */ + /* */ + /* <Description> */ + /* This section contains the declaration of Gzip-specific functions. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Stream_OpenGzip - * - * @description: - * Open a new stream to parse gzip-compressed font files. This is mainly - * used to support the compressed `*.pcf.gz` fonts that come with - * XFree86. - * - * @input: - * stream :: - * The target embedding stream. - * - * source :: - * The source stream. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The source stream must be opened _before_ calling this function. - * - * Calling the internal function `FT_Stream_Close` on the new stream will - * **not** call `FT_Stream_Close` on the source stream. None of the - * stream objects will be released to the heap. - * - * The stream implementation is very basic and resets the decompression - * process each time seeking backwards is needed within the stream. - * - * In certain builds of the library, gzip compression recognition is - * automatically handled when calling @FT_New_Face or @FT_Open_Face. - * This means that if no font driver is capable of handling the raw - * compressed file, the library will try to open a gzipped stream from it - * and re-open the face with it. - * - * This function may return `FT_Err_Unimplemented_Feature` if your build - * of FreeType was not compiled with zlib support. - */ + /************************************************************************ + * + * @function: + * FT_Stream_OpenGzip + * + * @description: + * Open a new stream to parse gzip-compressed font files. This is + * mainly used to support the compressed `*.pcf.gz' fonts that come + * with XFree86. + * + * @input: + * stream :: + * The target embedding stream. + * + * source :: + * The source stream. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * The source stream must be opened _before_ calling this function. + * + * Calling the internal function `FT_Stream_Close' on the new stream will + * *not* call `FT_Stream_Close' on the source stream. None of the stream + * objects will be released to the heap. + * + * The stream implementation is very basic and resets the decompression + * process each time seeking backwards is needed within the stream. + * + * In certain builds of the library, gzip compression recognition is + * automatically handled when calling @FT_New_Face or @FT_Open_Face. + * This means that if no font driver is capable of handling the raw + * compressed file, the library will try to open a gzipped stream from + * it and re-open the face with it. + * + * This function may return `FT_Err_Unimplemented_Feature' if your build + * of FreeType was not compiled with zlib support. + */ FT_EXPORT( FT_Error ) FT_Stream_OpenGzip( FT_Stream stream, FT_Stream source ); - /************************************************************************** - * - * @function: - * FT_Gzip_Uncompress - * - * @description: - * Decompress a zipped input buffer into an output buffer. This function - * is modeled after zlib's `uncompress` function. - * - * @input: - * memory :: - * A FreeType memory handle. - * - * input :: - * The input buffer. - * - * input_len :: - * The length of the input buffer. - * - * @output: - * output :: - * The output buffer. - * - * @inout: - * output_len :: - * Before calling the function, this is the total size of the output - * buffer, which must be large enough to hold the entire uncompressed - * data (so the size of the uncompressed data must be known in - * advance). After calling the function, `output_len` is the size of - * the used data in `output`. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function may return `FT_Err_Unimplemented_Feature` if your build - * of FreeType was not compiled with zlib support. - * - * @since: - * 2.5.1 - */ + /************************************************************************ + * + * @function: + * FT_Gzip_Uncompress + * + * @description: + * Decompress a zipped input buffer into an output buffer. This function + * is modeled after zlib's `uncompress' function. + * + * @input: + * memory :: + * A FreeType memory handle. + * + * input :: + * The input buffer. + * + * input_len :: + * The length of the input buffer. + * + * @output: + * output:: + * The output buffer. + * + * @inout: + * output_len :: + * Before calling the function, this is the the total size of the + * output buffer, which must be large enough to hold the entire + * uncompressed data (so the size of the uncompressed data must be + * known in advance). After calling the function, `output_len' is the + * size of the used data in `output'. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * This function may return `FT_Err_Unimplemented_Feature' if your build + * of FreeType was not compiled with zlib support. + */ FT_EXPORT( FT_Error ) FT_Gzip_Uncompress( FT_Memory memory, FT_Byte* output, diff --git a/android/x86_64/include/freetype/ftimage.h b/android/x86_64/include/freetype/ftimage.h index b9e23028..1d557c93 100644 --- a/android/x86_64/include/freetype/ftimage.h +++ b/android/x86_64/include/freetype/ftimage.h @@ -1,27 +1,27 @@ -/**************************************************************************** - * - * ftimage.h - * - * FreeType glyph image formats and default raster interface - * (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftimage.h */ +/* */ +/* FreeType glyph image formats and default raster interface */ +/* (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * Note: A 'raster' is simply a scan-line converter, used to render - * FT_Outlines into FT_Bitmaps. - * - */ + /*************************************************************************/ + /* */ + /* Note: A `raster' is simply a scan-line converter, used to render */ + /* FT_Outlines into FT_Bitmaps. */ + /* */ + /*************************************************************************/ #ifndef FTIMAGE_H_ @@ -30,49 +30,47 @@ /* STANDALONE_ is from ftgrays.c */ #ifndef STANDALONE_ -#include "ft2build.h" +#include <ft2build.h> #endif FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * basic_types - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* basic_types */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @type: - * FT_Pos - * - * @description: - * 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. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Pos */ + /* */ + /* <Description> */ + /* 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. */ + /* */ typedef signed long FT_Pos; - /************************************************************************** - * - * @struct: - * FT_Vector - * - * @description: - * A simple structure used to store a 2D vector; coordinates are of the - * FT_Pos type. - * - * @fields: - * x :: - * The horizontal coordinate. - * y :: - * The vertical coordinate. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Vector */ + /* */ + /* <Description> */ + /* A simple structure used to store a 2D vector; coordinates are of */ + /* the FT_Pos type. */ + /* */ + /* <Fields> */ + /* x :: The horizontal coordinate. */ + /* y :: The vertical coordinate. */ + /* */ typedef struct FT_Vector_ { FT_Pos x; @@ -81,41 +79,39 @@ FT_BEGIN_HEADER } FT_Vector; - /************************************************************************** - * - * @struct: - * FT_BBox - * - * @description: - * A structure used to hold an outline's bounding box, i.e., the - * coordinates of its extrema in the horizontal and vertical directions. - * - * @fields: - * xMin :: - * The horizontal minimum (left-most). - * - * yMin :: - * The vertical minimum (bottom-most). - * - * xMax :: - * The horizontal maximum (right-most). - * - * yMax :: - * The vertical maximum (top-most). - * - * @note: - * 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. - * - * If `yMin` is negative, this value gives the glyph's descender. - * Otherwise, the glyph doesn't descend below the baseline. Similarly, - * if `ymax` is positive, this value gives the glyph's ascender. - * - * `xMin` gives the horizontal distance from the glyph's origin to the - * left edge of the glyph's bounding box. If `xMin` is negative, the - * glyph extends to the left of the origin. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_BBox */ + /* */ + /* <Description> */ + /* A structure used to hold an outline's bounding box, i.e., the */ + /* coordinates of its extrema in the horizontal and vertical */ + /* directions. */ + /* */ + /* <Fields> */ + /* xMin :: The horizontal minimum (left-most). */ + /* */ + /* yMin :: The vertical minimum (bottom-most). */ + /* */ + /* xMax :: The horizontal maximum (right-most). */ + /* */ + /* yMax :: The vertical maximum (top-most). */ + /* */ + /* <Note> */ + /* 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. */ + /* */ + /* If `yMin' is negative, this value gives the glyph's descender. */ + /* Otherwise, the glyph doesn't descend below the baseline. */ + /* Similarly, if `ymax' is positive, this value gives the glyph's */ + /* ascender. */ + /* */ + /* `xMin' gives the horizontal distance from the glyph's origin to */ + /* the left edge of the glyph's bounding box. If `xMin' is negative, */ + /* the glyph extends to the left of the origin. */ + /* */ typedef struct FT_BBox_ { FT_Pos xMin, yMin; @@ -124,60 +120,63 @@ FT_BEGIN_HEADER } FT_BBox; - /************************************************************************** - * - * @enum: - * FT_Pixel_Mode - * - * @description: - * An enumeration type used to describe the format of pixels in a given - * bitmap. Note that additional formats may be added in the future. - * - * @values: - * FT_PIXEL_MODE_NONE :: - * Value~0 is reserved. - * - * FT_PIXEL_MODE_MONO :: - * 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. - * - * FT_PIXEL_MODE_GRAY :: - * 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 `num_grays` field of the @FT_Bitmap - * structure (it generally is 256). - * - * FT_PIXEL_MODE_GRAY2 :: - * 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. - * - * FT_PIXEL_MODE_GRAY4 :: - * 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. - * - * FT_PIXEL_MODE_LCD :: - * 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 @FT_RENDER_MODE_LCD. - * - * FT_PIXEL_MODE_LCD_V :: - * 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 - * @FT_RENDER_MODE_LCD_V. - * - * FT_PIXEL_MODE_BGRA :: - * [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 @FT_LOAD_COLOR. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_Pixel_Mode */ + /* */ + /* <Description> */ + /* An enumeration type used to describe the format of pixels in a */ + /* given bitmap. Note that additional formats may be added in the */ + /* future. */ + /* */ + /* <Values> */ + /* FT_PIXEL_MODE_NONE :: */ + /* Value~0 is reserved. */ + /* */ + /* FT_PIXEL_MODE_MONO :: */ + /* 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. */ + /* */ + /* FT_PIXEL_MODE_GRAY :: */ + /* 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 `num_grays' field of the */ + /* @FT_Bitmap structure (it generally is 256). */ + /* */ + /* FT_PIXEL_MODE_GRAY2 :: */ + /* 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. */ + /* */ + /* FT_PIXEL_MODE_GRAY4 :: */ + /* 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. */ + /* */ + /* FT_PIXEL_MODE_LCD :: */ + /* 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 */ + /* @FT_RENDER_MODE_LCD. */ + /* */ + /* FT_PIXEL_MODE_LCD_V :: */ + /* 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 */ + /* @FT_RENDER_MODE_LCD_V. */ + /* */ + /* FT_PIXEL_MODE_BGRA :: */ + /* 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 @FT_LOAD_COLOR. */ + /* */ typedef enum FT_Pixel_Mode_ { FT_PIXEL_MODE_NONE = 0, @@ -194,7 +193,7 @@ FT_BEGIN_HEADER } FT_Pixel_Mode; - /* these constants are deprecated; use the corresponding `FT_Pixel_Mode` */ + /* these constants are deprecated; use the corresponding `FT_Pixel_Mode' */ /* values instead. */ #define ft_pixel_mode_none FT_PIXEL_MODE_NONE #define ft_pixel_mode_mono FT_PIXEL_MODE_MONO @@ -203,61 +202,62 @@ FT_BEGIN_HEADER #define ft_pixel_mode_pal4 FT_PIXEL_MODE_GRAY4 - /************************************************************************** - * - * @struct: - * FT_Bitmap - * - * @description: - * A structure used to describe a bitmap or pixmap to the raster. Note - * that we now manage pixmaps of various depths through the `pixel_mode` - * field. - * - * @fields: - * rows :: - * The number of bitmap rows. - * - * width :: - * The number of pixels in bitmap row. - * - * pitch :: - * 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. - * - * Note that 'padding' means the alignment of a bitmap to a byte - * border, and FreeType functions normally align to the smallest - * possible integer value. - * - * For the B/W rasterizer, `pitch` is always an even number. - * - * To change the pitch of a bitmap (say, to make it a multiple of 4), - * use @FT_Bitmap_Convert. Alternatively, you might use callback - * functions to directly render to the application's surface; see the - * file `example2.cpp` in the tutorial for a demonstration. - * - * buffer :: - * A typeless pointer to the bitmap buffer. This value should be - * aligned on 32-bit boundaries in most cases. - * - * num_grays :: - * This field is only used with @FT_PIXEL_MODE_GRAY; it gives the - * number of gray levels used in the bitmap. - * - * pixel_mode :: - * The pixel mode, i.e., how pixel bits are stored. See @FT_Pixel_Mode - * for possible values. - * - * palette_mode :: - * This field is intended for paletted pixel modes; it indicates how - * the palette is stored. Not used currently. - * - * palette :: - * A typeless pointer to the bitmap palette; this field is intended for - * paletted pixel modes. Not used currently. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Bitmap */ + /* */ + /* <Description> */ + /* A structure used to describe a bitmap or pixmap to the raster. */ + /* Note that we now manage pixmaps of various depths through the */ + /* `pixel_mode' field. */ + /* */ + /* <Fields> */ + /* rows :: The number of bitmap rows. */ + /* */ + /* width :: The number of pixels in bitmap row. */ + /* */ + /* pitch :: 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. */ + /* */ + /* Note that `padding' means the alignment of a */ + /* bitmap to a byte border, and FreeType functions */ + /* normally align to the smallest possible integer */ + /* value. */ + /* */ + /* For the B/W rasterizer, `pitch' is always an even */ + /* number. */ + /* */ + /* To change the pitch of a bitmap (say, to make it a */ + /* multiple of 4), use @FT_Bitmap_Convert. */ + /* Alternatively, you might use callback functions to */ + /* directly render to the application's surface; see */ + /* the file `example2.cpp' in the tutorial for a */ + /* demonstration. */ + /* */ + /* buffer :: A typeless pointer to the bitmap buffer. This */ + /* value should be aligned on 32-bit boundaries in */ + /* most cases. */ + /* */ + /* num_grays :: This field is only used with */ + /* @FT_PIXEL_MODE_GRAY; it gives the number of gray */ + /* levels used in the bitmap. */ + /* */ + /* pixel_mode :: The pixel mode, i.e., how pixel bits are stored. */ + /* See @FT_Pixel_Mode for possible values. */ + /* */ + /* palette_mode :: This field is intended for paletted pixel modes; */ + /* it indicates how the palette is stored. Not */ + /* used currently. */ + /* */ + /* palette :: A typeless pointer to the bitmap palette; this */ + /* field is intended for paletted pixel modes. Not */ + /* used currently. */ + /* */ typedef struct FT_Bitmap_ { unsigned int rows; @@ -272,68 +272,65 @@ FT_BEGIN_HEADER } FT_Bitmap; - /************************************************************************** - * - * @section: - * outline_processing - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* outline_processing */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @struct: - * FT_Outline - * - * @description: - * This structure is used to describe an outline to the scan-line - * converter. - * - * @fields: - * n_contours :: - * The number of contours in the outline. - * - * n_points :: - * The number of points in the outline. - * - * points :: - * A pointer to an array of `n_points` @FT_Vector elements, giving the - * outline's point coordinates. - * - * tags :: - * A pointer to an array of `n_points` chars, giving each outline - * point's type. - * - * If bit~0 is unset, the point is 'off' the curve, i.e., a Bezier - * control point, while it is 'on' if set. - * - * Bit~1 is meaningful for 'off' points only. If set, it indicates a - * third-order Bezier arc control point; and a second-order control - * point if unset. - * - * If bit~2 is set, bits 5-7 contain the drop-out mode (as defined in - * the OpenType specification; the value is the same as the argument to - * the 'SCANMODE' instruction). - * - * Bits 3 and~4 are reserved for internal purposes. - * - * contours :: - * An array of `n_contours` shorts, giving the end point of each - * contour within the outline. For example, the first contour is - * defined by the points '0' to `contours[0]`, the second one is - * defined by the points `contours[0]+1` to `contours[1]`, etc. - * - * flags :: - * A set of bit flags used to characterize the outline and give hints - * to the scan-converter and hinter on how to convert/grid-fit it. See - * @FT_OUTLINE_XXX. - * - * @note: - * The B/W rasterizer only checks bit~2 in the `tags` array for the first - * point of each contour. The drop-out mode as given with - * @FT_OUTLINE_IGNORE_DROPOUTS, @FT_OUTLINE_SMART_DROPOUTS, and - * @FT_OUTLINE_INCLUDE_STUBS in `flags` is then overridden. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Outline */ + /* */ + /* <Description> */ + /* This structure is used to describe an outline to the scan-line */ + /* converter. */ + /* */ + /* <Fields> */ + /* n_contours :: The number of contours in the outline. */ + /* */ + /* n_points :: The number of points in the outline. */ + /* */ + /* points :: A pointer to an array of `n_points' @FT_Vector */ + /* elements, giving the outline's point coordinates. */ + /* */ + /* tags :: A pointer to an array of `n_points' chars, giving */ + /* each outline point's type. */ + /* */ + /* If bit~0 is unset, the point is `off' the curve, */ + /* i.e., a Bézier control point, while it is `on' if */ + /* set. */ + /* */ + /* Bit~1 is meaningful for `off' points only. If set, */ + /* it indicates a third-order Bézier arc control point; */ + /* and a second-order control point if unset. */ + /* */ + /* If bit~2 is set, bits 5-7 contain the drop-out mode */ + /* (as defined in the OpenType specification; the value */ + /* is the same as the argument to the SCANMODE */ + /* instruction). */ + /* */ + /* Bits 3 and~4 are reserved for internal purposes. */ + /* */ + /* contours :: An array of `n_contours' shorts, giving the end */ + /* point of each contour within the outline. For */ + /* example, the first contour is defined by the points */ + /* `0' to `contours[0]', the second one is defined by */ + /* the points `contours[0]+1' to `contours[1]', etc. */ + /* */ + /* flags :: A set of bit flags used to characterize the outline */ + /* and give hints to the scan-converter and hinter on */ + /* how to convert/grid-fit it. See @FT_OUTLINE_XXX. */ + /* */ + /* <Note> */ + /* The B/W rasterizer only checks bit~2 in the `tags' array for the */ + /* first point of each contour. The drop-out mode as given with */ + /* @FT_OUTLINE_IGNORE_DROPOUTS, @FT_OUTLINE_SMART_DROPOUTS, and */ + /* @FT_OUTLINE_INCLUDE_STUBS in `flags' is then overridden. */ + /* */ typedef struct FT_Outline_ { short n_contours; /* number of contours in glyph */ @@ -355,76 +352,78 @@ FT_BEGIN_HEADER #define FT_OUTLINE_POINTS_MAX SHRT_MAX - /************************************************************************** - * - * @enum: - * FT_OUTLINE_XXX - * - * @description: - * A list of bit-field constants used for the flags in an outline's - * `flags` field. - * - * @values: - * FT_OUTLINE_NONE :: - * Value~0 is reserved. - * - * FT_OUTLINE_OWNER :: - * If set, this flag indicates that the outline's field arrays (i.e., - * `points`, `flags`, and `contours`) are 'owned' by the outline - * object, and should thus be freed when it is destroyed. - * - * FT_OUTLINE_EVEN_ODD_FILL :: - * By default, outlines are filled using the non-zero winding rule. If - * set to 1, the outline will be filled using the even-odd fill rule - * (only works with the smooth rasterizer). - * - * FT_OUTLINE_REVERSE_FILL :: - * By default, outside contours of an outline are oriented in - * clock-wise direction, as defined in the TrueType specification. - * This flag is set if the outline uses the opposite direction - * (typically for Type~1 fonts). This flag is ignored by the scan - * converter. - * - * FT_OUTLINE_IGNORE_DROPOUTS :: - * By default, the scan converter will try to detect drop-outs in an - * outline and correct the glyph bitmap to ensure consistent shape - * continuity. If set, this flag hints the scan-line converter to - * ignore such cases. See below for more information. - * - * FT_OUTLINE_SMART_DROPOUTS :: - * Select smart dropout control. If unset, use simple dropout control. - * Ignored if @FT_OUTLINE_IGNORE_DROPOUTS is set. See below for more - * information. - * - * FT_OUTLINE_INCLUDE_STUBS :: - * If set, turn pixels on for 'stubs', otherwise exclude them. Ignored - * if @FT_OUTLINE_IGNORE_DROPOUTS is set. See below for more - * information. - * - * FT_OUTLINE_HIGH_PRECISION :: - * This flag indicates that the scan-line converter should try to - * convert this outline to bitmaps with the highest possible quality. - * It is typically set for small character sizes. Note that this is - * only a hint that might be completely ignored by a given - * scan-converter. - * - * FT_OUTLINE_SINGLE_PASS :: - * This flag is set to force a given scan-converter to only use a - * single pass over the outline to render a bitmap glyph image. - * Normally, it is set for very large character sizes. It is only a - * hint that might be completely ignored by a given scan-converter. - * - * @note: - * The flags @FT_OUTLINE_IGNORE_DROPOUTS, @FT_OUTLINE_SMART_DROPOUTS, and - * @FT_OUTLINE_INCLUDE_STUBS are ignored by the smooth rasterizer. - * - * There exists a second mechanism to pass the drop-out mode to the B/W - * rasterizer; see the `tags` field in @FT_Outline. - * - * Please refer to the description of the 'SCANTYPE' instruction in the - * OpenType specification (in file `ttinst1.doc`) how simple drop-outs, - * smart drop-outs, and stubs are defined. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_OUTLINE_XXX */ + /* */ + /* <Description> */ + /* A list of bit-field constants use for the flags in an outline's */ + /* `flags' field. */ + /* */ + /* <Values> */ + /* FT_OUTLINE_NONE :: */ + /* Value~0 is reserved. */ + /* */ + /* FT_OUTLINE_OWNER :: */ + /* If set, this flag indicates that the outline's field arrays */ + /* (i.e., `points', `flags', and `contours') are `owned' by the */ + /* outline object, and should thus be freed when it is destroyed. */ + /* */ + /* FT_OUTLINE_EVEN_ODD_FILL :: */ + /* By default, outlines are filled using the non-zero winding rule. */ + /* If set to 1, the outline will be filled using the even-odd fill */ + /* rule (only works with the smooth rasterizer). */ + /* */ + /* FT_OUTLINE_REVERSE_FILL :: */ + /* By default, outside contours of an outline are oriented in */ + /* clock-wise direction, as defined in the TrueType specification. */ + /* This flag is set if the outline uses the opposite direction */ + /* (typically for Type~1 fonts). This flag is ignored by the scan */ + /* converter. */ + /* */ + /* FT_OUTLINE_IGNORE_DROPOUTS :: */ + /* By default, the scan converter will try to detect drop-outs in */ + /* an outline and correct the glyph bitmap to ensure consistent */ + /* shape continuity. If set, this flag hints the scan-line */ + /* converter to ignore such cases. See below for more information. */ + /* */ + /* FT_OUTLINE_SMART_DROPOUTS :: */ + /* Select smart dropout control. If unset, use simple dropout */ + /* control. Ignored if @FT_OUTLINE_IGNORE_DROPOUTS is set. See */ + /* below for more information. */ + /* */ + /* FT_OUTLINE_INCLUDE_STUBS :: */ + /* If set, turn pixels on for `stubs', otherwise exclude them. */ + /* Ignored if @FT_OUTLINE_IGNORE_DROPOUTS is set. See below for */ + /* more information. */ + /* */ + /* FT_OUTLINE_HIGH_PRECISION :: */ + /* This flag indicates that the scan-line converter should try to */ + /* convert this outline to bitmaps with the highest possible */ + /* quality. It is typically set for small character sizes. Note */ + /* that this is only a hint that might be completely ignored by a */ + /* given scan-converter. */ + /* */ + /* FT_OUTLINE_SINGLE_PASS :: */ + /* This flag is set to force a given scan-converter to only use a */ + /* single pass over the outline to render a bitmap glyph image. */ + /* Normally, it is set for very large character sizes. It is only */ + /* a hint that might be completely ignored by a given */ + /* scan-converter. */ + /* */ + /* <Note> */ + /* The flags @FT_OUTLINE_IGNORE_DROPOUTS, @FT_OUTLINE_SMART_DROPOUTS, */ + /* and @FT_OUTLINE_INCLUDE_STUBS are ignored by the smooth */ + /* rasterizer. */ + /* */ + /* There exists a second mechanism to pass the drop-out mode to the */ + /* B/W rasterizer; see the `tags' field in @FT_Outline. */ + /* */ + /* Please refer to the description of the `SCANTYPE' instruction in */ + /* the OpenType specification (in file `ttinst1.doc') how simple */ + /* drop-outs, smart drop-outs, and stubs are defined. */ + /* */ #define FT_OUTLINE_NONE 0x0 #define FT_OUTLINE_OWNER 0x1 #define FT_OUTLINE_EVEN_ODD_FILL 0x2 @@ -438,7 +437,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_OUTLINE_XXX` values instead */ + /* `FT_OUTLINE_XXX' values instead */ #define ft_outline_none FT_OUTLINE_NONE #define ft_outline_owner FT_OUTLINE_OWNER #define ft_outline_even_odd_fill FT_OUTLINE_EVEN_ODD_FILL @@ -449,25 +448,20 @@ FT_BEGIN_HEADER /* */ -#define FT_CURVE_TAG( flag ) ( flag & 0x03 ) +#define FT_CURVE_TAG( flag ) ( flag & 3 ) - /* see the `tags` field in `FT_Outline` for a description of the values */ -#define FT_CURVE_TAG_ON 0x01 -#define FT_CURVE_TAG_CONIC 0x00 -#define FT_CURVE_TAG_CUBIC 0x02 +#define FT_CURVE_TAG_ON 1 +#define FT_CURVE_TAG_CONIC 0 +#define FT_CURVE_TAG_CUBIC 2 -#define FT_CURVE_TAG_HAS_SCANMODE 0x04 +#define FT_CURVE_TAG_HAS_SCANMODE 4 -#define FT_CURVE_TAG_TOUCH_X 0x08 /* reserved for TrueType hinter */ -#define FT_CURVE_TAG_TOUCH_Y 0x10 /* reserved for TrueType hinter */ +#define FT_CURVE_TAG_TOUCH_X 8 /* reserved for the TrueType hinter */ +#define FT_CURVE_TAG_TOUCH_Y 16 /* reserved for the TrueType hinter */ #define FT_CURVE_TAG_TOUCH_BOTH ( FT_CURVE_TAG_TOUCH_X | \ FT_CURVE_TAG_TOUCH_Y ) - /* values 0x20, 0x40, and 0x80 are reserved */ - - /* these constants are deprecated; use the corresponding */ - /* `FT_CURVE_TAG_XXX` values instead */ #define FT_Curve_Tag_On FT_CURVE_TAG_ON #define FT_Curve_Tag_Conic FT_CURVE_TAG_CONIC #define FT_Curve_Tag_Cubic FT_CURVE_TAG_CUBIC @@ -475,28 +469,26 @@ FT_BEGIN_HEADER #define FT_Curve_Tag_Touch_Y FT_CURVE_TAG_TOUCH_Y - /************************************************************************** - * - * @functype: - * FT_Outline_MoveToFunc - * - * @description: - * A function pointer type used to describe the signature of a 'move to' - * function during outline walking/decomposition. - * - * A 'move to' is emitted to start a new contour in an outline. - * - * @input: - * to :: - * A pointer to the target point of the 'move to'. - * - * user :: - * A typeless pointer, which is passed from the caller of the - * decomposition function. - * - * @return: - * Error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Outline_MoveToFunc */ + /* */ + /* <Description> */ + /* A function pointer type used to describe the signature of a `move */ + /* to' function during outline walking/decomposition. */ + /* */ + /* A `move to' is emitted to start a new contour in an outline. */ + /* */ + /* <Input> */ + /* to :: A pointer to the target point of the `move to'. */ + /* */ + /* user :: A typeless pointer, which is passed from the caller of the */ + /* decomposition function. */ + /* */ + /* <Return> */ + /* Error code. 0~means success. */ + /* */ typedef int (*FT_Outline_MoveToFunc)( const FT_Vector* to, void* user ); @@ -504,28 +496,26 @@ FT_BEGIN_HEADER #define FT_Outline_MoveTo_Func FT_Outline_MoveToFunc - /************************************************************************** - * - * @functype: - * FT_Outline_LineToFunc - * - * @description: - * A function pointer type used to describe the signature of a 'line to' - * function during outline walking/decomposition. - * - * A 'line to' is emitted to indicate a segment in the outline. - * - * @input: - * to :: - * A pointer to the target point of the 'line to'. - * - * user :: - * A typeless pointer, which is passed from the caller of the - * decomposition function. - * - * @return: - * Error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Outline_LineToFunc */ + /* */ + /* <Description> */ + /* A function pointer type used to describe the signature of a `line */ + /* to' function during outline walking/decomposition. */ + /* */ + /* A `line to' is emitted to indicate a segment in the outline. */ + /* */ + /* <Input> */ + /* to :: A pointer to the target point of the `line to'. */ + /* */ + /* user :: A typeless pointer, which is passed from the caller of the */ + /* decomposition function. */ + /* */ + /* <Return> */ + /* Error code. 0~means success. */ + /* */ typedef int (*FT_Outline_LineToFunc)( const FT_Vector* to, void* user ); @@ -533,33 +523,30 @@ FT_BEGIN_HEADER #define FT_Outline_LineTo_Func FT_Outline_LineToFunc - /************************************************************************** - * - * @functype: - * FT_Outline_ConicToFunc - * - * @description: - * A function pointer type used to describe the signature of a 'conic to' - * function during outline walking or decomposition. - * - * A 'conic to' is emitted to indicate a second-order Bezier arc in the - * outline. - * - * @input: - * control :: - * An intermediate control point between the last position and the new - * target in `to`. - * - * to :: - * A pointer to the target end point of the conic arc. - * - * user :: - * A typeless pointer, which is passed from the caller of the - * decomposition function. - * - * @return: - * Error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Outline_ConicToFunc */ + /* */ + /* <Description> */ + /* A function pointer type used to describe the signature of a `conic */ + /* to' function during outline walking or decomposition. */ + /* */ + /* A `conic to' is emitted to indicate a second-order Bézier arc in */ + /* the outline. */ + /* */ + /* <Input> */ + /* control :: An intermediate control point between the last position */ + /* and the new target in `to'. */ + /* */ + /* to :: A pointer to the target end point of the conic arc. */ + /* */ + /* user :: A typeless pointer, which is passed from the caller of */ + /* the decomposition function. */ + /* */ + /* <Return> */ + /* Error code. 0~means success. */ + /* */ typedef int (*FT_Outline_ConicToFunc)( const FT_Vector* control, const FT_Vector* to, @@ -568,34 +555,30 @@ FT_BEGIN_HEADER #define FT_Outline_ConicTo_Func FT_Outline_ConicToFunc - /************************************************************************** - * - * @functype: - * FT_Outline_CubicToFunc - * - * @description: - * A function pointer type used to describe the signature of a 'cubic to' - * function during outline walking or decomposition. - * - * A 'cubic to' is emitted to indicate a third-order Bezier arc. - * - * @input: - * control1 :: - * A pointer to the first Bezier control point. - * - * control2 :: - * A pointer to the second Bezier control point. - * - * to :: - * A pointer to the target end point. - * - * user :: - * A typeless pointer, which is passed from the caller of the - * decomposition function. - * - * @return: - * Error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Outline_CubicToFunc */ + /* */ + /* <Description> */ + /* A function pointer type used to describe the signature of a `cubic */ + /* to' function during outline walking or decomposition. */ + /* */ + /* A `cubic to' is emitted to indicate a third-order Bézier arc. */ + /* */ + /* <Input> */ + /* control1 :: A pointer to the first Bézier control point. */ + /* */ + /* control2 :: A pointer to the second Bézier control point. */ + /* */ + /* to :: A pointer to the target end point. */ + /* */ + /* user :: A typeless pointer, which is passed from the caller of */ + /* the decomposition function. */ + /* */ + /* <Return> */ + /* Error code. 0~means success. */ + /* */ typedef int (*FT_Outline_CubicToFunc)( const FT_Vector* control1, const FT_Vector* control2, @@ -605,49 +588,43 @@ FT_BEGIN_HEADER #define FT_Outline_CubicTo_Func FT_Outline_CubicToFunc - /************************************************************************** - * - * @struct: - * FT_Outline_Funcs - * - * @description: - * A structure to hold various function pointers used during outline - * decomposition in order to emit segments, conic, and cubic Beziers. - * - * @fields: - * move_to :: - * The 'move to' emitter. - * - * line_to :: - * The segment emitter. - * - * conic_to :: - * The second-order Bezier arc emitter. - * - * cubic_to :: - * The third-order Bezier arc emitter. - * - * shift :: - * The shift that is applied to coordinates before they are sent to the - * emitter. - * - * delta :: - * The delta that is applied to coordinates before they are sent to the - * emitter, but after the shift. - * - * @note: - * The point coordinates sent to the emitters are the transformed version - * of the original coordinates (this is important for high accuracy - * during scan-conversion). The transformation is simple: - * - * ``` - * x' = (x << shift) - delta - * y' = (y << shift) - delta - * ``` - * - * Set the values of `shift` and `delta` to~0 to get the original point - * coordinates. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Outline_Funcs */ + /* */ + /* <Description> */ + /* A structure to hold various function pointers used during outline */ + /* decomposition in order to emit segments, conic, and cubic Béziers. */ + /* */ + /* <Fields> */ + /* move_to :: The `move to' emitter. */ + /* */ + /* line_to :: The segment emitter. */ + /* */ + /* conic_to :: The second-order Bézier arc emitter. */ + /* */ + /* cubic_to :: The third-order Bézier arc emitter. */ + /* */ + /* shift :: The shift that is applied to coordinates before they */ + /* are sent to the emitter. */ + /* */ + /* delta :: The delta that is applied to coordinates before they */ + /* are sent to the emitter, but after the shift. */ + /* */ + /* <Note> */ + /* The point coordinates sent to the emitters are the transformed */ + /* version of the original coordinates (this is important for high */ + /* accuracy during scan-conversion). The transformation is simple: */ + /* */ + /* { */ + /* x' = (x << shift) - delta */ + /* y' = (x << shift) - delta */ + /* } */ + /* */ + /* Set the values of `shift' and `delta' to~0 to get the original */ + /* point coordinates. */ + /* */ typedef struct FT_Outline_Funcs_ { FT_Outline_MoveToFunc move_to; @@ -661,32 +638,33 @@ FT_BEGIN_HEADER } FT_Outline_Funcs; - /************************************************************************** - * - * @section: - * basic_types - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* basic_types */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @macro: - * FT_IMAGE_TAG - * - * @description: - * This macro converts four-letter tags to an unsigned long type. - * - * @note: - * Since many 16-bit compilers don't like 32-bit enumerations, you should - * redefine this macro in case of problems to something like this: - * - * ``` - * #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) value - * ``` - * - * to get a simple enumeration without assigning special numbers. - */ + /*************************************************************************/ + /* */ + /* <Macro> */ + /* FT_IMAGE_TAG */ + /* */ + /* <Description> */ + /* This macro converts four-letter tags to an unsigned long type. */ + /* */ + /* <Note> */ + /* Since many 16-bit compilers don't like 32-bit enumerations, you */ + /* should redefine this macro in case of problems to something like */ + /* this: */ + /* */ + /* { */ + /* #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) value */ + /* } */ + /* */ + /* to get a simple enumeration without assigning special numbers. */ + /* */ #ifndef FT_IMAGE_TAG #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) \ value = ( ( (unsigned long)_x1 << 24 ) | \ @@ -696,43 +674,44 @@ FT_BEGIN_HEADER #endif /* FT_IMAGE_TAG */ - /************************************************************************** - * - * @enum: - * FT_Glyph_Format - * - * @description: - * 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. - * - * @values: - * FT_GLYPH_FORMAT_NONE :: - * The value~0 is reserved. - * - * FT_GLYPH_FORMAT_COMPOSITE :: - * The glyph image is a composite of several other images. This format - * is _only_ used with @FT_LOAD_NO_RECURSE, and is used to report - * compound glyphs (like accented characters). - * - * FT_GLYPH_FORMAT_BITMAP :: - * The glyph image is a bitmap, and can be described as an @FT_Bitmap. - * You generally need to access the `bitmap` field of the - * @FT_GlyphSlotRec structure to read it. - * - * FT_GLYPH_FORMAT_OUTLINE :: - * The glyph image is a vectorial outline made of line segments and - * Bezier arcs; it can be described as an @FT_Outline; you generally - * want to access the `outline` field of the @FT_GlyphSlotRec structure - * to read it. - * - * FT_GLYPH_FORMAT_PLOTTER :: - * 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 @FT_Outline, - * but FreeType isn't currently capable of rendering them correctly. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_Glyph_Format */ + /* */ + /* <Description> */ + /* 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. */ + /* */ + /* <Values> */ + /* FT_GLYPH_FORMAT_NONE :: */ + /* The value~0 is reserved. */ + /* */ + /* FT_GLYPH_FORMAT_COMPOSITE :: */ + /* The glyph image is a composite of several other images. This */ + /* format is _only_ used with @FT_LOAD_NO_RECURSE, and is used to */ + /* report compound glyphs (like accented characters). */ + /* */ + /* FT_GLYPH_FORMAT_BITMAP :: */ + /* The glyph image is a bitmap, and can be described as an */ + /* @FT_Bitmap. You generally need to access the `bitmap' field of */ + /* the @FT_GlyphSlotRec structure to read it. */ + /* */ + /* FT_GLYPH_FORMAT_OUTLINE :: */ + /* The glyph image is a vectorial outline made of line segments */ + /* and Bézier arcs; it can be described as an @FT_Outline; you */ + /* generally want to access the `outline' field of the */ + /* @FT_GlyphSlotRec structure to read it. */ + /* */ + /* FT_GLYPH_FORMAT_PLOTTER :: */ + /* 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 */ + /* @FT_Outline, but FreeType isn't currently capable of rendering */ + /* them correctly. */ + /* */ typedef enum FT_Glyph_Format_ { FT_IMAGE_TAG( FT_GLYPH_FORMAT_NONE, 0, 0, 0, 0 ), @@ -746,7 +725,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `FT_Glyph_Format` values instead. */ + /* `FT_Glyph_Format' values instead. */ #define ft_glyph_format_none FT_GLYPH_FORMAT_NONE #define ft_glyph_format_composite FT_GLYPH_FORMAT_COMPOSITE #define ft_glyph_format_bitmap FT_GLYPH_FORMAT_BITMAP @@ -765,89 +744,87 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** - * - * A raster is a scan converter, in charge of rendering an outline into a - * bitmap. This section contains the public API for rasters. - * - * Note that in FreeType 2, all rasters are now encapsulated within - * specific modules called 'renderers'. See `ftrender.h` for more details - * on renderers. - * - */ + /*************************************************************************/ + /* */ + /* A raster is a scan converter, in charge of rendering an outline into */ + /* a a bitmap. This section contains the public API for rasters. */ + /* */ + /* Note that in FreeType 2, all rasters are now encapsulated within */ + /* specific modules called `renderers'. See `ftrender.h' for more */ + /* details on renderers. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @section: - * raster - * - * @title: - * Scanline Converter - * - * @abstract: - * How vectorial outlines are converted into bitmaps and pixmaps. - * - * @description: - * This section contains technical definitions. - * - * @order: - * FT_Raster - * FT_Span - * FT_SpanFunc - * - * FT_Raster_Params - * FT_RASTER_FLAG_XXX - * - * FT_Raster_NewFunc - * FT_Raster_DoneFunc - * FT_Raster_ResetFunc - * FT_Raster_SetModeFunc - * FT_Raster_RenderFunc - * FT_Raster_Funcs - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* raster */ + /* */ + /* <Title> */ + /* Scanline Converter */ + /* */ + /* <Abstract> */ + /* How vectorial outlines are converted into bitmaps and pixmaps. */ + /* */ + /* <Description> */ + /* This section contains technical definitions. */ + /* */ + /* <Order> */ + /* FT_Raster */ + /* FT_Span */ + /* FT_SpanFunc */ + /* */ + /* FT_Raster_Params */ + /* FT_RASTER_FLAG_XXX */ + /* */ + /* FT_Raster_NewFunc */ + /* FT_Raster_DoneFunc */ + /* FT_Raster_ResetFunc */ + /* FT_Raster_SetModeFunc */ + /* FT_Raster_RenderFunc */ + /* FT_Raster_Funcs */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @type: - * FT_Raster - * - * @description: - * An opaque handle (pointer) to a raster object. Each object can be - * used independently to convert an outline into a bitmap or pixmap. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Raster */ + /* */ + /* <Description> */ + /* An opaque handle (pointer) to a raster object. Each object can be */ + /* used independently to convert an outline into a bitmap or pixmap. */ + /* */ typedef struct FT_RasterRec_* FT_Raster; - /************************************************************************** - * - * @struct: - * FT_Span - * - * @description: - * A structure used to model a single span of gray pixels when rendering - * an anti-aliased bitmap. - * - * @fields: - * x :: - * The span's horizontal start position. - * - * len :: - * The span's length in pixels. - * - * coverage :: - * The span color/coverage, ranging from 0 (background) to 255 - * (foreground). - * - * @note: - * This structure is used by the span drawing callback type named - * @FT_SpanFunc that takes the y~coordinate of the span as a parameter. - * - * The coverage value is always between 0 and 255. If you want less gray - * values, the callback function has to reduce them. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Span */ + /* */ + /* <Description> */ + /* A structure used to model a single span of gray pixels when */ + /* rendering an anti-aliased bitmap. */ + /* */ + /* <Fields> */ + /* x :: The span's horizontal start position. */ + /* */ + /* len :: The span's length in pixels. */ + /* */ + /* coverage :: The span color/coverage, ranging from 0 (background) */ + /* to 255 (foreground). */ + /* */ + /* <Note> */ + /* This structure is used by the span drawing callback type named */ + /* @FT_SpanFunc that takes the y~coordinate of the span as a */ + /* parameter. */ + /* */ + /* The coverage value is always between 0 and 255. If you want less */ + /* gray values, the callback function has to reduce them. */ + /* */ typedef struct FT_Span_ { short x; @@ -857,36 +834,42 @@ FT_BEGIN_HEADER } FT_Span; - /************************************************************************** - * - * @functype: - * FT_SpanFunc - * - * @description: - * A function used as a call-back by the anti-aliased renderer in order - * to let client applications draw themselves the gray pixel spans on - * each scan line. - * - * @input: - * y :: - * The scanline's y~coordinate. - * - * count :: - * The number of spans to draw on this scanline. - * - * spans :: - * A table of `count` spans to draw on the scanline. - * - * user :: - * User-supplied data that is passed to the callback. - * - * @note: - * This callback allows client applications to directly render the gray - * spans of the anti-aliased bitmap to any kind of surfaces. - * - * This can be used to write anti-aliased outlines directly to a given - * background bitmap, and even perform translucency. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_SpanFunc */ + /* */ + /* <Description> */ + /* A function used as a call-back by the anti-aliased renderer in */ + /* order to let client applications draw themselves the gray pixel */ + /* spans on each scan line. */ + /* */ + /* <Input> */ + /* y :: The scanline's y~coordinate. */ + /* */ + /* count :: The number of spans to draw on this scanline. */ + /* */ + /* spans :: A table of `count' spans to draw on the scanline. */ + /* */ + /* user :: User-supplied data that is passed to the callback. */ + /* */ + /* <Note> */ + /* This callback allows client applications to directly render the */ + /* gray spans of the anti-aliased bitmap to any kind of surfaces. */ + /* */ + /* This can be used to write anti-aliased outlines directly to a */ + /* given background bitmap, and even perform translucency. */ + /* */ + /* Note that the `count' field cannot be greater than a fixed value */ + /* defined by the `FT_MAX_GRAY_SPANS' configuration macro in */ + /* `ftoption.h'. By default, this value is set to~32, which means */ + /* that if there are more than 32~spans on a given scanline, the */ + /* callback is called several times with the same `y' parameter in */ + /* order to draw all callbacks. */ + /* */ + /* Otherwise, the callback is only called once per scan-line, and */ + /* only for those scanlines that do have `gray' pixels on them. */ + /* */ typedef void (*FT_SpanFunc)( int y, int count, @@ -896,131 +879,131 @@ FT_BEGIN_HEADER #define FT_Raster_Span_Func FT_SpanFunc - /************************************************************************** - * - * @functype: - * FT_Raster_BitTest_Func - * - * @description: - * Deprecated, unimplemented. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Raster_BitTest_Func */ + /* */ + /* <Description> */ + /* Deprecated, unimplemented. */ + /* */ typedef int (*FT_Raster_BitTest_Func)( int y, int x, void* user ); - /************************************************************************** - * - * @functype: - * FT_Raster_BitSet_Func - * - * @description: - * Deprecated, unimplemented. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Raster_BitSet_Func */ + /* */ + /* <Description> */ + /* Deprecated, unimplemented. */ + /* */ typedef void (*FT_Raster_BitSet_Func)( int y, int x, void* user ); - /************************************************************************** - * - * @enum: - * FT_RASTER_FLAG_XXX - * - * @description: - * A list of bit flag constants as used in the `flags` field of a - * @FT_Raster_Params structure. - * - * @values: - * FT_RASTER_FLAG_DEFAULT :: - * This value is 0. - * - * FT_RASTER_FLAG_AA :: - * This flag is set to indicate that an anti-aliased glyph image should - * be generated. Otherwise, it will be monochrome (1-bit). - * - * FT_RASTER_FLAG_DIRECT :: - * This flag is set to indicate direct rendering. In this mode, client - * applications must provide their own span callback. This lets them - * directly draw or compose over an existing bitmap. If this bit is - * not set, the target pixmap's buffer _must_ be zeroed before - * rendering. - * - * Direct rendering is only possible with anti-aliased glyphs. - * - * FT_RASTER_FLAG_CLIP :: - * This flag is only used in direct rendering mode. If set, the output - * will be clipped to a box specified in the `clip_box` field of the - * @FT_Raster_Params structure. - * - * Note that by default, the glyph bitmap is clipped to the target - * pixmap, except in direct rendering mode where all spans are - * generated if no clipping box is set. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_RASTER_FLAG_XXX */ + /* */ + /* <Description> */ + /* A list of bit flag constants as used in the `flags' field of a */ + /* @FT_Raster_Params structure. */ + /* */ + /* <Values> */ + /* FT_RASTER_FLAG_DEFAULT :: This value is 0. */ + /* */ + /* FT_RASTER_FLAG_AA :: This flag is set to indicate that an */ + /* anti-aliased glyph image should be */ + /* generated. Otherwise, it will be */ + /* monochrome (1-bit). */ + /* */ + /* FT_RASTER_FLAG_DIRECT :: This flag is set to indicate direct */ + /* rendering. In this mode, client */ + /* applications must provide their own span */ + /* callback. This lets them directly */ + /* draw or compose over an existing bitmap. */ + /* If this bit is not set, the target */ + /* pixmap's buffer _must_ be zeroed before */ + /* rendering. */ + /* */ + /* Direct rendering is only possible with */ + /* anti-aliased glyphs. */ + /* */ + /* FT_RASTER_FLAG_CLIP :: This flag is only used in direct */ + /* rendering mode. If set, the output will */ + /* be clipped to a box specified in the */ + /* `clip_box' field of the */ + /* @FT_Raster_Params structure. */ + /* */ + /* Note that by default, the glyph bitmap */ + /* is clipped to the target pixmap, except */ + /* in direct rendering mode where all spans */ + /* are generated if no clipping box is set. */ + /* */ #define FT_RASTER_FLAG_DEFAULT 0x0 #define FT_RASTER_FLAG_AA 0x1 #define FT_RASTER_FLAG_DIRECT 0x2 #define FT_RASTER_FLAG_CLIP 0x4 /* these constants are deprecated; use the corresponding */ - /* `FT_RASTER_FLAG_XXX` values instead */ + /* `FT_RASTER_FLAG_XXX' values instead */ #define ft_raster_flag_default FT_RASTER_FLAG_DEFAULT #define ft_raster_flag_aa FT_RASTER_FLAG_AA #define ft_raster_flag_direct FT_RASTER_FLAG_DIRECT #define ft_raster_flag_clip FT_RASTER_FLAG_CLIP - /************************************************************************** - * - * @struct: - * FT_Raster_Params - * - * @description: - * A structure to hold the arguments used by a raster's render function. - * - * @fields: - * target :: - * The target bitmap. - * - * source :: - * A pointer to the source glyph image (e.g., an @FT_Outline). - * - * flags :: - * The rendering flags. - * - * gray_spans :: - * The gray span drawing callback. - * - * black_spans :: - * Unused. - * - * bit_test :: - * Unused. - * - * bit_set :: - * Unused. - * - * user :: - * User-supplied data that is passed to each drawing callback. - * - * clip_box :: - * An optional clipping box. It is only used in direct rendering mode. - * Note that coordinates here should be expressed in _integer_ pixels - * (and not in 26.6 fixed-point units). - * - * @note: - * An anti-aliased glyph bitmap is drawn if the @FT_RASTER_FLAG_AA bit - * flag is set in the `flags` field, otherwise a monochrome bitmap is - * generated. - * - * If the @FT_RASTER_FLAG_DIRECT bit flag is set in `flags`, the raster - * will call the `gray_spans` callback to draw gray pixel spans. This - * allows direct composition over a pre-existing bitmap through - * user-provided callbacks to perform the span drawing and composition. - * Not supported by the monochrome rasterizer. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Raster_Params */ + /* */ + /* <Description> */ + /* A structure to hold the arguments used by a raster's render */ + /* function. */ + /* */ + /* <Fields> */ + /* target :: The target bitmap. */ + /* */ + /* source :: A pointer to the source glyph image (e.g., an */ + /* @FT_Outline). */ + /* */ + /* flags :: The rendering flags. */ + /* */ + /* gray_spans :: The gray span drawing callback. */ + /* */ + /* black_spans :: Unused. */ + /* */ + /* bit_test :: Unused. */ + /* */ + /* bit_set :: Unused. */ + /* */ + /* user :: User-supplied data that is passed to each drawing */ + /* callback. */ + /* */ + /* clip_box :: An optional clipping box. It is only used in */ + /* direct rendering mode. Note that coordinates here */ + /* should be expressed in _integer_ pixels (and not in */ + /* 26.6 fixed-point units). */ + /* */ + /* <Note> */ + /* An anti-aliased glyph bitmap is drawn if the @FT_RASTER_FLAG_AA */ + /* bit flag is set in the `flags' field, otherwise a monochrome */ + /* bitmap is generated. */ + /* */ + /* If the @FT_RASTER_FLAG_DIRECT bit flag is set in `flags', the */ + /* raster will call the `gray_spans' callback to draw gray pixel */ + /* spans. This allows direct composition over a pre-existing bitmap */ + /* through user-provided callbacks to perform the span drawing and */ + /* composition. Not supported by the monochrome rasterizer. */ + /* */ typedef struct FT_Raster_Params_ { const FT_Bitmap* target; @@ -1036,32 +1019,30 @@ FT_BEGIN_HEADER } FT_Raster_Params; - /************************************************************************** - * - * @functype: - * FT_Raster_NewFunc - * - * @description: - * A function used to create a new raster object. - * - * @input: - * memory :: - * A handle to the memory allocator. - * - * @output: - * raster :: - * A handle to the new raster object. - * - * @return: - * Error code. 0~means success. - * - * @note: - * The `memory` parameter is a typeless pointer in order to avoid - * un-wanted dependencies on the rest of the FreeType code. In practice, - * it is an @FT_Memory object, i.e., a handle to the standard FreeType - * memory allocator. However, this field can be completely ignored by a - * given raster implementation. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Raster_NewFunc */ + /* */ + /* <Description> */ + /* A function used to create a new raster object. */ + /* */ + /* <Input> */ + /* memory :: A handle to the memory allocator. */ + /* */ + /* <Output> */ + /* raster :: A handle to the new raster object. */ + /* */ + /* <Return> */ + /* Error code. 0~means success. */ + /* */ + /* <Note> */ + /* The `memory' parameter is a typeless pointer in order to avoid */ + /* un-wanted dependencies on the rest of the FreeType code. In */ + /* practice, it is an @FT_Memory object, i.e., a handle to the */ + /* standard FreeType memory allocator. However, this field can be */ + /* completely ignored by a given raster implementation. */ + /* */ typedef int (*FT_Raster_NewFunc)( void* memory, FT_Raster* raster ); @@ -1069,52 +1050,49 @@ FT_BEGIN_HEADER #define FT_Raster_New_Func FT_Raster_NewFunc - /************************************************************************** - * - * @functype: - * FT_Raster_DoneFunc - * - * @description: - * A function used to destroy a given raster object. - * - * @input: - * raster :: - * A handle to the raster object. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Raster_DoneFunc */ + /* */ + /* <Description> */ + /* A function used to destroy a given raster object. */ + /* */ + /* <Input> */ + /* raster :: A handle to the raster object. */ + /* */ typedef void (*FT_Raster_DoneFunc)( FT_Raster raster ); #define FT_Raster_Done_Func FT_Raster_DoneFunc - /************************************************************************** - * - * @functype: - * FT_Raster_ResetFunc - * - * @description: - * FreeType used to provide an area of memory called the 'render pool' - * available to all registered rasterizers. This was not thread safe, - * however, and now FreeType never allocates this pool. - * - * This function is called after a new raster object is created. - * - * @input: - * raster :: - * A handle to the new raster object. - * - * pool_base :: - * Previously, the address in memory of the render pool. Set this to - * `NULL`. - * - * pool_size :: - * Previously, the size in bytes of the render pool. Set this to 0. - * - * @note: - * Rasterizers should rely on dynamic or stack allocation if they want to - * (a handle to the memory allocator is passed to the rasterizer - * constructor). - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Raster_ResetFunc */ + /* */ + /* <Description> */ + /* FreeType used to provide an area of memory called the `render */ + /* pool' available to all registered rasters. This was not thread */ + /* safe however and now FreeType never allocates this pool. NULL */ + /* is always passed in as pool_base. */ + /* */ + /* This function is called each time the render pool changes, or just */ + /* after a new raster object is created. */ + /* */ + /* <Input> */ + /* raster :: A handle to the new raster object. */ + /* */ + /* pool_base :: The address in memory of the render pool. */ + /* */ + /* pool_size :: The size in bytes of the render pool. */ + /* */ + /* <Note> */ + /* Rasters should ignore the render pool and rely on dynamic or stack */ + /* allocation if they want to (a handle to the memory allocator is */ + /* passed to the raster constructor). */ + /* */ typedef void (*FT_Raster_ResetFunc)( FT_Raster raster, unsigned char* pool_base, @@ -1123,26 +1101,24 @@ FT_BEGIN_HEADER #define FT_Raster_Reset_Func FT_Raster_ResetFunc - /************************************************************************** - * - * @functype: - * FT_Raster_SetModeFunc - * - * @description: - * This function is a generic facility to change modes or attributes in a - * given raster. This can be used for debugging purposes, or simply to - * allow implementation-specific 'features' in a given raster module. - * - * @input: - * raster :: - * A handle to the new raster object. - * - * mode :: - * A 4-byte tag used to name the mode or property. - * - * args :: - * A pointer to the new mode/property to use. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Raster_SetModeFunc */ + /* */ + /* <Description> */ + /* This function is a generic facility to change modes or attributes */ + /* in a given raster. This can be used for debugging purposes, or */ + /* simply to allow implementation-specific `features' in a given */ + /* raster module. */ + /* */ + /* <Input> */ + /* raster :: A handle to the new raster object. */ + /* */ + /* mode :: A 4-byte tag used to name the mode or property. */ + /* */ + /* args :: A pointer to the new mode/property to use. */ + /* */ typedef int (*FT_Raster_SetModeFunc)( FT_Raster raster, unsigned long mode, @@ -1151,36 +1127,40 @@ FT_BEGIN_HEADER #define FT_Raster_Set_Mode_Func FT_Raster_SetModeFunc - /************************************************************************** - * - * @functype: - * FT_Raster_RenderFunc - * - * @description: - * Invoke a given raster to scan-convert a given glyph image into a - * target bitmap. - * - * @input: - * raster :: - * A handle to the raster object. - * - * params :: - * A pointer to an @FT_Raster_Params structure used to store the - * rendering parameters. - * - * @return: - * Error code. 0~means success. - * - * @note: - * The exact format of the source image depends on the raster's glyph - * format defined in its @FT_Raster_Funcs structure. It can be an - * @FT_Outline or anything else in order to support a large array of - * glyph formats. - * - * Note also that the render function can fail and return a - * `FT_Err_Unimplemented_Feature` error code if the raster used does not - * support direct composition. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Raster_RenderFunc */ + /* */ + /* <Description> */ + /* Invoke a given raster to scan-convert a given glyph image into a */ + /* target bitmap. */ + /* */ + /* <Input> */ + /* raster :: A handle to the raster object. */ + /* */ + /* params :: A pointer to an @FT_Raster_Params structure used to */ + /* store the rendering parameters. */ + /* */ + /* <Return> */ + /* Error code. 0~means success. */ + /* */ + /* <Note> */ + /* The exact format of the source image depends on the raster's glyph */ + /* format defined in its @FT_Raster_Funcs structure. It can be an */ + /* @FT_Outline or anything else in order to support a large array of */ + /* glyph formats. */ + /* */ + /* Note also that the render function can fail and return a */ + /* `FT_Err_Unimplemented_Feature' error code if the raster used does */ + /* not support direct composition. */ + /* */ + /* XXX: For now, the standard raster doesn't support direct */ + /* composition but this should change for the final release (see */ + /* the files `demos/src/ftgrays.c' and `demos/src/ftgrays2.c' */ + /* for examples of distinct implementations that support direct */ + /* composition). */ + /* */ typedef int (*FT_Raster_RenderFunc)( FT_Raster raster, const FT_Raster_Params* params ); @@ -1188,34 +1168,28 @@ FT_BEGIN_HEADER #define FT_Raster_Render_Func FT_Raster_RenderFunc - /************************************************************************** - * - * @struct: - * FT_Raster_Funcs - * - * @description: - * A structure used to describe a given raster class to the library. - * - * @fields: - * glyph_format :: - * The supported glyph format for this raster. - * - * raster_new :: - * The raster constructor. - * - * raster_reset :: - * Used to reset the render pool within the raster. - * - * raster_render :: - * A function to render a glyph into a given bitmap. - * - * raster_done :: - * The raster destructor. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Raster_Funcs */ + /* */ + /* <Description> */ + /* A structure used to describe a given raster class to the library. */ + /* */ + /* <Fields> */ + /* glyph_format :: The supported glyph format for this raster. */ + /* */ + /* raster_new :: The raster constructor. */ + /* */ + /* raster_reset :: Used to reset the render pool within the raster. */ + /* */ + /* raster_render :: A function to render a glyph into a given bitmap. */ + /* */ + /* raster_done :: The raster destructor. */ + /* */ typedef struct FT_Raster_Funcs_ { FT_Glyph_Format glyph_format; - FT_Raster_NewFunc raster_new; FT_Raster_ResetFunc raster_reset; FT_Raster_SetModeFunc raster_set_mode; diff --git a/android/x86_64/include/freetype/ftincrem.h b/android/x86_64/include/freetype/ftincrem.h index b5547327..46b58b79 100644 --- a/android/x86_64/include/freetype/ftincrem.h +++ b/android/x86_64/include/freetype/ftincrem.h @@ -1,27 +1,26 @@ -/**************************************************************************** - * - * ftincrem.h - * - * FreeType incremental loading (specification). - * - * Copyright (C) 2002-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftincrem.h */ +/* */ +/* FreeType incremental loading (specification). */ +/* */ +/* Copyright 2002-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTINCREM_H_ #define FTINCREM_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H -#include FT_PARAMETER_TAGS_H #ifdef FREETYPE_H #error "freetype.h of FreeType 1 has been loaded!" @@ -32,7 +31,7 @@ FT_BEGIN_HEADER - /************************************************************************** + /*************************************************************************** * * @section: * incremental @@ -45,7 +44,7 @@ FT_BEGIN_HEADER * * @description: * This section contains various functions used to perform so-called - * 'incremental' glyph loading. This is a mode where all glyphs loaded + * `incremental' glyph loading. This is a mode where all glyphs loaded * from a given @FT_Face are provided by the client application. * * Apart from that, all other tables are loaded normally from the font @@ -60,24 +59,23 @@ FT_BEGIN_HEADER */ - /************************************************************************** + /*************************************************************************** * * @type: * FT_Incremental * * @description: * An opaque type describing a user-provided object used to implement - * 'incremental' glyph loading within FreeType. This is used to support - * embedded fonts in certain environments (e.g., PostScript - * interpreters), where the glyph data isn't in the font file, or must be - * overridden by different values. + * `incremental' glyph loading within FreeType. This is used to support + * embedded fonts in certain environments (e.g., PostScript interpreters), + * where the glyph data isn't in the font file, or must be overridden by + * different values. * * @note: - * It is up to client applications to create and implement - * @FT_Incremental objects, as long as they provide implementations for - * the methods @FT_Incremental_GetGlyphDataFunc, - * @FT_Incremental_FreeGlyphDataFunc and - * @FT_Incremental_GetGlyphMetricsFunc. + * It is up to client applications to create and implement @FT_Incremental + * objects, as long as they provide implementations for the methods + * @FT_Incremental_GetGlyphDataFunc, @FT_Incremental_FreeGlyphDataFunc + * and @FT_Incremental_GetGlyphMetricsFunc. * * See the description of @FT_Incremental_InterfaceRec to understand how * to use incremental objects with FreeType. @@ -86,14 +84,14 @@ FT_BEGIN_HEADER typedef struct FT_IncrementalRec_* FT_Incremental; - /************************************************************************** + /*************************************************************************** * * @struct: * FT_Incremental_MetricsRec * * @description: - * A small structure used to contain the basic glyph metrics returned by - * the @FT_Incremental_GetGlyphMetricsFunc method. + * A small structure used to contain the basic glyph metrics returned + * by the @FT_Incremental_GetGlyphMetricsFunc method. * * @fields: * bearing_x :: @@ -110,7 +108,7 @@ FT_BEGIN_HEADER * * @note: * These correspond to horizontal or vertical metrics depending on the - * value of the `vertical` argument to the function + * value of the `vertical' argument to the function * @FT_Incremental_GetGlyphMetricsFunc. * */ @@ -124,7 +122,7 @@ FT_BEGIN_HEADER } FT_Incremental_MetricsRec; - /************************************************************************** + /*************************************************************************** * * @struct: * FT_Incremental_Metrics @@ -136,7 +134,7 @@ FT_BEGIN_HEADER typedef struct FT_Incremental_MetricsRec_* FT_Incremental_Metrics; - /************************************************************************** + /*************************************************************************** * * @type: * FT_Incremental_GetGlyphDataFunc @@ -148,8 +146,8 @@ FT_BEGIN_HEADER * * Note that the format of the glyph's data bytes depends on the font * file format. For TrueType, it must correspond to the raw bytes within - * the 'glyf' table. For PostScript formats, it must correspond to the - * **unencrypted** charstring bytes, without any `lenIV` header. It is + * the `glyf' table. For PostScript formats, it must correspond to the + * *unencrypted* charstring bytes, without any `lenIV' header. It is * undefined for any other format. * * @input: @@ -170,8 +168,8 @@ FT_BEGIN_HEADER * * @note: * If this function returns successfully the method - * @FT_Incremental_FreeGlyphDataFunc will be called later to release the - * data bytes. + * @FT_Incremental_FreeGlyphDataFunc will be called later to release + * the data bytes. * * Nested calls to @FT_Incremental_GetGlyphDataFunc can happen for * compound glyphs. @@ -183,7 +181,7 @@ FT_BEGIN_HEADER FT_Data* adata ); - /************************************************************************** + /*************************************************************************** * * @type: * FT_Incremental_FreeGlyphDataFunc @@ -207,7 +205,7 @@ FT_BEGIN_HEADER FT_Data* data ); - /************************************************************************** + /*************************************************************************** * * @type: * FT_Incremental_GetGlyphMetricsFunc @@ -215,8 +213,8 @@ FT_BEGIN_HEADER * @description: * A function used to retrieve the basic metrics of a given glyph index * before accessing its data. This is necessary because, in certain - * formats like TrueType, the metrics are stored in a different place - * from the glyph images proper. + * formats like TrueType, the metrics are stored in a different place from + * the glyph images proper. * * @input: * incremental :: @@ -230,9 +228,9 @@ FT_BEGIN_HEADER * If true, return vertical metrics. * * ametrics :: - * This parameter is used for both input and output. The original - * glyph metrics, if any, in font units. If metrics are not available - * all the values must be set to zero. + * This parameter is used for both input and output. + * The original glyph metrics, if any, in font units. If metrics are + * not available all the values must be set to zero. * * @output: * ametrics :: @@ -253,8 +251,8 @@ FT_BEGIN_HEADER * FT_Incremental_FuncsRec * * @description: - * A table of functions for accessing fonts that load data incrementally. - * Used in @FT_Incremental_InterfaceRec. + * A table of functions for accessing fonts that load data + * incrementally. Used in @FT_Incremental_InterfaceRec. * * @fields: * get_glyph_data :: @@ -264,8 +262,8 @@ FT_BEGIN_HEADER * The function to release glyph data. Must not be null. * * get_glyph_metrics :: - * The function to get glyph metrics. May be null if the font does not - * provide overriding glyph metrics. + * The function to get glyph metrics. May be null if the font does + * not provide overriding glyph metrics. * */ typedef struct FT_Incremental_FuncsRec_ @@ -277,7 +275,7 @@ FT_BEGIN_HEADER } FT_Incremental_FuncsRec; - /************************************************************************** + /*************************************************************************** * * @struct: * FT_Incremental_InterfaceRec @@ -287,30 +285,30 @@ FT_BEGIN_HEADER * wants to support incremental glyph loading. You should use it with * @FT_PARAM_TAG_INCREMENTAL as in the following example: * - * ``` - * FT_Incremental_InterfaceRec inc_int; - * FT_Parameter parameter; - * FT_Open_Args open_args; + * { + * FT_Incremental_InterfaceRec inc_int; + * FT_Parameter parameter; + * FT_Open_Args open_args; * * - * // set up incremental descriptor - * inc_int.funcs = my_funcs; - * inc_int.object = my_object; + * // set up incremental descriptor + * inc_int.funcs = my_funcs; + * inc_int.object = my_object; * - * // set up optional parameter - * parameter.tag = FT_PARAM_TAG_INCREMENTAL; - * parameter.data = &inc_int; + * // set up optional parameter + * parameter.tag = FT_PARAM_TAG_INCREMENTAL; + * parameter.data = &inc_int; * - * // set up FT_Open_Args structure - * open_args.flags = FT_OPEN_PATHNAME | FT_OPEN_PARAMS; - * open_args.pathname = my_font_pathname; - * open_args.num_params = 1; - * open_args.params = ¶meter; // we use one optional argument + * // set up FT_Open_Args structure + * open_args.flags = FT_OPEN_PATHNAME | FT_OPEN_PARAMS; + * open_args.pathname = my_font_pathname; + * open_args.num_params = 1; + * open_args.params = ¶meter; // we use one optional argument * - * // open the font - * error = FT_Open_Face( library, &open_args, index, &face ); - * ... - * ``` + * // open the font + * error = FT_Open_Face( library, &open_args, index, &face ); + * ... + * } * */ typedef struct FT_Incremental_InterfaceRec_ @@ -321,7 +319,7 @@ FT_BEGIN_HEADER } FT_Incremental_InterfaceRec; - /************************************************************************** + /*************************************************************************** * * @type: * FT_Incremental_Interface @@ -333,6 +331,18 @@ FT_BEGIN_HEADER typedef FT_Incremental_InterfaceRec* FT_Incremental_Interface; + /*************************************************************************** + * + * @constant: + * FT_PARAM_TAG_INCREMENTAL + * + * @description: + * A constant used as the tag of @FT_Parameter structures to indicate + * an incremental loading object to be used by FreeType. + * + */ +#define FT_PARAM_TAG_INCREMENTAL FT_MAKE_TAG( 'i', 'n', 'c', 'r' ) + /* */ diff --git a/android/x86_64/include/freetype/ftlcdfil.h b/android/x86_64/include/freetype/ftlcdfil.h index 58c60ea1..e06a8957 100644 --- a/android/x86_64/include/freetype/ftlcdfil.h +++ b/android/x86_64/include/freetype/ftlcdfil.h @@ -1,28 +1,27 @@ -/**************************************************************************** - * - * ftlcdfil.h - * - * FreeType API for color filtering of subpixel bitmap glyphs - * (specification). - * - * Copyright (C) 2006-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftlcdfil.h */ +/* */ +/* FreeType API for color filtering of subpixel bitmap glyphs */ +/* (specification). */ +/* */ +/* Copyright 2006-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTLCDFIL_H_ #define FTLCDFIL_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H -#include FT_PARAMETER_TAGS_H #ifdef FREETYPE_H #error "freetype.h of FreeType 1 has been loaded!" @@ -33,98 +32,104 @@ FT_BEGIN_HEADER - /************************************************************************** + /*************************************************************************** * * @section: - * lcd_rendering + * lcd_filtering * * @title: - * Subpixel Rendering + * LCD Filtering * * @abstract: - * API to control subpixel rendering. + * Reduce color fringes of subpixel-rendered bitmaps. * * @description: - * FreeType provides two alternative subpixel rendering technologies. - * Should you define `FT_CONFIG_OPTION_SUBPIXEL_RENDERING` in your - * `ftoption.h` file, this enables patented ClearType-style rendering. - * Otherwise, Harmony LCD rendering is enabled. These technologies are - * controlled differently and API described below, although always - * available, performs its function when appropriate method is enabled - * and does nothing otherwise. + * Subpixel rendering exploits the color-striped structure of LCD + * pixels, increasing the available resolution in the direction of the + * stripe (usually horizontal RGB) by a factor of~3. Since these + * subpixels are color pixels, using them unfiltered creates severe + * color fringes. Use the @FT_Library_SetLcdFilter API to specify a + * low-pass filter, which is then applied to subpixel-rendered bitmaps + * generated through @FT_Render_Glyph. The filter sacrifices some of + * the higher resolution to reduce color fringes, making the glyph image + * slightly blurrier. Positional improvements will remain. * - * ClearType-style LCD rendering exploits the color-striped structure of - * LCD pixels, increasing the available resolution in the direction of - * the stripe (usually horizontal RGB) by a factor of~3. Using the - * subpixels coverages unfiltered can create severe color fringes - * especially when rendering thin features. Indeed, to produce - * black-on-white text, the nearby color subpixels must be dimmed - * equally. + * Note that no filter is active by default, and that this function is + * *not* implemented in default builds of the library. You need to + * #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your `ftoption.h' file + * in order to activate it and explicitly call @FT_Library_SetLcdFilter + * to enable it. * - * A good 5-tap FIR filter should be applied to subpixel coverages - * regardless of pixel boundaries and should have these properties: + * A filter should have two properties: * - * 1. It should be symmetrical, like {~a, b, c, b, a~}, to avoid - * any shifts in appearance. + * 1) It should be normalized, meaning the sum of the 5~components + * should be 256 (0x100). It is possible to go above or under this + * target sum, however: going under means tossing out contrast, going + * over means invoking clamping and thereby non-linearities that + * increase contrast somewhat at the expense of greater distortion + * and color-fringing. Contrast is better enhanced through stem + * darkening. * - * 2. It should be color-balanced, meaning a~+ b~=~c, to reduce color - * fringes by distributing the computed coverage for one subpixel to - * all subpixels equally. + * 2) It should be color-balanced, meaning a filter `{~a, b, c, b, a~}' + * where a~+ b~=~c. It distributes the computed coverage for one + * subpixel to all subpixels equally, sacrificing some won resolution + * but drastically reducing color-fringing. Positioning improvements + * remain! Note that color-fringing can only really be minimized + * when using a color-balanced filter and alpha-blending the glyph + * onto a surface in linear space; see @FT_Render_Glyph. * - * 3. It should be normalized, meaning 2a~+ 2b~+ c~=~1.0 to maintain - * overall brightness. + * Regarding the form, a filter can be a `boxy' filter or a `beveled' + * filter. Boxy filters are sharper but are less forgiving of non-ideal + * gamma curves of a screen (viewing angles!), beveled filters are + * fuzzier but more tolerant. * - * Boxy 3-tap filter {0, 1/3, 1/3, 1/3, 0} is sharper but is less - * forgiving of non-ideal gamma curves of a screen (and viewing angles), - * beveled filters are fuzzier but more tolerant. + * Examples: * - * Use the @FT_Library_SetLcdFilter or @FT_Library_SetLcdFilterWeights - * API to specify a low-pass filter, which is then applied to - * subpixel-rendered bitmaps generated through @FT_Render_Glyph. + * - [0x10 0x40 0x70 0x40 0x10] is beveled and neither balanced nor + * normalized. * - * Harmony LCD rendering is suitable to panels with any regular subpixel - * structure, not just monitors with 3 color striped subpixels, as long - * as the color subpixels have fixed positions relative to the pixel - * center. In this case, each color channel is then rendered separately - * after shifting the outline opposite to the subpixel shift so that the - * coverage maps are aligned. This method is immune to color fringes - * because the shifts do not change integral coverage. + * - [0x1A 0x33 0x4D 0x33 0x1A] is beveled and balanced but not + * normalized. * - * The subpixel geometry must be specified by xy-coordinates for each - * subpixel. By convention they may come in the RGB order: {{-1/3, 0}, - * {0, 0}, {1/3, 0}} for standard RGB striped panel or {{-1/6, 1/4}, - * {-1/6, -1/4}, {1/3, 0}} for a certain PenTile panel. + * - [0x19 0x33 0x66 0x4c 0x19] is beveled and normalized but not + * balanced. * - * Use the @FT_Library_SetLcdGeometry API to specify subpixel positions. - * If one follows the RGB order convention, the same order applies to the - * resulting @FT_PIXEL_MODE_LCD and @FT_PIXEL_MODE_LCD_V bitmaps. Note, - * however, that the coordinate frame for the latter must be rotated - * clockwise. Harmony with default LCD geometry is equivalent to - * ClearType with light filter. + * - [0x00 0x4c 0x66 0x4c 0x00] is boxily beveled and normalized but not + * balanced. * - * As a result of ClearType filtering or Harmony rendering, the - * dimensions of LCD bitmaps can be either wider or taller than the - * dimensions of the corresponding outline with regard to the pixel grid. - * For example, for @FT_RENDER_MODE_LCD, the filter adds 2~subpixels to - * the left, and 2~subpixels to the right. The bitmap offset values are - * adjusted accordingly, so clients shouldn't need to modify their layout - * and glyph positioning code when enabling the filter. + * - [0x00 0x55 0x56 0x55 0x00] is boxy, normalized, and almost + * balanced. * - * The ClearType and Harmony rendering is applicable to glyph bitmaps - * rendered through @FT_Render_Glyph, @FT_Load_Glyph, @FT_Load_Char, and - * @FT_Glyph_To_Bitmap, when @FT_RENDER_MODE_LCD or @FT_RENDER_MODE_LCD_V - * is specified. This API does not control @FT_Outline_Render and - * @FT_Outline_Get_Bitmap. + * - [0x08 0x4D 0x56 0x4D 0x08] is beveled, normalized and, almost + * balanced. * - * The described algorithms can completely remove color artefacts when - * combined with gamma-corrected alpha blending in linear space. Each of - * the 3~alpha values (subpixels) must by independently used to blend one - * color channel. That is, red alpha blends the red channel of the text - * color with the red channel of the background pixel. + * The filter affects glyph bitmaps rendered through @FT_Render_Glyph, + * @FT_Load_Glyph, and @FT_Load_Char. It does _not_ affect the output + * of @FT_Outline_Render and @FT_Outline_Get_Bitmap. + * + * If this feature is activated, the dimensions of LCD glyph bitmaps are + * either wider or taller than the dimensions of the corresponding + * outline with regard to the pixel grid. For example, for + * @FT_RENDER_MODE_LCD, the filter adds 3~subpixels to the left, and + * 3~subpixels to the right. The bitmap offset values are adjusted + * accordingly, so clients shouldn't need to modify their layout and + * glyph positioning code when enabling the filter. + * + * It is important to understand that linear alpha blending and gamma + * correction is critical for correctly rendering glyphs onto surfaces + * without artifacts and even more critical when subpixel rendering is + * involved. + * + * Each of the 3~alpha values (subpixels) is independently used to blend + * one color channel. That is, red alpha blends the red channel of the + * text color with the red channel of the background pixel. The + * distribution of density values by the color-balanced filter assumes + * alpha blending is done in linear space; only then color artifacts + * cancel out. */ - /************************************************************************** + /**************************************************************************** * * @enum: * FT_LcdFilter @@ -138,25 +143,47 @@ FT_BEGIN_HEADER * results in sometimes severe color fringes. * * FT_LCD_FILTER_DEFAULT :: - * This is a beveled, normalized, and color-balanced five-tap filter - * with weights of [0x08 0x4D 0x56 0x4D 0x08] in 1/256th units. + * The default filter reduces color fringes considerably, at the cost + * of a slight blurriness in the output. + * + * It is a beveled, normalized, and color-balanced five-tap filter + * that is more forgiving to screens with non-ideal gamma curves and + * viewing angles. Note that while color-fringing is reduced, it can + * only be minimized by using linear alpha blending and gamma + * correction to render glyphs onto surfaces. The default filter + * weights are [0x08 0x4D 0x56 0x4D 0x08]. * * FT_LCD_FILTER_LIGHT :: - * this is a boxy, normalized, and color-balanced three-tap filter with - * weights of [0x00 0x55 0x56 0x55 0x00] in 1/256th units. + * The light filter is a variant that is sharper at the cost of + * slightly more color fringes than the default one. + * + * It is a boxy, normalized, and color-balanced three-tap filter that + * is less forgiving to screens with non-ideal gamma curves and + * viewing angles. This filter works best when the rendering system + * uses linear alpha blending and gamma correction to render glyphs + * onto surfaces. The light filter weights are + * [0x00 0x55 0x56 0x55 0x00]. * * FT_LCD_FILTER_LEGACY :: - * FT_LCD_FILTER_LEGACY1 :: * This filter corresponds to the original libXft color filter. It * provides high contrast output but can exhibit really bad color * fringes if glyphs are not extremely well hinted to the pixel grid. + * In other words, it only works well if the TrueType bytecode + * interpreter is enabled *and* high-quality hinted fonts are used. + * * This filter is only provided for comparison purposes, and might be - * disabled or stay unsupported in the future. The second value is - * provided for compatibility with FontConfig, which historically used - * different enumeration, sometimes incorrectly forwarded to FreeType. + * disabled or stay unsupported in the future. + * + * FT_LCD_FILTER_LEGACY1 :: + * For historical reasons, the FontConfig library returns a different + * enumeration value for legacy LCD filtering. To make code work that + * (incorrectly) forwards FontConfig's enumeration value to + * @FT_Library_SetLcdFilter without proper mapping, it is thus easiest + * to have another enumeration value, which is completely equal to + * `FT_LCD_FILTER_LEGACY'. * * @since: - * 2.3.0 (`FT_LCD_FILTER_LEGACY1` since 2.6.2) + * 2.3.0 (`FT_LCD_FILTER_LEGACY1' since 2.6.2) */ typedef enum FT_LcdFilter_ { @@ -173,7 +200,7 @@ FT_BEGIN_HEADER /************************************************************************** * - * @function: + * @func: * FT_Library_SetLcdFilter * * @description: @@ -189,20 +216,20 @@ FT_BEGIN_HEADER * The filter type. * * You can use @FT_LCD_FILTER_NONE here to disable this feature, or - * @FT_LCD_FILTER_DEFAULT to use a default filter that should work well - * on most LCD screens. + * @FT_LCD_FILTER_DEFAULT to use a default filter that should work + * well on most LCD screens. * * @return: * FreeType error code. 0~means success. * * @note: * This feature is always disabled by default. Clients must make an - * explicit call to this function with a `filter` value other than + * explicit call to this function with a `filter' value other than * @FT_LCD_FILTER_NONE in order to enable it. * - * Due to **PATENTS** covering subpixel rendering, this function doesn't - * do anything except returning `FT_Err_Unimplemented_Feature` if the - * configuration macro `FT_CONFIG_OPTION_SUBPIXEL_RENDERING` is not + * Due to *PATENTS* covering subpixel rendering, this function doesn't + * do anything except returning `FT_Err_Unimplemented_Feature' if the + * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not * defined in your build of the library, which should correspond to all * default builds of FreeType. * @@ -216,7 +243,7 @@ FT_BEGIN_HEADER /************************************************************************** * - * @function: + * @func: * FT_Library_SetLcdFilterWeights * * @description: @@ -229,21 +256,18 @@ FT_BEGIN_HEADER * * weights :: * A pointer to an array; the function copies the first five bytes and - * uses them to specify the filter weights in 1/256th units. + * uses them to specify the filter weights. * * @return: * FreeType error code. 0~means success. * * @note: - * Due to **PATENTS** covering subpixel rendering, this function doesn't - * do anything except returning `FT_Err_Unimplemented_Feature` if the - * configuration macro `FT_CONFIG_OPTION_SUBPIXEL_RENDERING` is not + * Due to *PATENTS* covering subpixel rendering, this function doesn't + * do anything except returning `FT_Err_Unimplemented_Feature' if the + * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not * defined in your build of the library, which should correspond to all * default builds of FreeType. * - * LCD filter weights can also be set per face using @FT_Face_Properties - * with @FT_PARAM_TAG_LCD_FILTER_WEIGHTS. - * * @since: * 2.4.0 */ @@ -251,72 +275,6 @@ FT_BEGIN_HEADER FT_Library_SetLcdFilterWeights( FT_Library library, unsigned char *weights ); - - /************************************************************************** - * - * @type: - * FT_LcdFiveTapFilter - * - * @description: - * A typedef for passing the five LCD filter weights to - * @FT_Face_Properties within an @FT_Parameter structure. - * - * @since: - * 2.8 - * - */ -#define FT_LCD_FILTER_FIVE_TAPS 5 - - typedef FT_Byte FT_LcdFiveTapFilter[FT_LCD_FILTER_FIVE_TAPS]; - - - /************************************************************************** - * - * @function: - * FT_Library_SetLcdGeometry - * - * @description: - * This function can be used to modify default positions of color - * subpixels, which controls Harmony LCD rendering. - * - * @input: - * library :: - * A handle to the target library instance. - * - * sub :: - * A pointer to an array of 3 vectors in 26.6 fractional pixel format; - * the function modifies the default values, see the note below. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * Subpixel geometry examples: - * - * - {{-21, 0}, {0, 0}, {21, 0}} is the default, corresponding to 3 color - * stripes shifted by a third of a pixel. This could be an RGB panel. - * - * - {{21, 0}, {0, 0}, {-21, 0}} looks the same as the default but can - * specify a BGR panel instead, while keeping the bitmap in the same - * RGB888 format. - * - * - {{0, 21}, {0, 0}, {0, -21}} is the vertical RGB, but the bitmap - * stays RGB888 as a result. - * - * - {{-11, 16}, {-11, -16}, {22, 0}} is a certain PenTile arrangement. - * - * This function does nothing and returns `FT_Err_Unimplemented_Feature` - * in the context of ClearType-style subpixel rendering when - * `FT_CONFIG_OPTION_SUBPIXEL_RENDERING` is defined in your build of the - * library. - * - * @since: - * 2.10.0 - */ - FT_EXPORT( FT_Error ) - FT_Library_SetLcdGeometry( FT_Library library, - FT_Vector sub[3] ); - /* */ diff --git a/android/x86_64/include/freetype/ftlist.h b/android/x86_64/include/freetype/ftlist.h index e3ccf888..82f437ac 100644 --- a/android/x86_64/include/freetype/ftlist.h +++ b/android/x86_64/include/freetype/ftlist.h @@ -1,34 +1,34 @@ -/**************************************************************************** - * - * ftlist.h - * - * Generic list support for FreeType (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftlist.h */ +/* */ +/* Generic list support for FreeType (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * This file implements functions relative to list processing. Its data - * structures are defined in `freetype.h`. - * - */ + /*************************************************************************/ + /* */ + /* This file implements functions relative to list processing. Its */ + /* data structures are defined in `freetype.h'. */ + /* */ + /*************************************************************************/ #ifndef FTLIST_H_ #define FTLIST_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -41,245 +41,224 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * list_processing - * - * @title: - * List Processing - * - * @abstract: - * Simple management of lists. - * - * @description: - * This section contains various definitions related to list processing - * using doubly-linked nodes. - * - * @order: - * FT_List - * FT_ListNode - * FT_ListRec - * FT_ListNodeRec - * - * FT_List_Add - * FT_List_Insert - * FT_List_Find - * FT_List_Remove - * FT_List_Up - * FT_List_Iterate - * FT_List_Iterator - * FT_List_Finalize - * FT_List_Destructor - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* list_processing */ + /* */ + /* <Title> */ + /* List Processing */ + /* */ + /* <Abstract> */ + /* Simple management of lists. */ + /* */ + /* <Description> */ + /* This section contains various definitions related to list */ + /* processing using doubly-linked nodes. */ + /* */ + /* <Order> */ + /* FT_List */ + /* FT_ListNode */ + /* FT_ListRec */ + /* FT_ListNodeRec */ + /* */ + /* FT_List_Add */ + /* FT_List_Insert */ + /* FT_List_Find */ + /* FT_List_Remove */ + /* FT_List_Up */ + /* FT_List_Iterate */ + /* FT_List_Iterator */ + /* FT_List_Finalize */ + /* FT_List_Destructor */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_List_Find - * - * @description: - * Find the list node for a given listed object. - * - * @input: - * list :: - * A pointer to the parent list. - * data :: - * The address of the listed object. - * - * @return: - * List node. `NULL` if it wasn't found. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_List_Find */ + /* */ + /* <Description> */ + /* Find the list node for a given listed object. */ + /* */ + /* <Input> */ + /* list :: A pointer to the parent list. */ + /* data :: The address of the listed object. */ + /* */ + /* <Return> */ + /* List node. NULL if it wasn't found. */ + /* */ FT_EXPORT( FT_ListNode ) FT_List_Find( FT_List list, void* data ); - /************************************************************************** - * - * @function: - * FT_List_Add - * - * @description: - * Append an element to the end of a list. - * - * @inout: - * list :: - * A pointer to the parent list. - * node :: - * The node to append. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_List_Add */ + /* */ + /* <Description> */ + /* Append an element to the end of a list. */ + /* */ + /* <InOut> */ + /* list :: A pointer to the parent list. */ + /* node :: The node to append. */ + /* */ FT_EXPORT( void ) FT_List_Add( FT_List list, FT_ListNode node ); - /************************************************************************** - * - * @function: - * FT_List_Insert - * - * @description: - * Insert an element at the head of a list. - * - * @inout: - * list :: - * A pointer to parent list. - * node :: - * The node to insert. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_List_Insert */ + /* */ + /* <Description> */ + /* Insert an element at the head of a list. */ + /* */ + /* <InOut> */ + /* list :: A pointer to parent list. */ + /* node :: The node to insert. */ + /* */ FT_EXPORT( void ) FT_List_Insert( FT_List list, FT_ListNode node ); - /************************************************************************** - * - * @function: - * FT_List_Remove - * - * @description: - * Remove a node from a list. This function doesn't check whether the - * node is in the list! - * - * @input: - * node :: - * The node to remove. - * - * @inout: - * list :: - * A pointer to the parent list. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_List_Remove */ + /* */ + /* <Description> */ + /* Remove a node from a list. This function doesn't check whether */ + /* the node is in the list! */ + /* */ + /* <Input> */ + /* node :: The node to remove. */ + /* */ + /* <InOut> */ + /* list :: A pointer to the parent list. */ + /* */ FT_EXPORT( void ) FT_List_Remove( FT_List list, FT_ListNode node ); - /************************************************************************** - * - * @function: - * FT_List_Up - * - * @description: - * Move a node to the head/top of a list. Used to maintain LRU lists. - * - * @inout: - * list :: - * A pointer to the parent list. - * node :: - * The node to move. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_List_Up */ + /* */ + /* <Description> */ + /* Move a node to the head/top of a list. Used to maintain LRU */ + /* lists. */ + /* */ + /* <InOut> */ + /* list :: A pointer to the parent list. */ + /* node :: The node to move. */ + /* */ FT_EXPORT( void ) FT_List_Up( FT_List list, FT_ListNode node ); - /************************************************************************** - * - * @functype: - * FT_List_Iterator - * - * @description: - * An FT_List iterator function that is called during a list parse by - * @FT_List_Iterate. - * - * @input: - * node :: - * The current iteration list node. - * - * user :: - * A typeless pointer passed to @FT_List_Iterate. Can be used to point - * to the iteration's state. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_List_Iterator */ + /* */ + /* <Description> */ + /* An FT_List iterator function that is called during a list parse */ + /* by @FT_List_Iterate. */ + /* */ + /* <Input> */ + /* node :: The current iteration list node. */ + /* */ + /* user :: A typeless pointer passed to @FT_List_Iterate. */ + /* Can be used to point to the iteration's state. */ + /* */ typedef FT_Error (*FT_List_Iterator)( FT_ListNode node, void* user ); - /************************************************************************** - * - * @function: - * FT_List_Iterate - * - * @description: - * Parse a list and calls a given iterator function on each element. - * Note that parsing is stopped as soon as one of the iterator calls - * returns a non-zero value. - * - * @input: - * list :: - * A handle to the list. - * iterator :: - * An iterator function, called on each node of the list. - * user :: - * A user-supplied field that is passed as the second argument to the - * iterator. - * - * @return: - * The result (a FreeType error code) of the last iterator call. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_List_Iterate */ + /* */ + /* <Description> */ + /* Parse a list and calls a given iterator function on each element. */ + /* Note that parsing is stopped as soon as one of the iterator calls */ + /* returns a non-zero value. */ + /* */ + /* <Input> */ + /* list :: A handle to the list. */ + /* iterator :: An iterator function, called on each node of the list. */ + /* user :: A user-supplied field that is passed as the second */ + /* argument to the iterator. */ + /* */ + /* <Return> */ + /* The result (a FreeType error code) of the last iterator call. */ + /* */ FT_EXPORT( FT_Error ) FT_List_Iterate( FT_List list, FT_List_Iterator iterator, void* user ); - /************************************************************************** - * - * @functype: - * FT_List_Destructor - * - * @description: - * An @FT_List iterator function that is called during a list - * finalization by @FT_List_Finalize to destroy all elements in a given - * list. - * - * @input: - * system :: - * The current system object. - * - * data :: - * The current object to destroy. - * - * user :: - * A typeless pointer passed to @FT_List_Iterate. It can be used to - * point to the iteration's state. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_List_Destructor */ + /* */ + /* <Description> */ + /* An @FT_List iterator function that is called during a list */ + /* finalization by @FT_List_Finalize to destroy all elements in a */ + /* given list. */ + /* */ + /* <Input> */ + /* system :: The current system object. */ + /* */ + /* data :: The current object to destroy. */ + /* */ + /* user :: A typeless pointer passed to @FT_List_Iterate. It can */ + /* be used to point to the iteration's state. */ + /* */ typedef void (*FT_List_Destructor)( FT_Memory memory, void* data, void* user ); - /************************************************************************** - * - * @function: - * FT_List_Finalize - * - * @description: - * Destroy all elements in the list as well as the list itself. - * - * @input: - * list :: - * A handle to the list. - * - * destroy :: - * A list destructor that will be applied to each element of the list. - * Set this to `NULL` if not needed. - * - * memory :: - * The current memory object that handles deallocation. - * - * user :: - * A user-supplied field that is passed as the last argument to the - * destructor. - * - * @note: - * This function expects that all nodes added by @FT_List_Add or - * @FT_List_Insert have been dynamically allocated. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_List_Finalize */ + /* */ + /* <Description> */ + /* Destroy all elements in the list as well as the list itself. */ + /* */ + /* <Input> */ + /* list :: A handle to the list. */ + /* */ + /* destroy :: A list destructor that will be applied to each element */ + /* of the list. Set this to NULL if not needed. */ + /* */ + /* memory :: The current memory object that handles deallocation. */ + /* */ + /* user :: A user-supplied field that is passed as the last */ + /* argument to the destructor. */ + /* */ + /* <Note> */ + /* This function expects that all nodes added by @FT_List_Add or */ + /* @FT_List_Insert have been dynamically allocated. */ + /* */ FT_EXPORT( void ) FT_List_Finalize( FT_List list, FT_List_Destructor destroy, diff --git a/android/x86_64/include/freetype/ftlzw.h b/android/x86_64/include/freetype/ftlzw.h index e3041830..582e2c14 100644 --- a/android/x86_64/include/freetype/ftlzw.h +++ b/android/x86_64/include/freetype/ftlzw.h @@ -1,25 +1,25 @@ -/**************************************************************************** - * - * ftlzw.h - * - * LZW-compressed stream support. - * - * Copyright (C) 2004-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftlzw.h */ +/* */ +/* LZW-compressed stream support. */ +/* */ +/* Copyright 2004-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTLZW_H_ #define FTLZW_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -31,60 +31,59 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * lzw - * - * @title: - * LZW Streams - * - * @abstract: - * Using LZW-compressed font files. - * - * @description: - * This section contains the declaration of LZW-specific functions. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* lzw */ + /* */ + /* <Title> */ + /* LZW Streams */ + /* */ + /* <Abstract> */ + /* Using LZW-compressed font files. */ + /* */ + /* <Description> */ + /* This section contains the declaration of LZW-specific functions. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Stream_OpenLZW - * - * @description: - * Open a new stream to parse LZW-compressed font files. This is mainly - * used to support the compressed `*.pcf.Z` fonts that come with XFree86. - * - * @input: - * stream :: - * The target embedding stream. - * - * source :: - * The source stream. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The source stream must be opened _before_ calling this function. - * - * Calling the internal function `FT_Stream_Close` on the new stream will - * **not** call `FT_Stream_Close` on the source stream. None of the - * stream objects will be released to the heap. - * - * The stream implementation is very basic and resets the decompression - * process each time seeking backwards is needed within the stream - * - * In certain builds of the library, LZW compression recognition is - * automatically handled when calling @FT_New_Face or @FT_Open_Face. - * This means that if no font driver is capable of handling the raw - * compressed file, the library will try to open a LZW stream from it and - * re-open the face with it. - * - * This function may return `FT_Err_Unimplemented_Feature` if your build - * of FreeType was not compiled with LZW support. - */ + /************************************************************************ + * + * @function: + * FT_Stream_OpenLZW + * + * @description: + * Open a new stream to parse LZW-compressed font files. This is + * mainly used to support the compressed `*.pcf.Z' fonts that come + * with XFree86. + * + * @input: + * stream :: The target embedding stream. + * + * source :: The source stream. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * The source stream must be opened _before_ calling this function. + * + * Calling the internal function `FT_Stream_Close' on the new stream will + * *not* call `FT_Stream_Close' on the source stream. None of the stream + * objects will be released to the heap. + * + * The stream implementation is very basic and resets the decompression + * process each time seeking backwards is needed within the stream + * + * In certain builds of the library, LZW compression recognition is + * automatically handled when calling @FT_New_Face or @FT_Open_Face. + * This means that if no font driver is capable of handling the raw + * compressed file, the library will try to open a LZW stream from it + * and re-open the face with it. + * + * This function may return `FT_Err_Unimplemented_Feature' if your build + * of FreeType was not compiled with LZW support. + */ FT_EXPORT( FT_Error ) FT_Stream_OpenLZW( FT_Stream stream, FT_Stream source ); diff --git a/android/x86_64/include/freetype/ftmac.h b/android/x86_64/include/freetype/ftmac.h index 9c1b0832..adb15cad 100644 --- a/android/x86_64/include/freetype/ftmac.h +++ b/android/x86_64/include/freetype/ftmac.h @@ -1,105 +1,101 @@ -/**************************************************************************** - * - * ftmac.h - * - * Additional Mac-specific API. - * - * Copyright (C) 1996-2019 by - * Just van Rossum, David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftmac.h */ +/* */ +/* Additional Mac-specific API. */ +/* */ +/* Copyright 1996-2016 by */ +/* Just van Rossum, David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ -/**************************************************************************** - * - * NOTE: Include this file after `FT_FREETYPE_H` and after any - * Mac-specific headers (because this header uses Mac types such as - * 'Handle', 'FSSpec', 'FSRef', etc.) - * - */ +/***************************************************************************/ +/* */ +/* NOTE: Include this file after FT_FREETYPE_H and after any */ +/* Mac-specific headers (because this header uses Mac types such as */ +/* Handle, FSSpec, FSRef, etc.) */ +/* */ +/***************************************************************************/ #ifndef FTMAC_H_ #define FTMAC_H_ -#include "ft2build.h" +#include <ft2build.h> FT_BEGIN_HEADER - /* gcc-3.1 and later can warn about functions tagged as deprecated */ +/* gcc-3.4.1 and later can warn about functions tagged as deprecated */ #ifndef FT_DEPRECATED_ATTRIBUTE -#if defined( __GNUC__ ) && \ - ( ( __GNUC__ >= 4 ) || \ - ( ( __GNUC__ == 3 ) && ( __GNUC_MINOR__ >= 1 ) ) ) -#define FT_DEPRECATED_ATTRIBUTE __attribute__(( deprecated )) +#if defined(__GNUC__) && \ + ((__GNUC__ >= 4) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))) +#define FT_DEPRECATED_ATTRIBUTE __attribute__((deprecated)) #else #define FT_DEPRECATED_ATTRIBUTE #endif #endif - /************************************************************************** - * - * @section: - * mac_specific - * - * @title: - * Mac Specific Interface - * - * @abstract: - * Only available on the Macintosh. - * - * @description: - * The following definitions are only available if FreeType is compiled - * on a Macintosh. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* mac_specific */ + /* */ + /* <Title> */ + /* Mac Specific Interface */ + /* */ + /* <Abstract> */ + /* Only available on the Macintosh. */ + /* */ + /* <Description> */ + /* The following definitions are only available if FreeType is */ + /* compiled on a Macintosh. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_New_Face_From_FOND - * - * @description: - * Create a new face object from a FOND resource. - * - * @inout: - * library :: - * A handle to the library resource. - * - * @input: - * fond :: - * A FOND resource. - * - * face_index :: - * Only supported for the -1 'sanity check' special case. - * - * @output: - * aface :: - * A handle to a new face object. - * - * @return: - * FreeType error code. 0~means success. - * - * @example: - * This function can be used to create @FT_Face objects from fonts that - * are installed in the system as follows. - * - * ``` - * fond = GetResource( 'FOND', fontName ); - * error = FT_New_Face_From_FOND( library, fond, 0, &face ); - * ``` - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_New_Face_From_FOND */ + /* */ + /* <Description> */ + /* Create a new face object from a FOND resource. */ + /* */ + /* <InOut> */ + /* library :: A handle to the library resource. */ + /* */ + /* <Input> */ + /* fond :: A FOND resource. */ + /* */ + /* face_index :: Only supported for the -1 `sanity check' special */ + /* case. */ + /* */ + /* <Output> */ + /* aface :: A handle to a new face object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Notes> */ + /* This function can be used to create @FT_Face objects from fonts */ + /* that are installed in the system as follows. */ + /* */ + /* { */ + /* fond = GetResource( 'FOND', fontName ); */ + /* error = FT_New_Face_From_FOND( library, fond, 0, &face ); */ + /* } */ + /* */ FT_EXPORT( FT_Error ) FT_New_Face_From_FOND( FT_Library library, Handle fond, @@ -108,28 +104,28 @@ FT_BEGIN_HEADER FT_DEPRECATED_ATTRIBUTE; - /************************************************************************** - * - * @function: - * FT_GetFile_From_Mac_Name - * - * @description: - * Return an FSSpec for the disk file containing the named font. - * - * @input: - * fontName :: - * Mac OS name of the font (e.g., Times New Roman Bold). - * - * @output: - * pathSpec :: - * FSSpec to the file. For passing to @FT_New_Face_From_FSSpec. - * - * face_index :: - * Index of the face. For passing to @FT_New_Face_From_FSSpec. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_GetFile_From_Mac_Name */ + /* */ + /* <Description> */ + /* Return an FSSpec for the disk file containing the named font. */ + /* */ + /* <Input> */ + /* fontName :: Mac OS name of the font (e.g., Times New Roman */ + /* Bold). */ + /* */ + /* <Output> */ + /* pathSpec :: FSSpec to the file. For passing to */ + /* @FT_New_Face_From_FSSpec. */ + /* */ + /* face_index :: Index of the face. For passing to */ + /* @FT_New_Face_From_FSSpec. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_GetFile_From_Mac_Name( const char* fontName, FSSpec* pathSpec, @@ -137,28 +133,27 @@ FT_BEGIN_HEADER FT_DEPRECATED_ATTRIBUTE; - /************************************************************************** - * - * @function: - * FT_GetFile_From_Mac_ATS_Name - * - * @description: - * Return an FSSpec for the disk file containing the named font. - * - * @input: - * fontName :: - * Mac OS name of the font in ATS framework. - * - * @output: - * pathSpec :: - * FSSpec to the file. For passing to @FT_New_Face_From_FSSpec. - * - * face_index :: - * Index of the face. For passing to @FT_New_Face_From_FSSpec. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_GetFile_From_Mac_ATS_Name */ + /* */ + /* <Description> */ + /* Return an FSSpec for the disk file containing the named font. */ + /* */ + /* <Input> */ + /* fontName :: Mac OS name of the font in ATS framework. */ + /* */ + /* <Output> */ + /* pathSpec :: FSSpec to the file. For passing to */ + /* @FT_New_Face_From_FSSpec. */ + /* */ + /* face_index :: Index of the face. For passing to */ + /* @FT_New_Face_From_FSSpec. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_GetFile_From_Mac_ATS_Name( const char* fontName, FSSpec* pathSpec, @@ -166,33 +161,30 @@ FT_BEGIN_HEADER FT_DEPRECATED_ATTRIBUTE; - /************************************************************************** - * - * @function: - * FT_GetFilePath_From_Mac_ATS_Name - * - * @description: - * Return a pathname of the disk file and face index for given font name - * that is handled by ATS framework. - * - * @input: - * fontName :: - * Mac OS name of the font in ATS framework. - * - * @output: - * path :: - * Buffer to store pathname of the file. For passing to @FT_New_Face. - * The client must allocate this buffer before calling this function. - * - * maxPathSize :: - * Lengths of the buffer `path` that client allocated. - * - * face_index :: - * Index of the face. For passing to @FT_New_Face. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_GetFilePath_From_Mac_ATS_Name */ + /* */ + /* <Description> */ + /* Return a pathname of the disk file and face index for given font */ + /* name that is handled by ATS framework. */ + /* */ + /* <Input> */ + /* fontName :: Mac OS name of the font in ATS framework. */ + /* */ + /* <Output> */ + /* path :: Buffer to store pathname of the file. For passing */ + /* to @FT_New_Face. The client must allocate this */ + /* buffer before calling this function. */ + /* */ + /* maxPathSize :: Lengths of the buffer `path' that client allocated. */ + /* */ + /* face_index :: Index of the face. For passing to @FT_New_Face. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_GetFilePath_From_Mac_ATS_Name( const char* fontName, UInt8* path, @@ -201,37 +193,33 @@ FT_BEGIN_HEADER FT_DEPRECATED_ATTRIBUTE; - /************************************************************************** - * - * @function: - * FT_New_Face_From_FSSpec - * - * @description: - * Create a new face object from a given resource and typeface index - * using an FSSpec to the font file. - * - * @inout: - * library :: - * A handle to the library resource. - * - * @input: - * spec :: - * FSSpec to the font file. - * - * face_index :: - * The index of the face within the resource. The first face has - * index~0. - * @output: - * aface :: - * A handle to a new face object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * @FT_New_Face_From_FSSpec is identical to @FT_New_Face except it - * accepts an FSSpec instead of a path. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_New_Face_From_FSSpec */ + /* */ + /* <Description> */ + /* Create a new face object from a given resource and typeface index */ + /* using an FSSpec to the font file. */ + /* */ + /* <InOut> */ + /* library :: A handle to the library resource. */ + /* */ + /* <Input> */ + /* spec :: FSSpec to the font file. */ + /* */ + /* face_index :: The index of the face within the resource. The */ + /* first face has index~0. */ + /* <Output> */ + /* aface :: A handle to a new face object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* @FT_New_Face_From_FSSpec is identical to @FT_New_Face except */ + /* it accepts an FSSpec instead of a path. */ + /* */ FT_EXPORT( FT_Error ) FT_New_Face_From_FSSpec( FT_Library library, const FSSpec *spec, @@ -240,37 +228,33 @@ FT_BEGIN_HEADER FT_DEPRECATED_ATTRIBUTE; - /************************************************************************** - * - * @function: - * FT_New_Face_From_FSRef - * - * @description: - * Create a new face object from a given resource and typeface index - * using an FSRef to the font file. - * - * @inout: - * library :: - * A handle to the library resource. - * - * @input: - * spec :: - * FSRef to the font file. - * - * face_index :: - * The index of the face within the resource. The first face has - * index~0. - * @output: - * aface :: - * A handle to a new face object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * @FT_New_Face_From_FSRef is identical to @FT_New_Face except it accepts - * an FSRef instead of a path. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_New_Face_From_FSRef */ + /* */ + /* <Description> */ + /* Create a new face object from a given resource and typeface index */ + /* using an FSRef to the font file. */ + /* */ + /* <InOut> */ + /* library :: A handle to the library resource. */ + /* */ + /* <Input> */ + /* spec :: FSRef to the font file. */ + /* */ + /* face_index :: The index of the face within the resource. The */ + /* first face has index~0. */ + /* <Output> */ + /* aface :: A handle to a new face object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* @FT_New_Face_From_FSRef is identical to @FT_New_Face except */ + /* it accepts an FSRef instead of a path. */ + /* */ FT_EXPORT( FT_Error ) FT_New_Face_From_FSRef( FT_Library library, const FSRef *ref, diff --git a/android/x86_64/include/freetype/ftmm.h b/android/x86_64/include/freetype/ftmm.h index 417c6dc5..6c05f0c3 100644 --- a/android/x86_64/include/freetype/ftmm.h +++ b/android/x86_64/include/freetype/ftmm.h @@ -1,78 +1,75 @@ -/**************************************************************************** - * - * ftmm.h - * - * FreeType Multiple Master font interface (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftmm.h */ +/* */ +/* FreeType Multiple Master font interface (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTMM_H_ #define FTMM_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_TYPE1_TABLES_H FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * multiple_masters - * - * @title: - * Multiple Masters - * - * @abstract: - * How to manage Multiple Masters fonts. - * - * @description: - * The following types and functions are used to manage Multiple Master - * fonts, i.e., the selection of specific design instances by setting - * design axis coordinates. - * - * Besides Adobe MM fonts, the interface supports Apple's TrueType GX and - * OpenType variation fonts. Some of the routines only work with Adobe - * MM fonts, others will work with all three types. They are similar - * enough that a consistent interface makes sense. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* multiple_masters */ + /* */ + /* <Title> */ + /* Multiple Masters */ + /* */ + /* <Abstract> */ + /* How to manage Multiple Masters fonts. */ + /* */ + /* <Description> */ + /* The following types and functions are used to manage Multiple */ + /* Master fonts, i.e., the selection of specific design instances by */ + /* setting design axis coordinates. */ + /* */ + /* George Williams has extended this interface to make it work with */ + /* both Type~1 Multiple Masters fonts and GX distortable (var) */ + /* fonts. Some of these routines only work with MM fonts, others */ + /* will work with both types. They are similar enough that a */ + /* consistent interface makes sense. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @struct: - * FT_MM_Axis - * - * @description: - * A structure to model a given axis in design space for Multiple Masters - * fonts. - * - * This structure can't be used for TrueType GX or OpenType variation - * fonts. - * - * @fields: - * name :: - * The axis's name. - * - * minimum :: - * The axis's minimum design coordinate. - * - * maximum :: - * The axis's maximum design coordinate. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_MM_Axis */ + /* */ + /* <Description> */ + /* A simple structure used to model a given axis in design space for */ + /* Multiple Masters fonts. */ + /* */ + /* This structure can't be used for GX var fonts. */ + /* */ + /* <Fields> */ + /* name :: The axis's name. */ + /* */ + /* minimum :: The axis's minimum design coordinate. */ + /* */ + /* maximum :: The axis's maximum design coordinate. */ + /* */ typedef struct FT_MM_Axis_ { FT_String* name; @@ -82,29 +79,27 @@ FT_BEGIN_HEADER } FT_MM_Axis; - /************************************************************************** - * - * @struct: - * FT_Multi_Master - * - * @description: - * A structure to model the axes and space of a Multiple Masters font. - * - * This structure can't be used for TrueType GX or OpenType variation - * fonts. - * - * @fields: - * num_axis :: - * Number of axes. Cannot exceed~4. - * - * num_designs :: - * Number of designs; should be normally 2^num_axis even though the - * Type~1 specification strangely allows for intermediate designs to be - * present. This number cannot exceed~16. - * - * axis :: - * A table of axis descriptors. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Multi_Master */ + /* */ + /* <Description> */ + /* A structure used to model the axes and space of a Multiple Masters */ + /* font. */ + /* */ + /* This structure can't be used for GX var fonts. */ + /* */ + /* <Fields> */ + /* num_axis :: Number of axes. Cannot exceed~4. */ + /* */ + /* num_designs :: Number of designs; should be normally 2^num_axis */ + /* even though the Type~1 specification strangely */ + /* allows for intermediate designs to be present. */ + /* This number cannot exceed~16. */ + /* */ + /* axis :: A table of axis descriptors. */ + /* */ typedef struct FT_Multi_Master_ { FT_UInt num_axis; @@ -114,45 +109,34 @@ FT_BEGIN_HEADER } FT_Multi_Master; - /************************************************************************** - * - * @struct: - * FT_Var_Axis - * - * @description: - * A structure to model a given axis in design space for Multiple - * Masters, TrueType GX, and OpenType variation fonts. - * - * @fields: - * name :: - * The axis's name. Not always meaningful for TrueType GX or OpenType - * variation fonts. - * - * minimum :: - * The axis's minimum design coordinate. - * - * def :: - * The axis's default design coordinate. FreeType computes meaningful - * default values for Adobe MM fonts. - * - * maximum :: - * The axis's maximum design coordinate. - * - * tag :: - * The axis's tag (the equivalent to 'name' for TrueType GX and - * OpenType variation fonts). FreeType provides default values for - * Adobe MM fonts if possible. - * - * strid :: - * The axis name entry in the font's 'name' table. This is another - * (and often better) version of the 'name' field for TrueType GX or - * OpenType variation fonts. Not meaningful for Adobe MM fonts. - * - * @note: - * The fields `minimum`, `def`, and `maximum` are 16.16 fractional values - * for TrueType GX and OpenType variation fonts. For Adobe MM fonts, the - * values are integers. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Var_Axis */ + /* */ + /* <Description> */ + /* A simple structure used to model a given axis in design space for */ + /* Multiple Masters and GX var fonts. */ + /* */ + /* <Fields> */ + /* name :: The axis's name. */ + /* Not always meaningful for GX. */ + /* */ + /* minimum :: The axis's minimum design coordinate. */ + /* */ + /* def :: The axis's default design coordinate. */ + /* FreeType computes meaningful default values for MM; it */ + /* is then an integer value, not in 16.16 format. */ + /* */ + /* maximum :: The axis's maximum design coordinate. */ + /* */ + /* tag :: The axis's tag (the GX equivalent to `name'). */ + /* FreeType provides default values for MM if possible. */ + /* */ + /* strid :: The entry in `name' table (another GX version of */ + /* `name'). */ + /* Not meaningful for MM. */ + /* */ typedef struct FT_Var_Axis_ { FT_String* name; @@ -167,79 +151,66 @@ FT_BEGIN_HEADER } FT_Var_Axis; - /************************************************************************** - * - * @struct: - * FT_Var_Named_Style - * - * @description: - * A structure to model a named instance in a TrueType GX or OpenType - * variation font. - * - * This structure can't be used for Adobe MM fonts. - * - * @fields: - * coords :: - * The design coordinates for this instance. This is an array with one - * entry for each axis. - * - * strid :: - * The entry in 'name' table identifying this instance. - * - * psid :: - * The entry in 'name' table identifying a PostScript name for this - * instance. Value 0xFFFF indicates a missing entry. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Var_Named_Style */ + /* */ + /* <Description> */ + /* A simple structure used to model a named style in a GX var font. */ + /* */ + /* This structure can't be used for MM fonts. */ + /* */ + /* <Fields> */ + /* coords :: The design coordinates for this style. */ + /* This is an array with one entry for each axis. */ + /* */ + /* strid :: The entry in `name' table identifying this style. */ + /* */ typedef struct FT_Var_Named_Style_ { FT_Fixed* coords; FT_UInt strid; - FT_UInt psid; /* since 2.7.1 */ } FT_Var_Named_Style; - /************************************************************************** - * - * @struct: - * FT_MM_Var - * - * @description: - * A structure to model the axes and space of an Adobe MM, TrueType GX, - * or OpenType variation font. - * - * Some fields are specific to one format and not to the others. - * - * @fields: - * num_axis :: - * The number of axes. The maximum value is~4 for Adobe MM fonts; no - * limit in TrueType GX or OpenType variation fonts. - * - * num_designs :: - * The number of designs; should be normally 2^num_axis for Adobe MM - * fonts. Not meaningful for TrueType GX or OpenType variation fonts - * (where every glyph could have a different number of designs). - * - * num_namedstyles :: - * The number of named styles; a 'named style' is a tuple of design - * coordinates that has a string ID (in the 'name' table) associated - * with it. The font can tell the user that, for example, - * [Weight=1.5,Width=1.1] is 'Bold'. Another name for 'named style' is - * 'named instance'. - * - * For Adobe Multiple Masters fonts, this value is always zero because - * the format does not support named styles. - * - * axis :: - * An axis descriptor table. TrueType GX and OpenType variation fonts - * contain slightly more data than Adobe MM fonts. Memory management - * of this pointer is done internally by FreeType. - * - * namedstyle :: - * A named style (instance) table. Only meaningful for TrueType GX and - * OpenType variation fonts. Memory management of this pointer is done - * internally by FreeType. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_MM_Var */ + /* */ + /* <Description> */ + /* A structure used to model the axes and space of a Multiple Masters */ + /* or GX var distortable font. */ + /* */ + /* Some fields are specific to one format and not to the other. */ + /* */ + /* <Fields> */ + /* num_axis :: The number of axes. The maximum value is~4 for */ + /* MM; no limit in GX. */ + /* */ + /* num_designs :: The number of designs; should be normally */ + /* 2^num_axis for MM fonts. Not meaningful for GX */ + /* (where every glyph could have a different */ + /* number of designs). */ + /* */ + /* num_namedstyles :: The number of named styles; only meaningful for */ + /* GX that allows certain design coordinates to */ + /* have a string ID (in the `name' table) */ + /* associated with them. The font can tell the */ + /* user that, for example, Weight=1.5 is `Bold'. */ + /* */ + /* axis :: An axis descriptor table. */ + /* GX fonts contain slightly more data than MM. */ + /* Memory management of this pointer is done */ + /* internally by FreeType. */ + /* */ + /* namedstyle :: A named style table. */ + /* Only meaningful with GX. */ + /* Memory management of this pointer is done */ + /* internally by FreeType. */ + /* */ typedef struct FT_MM_Var_ { FT_UInt num_axis; @@ -251,497 +222,157 @@ FT_BEGIN_HEADER } FT_MM_Var; - /************************************************************************** - * - * @function: - * FT_Get_Multi_Master - * - * @description: - * Retrieve a variation descriptor of a given Adobe MM font. - * - * This function can't be used with TrueType GX or OpenType variation - * fonts. - * - * @input: - * face :: - * A handle to the source face. - * - * @output: - * amaster :: - * The Multiple Masters descriptor. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Multi_Master */ + /* */ + /* <Description> */ + /* Retrieve the Multiple Master descriptor of a given font. */ + /* */ + /* This function can't be used with GX fonts. */ + /* */ + /* <Input> */ + /* face :: A handle to the source face. */ + /* */ + /* <Output> */ + /* amaster :: The Multiple Masters descriptor. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Multi_Master( FT_Face face, FT_Multi_Master *amaster ); - /************************************************************************** - * - * @function: - * FT_Get_MM_Var - * - * @description: - * Retrieve a variation descriptor for a given font. - * - * This function works with all supported variation formats. - * - * @input: - * face :: - * A handle to the source face. - * - * @output: - * amaster :: - * The variation descriptor. Allocates a data structure, which the - * user must deallocate with a call to @FT_Done_MM_Var after use. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_MM_Var */ + /* */ + /* <Description> */ + /* Retrieve the Multiple Master/GX var descriptor of a given font. */ + /* */ + /* <Input> */ + /* face :: A handle to the source face. */ + /* */ + /* <Output> */ + /* amaster :: The Multiple Masters/GX var descriptor. */ + /* Allocates a data structure, which the user must */ + /* deallocate with `free' after use. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Get_MM_Var( FT_Face face, FT_MM_Var* *amaster ); - /************************************************************************** - * - * @function: - * FT_Done_MM_Var - * - * @description: - * Free the memory allocated by @FT_Get_MM_Var. - * - * @input: - * library :: - * A handle of the face's parent library object that was used in the - * call to @FT_Get_MM_Var to create `amaster`. - * - * @return: - * FreeType error code. 0~means success. - */ - FT_EXPORT( FT_Error ) - FT_Done_MM_Var( FT_Library library, - FT_MM_Var *amaster ); - - - /************************************************************************** - * - * @function: - * FT_Set_MM_Design_Coordinates - * - * @description: - * For Adobe MM fonts, choose an interpolated font design through design - * coordinates. - * - * This function can't be used with TrueType GX or OpenType variation - * fonts. - * - * @inout: - * face :: - * A handle to the source face. - * - * @input: - * num_coords :: - * The number of available design coordinates. If it is larger than - * the number of axes, ignore the excess values. If it is smaller than - * the number of axes, use default values for the remaining axes. - * - * coords :: - * An array of design coordinates. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * [Since 2.8.1] To reset all axes to the default values, call the - * function with `num_coords` set to zero and `coords` set to `NULL`. - * - * [Since 2.9] If `num_coords` is larger than zero, this function sets - * the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags` field - * (i.e., @FT_IS_VARIATION will return true). If `num_coords` is zero, - * this bit flag gets unset. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Set_MM_Design_Coordinates */ + /* */ + /* <Description> */ + /* For Multiple Masters fonts, choose an interpolated font design */ + /* through design coordinates. */ + /* */ + /* This function can't be used with GX fonts. */ + /* */ + /* <InOut> */ + /* face :: A handle to the source face. */ + /* */ + /* <Input> */ + /* num_coords :: The number of available design coordinates. If it */ + /* is larger than the number of axes, ignore the excess */ + /* values. If it is smaller than the number of axes, */ + /* use default values for the remaining axes. */ + /* */ + /* coords :: An array of design coordinates. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Set_MM_Design_Coordinates( FT_Face face, FT_UInt num_coords, FT_Long* coords ); - /************************************************************************** - * - * @function: - * FT_Set_Var_Design_Coordinates - * - * @description: - * Choose an interpolated font design through design coordinates. - * - * This function works with all supported variation formats. - * - * @inout: - * face :: - * A handle to the source face. - * - * @input: - * num_coords :: - * The number of available design coordinates. If it is larger than - * the number of axes, ignore the excess values. If it is smaller than - * the number of axes, use default values for the remaining axes. - * - * coords :: - * An array of design coordinates. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * [Since 2.8.1] To reset all axes to the default values, call the - * function with `num_coords` set to zero and `coords` set to `NULL`. - * [Since 2.9] 'Default values' means the currently selected named - * instance (or the base font if no named instance is selected). - * - * [Since 2.9] If `num_coords` is larger than zero, this function sets - * the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags` field - * (i.e., @FT_IS_VARIATION will return true). If `num_coords` is zero, - * this bit flag gets unset. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Set_Var_Design_Coordinates */ + /* */ + /* <Description> */ + /* For Multiple Master or GX Var fonts, choose an interpolated font */ + /* design through design coordinates. */ + /* */ + /* <InOut> */ + /* face :: A handle to the source face. */ + /* */ + /* <Input> */ + /* num_coords :: The number of available design coordinates. If it */ + /* is larger than the number of axes, ignore the excess */ + /* values. If it is smaller than the number of axes, */ + /* use default values for the remaining axes. */ + /* */ + /* coords :: An array of design coordinates. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Set_Var_Design_Coordinates( FT_Face face, FT_UInt num_coords, FT_Fixed* coords ); - /************************************************************************** - * - * @function: - * FT_Get_Var_Design_Coordinates - * - * @description: - * Get the design coordinates of the currently selected interpolated - * font. - * - * This function works with all supported variation formats. - * - * @input: - * face :: - * A handle to the source face. - * - * num_coords :: - * The number of design coordinates to retrieve. If it is larger than - * the number of axes, set the excess values to~0. - * - * @output: - * coords :: - * The design coordinates array. - * - * @return: - * FreeType error code. 0~means success. - * - * @since: - * 2.7.1 - */ - FT_EXPORT( FT_Error ) - FT_Get_Var_Design_Coordinates( FT_Face face, - FT_UInt num_coords, - FT_Fixed* coords ); - - - /************************************************************************** - * - * @function: - * FT_Set_MM_Blend_Coordinates - * - * @description: - * Choose an interpolated font design through normalized blend - * coordinates. - * - * This function works with all supported variation formats. - * - * @inout: - * face :: - * A handle to the source face. - * - * @input: - * num_coords :: - * The number of available design coordinates. If it is larger than - * the number of axes, ignore the excess values. If it is smaller than - * the number of axes, use default values for the remaining axes. - * - * coords :: - * The design coordinates array (each element must be between 0 and 1.0 - * for Adobe MM fonts, and between -1.0 and 1.0 for TrueType GX and - * OpenType variation fonts). - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * [Since 2.8.1] To reset all axes to the default values, call the - * function with `num_coords` set to zero and `coords` set to `NULL`. - * [Since 2.9] 'Default values' means the currently selected named - * instance (or the base font if no named instance is selected). - * - * [Since 2.9] If `num_coords` is larger than zero, this function sets - * the @FT_FACE_FLAG_VARIATION bit in @FT_Face's `face_flags` field - * (i.e., @FT_IS_VARIATION will return true). If `num_coords` is zero, - * this bit flag gets unset. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Set_MM_Blend_Coordinates */ + /* */ + /* <Description> */ + /* For Multiple Masters and GX var fonts, choose an interpolated font */ + /* design through normalized blend coordinates. */ + /* */ + /* <InOut> */ + /* face :: A handle to the source face. */ + /* */ + /* <Input> */ + /* num_coords :: The number of available design coordinates. If it */ + /* is larger than the number of axes, ignore the excess */ + /* values. If it is smaller than the number of axes, */ + /* use default values for the remaining axes. */ + /* */ + /* coords :: The design coordinates array (each element must be */ + /* between 0 and 1.0). */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Set_MM_Blend_Coordinates( FT_Face face, FT_UInt num_coords, FT_Fixed* coords ); - /************************************************************************** - * - * @function: - * FT_Get_MM_Blend_Coordinates - * - * @description: - * Get the normalized blend coordinates of the currently selected - * interpolated font. - * - * This function works with all supported variation formats. - * - * @input: - * face :: - * A handle to the source face. - * - * num_coords :: - * The number of normalized blend coordinates to retrieve. If it is - * larger than the number of axes, set the excess values to~0.5 for - * Adobe MM fonts, and to~0 for TrueType GX and OpenType variation - * fonts. - * - * @output: - * coords :: - * The normalized blend coordinates array. - * - * @return: - * FreeType error code. 0~means success. - * - * @since: - * 2.7.1 - */ - FT_EXPORT( FT_Error ) - FT_Get_MM_Blend_Coordinates( FT_Face face, - FT_UInt num_coords, - FT_Fixed* coords ); - - - /************************************************************************** - * - * @function: - * FT_Set_Var_Blend_Coordinates - * - * @description: - * This is another name of @FT_Set_MM_Blend_Coordinates. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Set_Var_Blend_Coordinates */ + /* */ + /* <Description> */ + /* This is another name of @FT_Set_MM_Blend_Coordinates. */ + /* */ FT_EXPORT( FT_Error ) FT_Set_Var_Blend_Coordinates( FT_Face face, FT_UInt num_coords, FT_Fixed* coords ); - - /************************************************************************** - * - * @function: - * FT_Get_Var_Blend_Coordinates - * - * @description: - * This is another name of @FT_Get_MM_Blend_Coordinates. - * - * @since: - * 2.7.1 - */ - FT_EXPORT( FT_Error ) - FT_Get_Var_Blend_Coordinates( FT_Face face, - FT_UInt num_coords, - FT_Fixed* coords ); - - - /************************************************************************** - * - * @function: - * FT_Set_MM_WeightVector - * - * @description: - * For Adobe MM fonts, choose an interpolated font design by directly - * setting the weight vector. - * - * This function can't be used with TrueType GX or OpenType variation - * fonts. - * - * @inout: - * face :: - * A handle to the source face. - * - * @input: - * len :: - * The length of the weight vector array. If it is larger than the - * number of designs, the extra values are ignored. If it is less than - * the number of designs, the remaining values are set to zero. - * - * weightvector :: - * An array representing the weight vector. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * Adobe Multiple Master fonts limit the number of designs, and thus the - * length of the weight vector to~16. - * - * If `len` is zero and `weightvector` is `NULL`, the weight vector array - * is reset to the default values. - * - * The Adobe documentation also states that the values in the - * WeightVector array must total 1.0 +/-~0.001. In practice this does - * not seem to be enforced, so is not enforced here, either. - * - * @since: - * 2.10 - */ - FT_EXPORT( FT_Error ) - FT_Set_MM_WeightVector( FT_Face face, - FT_UInt len, - FT_Fixed* weightvector ); - - - /************************************************************************** - * - * @function: - * FT_Get_MM_WeightVector - * - * @description: - * For Adobe MM fonts, retrieve the current weight vector of the font. - * - * This function can't be used with TrueType GX or OpenType variation - * fonts. - * - * @inout: - * face :: - * A handle to the source face. - * - * len :: - * A pointer to the size of the array to be filled. If the size of the - * array is less than the number of designs, `FT_Err_Invalid_Argument` - * is returned, and `len` is set to the required size (the number of - * designs). If the size of the array is greater than the number of - * designs, the remaining entries are set to~0. On successful - * completion, `len` is set to the number of designs (i.e., the number - * of values written to the array). - * - * @output: - * weightvector :: - * An array to be filled. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * Adobe Multiple Master fonts limit the number of designs, and thus the - * length of the WeightVector to~16. - * - * @since: - * 2.10 - */ - FT_EXPORT( FT_Error ) - FT_Get_MM_WeightVector( FT_Face face, - FT_UInt* len, - FT_Fixed* weightvector ); - - - /************************************************************************** - * - * @enum: - * FT_VAR_AXIS_FLAG_XXX - * - * @description: - * A list of bit flags used in the return value of - * @FT_Get_Var_Axis_Flags. - * - * @values: - * FT_VAR_AXIS_FLAG_HIDDEN :: - * The variation axis should not be exposed to user interfaces. - * - * @since: - * 2.8.1 - */ -#define FT_VAR_AXIS_FLAG_HIDDEN 1 - - - /************************************************************************** - * - * @function: - * FT_Get_Var_Axis_Flags - * - * @description: - * Get the 'flags' field of an OpenType Variation Axis Record. - * - * Not meaningful for Adobe MM fonts (`*flags` is always zero). - * - * @input: - * master :: - * The variation descriptor. - * - * axis_index :: - * The index of the requested variation axis. - * - * @output: - * flags :: - * The 'flags' field. See @FT_VAR_AXIS_FLAG_XXX for possible values. - * - * @return: - * FreeType error code. 0~means success. - * - * @since: - * 2.8.1 - */ - FT_EXPORT( FT_Error ) - FT_Get_Var_Axis_Flags( FT_MM_Var* master, - FT_UInt axis_index, - FT_UInt* flags ); - - - /************************************************************************** - * - * @function: - * FT_Set_Named_Instance - * - * @description: - * Set or change the current named instance. - * - * @input: - * face :: - * A handle to the source face. - * - * instance_index :: - * The index of the requested instance, starting with value 1. If set - * to value 0, FreeType switches to font access without a named - * instance. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The function uses the value of `instance_index` to set bits 16-30 of - * the face's `face_index` field. It also resets any variation applied - * to the font, and the @FT_FACE_FLAG_VARIATION bit of the face's - * `face_flags` field gets reset to zero (i.e., @FT_IS_VARIATION will - * return false). - * - * For Adobe MM fonts (which don't have named instances) this function - * simply resets the current face to the default instance. - * - * @since: - * 2.9 - */ - FT_EXPORT( FT_Error ) - FT_Set_Named_Instance( FT_Face face, - FT_UInt instance_index ); - /* */ diff --git a/android/x86_64/include/freetype/ftmodapi.h b/android/x86_64/include/freetype/ftmodapi.h index dcf7957b..b4d2758e 100644 --- a/android/x86_64/include/freetype/ftmodapi.h +++ b/android/x86_64/include/freetype/ftmodapi.h @@ -1,26 +1,26 @@ -/**************************************************************************** - * - * ftmodapi.h - * - * FreeType modules public interface (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftmodapi.h */ +/* */ +/* FreeType modules public interface (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTMODAPI_H_ #define FTMODAPI_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -33,77 +33,76 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * module_management - * - * @title: - * Module Management - * - * @abstract: - * How to add, upgrade, remove, and control modules from FreeType. - * - * @description: - * The definitions below are used to manage modules within FreeType. - * Modules can be added, upgraded, and removed at runtime. Additionally, - * some module properties can be controlled also. - * - * Here is a list of possible values of the `module_name` field in the - * @FT_Module_Class structure. - * - * ``` - * autofitter - * bdf - * cff - * gxvalid - * otvalid - * pcf - * pfr - * psaux - * pshinter - * psnames - * raster1 - * sfnt - * smooth, smooth-lcd, smooth-lcdv - * truetype - * type1 - * type42 - * t1cid - * winfonts - * ``` - * - * Note that the FreeType Cache sub-system is not a FreeType module. - * - * @order: - * FT_Module - * FT_Module_Constructor - * FT_Module_Destructor - * FT_Module_Requester - * FT_Module_Class - * - * FT_Add_Module - * FT_Get_Module - * FT_Remove_Module - * FT_Add_Default_Modules - * - * FT_Property_Set - * FT_Property_Get - * FT_Set_Default_Properties - * - * FT_New_Library - * FT_Done_Library - * FT_Reference_Library - * - * FT_Renderer - * FT_Renderer_Class - * - * FT_Get_Renderer - * FT_Set_Renderer - * - * FT_Set_Debug_Hook - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* module_management */ + /* */ + /* <Title> */ + /* Module Management */ + /* */ + /* <Abstract> */ + /* How to add, upgrade, remove, and control modules from FreeType. */ + /* */ + /* <Description> */ + /* The definitions below are used to manage modules within FreeType. */ + /* Modules can be added, upgraded, and removed at runtime. */ + /* Additionally, some module properties can be controlled also. */ + /* */ + /* Here is a list of possible values of the `module_name' field in */ + /* the @FT_Module_Class structure. */ + /* */ + /* { */ + /* autofitter */ + /* bdf */ + /* cff */ + /* gxvalid */ + /* otvalid */ + /* pcf */ + /* pfr */ + /* psaux */ + /* pshinter */ + /* psnames */ + /* raster1 */ + /* sfnt */ + /* smooth, smooth-lcd, smooth-lcdv */ + /* truetype */ + /* type1 */ + /* type42 */ + /* t1cid */ + /* winfonts */ + /* } */ + /* */ + /* Note that the FreeType Cache sub-system is not a FreeType module. */ + /* */ + /* <Order> */ + /* FT_Module */ + /* FT_Module_Constructor */ + /* FT_Module_Destructor */ + /* FT_Module_Requester */ + /* FT_Module_Class */ + /* */ + /* FT_Add_Module */ + /* FT_Get_Module */ + /* FT_Remove_Module */ + /* FT_Add_Default_Modules */ + /* */ + /* FT_Property_Set */ + /* FT_Property_Get */ + /* */ + /* FT_New_Library */ + /* FT_Done_Library */ + /* FT_Reference_Library */ + /* */ + /* FT_Renderer */ + /* FT_Renderer_Class */ + /* */ + /* FT_Get_Renderer */ + /* FT_Set_Renderer */ + /* */ + /* FT_Set_Debug_Hook */ + /* */ + /*************************************************************************/ /* module bit flags */ @@ -137,99 +136,83 @@ FT_BEGIN_HEADER typedef FT_Pointer FT_Module_Interface; - /************************************************************************** - * - * @functype: - * FT_Module_Constructor - * - * @description: - * A function used to initialize (not create) a new module object. - * - * @input: - * module :: - * The module to initialize. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Module_Constructor */ + /* */ + /* <Description> */ + /* A function used to initialize (not create) a new module object. */ + /* */ + /* <Input> */ + /* module :: The module to initialize. */ + /* */ typedef FT_Error (*FT_Module_Constructor)( FT_Module module ); - /************************************************************************** - * - * @functype: - * FT_Module_Destructor - * - * @description: - * A function used to finalize (not destroy) a given module object. - * - * @input: - * module :: - * The module to finalize. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Module_Destructor */ + /* */ + /* <Description> */ + /* A function used to finalize (not destroy) a given module object. */ + /* */ + /* <Input> */ + /* module :: The module to finalize. */ + /* */ typedef void (*FT_Module_Destructor)( FT_Module module ); - /************************************************************************** - * - * @functype: - * FT_Module_Requester - * - * @description: - * A function used to query a given module for a specific interface. - * - * @input: - * module :: - * The module to be searched. - * - * name :: - * The name of the interface in the module. - */ + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Module_Requester */ + /* */ + /* <Description> */ + /* A function used to query a given module for a specific interface. */ + /* */ + /* <Input> */ + /* module :: The module to be searched. */ + /* */ + /* name :: The name of the interface in the module. */ + /* */ typedef FT_Module_Interface (*FT_Module_Requester)( FT_Module module, const char* name ); - /************************************************************************** - * - * @struct: - * FT_Module_Class - * - * @description: - * The module class descriptor. While being a public structure necessary - * for FreeType's module bookkeeping, most of the fields are essentially - * internal, not to be used directly by an application. - * - * @fields: - * module_flags :: - * Bit flags describing the module. - * - * module_size :: - * The size of one module object/instance in bytes. - * - * module_name :: - * The name of the module. - * - * module_version :: - * The version, as a 16.16 fixed number (major.minor). - * - * module_requires :: - * The version of FreeType this module requires, as a 16.16 fixed - * number (major.minor). Starts at version 2.0, i.e., 0x20000. - * - * module_interface :: - * A typeless pointer to a structure (which varies between different - * modules) that holds the module's interface functions. This is - * essentially what `get_interface` returns. - * - * module_init :: - * The initializing function. - * - * module_done :: - * The finalizing function. - * - * get_interface :: - * The interface requesting function. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Module_Class */ + /* */ + /* <Description> */ + /* The module class descriptor. */ + /* */ + /* <Fields> */ + /* module_flags :: Bit flags describing the module. */ + /* */ + /* module_size :: The size of one module object/instance in */ + /* bytes. */ + /* */ + /* module_name :: The name of the module. */ + /* */ + /* module_version :: The version, as a 16.16 fixed number */ + /* (major.minor). */ + /* */ + /* module_requires :: The version of FreeType this module requires, */ + /* as a 16.16 fixed number (major.minor). Starts */ + /* at version 2.0, i.e., 0x20000. */ + /* */ + /* module_init :: The initializing function. */ + /* */ + /* module_done :: The finalizing function. */ + /* */ + /* get_interface :: The interface requesting function. */ + /* */ typedef struct FT_Module_Class_ { FT_ULong module_flags; @@ -247,89 +230,83 @@ FT_BEGIN_HEADER } FT_Module_Class; - /************************************************************************** - * - * @function: - * FT_Add_Module - * - * @description: - * Add a new module to a given library instance. - * - * @inout: - * library :: - * A handle to the library object. - * - * @input: - * clazz :: - * A pointer to class descriptor for the module. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * An error will be returned if a module already exists by that name, or - * if the module requires a version of FreeType that is too great. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Add_Module */ + /* */ + /* <Description> */ + /* Add a new module to a given library instance. */ + /* */ + /* <InOut> */ + /* library :: A handle to the library object. */ + /* */ + /* <Input> */ + /* clazz :: A pointer to class descriptor for the module. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* An error will be returned if a module already exists by that name, */ + /* or if the module requires a version of FreeType that is too great. */ + /* */ FT_EXPORT( FT_Error ) FT_Add_Module( FT_Library library, const FT_Module_Class* clazz ); - /************************************************************************** - * - * @function: - * FT_Get_Module - * - * @description: - * Find a module by its name. - * - * @input: - * library :: - * A handle to the library object. - * - * module_name :: - * The module's name (as an ASCII string). - * - * @return: - * A module handle. 0~if none was found. - * - * @note: - * FreeType's internal modules aren't documented very well, and you - * should look up the source code for details. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Module */ + /* */ + /* <Description> */ + /* Find a module by its name. */ + /* */ + /* <Input> */ + /* library :: A handle to the library object. */ + /* */ + /* module_name :: The module's name (as an ASCII string). */ + /* */ + /* <Return> */ + /* A module handle. 0~if none was found. */ + /* */ + /* <Note> */ + /* FreeType's internal modules aren't documented very well, and you */ + /* should look up the source code for details. */ + /* */ FT_EXPORT( FT_Module ) FT_Get_Module( FT_Library library, const char* module_name ); - /************************************************************************** - * - * @function: - * FT_Remove_Module - * - * @description: - * Remove a given module from a library instance. - * - * @inout: - * library :: - * A handle to a library object. - * - * @input: - * module :: - * A handle to a module object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The module object is destroyed by the function in case of success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Remove_Module */ + /* */ + /* <Description> */ + /* Remove a given module from a library instance. */ + /* */ + /* <InOut> */ + /* library :: A handle to a library object. */ + /* */ + /* <Input> */ + /* module :: A handle to a module object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The module object is destroyed by the function in case of success. */ + /* */ FT_EXPORT( FT_Error ) FT_Remove_Module( FT_Library library, FT_Module module ); - /************************************************************************** + /********************************************************************** * * @function: * FT_Property_Set @@ -339,51 +316,54 @@ FT_BEGIN_HEADER * * @input: * library :: - * A handle to the library the module is part of. + * A handle to the library the module is part of. * * module_name :: - * The module name. + * The module name. * * property_name :: - * The property name. Properties are described in section - * @properties. + * The property name. Properties are described in the `Synopsis' + * subsection of the module's documentation. * - * Note that only a few modules have properties. + * Note that only a few modules have properties. * * value :: - * A generic pointer to a variable or structure that gives the new - * value of the property. The exact definition of `value` is - * dependent on the property; see section @properties. + * A generic pointer to a variable or structure that gives the new + * value of the property. The exact definition of `value' is + * dependent on the property; see the `Synopsis' subsection of the + * module's documentation. * * @return: * FreeType error code. 0~means success. * * @note: - * If `module_name` isn't a valid module name, or `property_name` - * doesn't specify a valid property, or if `value` doesn't represent a + * If `module_name' isn't a valid module name, or `property_name' + * doesn't specify a valid property, or if `value' doesn't represent a * valid value for the given property, an error is returned. * - * The following example sets property 'bar' (a simple integer) in - * module 'foo' to value~1. + * The following example sets property `bar' (a simple integer) in + * module `foo' to value~1. * - * ``` + * { * FT_UInt bar; * * * bar = 1; * FT_Property_Set( library, "foo", "bar", &bar ); - * ``` + * } * * Note that the FreeType Cache sub-system doesn't recognize module * property changes. To avoid glyph lookup confusion within the cache - * you should call @FTC_Manager_Reset to completely flush the cache if a - * module property gets changed after @FTC_Manager_New has been called. + * you should call @FTC_Manager_Reset to completely flush the cache if + * a module property gets changed after @FTC_Manager_New has been + * called. * - * It is not possible to set properties of the FreeType Cache sub-system - * itself with FT_Property_Set; use @FTC_Property_Set instead. + * It is not possible to set properties of the FreeType Cache + * sub-system itself with FT_Property_Set; use @FTC_Property_Set + * instead. * - * @since: - * 2.4.11 + * @since: + * 2.4.11 * */ FT_EXPORT( FT_Error ) @@ -393,7 +373,7 @@ FT_BEGIN_HEADER const void* value ); - /************************************************************************** + /********************************************************************** * * @function: * FT_Property_Get @@ -403,32 +383,33 @@ FT_BEGIN_HEADER * * @input: * library :: - * A handle to the library the module is part of. + * A handle to the library the module is part of. * * module_name :: - * The module name. + * The module name. * * property_name :: - * The property name. Properties are described in section - * @properties. + * The property name. Properties are described in the `Synopsis' + * subsection of the module's documentation. * * @inout: * value :: - * A generic pointer to a variable or structure that gives the value - * of the property. The exact definition of `value` is dependent on - * the property; see section @properties. + * A generic pointer to a variable or structure that gives the + * value of the property. The exact definition of `value' is + * dependent on the property; see the `Synopsis' subsection of the + * module's documentation. * * @return: * FreeType error code. 0~means success. * * @note: - * If `module_name` isn't a valid module name, or `property_name` - * doesn't specify a valid property, or if `value` doesn't represent a + * If `module_name' isn't a valid module name, or `property_name' + * doesn't specify a valid property, or if `value' doesn't represent a * valid value for the given property, an error is returned. * - * The following example gets property 'baz' (a range) in module 'foo'. + * The following example gets property `baz' (a range) in module `foo'. * - * ``` + * { * typedef range_ * { * FT_Int32 min; @@ -440,13 +421,13 @@ FT_BEGIN_HEADER * * * FT_Property_Get( library, "foo", "baz", &baz ); - * ``` + * } * * It is not possible to retrieve properties of the FreeType Cache * sub-system with FT_Property_Get; use @FTC_Property_Get instead. * - * @since: - * 2.4.11 + * @since: + * 2.4.11 * */ FT_EXPORT( FT_Error ) @@ -456,243 +437,144 @@ FT_BEGIN_HEADER void* value ); - /************************************************************************** - * - * @function: - * FT_Set_Default_Properties - * - * @description: - * If compilation option `FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES` is - * set, this function reads the `FREETYPE_PROPERTIES` environment - * variable to control driver properties. See section @properties for - * more. - * - * If the compilation option is not set, this function does nothing. - * - * `FREETYPE_PROPERTIES` has the following syntax form (broken here into - * multiple lines for better readability). - * - * ``` - * <optional whitespace> - * <module-name1> ':' - * <property-name1> '=' <property-value1> - * <whitespace> - * <module-name2> ':' - * <property-name2> '=' <property-value2> - * ... - * ``` - * - * Example: - * - * ``` - * FREETYPE_PROPERTIES=truetype:interpreter-version=35 \ - * cff:no-stem-darkening=1 \ - * autofitter:warping=1 - * ``` - * - * @inout: - * library :: - * A handle to a new library object. - * - * @since: - * 2.8 - */ - FT_EXPORT( void ) - FT_Set_Default_Properties( FT_Library library ); - - - /************************************************************************** - * - * @function: - * FT_Reference_Library - * - * @description: - * A counter gets initialized to~1 at the time an @FT_Library structure - * is created. This function increments the counter. @FT_Done_Library - * then only destroys a library if the counter is~1, otherwise it simply - * decrements the counter. - * - * This function helps in managing life-cycles of structures that - * reference @FT_Library objects. - * - * @input: - * library :: - * A handle to a target library object. - * - * @return: - * FreeType error code. 0~means success. - * - * @since: - * 2.4.2 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Reference_Library */ + /* */ + /* <Description> */ + /* A counter gets initialized to~1 at the time an @FT_Library */ + /* structure is created. This function increments the counter. */ + /* @FT_Done_Library then only destroys a library if the counter is~1, */ + /* otherwise it simply decrements the counter. */ + /* */ + /* This function helps in managing life-cycles of structures that */ + /* reference @FT_Library objects. */ + /* */ + /* <Input> */ + /* library :: A handle to a target library object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Since> */ + /* 2.4.2 */ + /* */ FT_EXPORT( FT_Error ) FT_Reference_Library( FT_Library library ); - /************************************************************************** - * - * @function: - * FT_New_Library - * - * @description: - * This function is used to create a new FreeType library instance from a - * given memory object. It is thus possible to use libraries with - * distinct memory allocators within the same program. Note, however, - * that the used @FT_Memory structure is expected to remain valid for the - * life of the @FT_Library object. - * - * Normally, you would call this function (followed by a call to - * @FT_Add_Default_Modules or a series of calls to @FT_Add_Module, and a - * call to @FT_Set_Default_Properties) instead of @FT_Init_FreeType to - * initialize the FreeType library. - * - * Don't use @FT_Done_FreeType but @FT_Done_Library to destroy a library - * instance. - * - * @input: - * memory :: - * A handle to the original memory object. - * - * @output: - * alibrary :: - * A pointer to handle of a new library object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * See the discussion of reference counters in the description of - * @FT_Reference_Library. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_New_Library */ + /* */ + /* <Description> */ + /* This function is used to create a new FreeType library instance */ + /* from a given memory object. It is thus possible to use libraries */ + /* with distinct memory allocators within the same program. Note, */ + /* however, that the used @FT_Memory structure is expected to remain */ + /* valid for the life of the @FT_Library object. */ + /* */ + /* Normally, you would call this function (followed by a call to */ + /* @FT_Add_Default_Modules or a series of calls to @FT_Add_Module) */ + /* instead of @FT_Init_FreeType to initialize the FreeType library. */ + /* */ + /* Don't use @FT_Done_FreeType but @FT_Done_Library to destroy a */ + /* library instance. */ + /* */ + /* <Input> */ + /* memory :: A handle to the original memory object. */ + /* */ + /* <Output> */ + /* alibrary :: A pointer to handle of a new library object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* See the discussion of reference counters in the description of */ + /* @FT_Reference_Library. */ + /* */ FT_EXPORT( FT_Error ) FT_New_Library( FT_Memory memory, FT_Library *alibrary ); - /************************************************************************** - * - * @function: - * FT_Done_Library - * - * @description: - * Discard a given library object. This closes all drivers and discards - * all resource objects. - * - * @input: - * library :: - * A handle to the target library. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * See the discussion of reference counters in the description of - * @FT_Reference_Library. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Done_Library */ + /* */ + /* <Description> */ + /* Discard a given library object. This closes all drivers and */ + /* discards all resource objects. */ + /* */ + /* <Input> */ + /* library :: A handle to the target library. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* See the discussion of reference counters in the description of */ + /* @FT_Reference_Library. */ + /* */ FT_EXPORT( FT_Error ) FT_Done_Library( FT_Library library ); + /* */ - /************************************************************************** - * - * @functype: - * FT_DebugHook_Func - * - * @description: - * A drop-in replacement (or rather a wrapper) for the bytecode or - * charstring interpreter's main loop function. - * - * Its job is essentially - * - * - to activate debug mode to enforce single-stepping, - * - * - to call the main loop function to interpret the next opcode, and - * - * - to show the changed context to the user. - * - * An example for such a main loop function is `TT_RunIns` (declared in - * FreeType's internal header file `src/truetype/ttinterp.h`). - * - * Have a look at the source code of the `ttdebug` FreeType demo program - * for an example of a drop-in replacement. - * - * @inout: - * arg :: - * A typeless pointer, to be cast to the main loop function's data - * structure (which depends on the font module). For TrueType fonts - * it is bytecode interpreter's execution context, `TT_ExecContext`, - * which is declared in FreeType's internal header file `tttypes.h`. - */ typedef void (*FT_DebugHook_Func)( void* arg ); - /************************************************************************** - * - * @enum: - * FT_DEBUG_HOOK_XXX - * - * @description: - * A list of named debug hook indices. - * - * @values: - * FT_DEBUG_HOOK_TRUETYPE:: - * This hook index identifies the TrueType bytecode debugger. - */ -#define FT_DEBUG_HOOK_TRUETYPE 0 - - - /************************************************************************** - * - * @function: - * FT_Set_Debug_Hook - * - * @description: - * Set a debug hook function for debugging the interpreter of a font - * format. - * - * While this is a public API function, an application needs access to - * FreeType's internal header files to do something useful. - * - * Have a look at the source code of the `ttdebug` FreeType demo program - * for an example of its usage. - * - * @inout: - * library :: - * A handle to the library object. - * - * @input: - * hook_index :: - * The index of the debug hook. You should use defined enumeration - * macros like @FT_DEBUG_HOOK_TRUETYPE. - * - * debug_hook :: - * The function used to debug the interpreter. - * - * @note: - * Currently, four debug hook slots are available, but only one (for the - * TrueType interpreter) is defined. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Set_Debug_Hook */ + /* */ + /* <Description> */ + /* Set a debug hook function for debugging the interpreter of a font */ + /* format. */ + /* */ + /* <InOut> */ + /* library :: A handle to the library object. */ + /* */ + /* <Input> */ + /* hook_index :: The index of the debug hook. You should use the */ + /* values defined in `ftobjs.h', e.g., */ + /* `FT_DEBUG_HOOK_TRUETYPE'. */ + /* */ + /* debug_hook :: The function used to debug the interpreter. */ + /* */ + /* <Note> */ + /* Currently, four debug hook slots are available, but only two (for */ + /* the TrueType and the Type~1 interpreter) are defined. */ + /* */ + /* Since the internal headers of FreeType are no longer installed, */ + /* the symbol `FT_DEBUG_HOOK_TRUETYPE' isn't available publicly. */ + /* This is a bug and will be fixed in a forthcoming release. */ + /* */ FT_EXPORT( void ) FT_Set_Debug_Hook( FT_Library library, FT_UInt hook_index, FT_DebugHook_Func debug_hook ); - /************************************************************************** - * - * @function: - * FT_Add_Default_Modules - * - * @description: - * Add the set of default drivers to a given library object. This is - * only useful when you create a library object with @FT_New_Library - * (usually to plug a custom memory manager). - * - * @inout: - * library :: - * A handle to a new library object. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Add_Default_Modules */ + /* */ + /* <Description> */ + /* Add the set of default drivers to a given library object. */ + /* This is only useful when you create a library object with */ + /* @FT_New_Library (usually to plug a custom memory manager). */ + /* */ + /* <InOut> */ + /* library :: A handle to a new library object. */ + /* */ FT_EXPORT( void ) FT_Add_Default_Modules( FT_Library library ); @@ -718,28 +600,28 @@ FT_BEGIN_HEADER /************************************************************************** * - * @enum: - * FT_TrueTypeEngineType + * @enum: + * FT_TrueTypeEngineType * - * @description: - * A list of values describing which kind of TrueType bytecode engine is - * implemented in a given FT_Library instance. It is used by the - * @FT_Get_TrueType_Engine_Type function. + * @description: + * A list of values describing which kind of TrueType bytecode + * engine is implemented in a given FT_Library instance. It is used + * by the @FT_Get_TrueType_Engine_Type function. * - * @values: - * FT_TRUETYPE_ENGINE_TYPE_NONE :: - * The library doesn't implement any kind of bytecode interpreter. + * @values: + * FT_TRUETYPE_ENGINE_TYPE_NONE :: + * The library doesn't implement any kind of bytecode interpreter. * - * FT_TRUETYPE_ENGINE_TYPE_UNPATENTED :: - * Deprecated and removed. + * FT_TRUETYPE_ENGINE_TYPE_UNPATENTED :: + * Deprecated and removed. * - * FT_TRUETYPE_ENGINE_TYPE_PATENTED :: - * The library implements a bytecode interpreter that covers the full - * instruction set of the TrueType virtual machine (this was governed - * by patents until May 2010, hence the name). + * FT_TRUETYPE_ENGINE_TYPE_PATENTED :: + * The library implements a bytecode interpreter that covers + * the full instruction set of the TrueType virtual machine (this + * was governed by patents until May 2010, hence the name). * - * @since: - * 2.2 + * @since: + * 2.2 * */ typedef enum FT_TrueTypeEngineType_ @@ -753,22 +635,22 @@ FT_BEGIN_HEADER /************************************************************************** * - * @function: - * FT_Get_TrueType_Engine_Type + * @func: + * FT_Get_TrueType_Engine_Type * - * @description: - * Return an @FT_TrueTypeEngineType value to indicate which level of the - * TrueType virtual machine a given library instance supports. + * @description: + * Return an @FT_TrueTypeEngineType value to indicate which level of + * the TrueType virtual machine a given library instance supports. * - * @input: - * library :: - * A library instance. + * @input: + * library :: + * A library instance. * - * @return: - * A value indicating which level is supported. + * @return: + * A value indicating which level is supported. * - * @since: - * 2.2 + * @since: + * 2.2 * */ FT_EXPORT( FT_TrueTypeEngineType ) diff --git a/android/x86_64/include/freetype/ftmoderr.h b/android/x86_64/include/freetype/ftmoderr.h index e1699357..2a7671c8 100644 --- a/android/x86_64/include/freetype/ftmoderr.h +++ b/android/x86_64/include/freetype/ftmoderr.h @@ -1,103 +1,94 @@ -/**************************************************************************** - * - * ftmoderr.h - * - * FreeType module error offsets (specification). - * - * Copyright (C) 2001-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftmoderr.h */ +/* */ +/* FreeType module error offsets (specification). */ +/* */ +/* Copyright 2001-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * This file is used to define the FreeType module error codes. - * - * If the macro `FT_CONFIG_OPTION_USE_MODULE_ERRORS` in `ftoption.h` is - * set, the lower byte of an error value identifies the error code as - * usual. In addition, the higher byte identifies the module. For - * example, the error `FT_Err_Invalid_File_Format` has value 0x0003, the - * error `TT_Err_Invalid_File_Format` has value 0x1303, the error - * `T1_Err_Invalid_File_Format` has value 0x1403, etc. - * - * Note that `FT_Err_Ok`, `TT_Err_Ok`, etc. are always equal to zero, - * including the high byte. - * - * If `FT_CONFIG_OPTION_USE_MODULE_ERRORS` isn't set, the higher byte of an - * error value is set to zero. - * - * To hide the various `XXX_Err_` prefixes in the source code, FreeType - * provides some macros in `fttypes.h`. - * - * FT_ERR( err ) - * - * Add current error module prefix (as defined with the `FT_ERR_PREFIX` - * macro) to `err`. For example, in the BDF module the line - * - * ``` - * error = FT_ERR( Invalid_Outline ); - * ``` - * - * expands to - * - * ``` - * error = BDF_Err_Invalid_Outline; - * ``` - * - * For simplicity, you can always use `FT_Err_Ok` directly instead of - * `FT_ERR( Ok )`. - * - * FT_ERR_EQ( errcode, err ) - * FT_ERR_NEQ( errcode, err ) - * - * Compare error code `errcode` with the error `err` for equality and - * inequality, respectively. Example: - * - * ``` - * if ( FT_ERR_EQ( error, Invalid_Outline ) ) - * ... - * ``` - * - * Using this macro you don't have to think about error prefixes. Of - * course, if module errors are not active, the above example is the - * same as - * - * ``` - * if ( error == FT_Err_Invalid_Outline ) - * ... - * ``` - * - * FT_ERROR_BASE( errcode ) - * FT_ERROR_MODULE( errcode ) - * - * Get base error and module error code, respectively. - * - * It can also be used to create a module error message table easily with - * something like - * - * ``` - * #undef FTMODERR_H_ - * #define FT_MODERRDEF( e, v, s ) { FT_Mod_Err_ ## e, s }, - * #define FT_MODERR_START_LIST { - * #define FT_MODERR_END_LIST { 0, 0 } }; - * - * const struct - * { - * int mod_err_offset; - * const char* mod_err_msg - * } ft_mod_errors[] = - * - * #include FT_MODULE_ERRORS_H - * ``` - * - */ + /*************************************************************************/ + /* */ + /* This file is used to define the FreeType module error codes. */ + /* */ + /* If the macro FT_CONFIG_OPTION_USE_MODULE_ERRORS in `ftoption.h' is */ + /* set, the lower byte of an error value identifies the error code as */ + /* usual. In addition, the higher byte identifies the module. For */ + /* example, the error `FT_Err_Invalid_File_Format' has value 0x0003, the */ + /* error `TT_Err_Invalid_File_Format' has value 0x1303, the error */ + /* `T1_Err_Invalid_File_Format' has value 0x1403, etc. */ + /* */ + /* Note that `FT_Err_Ok', `TT_Err_Ok', etc. are always equal to zero, */ + /* including the high byte. */ + /* */ + /* If FT_CONFIG_OPTION_USE_MODULE_ERRORS isn't set, the higher byte of */ + /* an error value is set to zero. */ + /* */ + /* To hide the various `XXX_Err_' prefixes in the source code, FreeType */ + /* provides some macros in `fttypes.h'. */ + /* */ + /* FT_ERR( err ) */ + /* Add current error module prefix (as defined with the */ + /* `FT_ERR_PREFIX' macro) to `err'. For example, in the BDF module */ + /* the line */ + /* */ + /* error = FT_ERR( Invalid_Outline ); */ + /* */ + /* expands to */ + /* */ + /* error = BDF_Err_Invalid_Outline; */ + /* */ + /* For simplicity, you can always use `FT_Err_Ok' directly instead */ + /* of `FT_ERR( Ok )'. */ + /* */ + /* FT_ERR_EQ( errcode, err ) */ + /* FT_ERR_NEQ( errcode, err ) */ + /* Compare error code `errcode' with the error `err' for equality */ + /* and inequality, respectively. Example: */ + /* */ + /* if ( FT_ERR_EQ( error, Invalid_Outline ) ) */ + /* ... */ + /* */ + /* Using this macro you don't have to think about error prefixes. */ + /* Of course, if module errors are not active, the above example is */ + /* the same as */ + /* */ + /* if ( error == FT_Err_Invalid_Outline ) */ + /* ... */ + /* */ + /* FT_ERROR_BASE( errcode ) */ + /* FT_ERROR_MODULE( errcode ) */ + /* Get base error and module error code, respectively. */ + /* */ + /* */ + /* It can also be used to create a module error message table easily */ + /* with something like */ + /* */ + /* { */ + /* #undef FTMODERR_H_ */ + /* #define FT_MODERRDEF( e, v, s ) { FT_Mod_Err_ ## e, s }, */ + /* #define FT_MODERR_START_LIST { */ + /* #define FT_MODERR_END_LIST { 0, 0 } }; */ + /* */ + /* const struct */ + /* { */ + /* int mod_err_offset; */ + /* const char* mod_err_msg */ + /* } ft_mod_errors[] = */ + /* */ + /* #include FT_MODULE_ERRORS_H */ + /* } */ + /* */ + /*************************************************************************/ #ifndef FTMODERR_H_ diff --git a/android/x86_64/include/freetype/ftotval.h b/android/x86_64/include/freetype/ftotval.h index 0fb2a118..c678ef34 100644 --- a/android/x86_64/include/freetype/ftotval.h +++ b/android/x86_64/include/freetype/ftotval.h @@ -1,36 +1,36 @@ -/**************************************************************************** - * - * ftotval.h - * - * FreeType API for validating OpenType tables (specification). - * - * Copyright (C) 2004-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftotval.h */ +/* */ +/* FreeType API for validating OpenType tables (specification). */ +/* */ +/* Copyright 2004-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ -/**************************************************************************** - * - * - * Warning: This module might be moved to a different library in the - * future to avoid a tight dependency between FreeType and the - * OpenType specification. - * - * - */ +/***************************************************************************/ +/* */ +/* */ +/* Warning: This module might be moved to a different library in the */ +/* future to avoid a tight dependency between FreeType and the */ +/* OpenType specification. */ +/* */ +/* */ +/***************************************************************************/ #ifndef FTOTVAL_H_ #define FTOTVAL_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -43,62 +43,62 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * ot_validation - * - * @title: - * OpenType Validation - * - * @abstract: - * An API to validate OpenType tables. - * - * @description: - * This section contains the declaration of functions to validate some - * OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH). - * - * @order: - * FT_OpenType_Validate - * FT_OpenType_Free - * - * FT_VALIDATE_OTXXX - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* ot_validation */ + /* */ + /* <Title> */ + /* OpenType Validation */ + /* */ + /* <Abstract> */ + /* An API to validate OpenType tables. */ + /* */ + /* <Description> */ + /* This section contains the declaration of functions to validate */ + /* some OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH). */ + /* */ + /* <Order> */ + /* FT_OpenType_Validate */ + /* FT_OpenType_Free */ + /* */ + /* FT_VALIDATE_OTXXX */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @enum: - * FT_VALIDATE_OTXXX - * - * @description: - * A list of bit-field constants used with @FT_OpenType_Validate to - * indicate which OpenType tables should be validated. - * - * @values: - * FT_VALIDATE_BASE :: - * Validate BASE table. - * - * FT_VALIDATE_GDEF :: - * Validate GDEF table. - * - * FT_VALIDATE_GPOS :: - * Validate GPOS table. - * - * FT_VALIDATE_GSUB :: - * Validate GSUB table. - * - * FT_VALIDATE_JSTF :: - * Validate JSTF table. - * - * FT_VALIDATE_MATH :: - * Validate MATH table. - * - * FT_VALIDATE_OT :: - * Validate all OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH). - * - */ + /********************************************************************** + * + * @enum: + * FT_VALIDATE_OTXXX + * + * @description: + * A list of bit-field constants used with @FT_OpenType_Validate to + * indicate which OpenType tables should be validated. + * + * @values: + * FT_VALIDATE_BASE :: + * Validate BASE table. + * + * FT_VALIDATE_GDEF :: + * Validate GDEF table. + * + * FT_VALIDATE_GPOS :: + * Validate GPOS table. + * + * FT_VALIDATE_GSUB :: + * Validate GSUB table. + * + * FT_VALIDATE_JSTF :: + * Validate JSTF table. + * + * FT_VALIDATE_MATH :: + * Validate MATH table. + * + * FT_VALIDATE_OT :: + * Validate all OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH). + * + */ #define FT_VALIDATE_BASE 0x0100 #define FT_VALIDATE_GDEF 0x0200 #define FT_VALIDATE_GPOS 0x0400 @@ -106,61 +106,60 @@ FT_BEGIN_HEADER #define FT_VALIDATE_JSTF 0x1000 #define FT_VALIDATE_MATH 0x2000 -#define FT_VALIDATE_OT ( FT_VALIDATE_BASE | \ - FT_VALIDATE_GDEF | \ - FT_VALIDATE_GPOS | \ - FT_VALIDATE_GSUB | \ - FT_VALIDATE_JSTF | \ - FT_VALIDATE_MATH ) +#define FT_VALIDATE_OT FT_VALIDATE_BASE | \ + FT_VALIDATE_GDEF | \ + FT_VALIDATE_GPOS | \ + FT_VALIDATE_GSUB | \ + FT_VALIDATE_JSTF | \ + FT_VALIDATE_MATH - - /************************************************************************** - * - * @function: - * FT_OpenType_Validate - * - * @description: - * Validate various OpenType tables to assure that all offsets and - * indices are valid. The idea is that a higher-level library that - * actually does the text layout can access those tables without error - * checking (which can be quite time consuming). - * - * @input: - * face :: - * A handle to the input face. - * - * validation_flags :: - * A bit field that specifies the tables to be validated. See - * @FT_VALIDATE_OTXXX for possible values. - * - * @output: - * BASE_table :: - * A pointer to the BASE table. - * - * GDEF_table :: - * A pointer to the GDEF table. - * - * GPOS_table :: - * A pointer to the GPOS table. - * - * GSUB_table :: - * A pointer to the GSUB table. - * - * JSTF_table :: - * A pointer to the JSTF table. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function only works with OpenType fonts, returning an error - * otherwise. - * - * After use, the application should deallocate the five tables with - * @FT_OpenType_Free. A `NULL` value indicates that the table either - * doesn't exist in the font, or the application hasn't asked for - * validation. - */ + /********************************************************************** + * + * @function: + * FT_OpenType_Validate + * + * @description: + * Validate various OpenType tables to assure that all offsets and + * indices are valid. The idea is that a higher-level library that + * actually does the text layout can access those tables without + * error checking (which can be quite time consuming). + * + * @input: + * face :: + * A handle to the input face. + * + * validation_flags :: + * A bit field that specifies the tables to be validated. See + * @FT_VALIDATE_OTXXX for possible values. + * + * @output: + * BASE_table :: + * A pointer to the BASE table. + * + * GDEF_table :: + * A pointer to the GDEF table. + * + * GPOS_table :: + * A pointer to the GPOS table. + * + * GSUB_table :: + * A pointer to the GSUB table. + * + * JSTF_table :: + * A pointer to the JSTF table. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * This function only works with OpenType fonts, returning an error + * otherwise. + * + * After use, the application should deallocate the five tables with + * @FT_OpenType_Free. A NULL value indicates that the table either + * doesn't exist in the font, or the application hasn't asked for + * validation. + */ FT_EXPORT( FT_Error ) FT_OpenType_Validate( FT_Face face, FT_UInt validation_flags, @@ -170,32 +169,30 @@ FT_BEGIN_HEADER FT_Bytes *GSUB_table, FT_Bytes *JSTF_table ); - - /************************************************************************** - * - * @function: - * FT_OpenType_Free - * - * @description: - * Free the buffer allocated by OpenType validator. - * - * @input: - * face :: - * A handle to the input face. - * - * table :: - * The pointer to the buffer that is allocated by - * @FT_OpenType_Validate. - * - * @note: - * This function must be used to free the buffer allocated by - * @FT_OpenType_Validate only. - */ + /********************************************************************** + * + * @function: + * FT_OpenType_Free + * + * @description: + * Free the buffer allocated by OpenType validator. + * + * @input: + * face :: + * A handle to the input face. + * + * table :: + * The pointer to the buffer that is allocated by + * @FT_OpenType_Validate. + * + * @note: + * This function must be used to free the buffer allocated by + * @FT_OpenType_Validate only. + */ FT_EXPORT( void ) FT_OpenType_Free( FT_Face face, FT_Bytes table ); - /* */ diff --git a/android/x86_64/include/freetype/ftoutln.h b/android/x86_64/include/freetype/ftoutln.h index e6d78b2f..6a645120 100644 --- a/android/x86_64/include/freetype/ftoutln.h +++ b/android/x86_64/include/freetype/ftoutln.h @@ -1,27 +1,27 @@ -/**************************************************************************** - * - * ftoutln.h - * - * Support for the FT_Outline type used to store glyph shapes of - * most scalable font formats (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftoutln.h */ +/* */ +/* Support for the FT_Outline type used to store glyph shapes of */ +/* most scalable font formats (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTOUTLN_H_ #define FTOUTLN_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -34,131 +34,123 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * outline_processing - * - * @title: - * Outline Processing - * - * @abstract: - * Functions to create, transform, and render vectorial glyph images. - * - * @description: - * This section contains routines used to create and destroy scalable - * glyph images known as 'outlines'. These can also be measured, - * transformed, and converted into bitmaps and pixmaps. - * - * @order: - * FT_Outline - * FT_Outline_New - * FT_Outline_Done - * FT_Outline_Copy - * FT_Outline_Translate - * FT_Outline_Transform - * FT_Outline_Embolden - * FT_Outline_EmboldenXY - * FT_Outline_Reverse - * FT_Outline_Check - * - * FT_Outline_Get_CBox - * FT_Outline_Get_BBox - * - * FT_Outline_Get_Bitmap - * FT_Outline_Render - * FT_Outline_Decompose - * FT_Outline_Funcs - * FT_Outline_MoveToFunc - * FT_Outline_LineToFunc - * FT_Outline_ConicToFunc - * FT_Outline_CubicToFunc - * - * FT_Orientation - * FT_Outline_Get_Orientation - * - * FT_OUTLINE_XXX - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* outline_processing */ + /* */ + /* <Title> */ + /* Outline Processing */ + /* */ + /* <Abstract> */ + /* Functions to create, transform, and render vectorial glyph images. */ + /* */ + /* <Description> */ + /* This section contains routines used to create and destroy scalable */ + /* glyph images known as `outlines'. These can also be measured, */ + /* transformed, and converted into bitmaps and pixmaps. */ + /* */ + /* <Order> */ + /* FT_Outline */ + /* FT_Outline_New */ + /* FT_Outline_Done */ + /* FT_Outline_Copy */ + /* FT_Outline_Translate */ + /* FT_Outline_Transform */ + /* FT_Outline_Embolden */ + /* FT_Outline_EmboldenXY */ + /* FT_Outline_Reverse */ + /* FT_Outline_Check */ + /* */ + /* FT_Outline_Get_CBox */ + /* FT_Outline_Get_BBox */ + /* */ + /* FT_Outline_Get_Bitmap */ + /* FT_Outline_Render */ + /* FT_Outline_Decompose */ + /* FT_Outline_Funcs */ + /* FT_Outline_MoveToFunc */ + /* FT_Outline_LineToFunc */ + /* FT_Outline_ConicToFunc */ + /* FT_Outline_CubicToFunc */ + /* */ + /* FT_Orientation */ + /* FT_Outline_Get_Orientation */ + /* */ + /* FT_OUTLINE_XXX */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Outline_Decompose - * - * @description: - * Walk over an outline's structure to decompose it into individual - * segments and Bezier arcs. This function also emits 'move to' - * operations to indicate the start of new contours in the outline. - * - * @input: - * outline :: - * A pointer to the source target. - * - * func_interface :: - * A table of 'emitters', i.e., function pointers called during - * decomposition to indicate path operations. - * - * @inout: - * user :: - * A typeless pointer that is passed to each emitter during the - * decomposition. It can be used to store the state during the - * decomposition. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * A contour that contains a single point only is represented by a 'move - * to' operation followed by 'line to' to the same point. In most cases, - * it is best to filter this out before using the outline for stroking - * purposes (otherwise it would result in a visible dot when round caps - * are used). - * - * Similarly, the function returns success for an empty outline also - * (doing nothing, this is, not calling any emitter); if necessary, you - * should filter this out, too. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Decompose */ + /* */ + /* <Description> */ + /* Walk over an outline's structure to decompose it into individual */ + /* segments and Bézier arcs. This function also emits `move to' */ + /* operations to indicate the start of new contours in the outline. */ + /* */ + /* <Input> */ + /* outline :: A pointer to the source target. */ + /* */ + /* func_interface :: A table of `emitters', i.e., function pointers */ + /* called during decomposition to indicate path */ + /* operations. */ + /* */ + /* <InOut> */ + /* user :: A typeless pointer that is passed to each */ + /* emitter during the decomposition. It can be */ + /* used to store the state during the */ + /* decomposition. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* A contour that contains a single point only is represented by a */ + /* `move to' operation followed by `line to' to the same point. In */ + /* most cases, it is best to filter this out before using the */ + /* outline for stroking purposes (otherwise it would result in a */ + /* visible dot when round caps are used). */ + /* */ FT_EXPORT( FT_Error ) FT_Outline_Decompose( FT_Outline* outline, const FT_Outline_Funcs* func_interface, void* user ); - /************************************************************************** - * - * @function: - * FT_Outline_New - * - * @description: - * Create a new outline of a given size. - * - * @input: - * library :: - * A handle to the library object from where the outline is allocated. - * Note however that the new outline will **not** necessarily be - * **freed**, when destroying the library, by @FT_Done_FreeType. - * - * numPoints :: - * The maximum number of points within the outline. Must be smaller - * than or equal to 0xFFFF (65535). - * - * numContours :: - * The maximum number of contours within the outline. This value must - * be in the range 0 to `numPoints`. - * - * @output: - * anoutline :: - * A handle to the new outline. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The reason why this function takes a `library` parameter is simply to - * use the library's memory allocator. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_New */ + /* */ + /* <Description> */ + /* Create a new outline of a given size. */ + /* */ + /* <Input> */ + /* library :: A handle to the library object from where the */ + /* outline is allocated. Note however that the new */ + /* outline will *not* necessarily be *freed*, when */ + /* destroying the library, by @FT_Done_FreeType. */ + /* */ + /* numPoints :: The maximum number of points within the outline. */ + /* Must be smaller than or equal to 0xFFFF (65535). */ + /* */ + /* numContours :: The maximum number of contours within the outline. */ + /* This value must be in the range 0 to `numPoints'. */ + /* */ + /* <Output> */ + /* anoutline :: A handle to the new outline. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The reason why this function takes a `library' parameter is simply */ + /* to use the library's memory allocator. */ + /* */ FT_EXPORT( FT_Error ) FT_Outline_New( FT_Library library, FT_UInt numPoints, @@ -166,378 +158,368 @@ FT_BEGIN_HEADER FT_Outline *anoutline ); - /************************************************************************** - * - * @function: - * FT_Outline_Done - * - * @description: - * Destroy an outline created with @FT_Outline_New. - * - * @input: - * library :: - * A handle of the library object used to allocate the outline. - * - * outline :: - * A pointer to the outline object to be discarded. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * If the outline's 'owner' field is not set, only the outline descriptor - * will be released. - */ + FT_EXPORT( FT_Error ) + FT_Outline_New_Internal( FT_Memory memory, + FT_UInt numPoints, + FT_Int numContours, + FT_Outline *anoutline ); + + + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Done */ + /* */ + /* <Description> */ + /* Destroy an outline created with @FT_Outline_New. */ + /* */ + /* <Input> */ + /* library :: A handle of the library object used to allocate the */ + /* outline. */ + /* */ + /* outline :: A pointer to the outline object to be discarded. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* If the outline's `owner' field is not set, only the outline */ + /* descriptor will be released. */ + /* */ + /* The reason why this function takes an `library' parameter is */ + /* simply to use ft_mem_free(). */ + /* */ FT_EXPORT( FT_Error ) FT_Outline_Done( FT_Library library, FT_Outline* outline ); - /************************************************************************** - * - * @function: - * FT_Outline_Check - * - * @description: - * Check the contents of an outline descriptor. - * - * @input: - * outline :: - * A handle to a source outline. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * An empty outline, or an outline with a single point only is also - * valid. - */ + FT_EXPORT( FT_Error ) + FT_Outline_Done_Internal( FT_Memory memory, + FT_Outline* outline ); + + + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Check */ + /* */ + /* <Description> */ + /* Check the contents of an outline descriptor. */ + /* */ + /* <Input> */ + /* outline :: A handle to a source outline. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Outline_Check( FT_Outline* outline ); - /************************************************************************** - * - * @function: - * FT_Outline_Get_CBox - * - * @description: - * Return an outline's 'control box'. The control box encloses all the - * outline's points, including Bezier control points. Though it - * coincides with the exact bounding box for most glyphs, it can be - * slightly larger in some situations (like when rotating an outline that - * contains Bezier outside arcs). - * - * Computing the control box is very fast, while getting the bounding box - * can take much more time as it needs to walk over all segments and arcs - * in the outline. To get the latter, you can use the 'ftbbox' - * component, which is dedicated to this single task. - * - * @input: - * outline :: - * A pointer to the source outline descriptor. - * - * @output: - * acbox :: - * The outline's control box. - * - * @note: - * See @FT_Glyph_Get_CBox for a discussion of tricky fonts. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Get_CBox */ + /* */ + /* <Description> */ + /* Return an outline's `control box'. The control box encloses all */ + /* the outline's points, including Bézier control points. Though it */ + /* coincides with the exact bounding box for most glyphs, it can be */ + /* slightly larger in some situations (like when rotating an outline */ + /* that contains Bézier outside arcs). */ + /* */ + /* Computing the control box is very fast, while getting the bounding */ + /* box can take much more time as it needs to walk over all segments */ + /* and arcs in the outline. To get the latter, you can use the */ + /* `ftbbox' component, which is dedicated to this single task. */ + /* */ + /* <Input> */ + /* outline :: A pointer to the source outline descriptor. */ + /* */ + /* <Output> */ + /* acbox :: The outline's control box. */ + /* */ + /* <Note> */ + /* See @FT_Glyph_Get_CBox for a discussion of tricky fonts. */ + /* */ FT_EXPORT( void ) FT_Outline_Get_CBox( const FT_Outline* outline, FT_BBox *acbox ); - /************************************************************************** - * - * @function: - * FT_Outline_Translate - * - * @description: - * Apply a simple translation to the points of an outline. - * - * @inout: - * outline :: - * A pointer to the target outline descriptor. - * - * @input: - * xOffset :: - * The horizontal offset. - * - * yOffset :: - * The vertical offset. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Translate */ + /* */ + /* <Description> */ + /* Apply a simple translation to the points of an outline. */ + /* */ + /* <InOut> */ + /* outline :: A pointer to the target outline descriptor. */ + /* */ + /* <Input> */ + /* xOffset :: The horizontal offset. */ + /* */ + /* yOffset :: The vertical offset. */ + /* */ FT_EXPORT( void ) FT_Outline_Translate( const FT_Outline* outline, FT_Pos xOffset, FT_Pos yOffset ); - /************************************************************************** - * - * @function: - * FT_Outline_Copy - * - * @description: - * Copy an outline into another one. Both objects must have the same - * sizes (number of points & number of contours) when this function is - * called. - * - * @input: - * source :: - * A handle to the source outline. - * - * @output: - * target :: - * A handle to the target outline. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Copy */ + /* */ + /* <Description> */ + /* Copy an outline into another one. Both objects must have the */ + /* same sizes (number of points & number of contours) when this */ + /* function is called. */ + /* */ + /* <Input> */ + /* source :: A handle to the source outline. */ + /* */ + /* <Output> */ + /* target :: A handle to the target outline. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Outline_Copy( const FT_Outline* source, FT_Outline *target ); - /************************************************************************** - * - * @function: - * FT_Outline_Transform - * - * @description: - * Apply a simple 2x2 matrix to all of an outline's points. Useful for - * applying rotations, slanting, flipping, etc. - * - * @inout: - * outline :: - * A pointer to the target outline descriptor. - * - * @input: - * matrix :: - * A pointer to the transformation matrix. - * - * @note: - * You can use @FT_Outline_Translate if you need to translate the - * outline's points. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Transform */ + /* */ + /* <Description> */ + /* Apply a simple 2x2 matrix to all of an outline's points. Useful */ + /* for applying rotations, slanting, flipping, etc. */ + /* */ + /* <InOut> */ + /* outline :: A pointer to the target outline descriptor. */ + /* */ + /* <Input> */ + /* matrix :: A pointer to the transformation matrix. */ + /* */ + /* <Note> */ + /* You can use @FT_Outline_Translate if you need to translate the */ + /* outline's points. */ + /* */ FT_EXPORT( void ) FT_Outline_Transform( const FT_Outline* outline, const FT_Matrix* matrix ); - /************************************************************************** - * - * @function: - * FT_Outline_Embolden - * - * @description: - * Embolden an outline. The new outline will be at most 4~times - * `strength` pixels wider and higher. You may think of the left and - * bottom borders as unchanged. - * - * Negative `strength` values to reduce the outline thickness are - * possible also. - * - * @inout: - * outline :: - * A handle to the target outline. - * - * @input: - * strength :: - * How strong the glyph is emboldened. Expressed in 26.6 pixel format. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * The used algorithm to increase or decrease the thickness of the glyph - * doesn't change the number of points; this means that certain - * situations like acute angles or intersections are sometimes handled - * incorrectly. - * - * If you need 'better' metrics values you should call - * @FT_Outline_Get_CBox or @FT_Outline_Get_BBox. - * - * To get meaningful results, font scaling values must be set with - * functions like @FT_Set_Char_Size before calling FT_Render_Glyph. - * - * @example: - * ``` - * FT_Load_Glyph( face, index, FT_LOAD_DEFAULT ); - * - * if ( face->glyph->format == FT_GLYPH_FORMAT_OUTLINE ) - * FT_Outline_Embolden( &face->glyph->outline, strength ); - * ``` - * - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Embolden */ + /* */ + /* <Description> */ + /* Embolden an outline. The new outline will be at most 4~times */ + /* `strength' pixels wider and higher. You may think of the left and */ + /* bottom borders as unchanged. */ + /* */ + /* Negative `strength' values to reduce the outline thickness are */ + /* possible also. */ + /* */ + /* <InOut> */ + /* outline :: A handle to the target outline. */ + /* */ + /* <Input> */ + /* strength :: How strong the glyph is emboldened. Expressed in */ + /* 26.6 pixel format. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The used algorithm to increase or decrease the thickness of the */ + /* glyph doesn't change the number of points; this means that certain */ + /* situations like acute angles or intersections are sometimes */ + /* handled incorrectly. */ + /* */ + /* If you need `better' metrics values you should call */ + /* @FT_Outline_Get_CBox or @FT_Outline_Get_BBox. */ + /* */ + /* Example call: */ + /* */ + /* { */ + /* FT_Load_Glyph( face, index, FT_LOAD_DEFAULT ); */ + /* if ( face->glyph->format == FT_GLYPH_FORMAT_OUTLINE ) */ + /* FT_Outline_Embolden( &face->glyph->outline, strength ); */ + /* } */ + /* */ + /* To get meaningful results, font scaling values must be set with */ + /* functions like @FT_Set_Char_Size before calling FT_Render_Glyph. */ + /* */ FT_EXPORT( FT_Error ) FT_Outline_Embolden( FT_Outline* outline, FT_Pos strength ); - /************************************************************************** - * - * @function: - * FT_Outline_EmboldenXY - * - * @description: - * Embolden an outline. The new outline will be `xstrength` pixels wider - * and `ystrength` pixels higher. Otherwise, it is similar to - * @FT_Outline_Embolden, which uses the same strength in both directions. - * - * @since: - * 2.4.10 - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_EmboldenXY */ + /* */ + /* <Description> */ + /* Embolden an outline. The new outline will be `xstrength' pixels */ + /* wider and `ystrength' pixels higher. Otherwise, it is similar to */ + /* @FT_Outline_Embolden, which uses the same strength in both */ + /* directions. */ + /* */ FT_EXPORT( FT_Error ) FT_Outline_EmboldenXY( FT_Outline* outline, FT_Pos xstrength, FT_Pos ystrength ); - /************************************************************************** - * - * @function: - * FT_Outline_Reverse - * - * @description: - * Reverse the drawing direction of an outline. This is used to ensure - * consistent fill conventions for mirrored glyphs. - * - * @inout: - * outline :: - * A pointer to the target outline descriptor. - * - * @note: - * This function toggles the bit flag @FT_OUTLINE_REVERSE_FILL in the - * outline's `flags` field. - * - * It shouldn't be used by a normal client application, unless it knows - * what it is doing. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Reverse */ + /* */ + /* <Description> */ + /* Reverse the drawing direction of an outline. This is used to */ + /* ensure consistent fill conventions for mirrored glyphs. */ + /* */ + /* <InOut> */ + /* outline :: A pointer to the target outline descriptor. */ + /* */ + /* <Note> */ + /* This function toggles the bit flag @FT_OUTLINE_REVERSE_FILL in */ + /* the outline's `flags' field. */ + /* */ + /* It shouldn't be used by a normal client application, unless it */ + /* knows what it is doing. */ + /* */ FT_EXPORT( void ) FT_Outline_Reverse( FT_Outline* outline ); - /************************************************************************** - * - * @function: - * FT_Outline_Get_Bitmap - * - * @description: - * Render an outline within a bitmap. The outline's image is simply - * OR-ed to the target bitmap. - * - * @input: - * library :: - * A handle to a FreeType library object. - * - * outline :: - * A pointer to the source outline descriptor. - * - * @inout: - * abitmap :: - * A pointer to the target bitmap descriptor. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function does **not create** the bitmap, it only renders an - * outline image within the one you pass to it! Consequently, the - * various fields in `abitmap` should be set accordingly. - * - * It will use the raster corresponding to the default glyph format. - * - * The value of the `num_grays` field in `abitmap` is ignored. If you - * select the gray-level rasterizer, and you want less than 256 gray - * levels, you have to use @FT_Outline_Render directly. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Get_Bitmap */ + /* */ + /* <Description> */ + /* Render an outline within a bitmap. The outline's image is simply */ + /* OR-ed to the target bitmap. */ + /* */ + /* <Input> */ + /* library :: A handle to a FreeType library object. */ + /* */ + /* outline :: A pointer to the source outline descriptor. */ + /* */ + /* <InOut> */ + /* abitmap :: A pointer to the target bitmap descriptor. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* This function does NOT CREATE the bitmap, it only renders an */ + /* outline image within the one you pass to it! Consequently, the */ + /* various fields in `abitmap' should be set accordingly. */ + /* */ + /* It will use the raster corresponding to the default glyph format. */ + /* */ + /* The value of the `num_grays' field in `abitmap' is ignored. If */ + /* you select the gray-level rasterizer, and you want less than 256 */ + /* gray levels, you have to use @FT_Outline_Render directly. */ + /* */ FT_EXPORT( FT_Error ) FT_Outline_Get_Bitmap( FT_Library library, FT_Outline* outline, const FT_Bitmap *abitmap ); - /************************************************************************** - * - * @function: - * FT_Outline_Render - * - * @description: - * Render an outline within a bitmap using the current scan-convert. - * This function uses an @FT_Raster_Params structure as an argument, - * allowing advanced features like direct composition, translucency, etc. - * - * @input: - * library :: - * A handle to a FreeType library object. - * - * outline :: - * A pointer to the source outline descriptor. - * - * @inout: - * params :: - * A pointer to an @FT_Raster_Params structure used to describe the - * rendering operation. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * You should know what you are doing and how @FT_Raster_Params works to - * use this function. - * - * The field `params.source` will be set to `outline` before the scan - * converter is called, which means that the value you give to it is - * actually ignored. - * - * The gray-level rasterizer always uses 256 gray levels. If you want - * less gray levels, you have to provide your own span callback. See the - * @FT_RASTER_FLAG_DIRECT value of the `flags` field in the - * @FT_Raster_Params structure for more details. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Outline_Render */ + /* */ + /* <Description> */ + /* Render an outline within a bitmap using the current scan-convert. */ + /* This function uses an @FT_Raster_Params structure as an argument, */ + /* allowing advanced features like direct composition, translucency, */ + /* etc. */ + /* */ + /* <Input> */ + /* library :: A handle to a FreeType library object. */ + /* */ + /* outline :: A pointer to the source outline descriptor. */ + /* */ + /* <InOut> */ + /* params :: A pointer to an @FT_Raster_Params structure used to */ + /* describe the rendering operation. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* You should know what you are doing and how @FT_Raster_Params works */ + /* to use this function. */ + /* */ + /* The field `params.source' will be set to `outline' before the scan */ + /* converter is called, which means that the value you give to it is */ + /* actually ignored. */ + /* */ + /* The gray-level rasterizer always uses 256 gray levels. If you */ + /* want less gray levels, you have to provide your own span callback. */ + /* See the @FT_RASTER_FLAG_DIRECT value of the `flags' field in the */ + /* @FT_Raster_Params structure for more details. */ + /* */ FT_EXPORT( FT_Error ) FT_Outline_Render( FT_Library library, FT_Outline* outline, FT_Raster_Params* params ); - /************************************************************************** - * - * @enum: - * FT_Orientation - * - * @description: - * A list of values used to describe an outline's contour orientation. - * - * The TrueType and PostScript specifications use different conventions - * to determine whether outline contours should be filled or unfilled. - * - * @values: - * FT_ORIENTATION_TRUETYPE :: - * According to the TrueType specification, clockwise contours must be - * filled, and counter-clockwise ones must be unfilled. - * - * FT_ORIENTATION_POSTSCRIPT :: - * According to the PostScript specification, counter-clockwise - * contours must be filled, and clockwise ones must be unfilled. - * - * FT_ORIENTATION_FILL_RIGHT :: - * This is identical to @FT_ORIENTATION_TRUETYPE, but is used to - * remember that in TrueType, everything that is to the right of the - * drawing direction of a contour must be filled. - * - * FT_ORIENTATION_FILL_LEFT :: - * This is identical to @FT_ORIENTATION_POSTSCRIPT, but is used to - * remember that in PostScript, everything that is to the left of the - * drawing direction of a contour must be filled. - * - * FT_ORIENTATION_NONE :: - * The orientation cannot be determined. That is, different parts of - * the glyph have different orientation. - * - */ + /************************************************************************** + * + * @enum: + * FT_Orientation + * + * @description: + * A list of values used to describe an outline's contour orientation. + * + * The TrueType and PostScript specifications use different conventions + * to determine whether outline contours should be filled or unfilled. + * + * @values: + * FT_ORIENTATION_TRUETYPE :: + * According to the TrueType specification, clockwise contours must + * be filled, and counter-clockwise ones must be unfilled. + * + * FT_ORIENTATION_POSTSCRIPT :: + * According to the PostScript specification, counter-clockwise contours + * must be filled, and clockwise ones must be unfilled. + * + * FT_ORIENTATION_FILL_RIGHT :: + * This is identical to @FT_ORIENTATION_TRUETYPE, but is used to + * remember that in TrueType, everything that is to the right of + * the drawing direction of a contour must be filled. + * + * FT_ORIENTATION_FILL_LEFT :: + * This is identical to @FT_ORIENTATION_POSTSCRIPT, but is used to + * remember that in PostScript, everything that is to the left of + * the drawing direction of a contour must be filled. + * + * FT_ORIENTATION_NONE :: + * The orientation cannot be determined. That is, different parts of + * the glyph have different orientation. + * + */ typedef enum FT_Orientation_ { FT_ORIENTATION_TRUETYPE = 0, @@ -549,34 +531,33 @@ FT_BEGIN_HEADER } FT_Orientation; - /************************************************************************** - * - * @function: - * FT_Outline_Get_Orientation - * - * @description: - * This function analyzes a glyph outline and tries to compute its fill - * orientation (see @FT_Orientation). This is done by integrating the - * total area covered by the outline. The positive integral corresponds - * to the clockwise orientation and @FT_ORIENTATION_POSTSCRIPT is - * returned. The negative integral corresponds to the counter-clockwise - * orientation and @FT_ORIENTATION_TRUETYPE is returned. - * - * Note that this will return @FT_ORIENTATION_TRUETYPE for empty - * outlines. - * - * @input: - * outline :: - * A handle to the source outline. - * - * @return: - * The orientation. - * - */ + /************************************************************************** + * + * @function: + * FT_Outline_Get_Orientation + * + * @description: + * This function analyzes a glyph outline and tries to compute its + * fill orientation (see @FT_Orientation). This is done by integrating + * the total area covered by the outline. The positive integral + * corresponds to the clockwise orientation and @FT_ORIENTATION_POSTSCRIPT + * is returned. The negative integral corresponds to the counter-clockwise + * orientation and @FT_ORIENTATION_TRUETYPE is returned. + * + * Note that this will return @FT_ORIENTATION_TRUETYPE for empty + * outlines. + * + * @input: + * outline :: + * A handle to the source outline. + * + * @return: + * The orientation. + * + */ FT_EXPORT( FT_Orientation ) FT_Outline_Get_Orientation( FT_Outline* outline ); - /* */ diff --git a/android/x86_64/include/freetype/ftparams.h b/android/x86_64/include/freetype/ftparams.h deleted file mode 100644 index 4f526f1c..00000000 --- a/android/x86_64/include/freetype/ftparams.h +++ /dev/null @@ -1,204 +0,0 @@ -/**************************************************************************** - * - * ftparams.h - * - * FreeType API for possible FT_Parameter tags (specification only). - * - * Copyright (C) 2017-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ - - -#ifndef FTPARAMS_H_ -#define FTPARAMS_H_ - -#include "ft2build.h" -#include FT_FREETYPE_H - -#ifdef FREETYPE_H -#error "freetype.h of FreeType 1 has been loaded!" -#error "Please fix the directory search order for header files" -#error "so that freetype.h of FreeType 2 is found first." -#endif - - -FT_BEGIN_HEADER - - - /************************************************************************** - * - * @section: - * parameter_tags - * - * @title: - * Parameter Tags - * - * @abstract: - * Macros for driver property and font loading parameter tags. - * - * @description: - * This section contains macros for the @FT_Parameter structure that are - * used with various functions to activate some special functionality or - * different behaviour of various components of FreeType. - * - */ - - - /************************************************************************** - * - * @enum: - * FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY - * - * @description: - * A tag for @FT_Parameter to make @FT_Open_Face ignore typographic - * family names in the 'name' table (introduced in OpenType version 1.4). - * Use this for backward compatibility with legacy systems that have a - * four-faces-per-family restriction. - * - * @since: - * 2.8 - * - */ -#define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY \ - FT_MAKE_TAG( 'i', 'g', 'p', 'f' ) - - - /* this constant is deprecated */ -#define FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY \ - FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY - - - /************************************************************************** - * - * @enum: - * FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY - * - * @description: - * A tag for @FT_Parameter to make @FT_Open_Face ignore typographic - * subfamily names in the 'name' table (introduced in OpenType version - * 1.4). Use this for backward compatibility with legacy systems that - * have a four-faces-per-family restriction. - * - * @since: - * 2.8 - * - */ -#define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY \ - FT_MAKE_TAG( 'i', 'g', 'p', 's' ) - - - /* this constant is deprecated */ -#define FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY \ - FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY - - - /************************************************************************** - * - * @enum: - * FT_PARAM_TAG_INCREMENTAL - * - * @description: - * An @FT_Parameter tag to be used with @FT_Open_Face to indicate - * incremental glyph loading. - * - */ -#define FT_PARAM_TAG_INCREMENTAL \ - FT_MAKE_TAG( 'i', 'n', 'c', 'r' ) - - - /************************************************************************** - * - * @enum: - * FT_PARAM_TAG_LCD_FILTER_WEIGHTS - * - * @description: - * An @FT_Parameter tag to be used with @FT_Face_Properties. The - * corresponding argument specifies the five LCD filter weights for a - * given face (if using @FT_LOAD_TARGET_LCD, for example), overriding the - * global default values or the values set up with - * @FT_Library_SetLcdFilterWeights. - * - * @since: - * 2.8 - * - */ -#define FT_PARAM_TAG_LCD_FILTER_WEIGHTS \ - FT_MAKE_TAG( 'l', 'c', 'd', 'f' ) - - - /************************************************************************** - * - * @enum: - * FT_PARAM_TAG_RANDOM_SEED - * - * @description: - * An @FT_Parameter tag to be used with @FT_Face_Properties. The - * corresponding 32bit signed integer argument overrides the font - * driver's random seed value with a face-specific one; see @random-seed. - * - * @since: - * 2.8 - * - */ -#define FT_PARAM_TAG_RANDOM_SEED \ - FT_MAKE_TAG( 's', 'e', 'e', 'd' ) - - - /************************************************************************** - * - * @enum: - * FT_PARAM_TAG_STEM_DARKENING - * - * @description: - * An @FT_Parameter tag to be used with @FT_Face_Properties. The - * corresponding Boolean argument specifies whether to apply stem - * darkening, overriding the global default values or the values set up - * with @FT_Property_Set (see @no-stem-darkening). - * - * This is a passive setting that only takes effect if the font driver or - * autohinter honors it, which the CFF, Type~1, and CID drivers always - * do, but the autohinter only in 'light' hinting mode (as of version - * 2.9). - * - * @since: - * 2.8 - * - */ -#define FT_PARAM_TAG_STEM_DARKENING \ - FT_MAKE_TAG( 'd', 'a', 'r', 'k' ) - - - /************************************************************************** - * - * @enum: - * FT_PARAM_TAG_UNPATENTED_HINTING - * - * @description: - * Deprecated, no effect. - * - * Previously: A constant used as the tag of an @FT_Parameter structure - * to indicate that unpatented methods only should be used by the - * TrueType bytecode interpreter for a typeface opened by @FT_Open_Face. - * - */ -#define FT_PARAM_TAG_UNPATENTED_HINTING \ - FT_MAKE_TAG( 'u', 'n', 'p', 'a' ) - - - /* */ - - -FT_END_HEADER - - -#endif /* FTPARAMS_H_ */ - - -/* END */ diff --git a/android/x86_64/include/freetype/ftpfr.h b/android/x86_64/include/freetype/ftpfr.h index 17f8e38d..2e1bff2f 100644 --- a/android/x86_64/include/freetype/ftpfr.h +++ b/android/x86_64/include/freetype/ftpfr.h @@ -1,25 +1,25 @@ -/**************************************************************************** - * - * ftpfr.h - * - * FreeType API for accessing PFR-specific data (specification only). - * - * Copyright (C) 2002-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftpfr.h */ +/* */ +/* FreeType API for accessing PFR-specific data (specification only). */ +/* */ +/* Copyright 2002-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTPFR_H_ #define FTPFR_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -32,61 +32,60 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * pfr_fonts - * - * @title: - * PFR Fonts - * - * @abstract: - * PFR/TrueDoc-specific API. - * - * @description: - * This section contains the declaration of PFR-specific functions. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* pfr_fonts */ + /* */ + /* <Title> */ + /* PFR Fonts */ + /* */ + /* <Abstract> */ + /* PFR/TrueDoc specific API. */ + /* */ + /* <Description> */ + /* This section contains the declaration of PFR-specific functions. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_Get_PFR_Metrics - * - * @description: - * Return the outline and metrics resolutions of a given PFR face. - * - * @input: - * face :: - * Handle to the input face. It can be a non-PFR face. - * - * @output: - * aoutline_resolution :: - * Outline resolution. This is equivalent to `face->units_per_EM` for - * non-PFR fonts. Optional (parameter can be `NULL`). - * - * ametrics_resolution :: - * Metrics resolution. This is equivalent to `outline_resolution` for - * non-PFR fonts. Optional (parameter can be `NULL`). - * - * ametrics_x_scale :: - * A 16.16 fixed-point number used to scale distance expressed in - * metrics units to device subpixels. This is equivalent to - * `face->size->x_scale`, but for metrics only. Optional (parameter - * can be `NULL`). - * - * ametrics_y_scale :: - * Same as `ametrics_x_scale` but for the vertical direction. - * optional (parameter can be `NULL`). - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * If the input face is not a PFR, this function will return an error. - * However, in all cases, it will return valid values. - */ + /********************************************************************** + * + * @function: + * FT_Get_PFR_Metrics + * + * @description: + * Return the outline and metrics resolutions of a given PFR face. + * + * @input: + * face :: Handle to the input face. It can be a non-PFR face. + * + * @output: + * aoutline_resolution :: + * Outline resolution. This is equivalent to `face->units_per_EM' + * for non-PFR fonts. Optional (parameter can be NULL). + * + * ametrics_resolution :: + * Metrics resolution. This is equivalent to `outline_resolution' + * for non-PFR fonts. Optional (parameter can be NULL). + * + * ametrics_x_scale :: + * A 16.16 fixed-point number used to scale distance expressed + * in metrics units to device sub-pixels. This is equivalent to + * `face->size->x_scale', but for metrics only. Optional (parameter + * can be NULL). + * + * ametrics_y_scale :: + * Same as `ametrics_x_scale' but for the vertical direction. + * optional (parameter can be NULL). + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * If the input face is not a PFR, this function will return an error. + * However, in all cases, it will return valid values. + */ FT_EXPORT( FT_Error ) FT_Get_PFR_Metrics( FT_Face face, FT_UInt *aoutline_resolution, @@ -95,41 +94,37 @@ FT_BEGIN_HEADER FT_Fixed *ametrics_y_scale ); - /************************************************************************** - * - * @function: - * FT_Get_PFR_Kerning - * - * @description: - * Return the kerning pair corresponding to two glyphs in a PFR face. - * The distance is expressed in metrics units, unlike the result of - * @FT_Get_Kerning. - * - * @input: - * face :: - * A handle to the input face. - * - * left :: - * Index of the left glyph. - * - * right :: - * Index of the right glyph. - * - * @output: - * avector :: - * A kerning vector. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * This function always return distances in original PFR metrics units. - * This is unlike @FT_Get_Kerning with the @FT_KERNING_UNSCALED mode, - * which always returns distances converted to outline units. - * - * You can use the value of the `x_scale` and `y_scale` parameters - * returned by @FT_Get_PFR_Metrics to scale these to device subpixels. - */ + /********************************************************************** + * + * @function: + * FT_Get_PFR_Kerning + * + * @description: + * Return the kerning pair corresponding to two glyphs in a PFR face. + * The distance is expressed in metrics units, unlike the result of + * @FT_Get_Kerning. + * + * @input: + * face :: A handle to the input face. + * + * left :: Index of the left glyph. + * + * right :: Index of the right glyph. + * + * @output: + * avector :: A kerning vector. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * This function always return distances in original PFR metrics + * units. This is unlike @FT_Get_Kerning with the @FT_KERNING_UNSCALED + * mode, which always returns distances converted to outline units. + * + * You can use the value of the `x_scale' and `y_scale' parameters + * returned by @FT_Get_PFR_Metrics to scale these to device sub-pixels. + */ FT_EXPORT( FT_Error ) FT_Get_PFR_Kerning( FT_Face face, FT_UInt left, @@ -137,33 +132,30 @@ FT_BEGIN_HEADER FT_Vector *avector ); - /************************************************************************** - * - * @function: - * FT_Get_PFR_Advance - * - * @description: - * Return a given glyph advance, expressed in original metrics units, - * from a PFR font. - * - * @input: - * face :: - * A handle to the input face. - * - * gindex :: - * The glyph index. - * - * @output: - * aadvance :: - * The glyph advance in metrics units. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * You can use the `x_scale` or `y_scale` results of @FT_Get_PFR_Metrics - * to convert the advance to device subpixels (i.e., 1/64th of pixels). - */ + /********************************************************************** + * + * @function: + * FT_Get_PFR_Advance + * + * @description: + * Return a given glyph advance, expressed in original metrics units, + * from a PFR font. + * + * @input: + * face :: A handle to the input face. + * + * gindex :: The glyph index. + * + * @output: + * aadvance :: The glyph advance in metrics units. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * You can use the `x_scale' or `y_scale' results of @FT_Get_PFR_Metrics + * to convert the advance to device sub-pixels (i.e., 1/64th of pixels). + */ FT_EXPORT( FT_Error ) FT_Get_PFR_Advance( FT_Face face, FT_UInt gindex, diff --git a/android/x86_64/include/freetype/ftrender.h b/android/x86_64/include/freetype/ftrender.h index eca3e220..9f7ed9e9 100644 --- a/android/x86_64/include/freetype/ftrender.h +++ b/android/x86_64/include/freetype/ftrender.h @@ -1,26 +1,26 @@ -/**************************************************************************** - * - * ftrender.h - * - * FreeType renderer modules public interface (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftrender.h */ +/* */ +/* FreeType renderer modules public interface (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTRENDER_H_ #define FTRENDER_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_MODULE_H #include FT_GLYPH_H @@ -28,12 +28,12 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * module_management - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* module_management */ + /* */ + /*************************************************************************/ /* create a new glyph object */ @@ -75,7 +75,6 @@ FT_BEGIN_HEADER { FT_Long glyph_size; FT_Glyph_Format glyph_format; - FT_Glyph_InitFunc glyph_init; FT_Glyph_DoneFunc glyph_done; FT_Glyph_CopyFunc glyph_copy; @@ -88,7 +87,7 @@ FT_BEGIN_HEADER typedef FT_Error (*FT_Renderer_RenderFunc)( FT_Renderer renderer, FT_GlyphSlot slot, - FT_Render_Mode mode, + FT_UInt mode, const FT_Vector* origin ); typedef FT_Error @@ -116,38 +115,32 @@ FT_BEGIN_HEADER #define FTRenderer_setMode FT_Renderer_SetModeFunc - /************************************************************************** - * - * @struct: - * FT_Renderer_Class - * - * @description: - * The renderer module class descriptor. - * - * @fields: - * root :: - * The root @FT_Module_Class fields. - * - * glyph_format :: - * The glyph image format this renderer handles. - * - * render_glyph :: - * A method used to render the image that is in a given glyph slot into - * a bitmap. - * - * transform_glyph :: - * A method used to transform the image that is in a given glyph slot. - * - * get_glyph_cbox :: - * A method used to access the glyph's cbox. - * - * set_mode :: - * A method used to pass additional parameters. - * - * raster_class :: - * For @FT_GLYPH_FORMAT_OUTLINE renderers only. This is a pointer to - * its raster's class. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Renderer_Class */ + /* */ + /* <Description> */ + /* The renderer module class descriptor. */ + /* */ + /* <Fields> */ + /* root :: The root @FT_Module_Class fields. */ + /* */ + /* glyph_format :: The glyph image format this renderer handles. */ + /* */ + /* render_glyph :: A method used to render the image that is in a */ + /* given glyph slot into a bitmap. */ + /* */ + /* transform_glyph :: A method used to transform the image that is in */ + /* a given glyph slot. */ + /* */ + /* get_glyph_cbox :: A method used to access the glyph's cbox. */ + /* */ + /* set_mode :: A method used to pass additional parameters. */ + /* */ + /* raster_class :: For @FT_GLYPH_FORMAT_OUTLINE renderers only. */ + /* This is a pointer to its raster's class. */ + /* */ typedef struct FT_Renderer_Class_ { FT_Module_Class root; @@ -164,70 +157,64 @@ FT_BEGIN_HEADER } FT_Renderer_Class; - /************************************************************************** - * - * @function: - * FT_Get_Renderer - * - * @description: - * Retrieve the current renderer for a given glyph format. - * - * @input: - * library :: - * A handle to the library object. - * - * format :: - * The glyph format. - * - * @return: - * A renderer handle. 0~if none found. - * - * @note: - * An error will be returned if a module already exists by that name, or - * if the module requires a version of FreeType that is too great. - * - * To add a new renderer, simply use @FT_Add_Module. To retrieve a - * renderer by its name, use @FT_Get_Module. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Renderer */ + /* */ + /* <Description> */ + /* Retrieve the current renderer for a given glyph format. */ + /* */ + /* <Input> */ + /* library :: A handle to the library object. */ + /* */ + /* format :: The glyph format. */ + /* */ + /* <Return> */ + /* A renderer handle. 0~if none found. */ + /* */ + /* <Note> */ + /* An error will be returned if a module already exists by that name, */ + /* or if the module requires a version of FreeType that is too great. */ + /* */ + /* To add a new renderer, simply use @FT_Add_Module. To retrieve a */ + /* renderer by its name, use @FT_Get_Module. */ + /* */ FT_EXPORT( FT_Renderer ) FT_Get_Renderer( FT_Library library, FT_Glyph_Format format ); - /************************************************************************** - * - * @function: - * FT_Set_Renderer - * - * @description: - * Set the current renderer to use, and set additional mode. - * - * @inout: - * library :: - * A handle to the library object. - * - * @input: - * renderer :: - * A handle to the renderer object. - * - * num_params :: - * The number of additional parameters. - * - * parameters :: - * Additional parameters. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * In case of success, the renderer will be used to convert glyph images - * in the renderer's known format into bitmaps. - * - * This doesn't change the current renderer for other formats. - * - * Currently, no FreeType renderer module uses `parameters`; you should - * thus always pass `NULL` as the value. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Set_Renderer */ + /* */ + /* <Description> */ + /* Set the current renderer to use, and set additional mode. */ + /* */ + /* <InOut> */ + /* library :: A handle to the library object. */ + /* */ + /* <Input> */ + /* renderer :: A handle to the renderer object. */ + /* */ + /* num_params :: The number of additional parameters. */ + /* */ + /* parameters :: Additional parameters. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* In case of success, the renderer will be used to convert glyph */ + /* images in the renderer's known format into bitmaps. */ + /* */ + /* This doesn't change the current renderer for other formats. */ + /* */ + /* Currently, no FreeType renderer module uses `parameters'; you */ + /* should thus always pass NULL as the value. */ + /* */ FT_EXPORT( FT_Error ) FT_Set_Renderer( FT_Library library, FT_Renderer renderer, diff --git a/android/x86_64/include/freetype/ftsizes.h b/android/x86_64/include/freetype/ftsizes.h index 2d63295e..55e0d5cc 100644 --- a/android/x86_64/include/freetype/ftsizes.h +++ b/android/x86_64/include/freetype/ftsizes.h @@ -1,35 +1,35 @@ -/**************************************************************************** - * - * ftsizes.h - * - * FreeType size objects management (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftsizes.h */ +/* */ +/* FreeType size objects management (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ - /************************************************************************** - * - * Typical application would normally not need to use these functions. - * However, they have been placed in a public API for the rare cases where - * they are needed. - * - */ + /*************************************************************************/ + /* */ + /* Typical application would normally not need to use these functions. */ + /* However, they have been placed in a public API for the rare cases */ + /* where they are needed. */ + /* */ + /*************************************************************************/ #ifndef FTSIZES_H_ #define FTSIZES_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -42,110 +42,109 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * sizes_management - * - * @title: - * Size Management - * - * @abstract: - * Managing multiple sizes per face. - * - * @description: - * When creating a new face object (e.g., with @FT_New_Face), an @FT_Size - * object is automatically created and used to store all pixel-size - * dependent information, available in the `face->size` field. - * - * It is however possible to create more sizes for a given face, mostly - * in order to manage several character pixel sizes of the same font - * family and style. See @FT_New_Size and @FT_Done_Size. - * - * Note that @FT_Set_Pixel_Sizes and @FT_Set_Char_Size only modify the - * contents of the current 'active' size; you thus need to use - * @FT_Activate_Size to change it. - * - * 99% of applications won't need the functions provided here, especially - * if they use the caching sub-system, so be cautious when using these. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* sizes_management */ + /* */ + /* <Title> */ + /* Size Management */ + /* */ + /* <Abstract> */ + /* Managing multiple sizes per face. */ + /* */ + /* <Description> */ + /* When creating a new face object (e.g., with @FT_New_Face), an */ + /* @FT_Size object is automatically created and used to store all */ + /* pixel-size dependent information, available in the `face->size' */ + /* field. */ + /* */ + /* It is however possible to create more sizes for a given face, */ + /* mostly in order to manage several character pixel sizes of the */ + /* same font family and style. See @FT_New_Size and @FT_Done_Size. */ + /* */ + /* Note that @FT_Set_Pixel_Sizes and @FT_Set_Char_Size only */ + /* modify the contents of the current `active' size; you thus need */ + /* to use @FT_Activate_Size to change it. */ + /* */ + /* 99% of applications won't need the functions provided here, */ + /* especially if they use the caching sub-system, so be cautious */ + /* when using these. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @function: - * FT_New_Size - * - * @description: - * Create a new size object from a given face object. - * - * @input: - * face :: - * A handle to a parent face object. - * - * @output: - * asize :: - * A handle to a new size object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * You need to call @FT_Activate_Size in order to select the new size for - * upcoming calls to @FT_Set_Pixel_Sizes, @FT_Set_Char_Size, - * @FT_Load_Glyph, @FT_Load_Char, etc. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_New_Size */ + /* */ + /* <Description> */ + /* Create a new size object from a given face object. */ + /* */ + /* <Input> */ + /* face :: A handle to a parent face object. */ + /* */ + /* <Output> */ + /* asize :: A handle to a new size object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* You need to call @FT_Activate_Size in order to select the new size */ + /* for upcoming calls to @FT_Set_Pixel_Sizes, @FT_Set_Char_Size, */ + /* @FT_Load_Glyph, @FT_Load_Char, etc. */ + /* */ FT_EXPORT( FT_Error ) FT_New_Size( FT_Face face, FT_Size* size ); - /************************************************************************** - * - * @function: - * FT_Done_Size - * - * @description: - * Discard a given size object. Note that @FT_Done_Face automatically - * discards all size objects allocated with @FT_New_Size. - * - * @input: - * size :: - * A handle to a target size object. - * - * @return: - * FreeType error code. 0~means success. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Done_Size */ + /* */ + /* <Description> */ + /* Discard a given size object. Note that @FT_Done_Face */ + /* automatically discards all size objects allocated with */ + /* @FT_New_Size. */ + /* */ + /* <Input> */ + /* size :: A handle to a target size object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ FT_EXPORT( FT_Error ) FT_Done_Size( FT_Size size ); - /************************************************************************** - * - * @function: - * FT_Activate_Size - * - * @description: - * Even though it is possible to create several size objects for a given - * face (see @FT_New_Size for details), functions like @FT_Load_Glyph or - * @FT_Load_Char only use the one that has been activated last to - * determine the 'current character pixel size'. - * - * This function can be used to 'activate' a previously created size - * object. - * - * @input: - * size :: - * A handle to a target size object. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * If `face` is the size's parent face object, this function changes the - * value of `face->size` to the input size handle. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Activate_Size */ + /* */ + /* <Description> */ + /* Even though it is possible to create several size objects for a */ + /* given face (see @FT_New_Size for details), functions like */ + /* @FT_Load_Glyph or @FT_Load_Char only use the one that has been */ + /* activated last to determine the `current character pixel size'. */ + /* */ + /* This function can be used to `activate' a previously created size */ + /* object. */ + /* */ + /* <Input> */ + /* size :: A handle to a target size object. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* If `face' is the size's parent face object, this function changes */ + /* the value of `face->size' to the input size handle. */ + /* */ FT_EXPORT( FT_Error ) FT_Activate_Size( FT_Size size ); diff --git a/android/x86_64/include/freetype/ftsnames.h b/android/x86_64/include/freetype/ftsnames.h index fe32ec22..a7b51c2c 100644 --- a/android/x86_64/include/freetype/ftsnames.h +++ b/android/x86_64/include/freetype/ftsnames.h @@ -1,31 +1,30 @@ -/**************************************************************************** - * - * ftsnames.h - * - * Simple interface to access SFNT 'name' tables (which are used - * to hold font names, copyright info, notices, etc.) (specification). - * - * This is _not_ used to retrieve glyph names! - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftsnames.h */ +/* */ +/* Simple interface to access SFNT name tables (which are used */ +/* to hold font names, copyright info, notices, etc.) (specification). */ +/* */ +/* This is _not_ used to retrieve glyph names! */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTSNAMES_H_ #define FTSNAMES_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H -#include FT_PARAMETER_TAGS_H #ifdef FREETYPE_H #error "freetype.h of FreeType 1 has been loaded!" @@ -37,74 +36,65 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * sfnt_names - * - * @title: - * SFNT Names - * - * @abstract: - * Access the names embedded in TrueType and OpenType files. - * - * @description: - * 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. - * - * The definitions below are used to access them if available. - * - * Note that this has nothing to do with glyph names! - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* sfnt_names */ + /* */ + /* <Title> */ + /* SFNT Names */ + /* */ + /* <Abstract> */ + /* Access the names embedded in TrueType and OpenType files. */ + /* */ + /* <Description> */ + /* The TrueType and OpenType specifications allow the inclusion of */ + /* a special `names table' in font files. This table contains */ + /* textual (and internationalized) information regarding the font, */ + /* like family name, copyright, version, etc. */ + /* */ + /* The definitions below are used to access them if available. */ + /* */ + /* Note that this has nothing to do with glyph names! */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @struct: - * FT_SfntName - * - * @description: - * A structure used to model an SFNT 'name' table entry. - * - * @fields: - * platform_id :: - * The platform ID for `string`. See @TT_PLATFORM_XXX for possible - * values. - * - * encoding_id :: - * The encoding ID for `string`. See @TT_APPLE_ID_XXX, @TT_MAC_ID_XXX, - * @TT_ISO_ID_XXX, @TT_MS_ID_XXX, and @TT_ADOBE_ID_XXX for possible - * values. - * - * language_id :: - * The language ID for `string`. See @TT_MAC_LANGID_XXX and - * @TT_MS_LANGID_XXX for possible values. - * - * 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 @FT_Get_Sfnt_LangTag with `language_id` as its argument to - * retrieve the associated language tag. - * - * name_id :: - * An identifier for `string`. See @TT_NAME_ID_XXX for possible - * values. - * - * string :: - * 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. - * - * string_len :: - * The length of `string` in bytes. - * - * @note: - * Please refer to the TrueType or OpenType specification for more - * details. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_SfntName */ + /* */ + /* <Description> */ + /* A structure used to model an SFNT `name' table entry. */ + /* */ + /* <Fields> */ + /* platform_id :: The platform ID for `string'. */ + /* */ + /* encoding_id :: The encoding ID for `string'. */ + /* */ + /* language_id :: The language ID for `string'. */ + /* */ + /* name_id :: An identifier for `string'. */ + /* */ + /* string :: The `name' string. Note that its format differs */ + /* depending on the (platform,encoding) pair. It can */ + /* be a Pascal String, a UTF-16 one, etc. */ + /* */ + /* Generally speaking, the string is not */ + /* zero-terminated. Please refer to the TrueType */ + /* specification for details. */ + /* */ + /* string_len :: The length of `string' in bytes. */ + /* */ + /* <Note> */ + /* Possible values for `platform_id', `encoding_id', `language_id', */ + /* and `name_id' are given in the file `ttnameid.h'. For details */ + /* please refer to the TrueType or OpenType specification. */ + /* */ + /* See also @TT_PLATFORM_XXX, @TT_APPLE_ID_XXX, @TT_MAC_ID_XXX, */ + /* @TT_ISO_ID_XXX, and @TT_MS_ID_XXX. */ + /* */ typedef struct FT_SfntName_ { FT_UShort platform_id; @@ -113,154 +103,91 @@ FT_BEGIN_HEADER FT_UShort name_id; FT_Byte* string; /* this string is *not* null-terminated! */ - FT_UInt string_len; /* in bytes */ + FT_UInt string_len; /* in bytes */ } FT_SfntName; - /************************************************************************** - * - * @function: - * FT_Get_Sfnt_Name_Count - * - * @description: - * Retrieve the number of name strings in the SFNT 'name' table. - * - * @input: - * face :: - * A handle to the source face. - * - * @return: - * The number of strings in the 'name' table. - * - * @note: - * This function always returns an error if the config macro - * `TT_CONFIG_OPTION_SFNT_NAMES` is not defined in `ftoption.h`. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Sfnt_Name_Count */ + /* */ + /* <Description> */ + /* Retrieve the number of name strings in the SFNT `name' table. */ + /* */ + /* <Input> */ + /* face :: A handle to the source face. */ + /* */ + /* <Return> */ + /* The number of strings in the `name' table. */ + /* */ FT_EXPORT( FT_UInt ) FT_Get_Sfnt_Name_Count( FT_Face face ); - /************************************************************************** - * - * @function: - * FT_Get_Sfnt_Name - * - * @description: - * Retrieve a string of the SFNT 'name' table for a given index. - * - * @input: - * face :: - * A handle to the source face. - * - * idx :: - * The index of the 'name' string. - * - * @output: - * aname :: - * The indexed @FT_SfntName structure. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * 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 @FT_Done_Face. - * - * Use @FT_Get_Sfnt_Name_Count to get the total number of available - * 'name' table entries, then do a loop until you get the right platform, - * encoding, and name ID. - * - * 'name' table format~1 entries can use language tags also, see - * @FT_Get_Sfnt_LangTag. - * - * This function always returns an error if the config macro - * `TT_CONFIG_OPTION_SFNT_NAMES` is not defined in `ftoption.h`. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Sfnt_Name */ + /* */ + /* <Description> */ + /* Retrieve a string of the SFNT `name' table for a given index. */ + /* */ + /* <Input> */ + /* face :: A handle to the source face. */ + /* */ + /* idx :: The index of the `name' string. */ + /* */ + /* <Output> */ + /* aname :: The indexed @FT_SfntName structure. */ + /* */ + /* <Return> */ + /* FreeType error code. 0~means success. */ + /* */ + /* <Note> */ + /* The `string' array returned in the `aname' structure is not */ + /* null-terminated. The application should deallocate it if it is no */ + /* longer in use. */ + /* */ + /* Use @FT_Get_Sfnt_Name_Count to get the total number of available */ + /* `name' table entries, then do a loop until you get the right */ + /* platform, encoding, and name ID. */ + /* */ FT_EXPORT( FT_Error ) FT_Get_Sfnt_Name( FT_Face face, FT_UInt idx, FT_SfntName *aname ); - /************************************************************************** + /*************************************************************************** * - * @struct: - * FT_SfntLangTag + * @constant: + * FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY * * @description: - * A structure to model a language tag entry from an SFNT 'name' table. + * A constant used as the tag of @FT_Parameter structures to make + * FT_Open_Face() ignore preferred family subfamily names in `name' + * table since OpenType version 1.4. For backwards compatibility with + * legacy systems that have a 4-face-per-family restriction. * - * @fields: - * string :: - * The language tag string, encoded in UTF-16BE (without trailing - * `NULL` bytes). - * - * string_len :: - * The length of `string` in **bytes**. - * - * @note: - * Please refer to the TrueType or OpenType specification for more - * details. - * - * @since: - * 2.8 */ - typedef struct FT_SfntLangTag_ - { - FT_Byte* string; /* this string is *not* null-terminated! */ - FT_UInt string_len; /* in bytes */ - - } FT_SfntLangTag; +#define FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY FT_MAKE_TAG( 'i', 'g', 'p', 'f' ) - /************************************************************************** + /*************************************************************************** * - * @function: - * FT_Get_Sfnt_LangTag + * @constant: + * FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY * * @description: - * Retrieve the language tag associated with a language ID of an SFNT - * 'name' table entry. + * A constant used as the tag of @FT_Parameter structures to make + * FT_Open_Face() ignore preferred subfamily names in `name' table since + * OpenType version 1.4. For backwards compatibility with legacy + * systems that have a 4-face-per-family restriction. * - * @input: - * face :: - * A handle to the source face. - * - * langID :: - * The language ID, as returned by @FT_Get_Sfnt_Name. This is always a - * value larger than 0x8000. - * - * @output: - * alangTag :: - * The language tag associated with the 'name' table entry's language - * ID. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * 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 @FT_Done_Face. - * - * 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. - * - * This function always returns an error if the config macro - * `TT_CONFIG_OPTION_SFNT_NAMES` is not defined in `ftoption.h`. - * - * @since: - * 2.8 */ - FT_EXPORT( FT_Error ) - FT_Get_Sfnt_LangTag( FT_Face face, - FT_UInt langID, - FT_SfntLangTag *alangTag ); - +#define FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY FT_MAKE_TAG( 'i', 'g', 'p', 's' ) /* */ diff --git a/android/x86_64/include/freetype/ftstroke.h b/android/x86_64/include/freetype/ftstroke.h index 53c4eee5..b3b9922d 100644 --- a/android/x86_64/include/freetype/ftstroke.h +++ b/android/x86_64/include/freetype/ftstroke.h @@ -1,25 +1,25 @@ -/**************************************************************************** - * - * ftstroke.h - * - * FreeType path stroker (specification). - * - * Copyright (C) 2002-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftstroke.h */ +/* */ +/* FreeType path stroker (specification). */ +/* */ +/* Copyright 2002-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTSTROKE_H_ #define FTSTROKE_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_OUTLINE_H #include FT_GLYPH_H @@ -27,113 +27,116 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * glyph_stroker - * - * @title: - * Glyph Stroker - * - * @abstract: - * Generating bordered and stroked glyphs. - * - * @description: - * This component generates stroked outlines of a given vectorial glyph. - * It also allows you to retrieve the 'outside' and/or the 'inside' - * borders of the stroke. - * - * This can be useful to generate 'bordered' glyph, i.e., glyphs - * displayed with a coloured (and anti-aliased) border around their - * shape. - * - * @order: - * FT_Stroker - * - * FT_Stroker_LineJoin - * FT_Stroker_LineCap - * FT_StrokerBorder - * - * FT_Outline_GetInsideBorder - * FT_Outline_GetOutsideBorder - * - * FT_Glyph_Stroke - * FT_Glyph_StrokeBorder - * - * FT_Stroker_New - * FT_Stroker_Set - * FT_Stroker_Rewind - * FT_Stroker_ParseOutline - * FT_Stroker_Done - * - * FT_Stroker_BeginSubPath - * FT_Stroker_EndSubPath - * - * FT_Stroker_LineTo - * FT_Stroker_ConicTo - * FT_Stroker_CubicTo - * - * FT_Stroker_GetBorderCounts - * FT_Stroker_ExportBorder - * FT_Stroker_GetCounts - * FT_Stroker_Export - * - */ + /************************************************************************ + * + * @section: + * glyph_stroker + * + * @title: + * Glyph Stroker + * + * @abstract: + * Generating bordered and stroked glyphs. + * + * @description: + * This component generates stroked outlines of a given vectorial + * glyph. It also allows you to retrieve the `outside' and/or the + * `inside' borders of the stroke. + * + * This can be useful to generate `bordered' glyph, i.e., glyphs + * displayed with a coloured (and anti-aliased) border around their + * shape. + * + * @order: + * FT_Stroker + * + * FT_Stroker_LineJoin + * FT_Stroker_LineCap + * FT_StrokerBorder + * + * FT_Outline_GetInsideBorder + * FT_Outline_GetOutsideBorder + * + * FT_Glyph_Stroke + * FT_Glyph_StrokeBorder + * + * FT_Stroker_New + * FT_Stroker_Set + * FT_Stroker_Rewind + * FT_Stroker_ParseOutline + * FT_Stroker_Done + * + * FT_Stroker_BeginSubPath + * FT_Stroker_EndSubPath + * + * FT_Stroker_LineTo + * FT_Stroker_ConicTo + * FT_Stroker_CubicTo + * + * FT_Stroker_GetBorderCounts + * FT_Stroker_ExportBorder + * FT_Stroker_GetCounts + * FT_Stroker_Export + * + */ - /************************************************************************** - * - * @type: - * FT_Stroker - * - * @description: - * Opaque handle to a path stroker object. - */ + /************************************************************** + * + * @type: + * FT_Stroker + * + * @description: + * Opaque handle to a path stroker object. + */ typedef struct FT_StrokerRec_* FT_Stroker; - /************************************************************************** + /************************************************************** * * @enum: * FT_Stroker_LineJoin * * @description: - * These values determine how two joining lines are rendered in a - * stroker. + * These values determine how two joining lines are rendered + * in a stroker. * * @values: * FT_STROKER_LINEJOIN_ROUND :: - * Used to render rounded line joins. Circular arcs are used to join - * two lines smoothly. + * Used to render rounded line joins. Circular arcs are used + * to join two lines smoothly. * * FT_STROKER_LINEJOIN_BEVEL :: - * Used to render beveled line joins. The outer corner of the joined - * lines is filled by enclosing the triangular region of the corner - * with a straight line between the outer corners of each stroke. + * Used to render beveled line joins. The outer corner of + * the joined lines is filled by enclosing the triangular + * region of the corner with a straight line between the + * outer corners of each stroke. * * FT_STROKER_LINEJOIN_MITER_FIXED :: - * Used to render mitered line joins, with fixed bevels if the miter - * limit is exceeded. The outer edges of the strokes for the two - * segments are extended until they meet at an angle. If the segments - * meet at too sharp an angle (such that the miter would extend from - * the intersection of the segments a distance greater than the product - * of the miter limit value and the border radius), then a bevel join - * (see above) is used instead. This prevents long spikes being - * created. `FT_STROKER_LINEJOIN_MITER_FIXED` generates a miter line - * join as used in PostScript and PDF. + * Used to render mitered line joins, with fixed bevels if the + * miter limit is exceeded. The outer edges of the strokes + * for the two segments are extended until they meet at an + * angle. If the segments meet at too sharp an angle (such + * that the miter would extend from the intersection of the + * segments a distance greater than the product of the miter + * limit value and the border radius), then a bevel join (see + * above) is used instead. This prevents long spikes being + * created. FT_STROKER_LINEJOIN_MITER_FIXED generates a miter + * line join as used in PostScript and PDF. * * FT_STROKER_LINEJOIN_MITER_VARIABLE :: * FT_STROKER_LINEJOIN_MITER :: - * Used to render mitered line joins, with variable bevels if the miter - * limit is exceeded. The intersection of the strokes is clipped at a - * line perpendicular to the bisector of the angle between the strokes, - * at the distance from the intersection of the segments equal to the - * product of the miter limit value and the border radius. This - * prevents long spikes being created. - * `FT_STROKER_LINEJOIN_MITER_VARIABLE` generates a mitered line join - * as used in XPS. `FT_STROKER_LINEJOIN_MITER` is an alias for - * `FT_STROKER_LINEJOIN_MITER_VARIABLE`, retained for backward - * compatibility. + * Used to render mitered line joins, with variable bevels if + * the miter limit is exceeded. The intersection of the + * strokes is clipped at a line perpendicular to the bisector + * of the angle between the strokes, at the distance from the + * intersection of the segments equal to the product of the + * miter limit value and the border radius. This prevents + * long spikes being created. + * FT_STROKER_LINEJOIN_MITER_VARIABLE generates a mitered line + * join as used in XPS. FT_STROKER_LINEJOIN_MITER is an alias + * for FT_STROKER_LINEJOIN_MITER_VARIABLE, retained for + * backwards compatibility. */ typedef enum FT_Stroker_LineJoin_ { @@ -146,25 +149,27 @@ FT_BEGIN_HEADER } FT_Stroker_LineJoin; - /************************************************************************** + /************************************************************** * * @enum: * FT_Stroker_LineCap * * @description: - * These values determine how the end of opened sub-paths are rendered in - * a stroke. + * These values determine how the end of opened sub-paths are + * rendered in a stroke. * * @values: * FT_STROKER_LINECAP_BUTT :: - * The end of lines is rendered as a full stop on the last point - * itself. + * The end of lines is rendered as a full stop on the last + * point itself. * * FT_STROKER_LINECAP_ROUND :: - * The end of lines is rendered as a half-circle around the last point. + * The end of lines is rendered as a half-circle around the + * last point. * * FT_STROKER_LINECAP_SQUARE :: - * The end of lines is rendered as a square around the last point. + * The end of lines is rendered as a square around the + * last point. */ typedef enum FT_Stroker_LineCap_ { @@ -175,14 +180,14 @@ FT_BEGIN_HEADER } FT_Stroker_LineCap; - /************************************************************************** + /************************************************************** * * @enum: * FT_StrokerBorder * * @description: - * These values are used to select a given stroke border in - * @FT_Stroker_GetBorderCounts and @FT_Stroker_ExportBorder. + * These values are used to select a given stroke border + * in @FT_Stroker_GetBorderCounts and @FT_Stroker_ExportBorder. * * @values: * FT_STROKER_BORDER_LEFT :: @@ -192,9 +197,9 @@ FT_BEGIN_HEADER * Select the right border, relative to the drawing direction. * * @note: - * Applications are generally interested in the 'inside' and 'outside' + * Applications are generally interested in the `inside' and `outside' * borders. However, there is no direct mapping between these and the - * 'left' and 'right' ones, since this really depends on the glyph's + * `left' and `right' ones, since this really depends on the glyph's * drawing orientation, which varies between font formats. * * You can however use @FT_Outline_GetInsideBorder and @@ -208,14 +213,14 @@ FT_BEGIN_HEADER } FT_StrokerBorder; - /************************************************************************** + /************************************************************** * * @function: * FT_Outline_GetInsideBorder * * @description: - * Retrieve the @FT_StrokerBorder value corresponding to the 'inside' - * borders of a given outline. + * Retrieve the @FT_StrokerBorder value corresponding to the + * `inside' borders of a given outline. * * @input: * outline :: @@ -229,14 +234,14 @@ FT_BEGIN_HEADER FT_Outline_GetInsideBorder( FT_Outline* outline ); - /************************************************************************** + /************************************************************** * * @function: * FT_Outline_GetOutsideBorder * * @description: - * Retrieve the @FT_StrokerBorder value corresponding to the 'outside' - * borders of a given outline. + * Retrieve the @FT_StrokerBorder value corresponding to the + * `outside' borders of a given outline. * * @input: * outline :: @@ -250,7 +255,7 @@ FT_BEGIN_HEADER FT_Outline_GetOutsideBorder( FT_Outline* outline ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_New @@ -264,7 +269,7 @@ FT_BEGIN_HEADER * * @output: * astroker :: - * A new stroker object handle. `NULL` in case of error. + * A new stroker object handle. NULL in case of error. * * @return: * FreeType error code. 0~means success. @@ -274,7 +279,7 @@ FT_BEGIN_HEADER FT_Stroker *astroker ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_Set @@ -296,12 +301,13 @@ FT_BEGIN_HEADER * The line join style. * * miter_limit :: - * The miter limit for the `FT_STROKER_LINEJOIN_MITER_FIXED` and - * `FT_STROKER_LINEJOIN_MITER_VARIABLE` line join styles, expressed as - * 16.16 fixed-point value. + * The miter limit for the FT_STROKER_LINEJOIN_MITER_FIXED and + * FT_STROKER_LINEJOIN_MITER_VARIABLE line join styles, + * expressed as 16.16 fixed-point value. * * @note: - * The radius is expressed in the same units as the outline coordinates. + * The radius is expressed in the same units as the outline + * coordinates. * * This function calls @FT_Stroker_Rewind automatically. */ @@ -313,15 +319,16 @@ FT_BEGIN_HEADER FT_Fixed miter_limit ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_Rewind * * @description: - * Reset a stroker object without changing its attributes. You should - * call this function before beginning a new series of calls to - * @FT_Stroker_BeginSubPath or @FT_Stroker_EndSubPath. + * Reset a stroker object without changing its attributes. + * You should call this function before beginning a new + * series of calls to @FT_Stroker_BeginSubPath or + * @FT_Stroker_EndSubPath. * * @input: * stroker :: @@ -331,15 +338,15 @@ FT_BEGIN_HEADER FT_Stroker_Rewind( FT_Stroker stroker ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_ParseOutline * * @description: - * A convenience function used to parse a whole outline with the stroker. - * The resulting outline(s) can be retrieved later by functions like - * @FT_Stroker_GetCounts and @FT_Stroker_Export. + * A convenience function used to parse a whole outline with + * the stroker. The resulting outline(s) can be retrieved + * later by functions like @FT_Stroker_GetCounts and @FT_Stroker_Export. * * @input: * stroker :: @@ -349,18 +356,18 @@ FT_BEGIN_HEADER * The source outline. * * opened :: - * A boolean. If~1, the outline is treated as an open path instead of - * a closed one. + * A boolean. If~1, the outline is treated as an open path instead + * of a closed one. * * @return: * FreeType error code. 0~means success. * * @note: - * If `opened` is~0 (the default), the outline is treated as a closed - * path, and the stroker generates two distinct 'border' outlines. + * If `opened' is~0 (the default), the outline is treated as a closed + * path, and the stroker generates two distinct `border' outlines. * - * If `opened` is~1, the outline is processed as an open path, and the - * stroker generates a single 'stroke' outline. + * If `opened' is~1, the outline is processed as an open path, and the + * stroker generates a single `stroke' outline. * * This function calls @FT_Stroker_Rewind automatically. */ @@ -370,7 +377,7 @@ FT_BEGIN_HEADER FT_Bool opened ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_BeginSubPath @@ -392,8 +399,8 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * This function is useful when you need to stroke a path that is not - * stored as an @FT_Outline object. + * This function is useful when you need to stroke a path that is + * not stored as an @FT_Outline object. */ FT_EXPORT( FT_Error ) FT_Stroker_BeginSubPath( FT_Stroker stroker, @@ -401,7 +408,7 @@ FT_BEGIN_HEADER FT_Bool open ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_EndSubPath @@ -417,22 +424,22 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * You should call this function after @FT_Stroker_BeginSubPath. If the - * subpath was not 'opened', this function 'draws' a single line segment - * to the start position when needed. + * You should call this function after @FT_Stroker_BeginSubPath. + * If the subpath was not `opened', this function `draws' a + * single line segment to the start position when needed. */ FT_EXPORT( FT_Error ) FT_Stroker_EndSubPath( FT_Stroker stroker ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_LineTo * * @description: - * 'Draw' a single line segment in the stroker's current sub-path, from - * the last position. + * `Draw' a single line segment in the stroker's current sub-path, + * from the last position. * * @input: * stroker :: @@ -453,13 +460,13 @@ FT_BEGIN_HEADER FT_Vector* to ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_ConicTo * * @description: - * 'Draw' a single quadratic Bezier in the stroker's current sub-path, + * `Draw' a single quadratic Bézier in the stroker's current sub-path, * from the last position. * * @input: @@ -467,7 +474,7 @@ FT_BEGIN_HEADER * The target stroker handle. * * control :: - * A pointer to a Bezier control point. + * A pointer to a Bézier control point. * * to :: * A pointer to the destination point. @@ -485,24 +492,24 @@ FT_BEGIN_HEADER FT_Vector* to ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_CubicTo * * @description: - * 'Draw' a single cubic Bezier in the stroker's current sub-path, from - * the last position. + * `Draw' a single cubic Bézier in the stroker's current sub-path, + * from the last position. * * @input: * stroker :: * The target stroker handle. * * control1 :: - * A pointer to the first Bezier control point. + * A pointer to the first Bézier control point. * * control2 :: - * A pointer to second Bezier control point. + * A pointer to second Bézier control point. * * to :: * A pointer to the destination point. @@ -521,16 +528,16 @@ FT_BEGIN_HEADER FT_Vector* to ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_GetBorderCounts * * @description: - * Call this function once you have finished parsing your paths with the - * stroker. It returns the number of points and contours necessary to - * export one of the 'border' or 'stroke' outlines generated by the - * stroker. + * Call this function once you have finished parsing your paths + * with the stroker. It returns the number of points and + * contours necessary to export one of the `border' or `stroke' + * outlines generated by the stroker. * * @input: * stroker :: @@ -550,15 +557,15 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * When an outline, or a sub-path, is 'closed', the stroker generates two - * independent 'border' outlines, named 'left' and 'right'. + * When an outline, or a sub-path, is `closed', the stroker generates + * two independent `border' outlines, named `left' and `right'. * - * When the outline, or a sub-path, is 'opened', the stroker merges the - * 'border' outlines with caps. The 'left' border receives all points, - * while the 'right' border becomes empty. + * When the outline, or a sub-path, is `opened', the stroker merges + * the `border' outlines with caps. The `left' border receives all + * points, while the `right' border becomes empty. * - * Use the function @FT_Stroker_GetCounts instead if you want to retrieve - * the counts associated to both borders. + * Use the function @FT_Stroker_GetCounts instead if you want to + * retrieve the counts associated to both borders. */ FT_EXPORT( FT_Error ) FT_Stroker_GetBorderCounts( FT_Stroker stroker, @@ -567,17 +574,19 @@ FT_BEGIN_HEADER FT_UInt *anum_contours ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_ExportBorder * * @description: - * Call this function after @FT_Stroker_GetBorderCounts to export the - * corresponding border to your own @FT_Outline structure. + * Call this function after @FT_Stroker_GetBorderCounts to + * export the corresponding border to your own @FT_Outline + * structure. * - * Note that this function appends the border points and contours to your - * outline, but does not try to resize its arrays. + * Note that this function appends the border points and + * contours to your outline, but does not try to resize its + * arrays. * * @input: * stroker :: @@ -590,19 +599,19 @@ FT_BEGIN_HEADER * The target outline handle. * * @note: - * Always call this function after @FT_Stroker_GetBorderCounts to get - * sure that there is enough room in your @FT_Outline object to receive - * all new data. + * Always call this function after @FT_Stroker_GetBorderCounts to + * get sure that there is enough room in your @FT_Outline object to + * receive all new data. * - * When an outline, or a sub-path, is 'closed', the stroker generates two - * independent 'border' outlines, named 'left' and 'right'. + * When an outline, or a sub-path, is `closed', the stroker generates + * two independent `border' outlines, named `left' and `right'. * - * When the outline, or a sub-path, is 'opened', the stroker merges the - * 'border' outlines with caps. The 'left' border receives all points, - * while the 'right' border becomes empty. + * When the outline, or a sub-path, is `opened', the stroker merges + * the `border' outlines with caps. The `left' border receives all + * points, while the `right' border becomes empty. * - * Use the function @FT_Stroker_Export instead if you want to retrieve - * all borders at once. + * Use the function @FT_Stroker_Export instead if you want to + * retrieve all borders at once. */ FT_EXPORT( void ) FT_Stroker_ExportBorder( FT_Stroker stroker, @@ -610,15 +619,16 @@ FT_BEGIN_HEADER FT_Outline* outline ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_GetCounts * * @description: - * Call this function once you have finished parsing your paths with the - * stroker. It returns the number of points and contours necessary to - * export all points/borders from the stroked outline/path. + * Call this function once you have finished parsing your paths + * with the stroker. It returns the number of points and + * contours necessary to export all points/borders from the stroked + * outline/path. * * @input: * stroker :: @@ -640,17 +650,18 @@ FT_BEGIN_HEADER FT_UInt *anum_contours ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_Export * * @description: - * Call this function after @FT_Stroker_GetBorderCounts to export all - * borders to your own @FT_Outline structure. + * Call this function after @FT_Stroker_GetBorderCounts to + * export all borders to your own @FT_Outline structure. * - * Note that this function appends the border points and contours to your - * outline, but does not try to resize its arrays. + * Note that this function appends the border points and + * contours to your outline, but does not try to resize its + * arrays. * * @input: * stroker :: @@ -664,7 +675,7 @@ FT_BEGIN_HEADER FT_Outline* outline ); - /************************************************************************** + /************************************************************** * * @function: * FT_Stroker_Done @@ -674,13 +685,13 @@ FT_BEGIN_HEADER * * @input: * stroker :: - * A stroker handle. Can be `NULL`. + * A stroker handle. Can be NULL. */ FT_EXPORT( void ) FT_Stroker_Done( FT_Stroker stroker ); - /************************************************************************** + /************************************************************** * * @function: * FT_Glyph_Stroke @@ -697,7 +708,8 @@ FT_BEGIN_HEADER * A stroker handle. * * destroy :: - * A Boolean. If~1, the source glyph object is destroyed on success. + * A Boolean. If~1, the source glyph object is destroyed + * on success. * * @return: * FreeType error code. 0~means success. @@ -707,8 +719,8 @@ FT_BEGIN_HEADER * * Adding stroke may yield a significantly wider and taller glyph * depending on how large of a radius was used to stroke the glyph. You - * may need to manually adjust horizontal and vertical advance amounts to - * account for this added size. + * may need to manually adjust horizontal and vertical advance amounts + * to account for this added size. */ FT_EXPORT( FT_Error ) FT_Glyph_Stroke( FT_Glyph *pglyph, @@ -716,14 +728,14 @@ FT_BEGIN_HEADER FT_Bool destroy ); - /************************************************************************** + /************************************************************** * * @function: * FT_Glyph_StrokeBorder * * @description: - * Stroke a given outline glyph object with a given stroker, but only - * return either its inside or outside border. + * Stroke a given outline glyph object with a given stroker, but + * only return either its inside or outside border. * * @inout: * pglyph :: @@ -734,11 +746,12 @@ FT_BEGIN_HEADER * A stroker handle. * * inside :: - * A Boolean. If~1, return the inside border, otherwise the outside - * border. + * A Boolean. If~1, return the inside border, otherwise + * the outside border. * * destroy :: - * A Boolean. If~1, the source glyph object is destroyed on success. + * A Boolean. If~1, the source glyph object is destroyed + * on success. * * @return: * FreeType error code. 0~means success. @@ -748,8 +761,8 @@ FT_BEGIN_HEADER * * Adding stroke may yield a significantly wider and taller glyph * depending on how large of a radius was used to stroke the glyph. You - * may need to manually adjust horizontal and vertical advance amounts to - * account for this added size. + * may need to manually adjust horizontal and vertical advance amounts + * to account for this added size. */ FT_EXPORT( FT_Error ) FT_Glyph_StrokeBorder( FT_Glyph *pglyph, diff --git a/android/x86_64/include/freetype/ftsynth.h b/android/x86_64/include/freetype/ftsynth.h index 98f54c80..fdfcb691 100644 --- a/android/x86_64/include/freetype/ftsynth.h +++ b/android/x86_64/include/freetype/ftsynth.h @@ -1,20 +1,20 @@ -/**************************************************************************** - * - * ftsynth.h - * - * FreeType synthesizing code for emboldening and slanting - * (specification). - * - * Copyright (C) 2000-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftsynth.h */ +/* */ +/* FreeType synthesizing code for emboldening and slanting */ +/* (specification). */ +/* */ +/* Copyright 2000-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ /*************************************************************************/ @@ -35,7 +35,7 @@ /* Main reason for not lifting the functions in this module to a */ - /* 'standard' API is that the used parameters for emboldening and */ + /* `standard' API is that the used parameters for emboldening and */ /* slanting are not configurable. Consider the functions as a */ /* code resource that should be copied into the application and */ /* adapted to the particular needs. */ @@ -45,7 +45,7 @@ #define FTSYNTH_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -57,7 +57,7 @@ FT_BEGIN_HEADER - /* Embolden a glyph by a 'reasonable' value (which is highly a matter of */ + /* Embolden a glyph by a `reasonable' value (which is highly a matter of */ /* taste). This function is actually a convenience function, providing */ /* a wrapper for @FT_Outline_Embolden and @FT_Bitmap_Embolden. */ /* */ diff --git a/android/x86_64/include/freetype/ftsystem.h b/android/x86_64/include/freetype/ftsystem.h index f22bf540..908ae07f 100644 --- a/android/x86_64/include/freetype/ftsystem.h +++ b/android/x86_64/include/freetype/ftsystem.h @@ -1,58 +1,59 @@ -/**************************************************************************** - * - * ftsystem.h - * - * FreeType low-level system interface definition (specification). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftsystem.h */ +/* */ +/* FreeType low-level system interface definition (specification). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTSYSTEM_H_ #define FTSYSTEM_H_ -#include "ft2build.h" +#include <ft2build.h> FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * system_interface - * - * @title: - * System Interface - * - * @abstract: - * How FreeType manages memory and i/o. - * - * @description: - * This section contains various definitions related to memory management - * and i/o access. You need to understand this information if you want to - * use a custom memory manager or you own i/o streams. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* system_interface */ + /* */ + /* <Title> */ + /* System Interface */ + /* */ + /* <Abstract> */ + /* How FreeType manages memory and i/o. */ + /* */ + /* <Description> */ + /* This section contains various definitions related to memory */ + /* management and i/o access. You need to understand this */ + /* information if you want to use a custom memory manager or you own */ + /* i/o streams. */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * M E M O R Y M A N A G E M E N T - * - */ + /*************************************************************************/ + /* */ + /* M E M O R Y M A N A G E M E N T */ + /* */ + /*************************************************************************/ - /************************************************************************** + /************************************************************************* * * @type: * FT_Memory @@ -65,13 +66,13 @@ FT_BEGIN_HEADER typedef struct FT_MemoryRec_* FT_Memory; - /************************************************************************** + /************************************************************************* * * @functype: * FT_Alloc_Func * * @description: - * A function used to allocate `size` bytes from `memory`. + * A function used to allocate `size' bytes from `memory'. * * @input: * memory :: @@ -89,7 +90,7 @@ FT_BEGIN_HEADER long size ); - /************************************************************************** + /************************************************************************* * * @functype: * FT_Free_Func @@ -110,7 +111,7 @@ FT_BEGIN_HEADER void* block ); - /************************************************************************** + /************************************************************************* * * @functype: * FT_Realloc_Func @@ -145,7 +146,7 @@ FT_BEGIN_HEADER void* block ); - /************************************************************************** + /************************************************************************* * * @struct: * FT_MemoryRec @@ -176,14 +177,14 @@ FT_BEGIN_HEADER }; - /************************************************************************** - * - * I / O M A N A G E M E N T - * - */ + /*************************************************************************/ + /* */ + /* I / O M A N A G E M E N T */ + /* */ + /*************************************************************************/ - /************************************************************************** + /************************************************************************* * * @type: * FT_Stream @@ -192,21 +193,21 @@ FT_BEGIN_HEADER * A handle to an input stream. * * @also: - * See @FT_StreamRec for the publicly accessible fields of a given stream - * object. + * See @FT_StreamRec for the publicly accessible fields of a given + * stream object. * */ typedef struct FT_StreamRec_* FT_Stream; - /************************************************************************** + /************************************************************************* * * @struct: * FT_StreamDesc * * @description: * A union type used to store either a long or a pointer. This is used - * to store a file descriptor or a `FILE*` in an input stream. + * to store a file descriptor or a `FILE*' in an input stream. * */ typedef union FT_StreamDesc_ @@ -217,7 +218,7 @@ FT_BEGIN_HEADER } FT_StreamDesc; - /************************************************************************** + /************************************************************************* * * @functype: * FT_Stream_IoFunc @@ -242,8 +243,9 @@ FT_BEGIN_HEADER * The number of bytes effectively read by the stream. * * @note: - * This function might be called to perform a seek or skip operation with - * a `count` of~0. A non-zero return value then indicates an error. + * This function might be called to perform a seek or skip operation + * with a `count' of~0. A non-zero return value then indicates an + * error. * */ typedef unsigned long @@ -253,7 +255,7 @@ FT_BEGIN_HEADER unsigned long count ); - /************************************************************************** + /************************************************************************* * * @functype: * FT_Stream_CloseFunc @@ -263,14 +265,14 @@ FT_BEGIN_HEADER * * @input: * stream :: - * A handle to the target stream. + * A handle to the target stream. * */ typedef void (*FT_Stream_CloseFunc)( FT_Stream stream ); - /************************************************************************** + /************************************************************************* * * @struct: * FT_StreamRec @@ -281,14 +283,14 @@ FT_BEGIN_HEADER * @input: * base :: * For memory-based streams, this is the address of the first stream - * byte in memory. This field should always be set to `NULL` for + * byte in memory. This field should always be set to NULL for * disk-based streams. * * size :: * The stream size in bytes. * * In case of compressed streams where the size is unknown before - * actually doing the decompression, the value is set to 0x7FFFFFFF. + * actually doing the decompression, the value is set to 0x7FFFFFFF. * (Note that this size value can occur for normal streams also; it is * thus just a hint.) * @@ -297,7 +299,7 @@ FT_BEGIN_HEADER * * descriptor :: * This field is a union that can hold an integer or a pointer. It is - * used by stream implementations to store file descriptors or `FILE*` + * used by stream implementations to store file descriptors or `FILE*' * pointers. * * pathname :: @@ -312,13 +314,13 @@ FT_BEGIN_HEADER * The stream's close function. * * memory :: - * The memory manager to use to preload frames. This is set internally - * by FreeType and shouldn't be touched by stream implementations. + * The memory manager to use to preload frames. This is set + * internally by FreeType and shouldn't be touched by stream + * implementations. * * cursor :: * This field is set and used internally by FreeType when parsing - * frames. In particular, the `FT_GET_XXX` macros use this instead of - * the `pos` field. + * frames. * * limit :: * This field is set and used internally by FreeType when parsing diff --git a/android/x86_64/include/freetype/fttrigon.h b/android/x86_64/include/freetype/fttrigon.h index 37e1412f..f789b524 100644 --- a/android/x86_64/include/freetype/fttrigon.h +++ b/android/x86_64/include/freetype/fttrigon.h @@ -1,19 +1,19 @@ -/**************************************************************************** - * - * fttrigon.h - * - * FreeType trigonometric functions (specification). - * - * Copyright (C) 2001-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* fttrigon.h */ +/* */ +/* FreeType trigonometric functions (specification). */ +/* */ +/* Copyright 2001-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTTRIGON_H_ @@ -31,15 +31,15 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * computations - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* computations */ + /* */ + /*************************************************************************/ - /************************************************************************** + /************************************************************************* * * @type: * FT_Angle @@ -52,7 +52,7 @@ FT_BEGIN_HEADER typedef FT_Fixed FT_Angle; - /************************************************************************** + /************************************************************************* * * @macro: * FT_ANGLE_PI @@ -64,7 +64,7 @@ FT_BEGIN_HEADER #define FT_ANGLE_PI ( 180L << 16 ) - /************************************************************************** + /************************************************************************* * * @macro: * FT_ANGLE_2PI @@ -76,7 +76,7 @@ FT_BEGIN_HEADER #define FT_ANGLE_2PI ( FT_ANGLE_PI * 2 ) - /************************************************************************** + /************************************************************************* * * @macro: * FT_ANGLE_PI2 @@ -88,7 +88,7 @@ FT_BEGIN_HEADER #define FT_ANGLE_PI2 ( FT_ANGLE_PI / 2 ) - /************************************************************************** + /************************************************************************* * * @macro: * FT_ANGLE_PI4 @@ -100,7 +100,7 @@ FT_BEGIN_HEADER #define FT_ANGLE_PI4 ( FT_ANGLE_PI / 4 ) - /************************************************************************** + /************************************************************************* * * @function: * FT_Sin @@ -124,7 +124,7 @@ FT_BEGIN_HEADER FT_Sin( FT_Angle angle ); - /************************************************************************** + /************************************************************************* * * @function: * FT_Cos @@ -148,7 +148,7 @@ FT_BEGIN_HEADER FT_Cos( FT_Angle angle ); - /************************************************************************** + /************************************************************************* * * @function: * FT_Tan @@ -168,14 +168,14 @@ FT_BEGIN_HEADER FT_Tan( FT_Angle angle ); - /************************************************************************** + /************************************************************************* * * @function: * FT_Atan2 * * @description: - * Return the arc-tangent corresponding to a given vector (x,y) in the 2d - * plane. + * Return the arc-tangent corresponding to a given vector (x,y) in + * the 2d plane. * * @input: * x :: @@ -193,7 +193,7 @@ FT_BEGIN_HEADER FT_Fixed y ); - /************************************************************************** + /************************************************************************* * * @function: * FT_Angle_Diff @@ -210,7 +210,7 @@ FT_BEGIN_HEADER * Second angle. * * @return: - * Constrained value of `angle2-angle1`. + * Constrained value of `value2-value1'. * */ FT_EXPORT( FT_Angle ) @@ -218,15 +218,15 @@ FT_BEGIN_HEADER FT_Angle angle2 ); - /************************************************************************** + /************************************************************************* * * @function: * FT_Vector_Unit * * @description: * Return the unit vector corresponding to a given angle. After the - * call, the value of `vec.x` will be `cos(angle)`, and the value of - * `vec.y` will be `sin(angle)`. + * call, the value of `vec.x' will be `cos(angle)', and the value of + * `vec.y' will be `sin(angle)'. * * This function is useful to retrieve both the sinus and cosinus of a * given angle quickly. @@ -245,7 +245,7 @@ FT_BEGIN_HEADER FT_Angle angle ); - /************************************************************************** + /************************************************************************* * * @function: * FT_Vector_Rotate @@ -267,7 +267,7 @@ FT_BEGIN_HEADER FT_Angle angle ); - /************************************************************************** + /************************************************************************* * * @function: * FT_Vector_Length @@ -288,7 +288,7 @@ FT_BEGIN_HEADER FT_Vector_Length( FT_Vector* vec ); - /************************************************************************** + /************************************************************************* * * @function: * FT_Vector_Polarize @@ -314,7 +314,7 @@ FT_BEGIN_HEADER FT_Angle *angle ); - /************************************************************************** + /************************************************************************* * * @function: * FT_Vector_From_Polar diff --git a/android/x86_64/include/freetype/ftttdrv.h b/android/x86_64/include/freetype/ftttdrv.h new file mode 100644 index 00000000..6c02e657 --- /dev/null +++ b/android/x86_64/include/freetype/ftttdrv.h @@ -0,0 +1,310 @@ +/***************************************************************************/ +/* */ +/* ftttdrv.h */ +/* */ +/* FreeType API for controlling the TrueType driver */ +/* (specification only). */ +/* */ +/* Copyright 2013-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ + + +#ifndef FTTTDRV_H_ +#define FTTTDRV_H_ + +#include <ft2build.h> +#include FT_FREETYPE_H + +#ifdef FREETYPE_H +#error "freetype.h of FreeType 1 has been loaded!" +#error "Please fix the directory search order for header files" +#error "so that freetype.h of FreeType 2 is found first." +#endif + + +FT_BEGIN_HEADER + + + /************************************************************************** + * + * @section: + * tt_driver + * + * @title: + * The TrueType driver + * + * @abstract: + * Controlling the TrueType driver module. + * + * @description: + * While FreeType's TrueType driver doesn't expose API functions by + * itself, it is possible to control its behaviour with @FT_Property_Set + * and @FT_Property_Get. The following lists the available properties + * together with the necessary macros and structures. + * + * The TrueType driver's module name is `truetype'. + * + * We start with a list of definitions, kindly provided by Greg + * Hitchcock. + * + * _Bi-Level_ _Rendering_ + * + * Monochromatic rendering, exclusively used in the early days of + * TrueType by both Apple and Microsoft. Microsoft's GDI interface + * supported hinting of the right-side bearing point, such that the + * advance width could be non-linear. Most often this was done to + * achieve some level of glyph symmetry. To enable reasonable + * performance (e.g., not having to run hinting on all glyphs just to + * get the widths) there was a bit in the head table indicating if the + * side bearing was hinted, and additional tables, `hdmx' and `LTSH', to + * cache hinting widths across multiple sizes and device aspect ratios. + * + * _Font_ _Smoothing_ + * + * Microsoft's GDI implementation of anti-aliasing. Not traditional + * anti-aliasing as the outlines were hinted before the sampling. The + * widths matched the bi-level rendering. + * + * _ClearType_ _Rendering_ + * + * Technique that uses physical subpixels to improve rendering on LCD + * (and other) displays. Because of the higher resolution, many methods + * of improving symmetry in glyphs through hinting the right-side + * bearing were no longer necessary. This lead to what GDI calls + * `natural widths' ClearType, see + * http://www.beatstamm.com/typography/RTRCh4.htm#Sec21. Since hinting + * has extra resolution, most non-linearity went away, but it is still + * possible for hints to change the advance widths in this mode. + * + * _ClearType_ _Compatible_ _Widths_ + * + * One of the earliest challenges with ClearType was allowing the + * implementation in GDI to be selected without requiring all UI and + * documents to reflow. To address this, a compatible method of + * rendering ClearType was added where the font hints are executed once + * to determine the width in bi-level rendering, and then re-run in + * ClearType, with the difference in widths being absorbed in the font + * hints for ClearType (mostly in the white space of hints); see + * http://www.beatstamm.com/typography/RTRCh4.htm#Sec20. Somewhat by + * definition, compatible width ClearType allows for non-linear widths, + * but only when the bi-level version has non-linear widths. + * + * _ClearType_ _Subpixel_ _Positioning_ + * + * One of the nice benefits of ClearType is the ability to more crisply + * display fractional widths; unfortunately, the GDI model of integer + * bitmaps did not support this. However, the WPF and Direct Write + * frameworks do support fractional widths. DWrite calls this `natural + * mode', not to be confused with GDI's `natural widths'. Subpixel + * positioning, in the current implementation of Direct Write, + * unfortunately does not support hinted advance widths, see + * http://www.beatstamm.com/typography/RTRCh4.htm#Sec22. Note that the + * TrueType interpreter fully allows the advance width to be adjusted in + * this mode, just the DWrite client will ignore those changes. + * + * _ClearType_ _Backwards_ _Compatibility_ + * + * This is a set of exceptions made in the TrueType interpreter to + * minimize hinting techniques that were problematic with the extra + * resolution of ClearType; see + * http://www.beatstamm.com/typography/RTRCh4.htm#Sec1 and + * http://www.microsoft.com/typography/cleartype/truetypecleartype.aspx. + * This technique is not to be confused with ClearType compatible + * widths. ClearType backwards compatibility has no direct impact on + * changing advance widths, but there might be an indirect impact on + * disabling some deltas. This could be worked around in backwards + * compatibility mode. + * + * _Native_ _ClearType_ _Mode_ + * + * (Not to be confused with `natural widths'.) This mode removes all + * the exceptions in the TrueType interpreter when running with + * ClearType. Any issues on widths would still apply, though. + * + */ + + + /************************************************************************** + * + * @property: + * interpreter-version + * + * @description: + * Currently, two versions are available, representing the bytecode + * interpreter with and without subpixel hinting support, + * respectively. The default is subpixel support if + * TT_CONFIG_OPTION_SUBPIXEL_HINTING is defined, and no subpixel + * support otherwise (since it isn't available then). + * + * If subpixel hinting is on, many TrueType bytecode instructions behave + * differently compared to B/W or grayscale rendering (except if `native + * ClearType' is selected by the font). The main idea is to render at a + * much increased horizontal resolution, then sampling down the created + * output to subpixel precision. However, many older fonts are not + * suited to this and must be specially taken care of by applying + * (hardcoded) font-specific tweaks. + * + * Details on subpixel hinting and some of the necessary tweaks can be + * found in Greg Hitchcock's whitepaper at + * `http://www.microsoft.com/typography/cleartype/truetypecleartype.aspx'. + * + * The following example code demonstrates how to activate subpixel + * hinting (omitting the error handling). + * + * { + * FT_Library library; + * FT_Face face; + * FT_UInt interpreter_version = TT_INTERPRETER_VERSION_38; + * + * + * FT_Init_FreeType( &library ); + * + * FT_Property_Set( library, "truetype", + * "interpreter-version", + * &interpreter_version ); + * } + * + * @note: + * This property can be used with @FT_Property_Get also. + * + */ + + + /************************************************************************** + * + * @enum: + * TT_INTERPRETER_VERSION_XXX + * + * @description: + * A list of constants used for the @interpreter-version property to + * select the hinting engine for Truetype fonts. + * + * The numeric value in the constant names represents the version + * number as returned by the `GETINFO' bytecode instruction. + * + * @values: + * TT_INTERPRETER_VERSION_35 :: + * Version~35 corresponds to MS rasterizer v.1.7 as used e.g. in + * Windows~98; only grayscale and B/W rasterizing is supported. + * + * TT_INTERPRETER_VERSION_38 :: + * Version~38 corresponds to MS rasterizer v.1.9; it is roughly + * equivalent to the hinting provided by DirectWrite ClearType (as + * can be found, for example, in the Internet Explorer~9 running on + * Windows~7). + * + * @note: + * This property controls the behaviour of the bytecode interpreter + * and thus how outlines get hinted. It does *not* control how glyph + * get rasterized! In particular, it does not control subpixel color + * filtering. + * + * If FreeType has not been compiled with configuration option + * FT_CONFIG_OPTION_SUBPIXEL_HINTING, selecting version~38 causes an + * `FT_Err_Unimplemented_Feature' error. + * + * Depending on the graphics framework, Microsoft uses different + * bytecode and rendering engines. As a consequence, the version + * numbers returned by a call to the `GETINFO' bytecode instruction are + * more convoluted than desired. + * + * Here are two tables that try to shed some light on the possible + * values for the MS rasterizer engine, together with the additional + * features introduced by it. + * + * { + * GETINFO framework version feature + * ------------------------------------------------------------------- + * 3 GDI (Win 3.1), v1.0 16-bit, first version + * TrueImage + * 33 GDI (Win NT 3.1), v1.5 32-bit + * HP Laserjet + * 34 GDI (Win 95) v1.6 font smoothing, + * new SCANTYPE opcode + * 35 GDI (Win 98/2000) v1.7 (UN)SCALED_COMPONENT_OFFSET + * bits in composite glyphs + * 36 MGDI (Win CE 2) v1.6+ classic ClearType + * 37 GDI (XP and later), v1.8 ClearType + * GDI+ old (before Vista) + * 38 GDI+ old (Vista, Win 7), v1.9 subpixel ClearType, + * WPF Y-direction ClearType, + * additional error checking + * 39 DWrite (before Win 8) v2.0 subpixel ClearType flags + * in GETINFO opcode, + * bug fixes + * 40 GDI+ (after Win 7), v2.1 Y-direction ClearType flag + * DWrite (Win 8) in GETINFO opcode, + * Gray ClearType + * } + * + * The `version' field gives a rough orientation only, since some + * applications provided certain features much earlier (as an example, + * Microsoft Reader used subpixel and Y-direction ClearType already in + * Windows 2000). Similarly, updates to a given framework might include + * improved hinting support. + * + * { + * version sampling rendering comment + * x y x y + * -------------------------------------------------------------- + * v1.0 normal normal B/W B/W bi-level + * v1.6 high high gray gray grayscale + * v1.8 high normal color-filter B/W (GDI) ClearType + * v1.9 high high color-filter gray Color ClearType + * v2.1 high normal gray B/W Gray ClearType + * v2.1 high high gray gray Gray ClearType + * } + * + * Color and Gray ClearType are the two available variants of + * `Y-direction ClearType', meaning grayscale rasterization along the + * Y-direction; the name used in the TrueType specification for this + * feature is `symmetric smoothing'. `Classic ClearType' is the + * original algorithm used before introducing a modified version in + * Win~XP. Another name for v1.6's grayscale rendering is `font + * smoothing', and `Color ClearType' is sometimes also called `DWrite + * ClearType'. To differentiate between today's Color ClearType and the + * earlier ClearType variant with B/W rendering along the vertical axis, + * the latter is sometimes called `GDI ClearType'. + * + * `Normal' and `high' sampling describe the (virtual) resolution to + * access the rasterized outline after the hinting process. `Normal' + * means 1 sample per grid line (i.e., B/W). In the current Microsoft + * implementation, `high' means an extra virtual resolution of 16x16 (or + * 16x1) grid lines per pixel for bytecode instructions like `MIRP'. + * After hinting, these 16 grid lines are mapped to 6x5 (or 6x1) grid + * lines for color filtering if Color ClearType is activated. + * + * Note that `Gray ClearType' is essentially the same as v1.6's + * grayscale rendering. However, the GETINFO instruction handles it + * differently: v1.6 returns bit~12 (hinting for grayscale), while v2.1 + * returns bits~13 (hinting for ClearType), 18 (symmetrical smoothing), + * and~19 (Gray ClearType). Also, this mode respects bits 2 and~3 for + * the version~1 gasp table exclusively (like Color ClearType), while + * v1.6 only respects the values of version~0 (bits 0 and~1). + * + * FreeType doesn't provide all capabilities of the most recent + * ClearType incarnation, thus we identify our subpixel support as + * version~38. + * + */ +#define TT_INTERPRETER_VERSION_35 35 +#define TT_INTERPRETER_VERSION_38 38 + + /* */ + + +FT_END_HEADER + + +#endif /* FTTTDRV_H_ */ + + +/* END */ diff --git a/android/x86_64/include/freetype/fttypes.h b/android/x86_64/include/freetype/fttypes.h index 2a1bdd06..2673e79c 100644 --- a/android/x86_64/include/freetype/fttypes.h +++ b/android/x86_64/include/freetype/fttypes.h @@ -1,26 +1,26 @@ -/**************************************************************************** - * - * fttypes.h - * - * FreeType simple types definitions (specification only). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* fttypes.h */ +/* */ +/* FreeType simple types definitions (specification only). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTTYPES_H_ #define FTTYPES_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_CONFIG_CONFIG_H #include FT_SYSTEM_H #include FT_IMAGE_H @@ -31,327 +31,326 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * basic_types - * - * @title: - * Basic Data Types - * - * @abstract: - * The basic data types defined by the library. - * - * @description: - * 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. - * - * @order: - * FT_Byte - * FT_Bytes - * FT_Char - * FT_Int - * FT_UInt - * FT_Int16 - * FT_UInt16 - * FT_Int32 - * FT_UInt32 - * FT_Int64 - * FT_UInt64 - * FT_Short - * FT_UShort - * FT_Long - * FT_ULong - * FT_Bool - * FT_Offset - * FT_PtrDist - * FT_String - * FT_Tag - * FT_Error - * FT_Fixed - * FT_Pointer - * FT_Pos - * FT_Vector - * FT_BBox - * FT_Matrix - * FT_FWord - * FT_UFWord - * FT_F2Dot14 - * FT_UnitVector - * FT_F26Dot6 - * FT_Data - * - * FT_MAKE_TAG - * - * FT_Generic - * FT_Generic_Finalizer - * - * FT_Bitmap - * FT_Pixel_Mode - * FT_Palette_Mode - * FT_Glyph_Format - * FT_IMAGE_TAG - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* basic_types */ + /* */ + /* <Title> */ + /* Basic Data Types */ + /* */ + /* <Abstract> */ + /* The basic data types defined by the library. */ + /* */ + /* <Description> */ + /* 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. */ + /* */ + /* <Order> */ + /* FT_Byte */ + /* FT_Bytes */ + /* FT_Char */ + /* FT_Int */ + /* FT_UInt */ + /* FT_Int16 */ + /* FT_UInt16 */ + /* FT_Int32 */ + /* FT_UInt32 */ + /* FT_Int64 */ + /* FT_UInt64 */ + /* FT_Short */ + /* FT_UShort */ + /* FT_Long */ + /* FT_ULong */ + /* FT_Bool */ + /* FT_Offset */ + /* FT_PtrDist */ + /* FT_String */ + /* FT_Tag */ + /* FT_Error */ + /* FT_Fixed */ + /* FT_Pointer */ + /* FT_Pos */ + /* FT_Vector */ + /* FT_BBox */ + /* FT_Matrix */ + /* FT_FWord */ + /* FT_UFWord */ + /* FT_F2Dot14 */ + /* FT_UnitVector */ + /* FT_F26Dot6 */ + /* FT_Data */ + /* */ + /* FT_MAKE_TAG */ + /* */ + /* FT_Generic */ + /* FT_Generic_Finalizer */ + /* */ + /* FT_Bitmap */ + /* FT_Pixel_Mode */ + /* FT_Palette_Mode */ + /* FT_Glyph_Format */ + /* FT_IMAGE_TAG */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @type: - * FT_Bool - * - * @description: - * A typedef of unsigned char, used for simple booleans. As usual, - * values 1 and~0 represent true and false, respectively. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Bool */ + /* */ + /* <Description> */ + /* A typedef of unsigned char, used for simple booleans. As usual, */ + /* values 1 and~0 represent true and false, respectively. */ + /* */ typedef unsigned char FT_Bool; - /************************************************************************** - * - * @type: - * FT_FWord - * - * @description: - * A signed 16-bit integer used to store a distance in original font - * units. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_FWord */ + /* */ + /* <Description> */ + /* A signed 16-bit integer used to store a distance in original font */ + /* units. */ + /* */ typedef signed short FT_FWord; /* distance in FUnits */ - /************************************************************************** - * - * @type: - * FT_UFWord - * - * @description: - * An unsigned 16-bit integer used to store a distance in original font - * units. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_UFWord */ + /* */ + /* <Description> */ + /* An unsigned 16-bit integer used to store a distance in original */ + /* font units. */ + /* */ typedef unsigned short FT_UFWord; /* unsigned distance */ - /************************************************************************** - * - * @type: - * FT_Char - * - * @description: - * A simple typedef for the _signed_ char type. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Char */ + /* */ + /* <Description> */ + /* A simple typedef for the _signed_ char type. */ + /* */ typedef signed char FT_Char; - /************************************************************************** - * - * @type: - * FT_Byte - * - * @description: - * A simple typedef for the _unsigned_ char type. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Byte */ + /* */ + /* <Description> */ + /* A simple typedef for the _unsigned_ char type. */ + /* */ typedef unsigned char FT_Byte; - /************************************************************************** - * - * @type: - * FT_Bytes - * - * @description: - * A typedef for constant memory areas. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Bytes */ + /* */ + /* <Description> */ + /* A typedef for constant memory areas. */ + /* */ typedef const FT_Byte* FT_Bytes; - /************************************************************************** - * - * @type: - * FT_Tag - * - * @description: - * A typedef for 32-bit tags (as used in the SFNT format). - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Tag */ + /* */ + /* <Description> */ + /* A typedef for 32-bit tags (as used in the SFNT format). */ + /* */ typedef FT_UInt32 FT_Tag; - /************************************************************************** - * - * @type: - * FT_String - * - * @description: - * A simple typedef for the char type, usually used for strings. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_String */ + /* */ + /* <Description> */ + /* A simple typedef for the char type, usually used for strings. */ + /* */ typedef char FT_String; - /************************************************************************** - * - * @type: - * FT_Short - * - * @description: - * A typedef for signed short. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Short */ + /* */ + /* <Description> */ + /* A typedef for signed short. */ + /* */ typedef signed short FT_Short; - /************************************************************************** - * - * @type: - * FT_UShort - * - * @description: - * A typedef for unsigned short. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_UShort */ + /* */ + /* <Description> */ + /* A typedef for unsigned short. */ + /* */ typedef unsigned short FT_UShort; - /************************************************************************** - * - * @type: - * FT_Int - * - * @description: - * A typedef for the int type. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Int */ + /* */ + /* <Description> */ + /* A typedef for the int type. */ + /* */ typedef signed int FT_Int; - /************************************************************************** - * - * @type: - * FT_UInt - * - * @description: - * A typedef for the unsigned int type. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_UInt */ + /* */ + /* <Description> */ + /* A typedef for the unsigned int type. */ + /* */ typedef unsigned int FT_UInt; - /************************************************************************** - * - * @type: - * FT_Long - * - * @description: - * A typedef for signed long. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Long */ + /* */ + /* <Description> */ + /* A typedef for signed long. */ + /* */ typedef signed long FT_Long; - /************************************************************************** - * - * @type: - * FT_ULong - * - * @description: - * A typedef for unsigned long. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_ULong */ + /* */ + /* <Description> */ + /* A typedef for unsigned long. */ + /* */ typedef unsigned long FT_ULong; - /************************************************************************** - * - * @type: - * FT_F2Dot14 - * - * @description: - * A signed 2.14 fixed-point type used for unit vectors. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_F2Dot14 */ + /* */ + /* <Description> */ + /* A signed 2.14 fixed-point type used for unit vectors. */ + /* */ typedef signed short FT_F2Dot14; - /************************************************************************** - * - * @type: - * FT_F26Dot6 - * - * @description: - * A signed 26.6 fixed-point type used for vectorial pixel coordinates. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_F26Dot6 */ + /* */ + /* <Description> */ + /* A signed 26.6 fixed-point type used for vectorial pixel */ + /* coordinates. */ + /* */ typedef signed long FT_F26Dot6; - /************************************************************************** - * - * @type: - * FT_Fixed - * - * @description: - * This type is used to store 16.16 fixed-point values, like scaling - * values or matrix coefficients. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Fixed */ + /* */ + /* <Description> */ + /* This type is used to store 16.16 fixed-point values, like scaling */ + /* values or matrix coefficients. */ + /* */ typedef signed long FT_Fixed; - /************************************************************************** - * - * @type: - * FT_Error - * - * @description: - * The FreeType error code type. A value of~0 is always interpreted as a - * successful operation. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Error */ + /* */ + /* <Description> */ + /* The FreeType error code type. A value of~0 is always interpreted */ + /* as a successful operation. */ + /* */ typedef int FT_Error; - /************************************************************************** - * - * @type: - * FT_Pointer - * - * @description: - * A simple typedef for a typeless pointer. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Pointer */ + /* */ + /* <Description> */ + /* A simple typedef for a typeless pointer. */ + /* */ typedef void* FT_Pointer; - /************************************************************************** - * - * @type: - * FT_Offset - * - * @description: - * This is equivalent to the ANSI~C `size_t` type, i.e., the largest - * _unsigned_ integer type used to express a file size or position, or a - * memory block size. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_Offset */ + /* */ + /* <Description> */ + /* This is equivalent to the ANSI~C `size_t' type, i.e., the largest */ + /* _unsigned_ integer type used to express a file size or position, */ + /* or a memory block size. */ + /* */ typedef size_t FT_Offset; - /************************************************************************** - * - * @type: - * FT_PtrDist - * - * @description: - * This is equivalent to the ANSI~C `ptrdiff_t` type, i.e., the largest - * _signed_ integer type used to express the distance between two - * pointers. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_PtrDist */ + /* */ + /* <Description> */ + /* This is equivalent to the ANSI~C `ptrdiff_t' type, i.e., the */ + /* largest _signed_ integer type used to express the distance */ + /* between two pointers. */ + /* */ typedef ft_ptrdiff_t FT_PtrDist; - /************************************************************************** - * - * @struct: - * FT_UnitVector - * - * @description: - * A simple structure used to store a 2D vector unit vector. Uses - * FT_F2Dot14 types. - * - * @fields: - * x :: - * Horizontal coordinate. - * - * y :: - * Vertical coordinate. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_UnitVector */ + /* */ + /* <Description> */ + /* A simple structure used to store a 2D vector unit vector. Uses */ + /* FT_F2Dot14 types. */ + /* */ + /* <Fields> */ + /* x :: Horizontal coordinate. */ + /* */ + /* y :: Vertical coordinate. */ + /* */ typedef struct FT_UnitVector_ { FT_F2Dot14 x; @@ -360,33 +359,29 @@ FT_BEGIN_HEADER } FT_UnitVector; - /************************************************************************** - * - * @struct: - * FT_Matrix - * - * @description: - * A simple structure used to store a 2x2 matrix. Coefficients are in - * 16.16 fixed-point format. The computation performed is: - * - * ``` - * x' = x*xx + y*xy - * y' = x*yx + y*yy - * ``` - * - * @fields: - * xx :: - * Matrix coefficient. - * - * xy :: - * Matrix coefficient. - * - * yx :: - * Matrix coefficient. - * - * yy :: - * Matrix coefficient. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Matrix */ + /* */ + /* <Description> */ + /* A simple structure used to store a 2x2 matrix. Coefficients are */ + /* in 16.16 fixed-point format. The computation performed is: */ + /* */ + /* { */ + /* x' = x*xx + y*xy */ + /* y' = x*yx + y*yy */ + /* } */ + /* */ + /* <Fields> */ + /* xx :: Matrix coefficient. */ + /* */ + /* xy :: Matrix coefficient. */ + /* */ + /* yx :: Matrix coefficient. */ + /* */ + /* yy :: Matrix coefficient. */ + /* */ typedef struct FT_Matrix_ { FT_Fixed xx, xy; @@ -395,21 +390,19 @@ FT_BEGIN_HEADER } FT_Matrix; - /************************************************************************** - * - * @struct: - * FT_Data - * - * @description: - * Read-only binary data represented as a pointer and a length. - * - * @fields: - * pointer :: - * The data. - * - * length :: - * The length of the data in bytes. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Data */ + /* */ + /* <Description> */ + /* Read-only binary data represented as a pointer and a length. */ + /* */ + /* <Fields> */ + /* pointer :: The data. */ + /* */ + /* length :: The length of the data in bytes. */ + /* */ typedef struct FT_Data_ { const FT_Byte* pointer; @@ -418,52 +411,51 @@ FT_BEGIN_HEADER } FT_Data; - /************************************************************************** - * - * @functype: - * FT_Generic_Finalizer - * - * @description: - * Describe a function used to destroy the 'client' data of any FreeType - * object. See the description of the @FT_Generic type for details of - * usage. - * - * @input: - * The address of the FreeType object that is under finalization. Its - * client data is accessed through its `generic` field. - */ - typedef void (*FT_Generic_Finalizer)( void* object ); + /*************************************************************************/ + /* */ + /* <FuncType> */ + /* FT_Generic_Finalizer */ + /* */ + /* <Description> */ + /* Describe a function used to destroy the `client' data of any */ + /* FreeType object. See the description of the @FT_Generic type for */ + /* details of usage. */ + /* */ + /* <Input> */ + /* The address of the FreeType object that is under finalization. */ + /* Its client data is accessed through its `generic' field. */ + /* */ + typedef void (*FT_Generic_Finalizer)(void* object); - /************************************************************************** - * - * @struct: - * FT_Generic - * - * @description: - * 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. - * - * Some FreeType object contains a `generic` field, of type `FT_Generic`, - * which usage is left to client applications and font servers. - * - * 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 `finalizer` field). - * - * @fields: - * data :: - * A typeless pointer to any client-specified data. This field is - * completely ignored by the FreeType library. - * - * finalizer :: - * A pointer to a 'generic finalizer' function, which will be called - * when the object is destroyed. If this field is set to `NULL`, no - * code will be called. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_Generic */ + /* */ + /* <Description> */ + /* 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. */ + /* */ + /* Some FreeType object contains a `generic' field, of type */ + /* FT_Generic, which usage is left to client applications and font */ + /* servers. */ + /* */ + /* 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 `finalizer' field). */ + /* */ + /* <Fields> */ + /* data :: A typeless pointer to any client-specified data. This */ + /* field is completely ignored by the FreeType library. */ + /* */ + /* finalizer :: A pointer to a `generic finalizer' function, which */ + /* will be called when the object is destroyed. If this */ + /* field is set to NULL, no code will be called. */ + /* */ typedef struct FT_Generic_ { void* data; @@ -472,19 +464,19 @@ FT_BEGIN_HEADER } FT_Generic; - /************************************************************************** - * - * @macro: - * FT_MAKE_TAG - * - * @description: - * This macro converts four-letter tags that are used to label TrueType - * tables into an unsigned long, to be used within FreeType. - * - * @note: - * The produced values **must** be 32-bit integers. Don't redefine this - * macro. - */ + /*************************************************************************/ + /* */ + /* <Macro> */ + /* FT_MAKE_TAG */ + /* */ + /* <Description> */ + /* This macro converts four-letter tags that are used to label */ + /* TrueType tables into an unsigned long, to be used within FreeType. */ + /* */ + /* <Note> */ + /* The produced values *must* be 32-bit integers. Don't redefine */ + /* this macro. */ + /* */ #define FT_MAKE_TAG( _x1, _x2, _x3, _x4 ) \ (FT_Tag) \ ( ( (FT_ULong)_x1 << 24 ) | \ @@ -502,56 +494,53 @@ FT_BEGIN_HEADER /*************************************************************************/ - /************************************************************************** - * - * @section: - * list_processing - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* list_processing */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @type: - * FT_ListNode - * - * @description: - * Many elements and objects in FreeType are listed through an @FT_List - * record (see @FT_ListRec). As its name suggests, an FT_ListNode is a - * handle to a single list element. - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_ListNode */ + /* */ + /* <Description> */ + /* Many elements and objects in FreeType are listed through an */ + /* @FT_List record (see @FT_ListRec). As its name suggests, an */ + /* FT_ListNode is a handle to a single list element. */ + /* */ typedef struct FT_ListNodeRec_* FT_ListNode; - /************************************************************************** - * - * @type: - * FT_List - * - * @description: - * A handle to a list record (see @FT_ListRec). - */ + /*************************************************************************/ + /* */ + /* <Type> */ + /* FT_List */ + /* */ + /* <Description> */ + /* A handle to a list record (see @FT_ListRec). */ + /* */ typedef struct FT_ListRec_* FT_List; - /************************************************************************** - * - * @struct: - * FT_ListNodeRec - * - * @description: - * A structure used to hold a single list element. - * - * @fields: - * prev :: - * The previous element in the list. `NULL` if first. - * - * next :: - * The next element in the list. `NULL` if last. - * - * data :: - * A typeless pointer to the listed object. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_ListNodeRec */ + /* */ + /* <Description> */ + /* A structure used to hold a single list element. */ + /* */ + /* <Fields> */ + /* prev :: The previous element in the list. NULL if first. */ + /* */ + /* next :: The next element in the list. NULL if last. */ + /* */ + /* data :: A typeless pointer to the listed object. */ + /* */ typedef struct FT_ListNodeRec_ { FT_ListNode prev; @@ -561,22 +550,20 @@ FT_BEGIN_HEADER } FT_ListNodeRec; - /************************************************************************** - * - * @struct: - * FT_ListRec - * - * @description: - * A structure used to hold a simple doubly-linked list. These are used - * in many parts of FreeType. - * - * @fields: - * head :: - * The head (first element) of doubly-linked list. - * - * tail :: - * The tail (last element) of doubly-linked list. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_ListRec */ + /* */ + /* <Description> */ + /* A structure used to hold a simple doubly-linked list. These are */ + /* used in many parts of FreeType. */ + /* */ + /* <Fields> */ + /* head :: The head (first element) of doubly-linked list. */ + /* */ + /* tail :: The tail (last element) of doubly-linked list. */ + /* */ typedef struct FT_ListRec_ { FT_ListNode head; @@ -588,13 +575,13 @@ FT_BEGIN_HEADER #define FT_IS_EMPTY( list ) ( (list).head == 0 ) -#define FT_BOOL( x ) ( (FT_Bool)( (x) != 0 ) ) +#define FT_BOOL( x ) ( (FT_Bool)( x ) ) /* concatenate C tokens */ #define FT_ERR_XCAT( x, y ) x ## y #define FT_ERR_CAT( x, y ) FT_ERR_XCAT( x, y ) - /* see `ftmoderr.h` for descriptions of the following macros */ + /* see `ftmoderr.h' for descriptions of the following macros */ #define FT_ERR( e ) FT_ERR_CAT( FT_ERR_PREFIX, e ) diff --git a/android/x86_64/include/freetype/ftwinfnt.h b/android/x86_64/include/freetype/ftwinfnt.h index 7ef0a972..a1a715ba 100644 --- a/android/x86_64/include/freetype/ftwinfnt.h +++ b/android/x86_64/include/freetype/ftwinfnt.h @@ -1,25 +1,25 @@ -/**************************************************************************** - * - * ftwinfnt.h - * - * FreeType API for accessing Windows fnt-specific data. - * - * Copyright (C) 2003-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ftwinfnt.h */ +/* */ +/* FreeType API for accessing Windows fnt-specific data. */ +/* */ +/* Copyright 2003-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef FTWINFNT_H_ #define FTWINFNT_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -32,43 +32,44 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * winfnt_fonts - * - * @title: - * Window FNT Files - * - * @abstract: - * Windows FNT-specific API. - * - * @description: - * This section contains the declaration of Windows FNT-specific - * functions. - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* winfnt_fonts */ + /* */ + /* <Title> */ + /* Window FNT Files */ + /* */ + /* <Abstract> */ + /* Windows FNT specific API. */ + /* */ + /* <Description> */ + /* This section contains the declaration of Windows FNT specific */ + /* functions. */ + /* */ + /*************************************************************************/ - /************************************************************************** + /************************************************************************* * * @enum: * FT_WinFNT_ID_XXX * * @description: - * A list of valid values for the `charset` byte in @FT_WinFNT_HeaderRec. - * Exact mapping tables for the various 'cpXXXX' encodings (except for - * 'cp1361') can be found at 'ftp://ftp.unicode.org/Public' in the - * `MAPPINGS/VENDORS/MICSFT/WINDOWS` subdirectory. 'cp1361' is roughly a - * superset of `MAPPINGS/OBSOLETE/EASTASIA/KSC/JOHAB.TXT`. + * A list of valid values for the `charset' byte in + * @FT_WinFNT_HeaderRec. Exact mapping tables for the various cpXXXX + * encodings (except for cp1361) can be found at + * ftp://ftp.unicode.org/Public in the MAPPINGS/VENDORS/MICSFT/WINDOWS + * subdirectory. cp1361 is roughly a superset of + * MAPPINGS/OBSOLETE/EASTASIA/KSC/JOHAB.TXT. * * @values: * FT_WinFNT_ID_DEFAULT :: - * This is used for font enumeration and font creation as a 'don't - * care' value. Valid font files don't contain this value. When - * querying for information about the character set of the font that is - * currently selected into a specified device context, this return - * value (of the related Windows API) simply denotes failure. + * This is used for font enumeration and font creation as a + * `don't care' value. Valid font files don't contain this value. + * When querying for information about the character set of the font + * that is currently selected into a specified device context, this + * return value (of the related Windows API) simply denotes failure. * * FT_WinFNT_ID_SYMBOL :: * There is no known mapping table available. @@ -77,29 +78,28 @@ FT_BEGIN_HEADER * Mac Roman encoding. * * FT_WinFNT_ID_OEM :: - * From Michael Poettgen <michael@poettgen.de>: + * From Michael Pöttgen <michael@poettgen.de>: * - * The 'Windows Font Mapping' article says that `FT_WinFNT_ID_OEM` is - * used for the charset of vector fonts, like `modern.fon`, - * `roman.fon`, and `script.fon` on Windows. + * The `Windows Font Mapping' article says that FT_WinFNT_ID_OEM + * is used for the charset of vector fonts, like `modern.fon', + * `roman.fon', and `script.fon' on Windows. * - * The 'CreateFont' documentation says: The `FT_WinFNT_ID_OEM` value - * specifies a character set that is operating-system dependent. + * The `CreateFont' documentation says: The FT_WinFNT_ID_OEM value + * specifies a character set that is operating-system dependent. * - * The 'IFIMETRICS' documentation from the 'Windows Driver Development - * Kit' says: This font supports an OEM-specific character set. The - * OEM character set is system dependent. + * The `IFIMETRICS' documentation from the `Windows Driver + * Development Kit' says: This font supports an OEM-specific + * character set. The OEM character set is system dependent. * - * In general OEM, as opposed to ANSI (i.e., 'cp1252'), denotes the - * second default codepage that most international versions of Windows - * have. It is one of the OEM codepages from + * In general OEM, as opposed to ANSI (i.e., cp1252), denotes the + * second default codepage that most international versions of + * Windows have. It is one of the OEM codepages from * - * https://docs.microsoft.com/en-us/windows/desktop/intl/code-page-identifiers - * , + * https://msdn.microsoft.com/en-us/goglobal/bb964655, * - * and is used for the 'DOS boxes', to support legacy applications. A - * German Windows version for example usually uses ANSI codepage 1252 - * and OEM codepage 850. + * and is used for the `DOS boxes', to support legacy applications. + * A German Windows version for example usually uses ANSI codepage + * 1252 and OEM codepage 850. * * FT_WinFNT_ID_CP874 :: * A superset of Thai TIS 620 and ISO 8859-11. @@ -112,8 +112,8 @@ FT_BEGIN_HEADER * ordering and minor deviations). * * FT_WinFNT_ID_CP949 :: - * A superset of Korean Hangul KS~C 5601-1987 (with different ordering - * and minor deviations). + * A superset of Korean Hangul KS~C 5601-1987 (with different + * ordering and minor deviations). * * FT_WinFNT_ID_CP950 :: * A superset of traditional Chinese Big~5 ETen (with different @@ -173,14 +173,14 @@ FT_BEGIN_HEADER #define FT_WinFNT_ID_OEM 255 - /************************************************************************** - * - * @struct: - * FT_WinFNT_HeaderRec - * - * @description: - * Windows FNT Header info. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_WinFNT_HeaderRec */ + /* */ + /* <Description> */ + /* Windows FNT Header info. */ + /* */ typedef struct FT_WinFNT_HeaderRec_ { FT_UShort version; @@ -223,18 +223,18 @@ FT_BEGIN_HEADER } FT_WinFNT_HeaderRec; - /************************************************************************** - * - * @struct: - * FT_WinFNT_Header - * - * @description: - * A handle to an @FT_WinFNT_HeaderRec structure. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* FT_WinFNT_Header */ + /* */ + /* <Description> */ + /* A handle to an @FT_WinFNT_HeaderRec structure. */ + /* */ typedef struct FT_WinFNT_HeaderRec_* FT_WinFNT_Header; - /************************************************************************** + /********************************************************************** * * @function: * FT_Get_WinFNT_Header @@ -243,12 +243,10 @@ FT_BEGIN_HEADER * Retrieve a Windows FNT font info header. * * @input: - * face :: - * A handle to the input face. + * face :: A handle to the input face. * * @output: - * aheader :: - * The WinFNT header. + * aheader :: The WinFNT header. * * @return: * FreeType error code. 0~means success. diff --git a/android/x86_64/include/freetype/t1tables.h b/android/x86_64/include/freetype/t1tables.h index 926bd5a7..e272324b 100644 --- a/android/x86_64/include/freetype/t1tables.h +++ b/android/x86_64/include/freetype/t1tables.h @@ -1,27 +1,27 @@ -/**************************************************************************** - * - * t1tables.h - * - * Basic Type 1/Type 2 tables definitions and interface (specification - * only). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* t1tables.h */ +/* */ +/* Basic Type 1/Type 2 tables definitions and interface (specification */ +/* only). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef T1TABLES_H_ #define T1TABLES_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -34,58 +34,58 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * type1_tables - * - * @title: - * Type 1 Tables - * - * @abstract: - * Type~1-specific font tables. - * - * @description: - * This section contains the definition of Type~1-specific tables, - * including structures related to other PostScript font formats. - * - * @order: - * PS_FontInfoRec - * PS_FontInfo - * PS_PrivateRec - * PS_Private - * - * CID_FaceDictRec - * CID_FaceDict - * CID_FaceInfoRec - * CID_FaceInfo - * - * FT_Has_PS_Glyph_Names - * FT_Get_PS_Font_Info - * FT_Get_PS_Font_Private - * FT_Get_PS_Font_Value - * - * T1_Blend_Flags - * T1_EncodingType - * PS_Dict_Keys - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* type1_tables */ + /* */ + /* <Title> */ + /* Type 1 Tables */ + /* */ + /* <Abstract> */ + /* Type~1 (PostScript) specific font tables. */ + /* */ + /* <Description> */ + /* This section contains the definition of Type 1-specific tables, */ + /* including structures related to other PostScript font formats. */ + /* */ + /* <Order> */ + /* PS_FontInfoRec */ + /* PS_FontInfo */ + /* PS_PrivateRec */ + /* PS_Private */ + /* */ + /* CID_FaceDictRec */ + /* CID_FaceDict */ + /* CID_FaceInfoRec */ + /* CID_FaceInfo */ + /* */ + /* FT_Has_PS_Glyph_Names */ + /* FT_Get_PS_Font_Info */ + /* FT_Get_PS_Font_Private */ + /* FT_Get_PS_Font_Value */ + /* */ + /* T1_Blend_Flags */ + /* T1_EncodingType */ + /* PS_Dict_Keys */ + /* */ + /*************************************************************************/ /* Note that we separate font data in PS_FontInfoRec and PS_PrivateRec */ /* structures in order to support Multiple Master fonts. */ - /************************************************************************** - * - * @struct: - * PS_FontInfoRec - * - * @description: - * A structure used to model a Type~1 or Type~2 FontInfo dictionary. - * Note that for Multiple Master fonts, each instance has its own - * FontInfo dictionary. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* PS_FontInfoRec */ + /* */ + /* <Description> */ + /* A structure used to model a Type~1 or Type~2 FontInfo dictionary. */ + /* Note that for Multiple Master fonts, each instance has its own */ + /* FontInfo dictionary. */ + /* */ typedef struct PS_FontInfoRec_ { FT_String* version; @@ -101,39 +101,40 @@ FT_BEGIN_HEADER } PS_FontInfoRec; - /************************************************************************** - * - * @struct: - * PS_FontInfo - * - * @description: - * A handle to a @PS_FontInfoRec structure. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* PS_FontInfo */ + /* */ + /* <Description> */ + /* A handle to a @PS_FontInfoRec structure. */ + /* */ typedef struct PS_FontInfoRec_* PS_FontInfo; - /************************************************************************** - * - * @struct: - * T1_FontInfo - * - * @description: - * This type is equivalent to @PS_FontInfoRec. It is deprecated but kept - * to maintain source compatibility between various versions of FreeType. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* T1_FontInfo */ + /* */ + /* <Description> */ + /* This type is equivalent to @PS_FontInfoRec. It is deprecated but */ + /* kept to maintain source compatibility between various versions of */ + /* FreeType. */ + /* */ typedef PS_FontInfoRec T1_FontInfo; - /************************************************************************** - * - * @struct: - * PS_PrivateRec - * - * @description: - * A structure used to model a Type~1 or Type~2 private dictionary. Note - * that for Multiple Master fonts, each instance has its own Private - * dictionary. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* PS_PrivateRec */ + /* */ + /* <Description> */ + /* A structure used to model a Type~1 or Type~2 private dictionary. */ + /* Note that for Multiple Master fonts, each instance has its own */ + /* Private dictionary. */ + /* */ typedef struct PS_PrivateRec_ { FT_Int unique_id; @@ -175,55 +176,56 @@ FT_BEGIN_HEADER } PS_PrivateRec; - /************************************************************************** - * - * @struct: - * PS_Private - * - * @description: - * A handle to a @PS_PrivateRec structure. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* PS_Private */ + /* */ + /* <Description> */ + /* A handle to a @PS_PrivateRec structure. */ + /* */ typedef struct PS_PrivateRec_* PS_Private; - /************************************************************************** - * - * @struct: - * T1_Private - * - * @description: - * This type is equivalent to @PS_PrivateRec. It is deprecated but kept - * to maintain source compatibility between various versions of FreeType. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* T1_Private */ + /* */ + /* <Description> */ + /* This type is equivalent to @PS_PrivateRec. It is deprecated but */ + /* kept to maintain source compatibility between various versions of */ + /* FreeType. */ + /* */ typedef PS_PrivateRec T1_Private; - /************************************************************************** - * - * @enum: - * T1_Blend_Flags - * - * @description: - * A set of flags used to indicate which fields are present in a given - * blend dictionary (font info or private). Used to support Multiple - * Masters fonts. - * - * @values: - * T1_BLEND_UNDERLINE_POSITION :: - * T1_BLEND_UNDERLINE_THICKNESS :: - * T1_BLEND_ITALIC_ANGLE :: - * T1_BLEND_BLUE_VALUES :: - * T1_BLEND_OTHER_BLUES :: - * T1_BLEND_STANDARD_WIDTH :: - * T1_BLEND_STANDARD_HEIGHT :: - * T1_BLEND_STEM_SNAP_WIDTHS :: - * T1_BLEND_STEM_SNAP_HEIGHTS :: - * T1_BLEND_BLUE_SCALE :: - * T1_BLEND_BLUE_SHIFT :: - * T1_BLEND_FAMILY_BLUES :: - * T1_BLEND_FAMILY_OTHER_BLUES :: - * T1_BLEND_FORCE_BOLD :: - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* T1_Blend_Flags */ + /* */ + /* <Description> */ + /* A set of flags used to indicate which fields are present in a */ + /* given blend dictionary (font info or private). Used to support */ + /* Multiple Masters fonts. */ + /* */ + /* <Values> */ + /* T1_BLEND_UNDERLINE_POSITION :: */ + /* T1_BLEND_UNDERLINE_THICKNESS :: */ + /* T1_BLEND_ITALIC_ANGLE :: */ + /* T1_BLEND_BLUE_VALUES :: */ + /* T1_BLEND_OTHER_BLUES :: */ + /* T1_BLEND_STANDARD_WIDTH :: */ + /* T1_BLEND_STANDARD_HEIGHT :: */ + /* T1_BLEND_STEM_SNAP_WIDTHS :: */ + /* T1_BLEND_STEM_SNAP_HEIGHTS :: */ + /* T1_BLEND_BLUE_SCALE :: */ + /* T1_BLEND_BLUE_SHIFT :: */ + /* T1_BLEND_FAMILY_BLUES :: */ + /* T1_BLEND_FAMILY_OTHER_BLUES :: */ + /* T1_BLEND_FORCE_BOLD :: */ + /* */ typedef enum T1_Blend_Flags_ { /* required fields in a FontInfo blend dictionary */ @@ -250,7 +252,7 @@ FT_BEGIN_HEADER /* these constants are deprecated; use the corresponding */ - /* `T1_Blend_Flags` values instead */ + /* `T1_Blend_Flags' values instead */ #define t1_blend_underline_position T1_BLEND_UNDERLINE_POSITION #define t1_blend_underline_thickness T1_BLEND_UNDERLINE_THICKNESS #define t1_blend_italic_angle T1_BLEND_ITALIC_ANGLE @@ -289,7 +291,7 @@ FT_BEGIN_HEADER } PS_DesignMapRec, *PS_DesignMap; - /* backward compatible definition */ + /* backwards-compatible definition */ typedef PS_DesignMapRec T1_DesignMap; @@ -324,27 +326,18 @@ FT_BEGIN_HEADER } PS_BlendRec, *PS_Blend; - /* backward compatible definition */ + /* backwards-compatible definition */ typedef PS_BlendRec T1_Blend; - /************************************************************************** - * - * @struct: - * CID_FaceDictRec - * - * @description: - * A structure used to represent data in a CID top-level dictionary. In - * most cases, they are part of the font's '/FDArray' array. Within a - * CID font file, such (internal) subfont dictionaries are enclosed by - * '%ADOBeginFontDict' and '%ADOEndFontDict' comments. - * - * Note that `CID_FaceDictRec` misses a field for the '/FontName' - * keyword, specifying the subfont's name (the top-level font name is - * given by the '/CIDFontName' keyword). This is an oversight, but it - * doesn't limit the 'cid' font module's functionality because FreeType - * neither needs this entry nor gives access to CID subfonts. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* CID_FaceDictRec */ + /* */ + /* <Description> */ + /* A structure used to represent data in a CID top-level dictionary. */ + /* */ typedef struct CID_FaceDictRec_ { PS_PrivateRec private_dict; @@ -352,8 +345,8 @@ FT_BEGIN_HEADER FT_UInt len_buildchar; FT_Fixed forcebold_threshold; FT_Pos stroke_width; - FT_Fixed expansion_factor; /* this is a duplicate of */ - /* `private_dict->expansion_factor' */ + FT_Fixed expansion_factor; + FT_Byte paint_type; FT_Byte font_type; FT_Matrix font_matrix; @@ -366,38 +359,38 @@ FT_BEGIN_HEADER } CID_FaceDictRec; - /************************************************************************** - * - * @struct: - * CID_FaceDict - * - * @description: - * A handle to a @CID_FaceDictRec structure. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* CID_FaceDict */ + /* */ + /* <Description> */ + /* A handle to a @CID_FaceDictRec structure. */ + /* */ typedef struct CID_FaceDictRec_* CID_FaceDict; - /************************************************************************** - * - * @struct: - * CID_FontDict - * - * @description: - * This type is equivalent to @CID_FaceDictRec. It is deprecated but - * kept to maintain source compatibility between various versions of - * FreeType. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* CID_FontDict */ + /* */ + /* <Description> */ + /* This type is equivalent to @CID_FaceDictRec. It is deprecated but */ + /* kept to maintain source compatibility between various versions of */ + /* FreeType. */ + /* */ typedef CID_FaceDictRec CID_FontDict; - /************************************************************************** - * - * @struct: - * CID_FaceInfoRec - * - * @description: - * A structure used to represent CID Face information. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* CID_FaceInfoRec */ + /* */ + /* <Description> */ + /* A structure used to represent CID Face information. */ + /* */ typedef struct CID_FaceInfoRec_ { FT_String* cid_font_name; @@ -428,45 +421,47 @@ FT_BEGIN_HEADER } CID_FaceInfoRec; - /************************************************************************** - * - * @struct: - * CID_FaceInfo - * - * @description: - * A handle to a @CID_FaceInfoRec structure. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* CID_FaceInfo */ + /* */ + /* <Description> */ + /* A handle to a @CID_FaceInfoRec structure. */ + /* */ typedef struct CID_FaceInfoRec_* CID_FaceInfo; - /************************************************************************** - * - * @struct: - * CID_Info - * - * @description: - * This type is equivalent to @CID_FaceInfoRec. It is deprecated but kept - * to maintain source compatibility between various versions of FreeType. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* CID_Info */ + /* */ + /* <Description> */ + /* This type is equivalent to @CID_FaceInfoRec. It is deprecated but */ + /* kept to maintain source compatibility between various versions of */ + /* FreeType. */ + /* */ typedef CID_FaceInfoRec CID_Info; - /************************************************************************** + /************************************************************************ * * @function: * FT_Has_PS_Glyph_Names * * @description: - * Return true if a given face provides reliable PostScript glyph names. - * This is similar to using the @FT_HAS_GLYPH_NAMES macro, except that - * certain fonts (mostly TrueType) contain incorrect glyph name tables. + * Return true if a given face provides reliable PostScript glyph + * names. This is similar to using the @FT_HAS_GLYPH_NAMES macro, + * except that certain fonts (mostly TrueType) contain incorrect + * glyph name tables. * * When this function returns true, the caller is sure that the glyph * names returned by @FT_Get_Glyph_Name are reliable. * * @input: * face :: - * face handle + * face handle * * @return: * Boolean. True if glyph names are reliable. @@ -476,7 +471,7 @@ FT_BEGIN_HEADER FT_Has_PS_Glyph_Names( FT_Face face ); - /************************************************************************** + /************************************************************************ * * @function: * FT_Get_PS_Font_Info @@ -487,22 +482,22 @@ FT_BEGIN_HEADER * * @input: * face :: - * PostScript face handle. + * PostScript face handle. * * @output: * afont_info :: - * Output font info structure pointer. + * Output font info structure pointer. * * @return: * FreeType error code. 0~means success. * * @note: - * String pointers within the @PS_FontInfoRec structure are owned by the - * face and don't need to be freed by the caller. Missing entries in - * the font's FontInfo dictionary are represented by `NULL` pointers. + * String pointers within the @PS_FontInfoRec structure are owned by + * the face and don't need to be freed by the caller. Missing entries + * in the font's FontInfo dictionary are represented by NULL pointers. * * If the font's format is not PostScript-based, this function will - * return the `FT_Err_Invalid_Argument` error code. + * return the `FT_Err_Invalid_Argument' error code. * */ FT_EXPORT( FT_Error ) @@ -510,7 +505,7 @@ FT_BEGIN_HEADER PS_FontInfo afont_info ); - /************************************************************************** + /************************************************************************ * * @function: * FT_Get_PS_Font_Private @@ -521,11 +516,11 @@ FT_BEGIN_HEADER * * @input: * face :: - * PostScript face handle. + * PostScript face handle. * * @output: * afont_private :: - * Output private dictionary structure pointer. + * Output private dictionary structure pointer. * * @return: * FreeType error code. 0~means success. @@ -535,7 +530,7 @@ FT_BEGIN_HEADER * the face and don't need to be freed by the caller. * * If the font's format is not PostScript-based, this function returns - * the `FT_Err_Invalid_Argument` error code. + * the `FT_Err_Invalid_Argument' error code. * */ FT_EXPORT( FT_Error ) @@ -543,24 +538,22 @@ FT_BEGIN_HEADER PS_Private afont_private ); - /************************************************************************** - * - * @enum: - * T1_EncodingType - * - * @description: - * An enumeration describing the 'Encoding' entry in a Type 1 dictionary. - * - * @values: - * T1_ENCODING_TYPE_NONE :: - * T1_ENCODING_TYPE_ARRAY :: - * T1_ENCODING_TYPE_STANDARD :: - * T1_ENCODING_TYPE_ISOLATIN1 :: - * T1_ENCODING_TYPE_EXPERT :: - * - * @since: - * 2.4.8 - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* T1_EncodingType */ + /* */ + /* <Description> */ + /* An enumeration describing the `Encoding' entry in a Type 1 */ + /* dictionary. */ + /* */ + /* <Values> */ + /* T1_ENCODING_TYPE_NONE :: */ + /* T1_ENCODING_TYPE_ARRAY :: */ + /* T1_ENCODING_TYPE_STANDARD :: */ + /* T1_ENCODING_TYPE_ISOLATIN1 :: */ + /* T1_ENCODING_TYPE_EXPERT :: */ + /* */ typedef enum T1_EncodingType_ { T1_ENCODING_TYPE_NONE = 0, @@ -572,66 +565,63 @@ FT_BEGIN_HEADER } T1_EncodingType; - /************************************************************************** - * - * @enum: - * PS_Dict_Keys - * - * @description: - * An enumeration used in calls to @FT_Get_PS_Font_Value to identify the - * Type~1 dictionary entry to retrieve. - * - * @values: - * PS_DICT_FONT_TYPE :: - * PS_DICT_FONT_MATRIX :: - * PS_DICT_FONT_BBOX :: - * PS_DICT_PAINT_TYPE :: - * PS_DICT_FONT_NAME :: - * PS_DICT_UNIQUE_ID :: - * PS_DICT_NUM_CHAR_STRINGS :: - * PS_DICT_CHAR_STRING_KEY :: - * PS_DICT_CHAR_STRING :: - * PS_DICT_ENCODING_TYPE :: - * PS_DICT_ENCODING_ENTRY :: - * PS_DICT_NUM_SUBRS :: - * PS_DICT_SUBR :: - * PS_DICT_STD_HW :: - * PS_DICT_STD_VW :: - * PS_DICT_NUM_BLUE_VALUES :: - * PS_DICT_BLUE_VALUE :: - * PS_DICT_BLUE_FUZZ :: - * PS_DICT_NUM_OTHER_BLUES :: - * PS_DICT_OTHER_BLUE :: - * PS_DICT_NUM_FAMILY_BLUES :: - * PS_DICT_FAMILY_BLUE :: - * PS_DICT_NUM_FAMILY_OTHER_BLUES :: - * PS_DICT_FAMILY_OTHER_BLUE :: - * PS_DICT_BLUE_SCALE :: - * PS_DICT_BLUE_SHIFT :: - * PS_DICT_NUM_STEM_SNAP_H :: - * PS_DICT_STEM_SNAP_H :: - * PS_DICT_NUM_STEM_SNAP_V :: - * PS_DICT_STEM_SNAP_V :: - * PS_DICT_FORCE_BOLD :: - * PS_DICT_RND_STEM_UP :: - * PS_DICT_MIN_FEATURE :: - * PS_DICT_LEN_IV :: - * PS_DICT_PASSWORD :: - * PS_DICT_LANGUAGE_GROUP :: - * PS_DICT_VERSION :: - * PS_DICT_NOTICE :: - * PS_DICT_FULL_NAME :: - * PS_DICT_FAMILY_NAME :: - * PS_DICT_WEIGHT :: - * PS_DICT_IS_FIXED_PITCH :: - * PS_DICT_UNDERLINE_POSITION :: - * PS_DICT_UNDERLINE_THICKNESS :: - * PS_DICT_FS_TYPE :: - * PS_DICT_ITALIC_ANGLE :: - * - * @since: - * 2.4.8 - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* PS_Dict_Keys */ + /* */ + /* <Description> */ + /* An enumeration used in calls to @FT_Get_PS_Font_Value to identify */ + /* the Type~1 dictionary entry to retrieve. */ + /* */ + /* <Values> */ + /* PS_DICT_FONT_TYPE :: */ + /* PS_DICT_FONT_MATRIX :: */ + /* PS_DICT_FONT_BBOX :: */ + /* PS_DICT_PAINT_TYPE :: */ + /* PS_DICT_FONT_NAME :: */ + /* PS_DICT_UNIQUE_ID :: */ + /* PS_DICT_NUM_CHAR_STRINGS :: */ + /* PS_DICT_CHAR_STRING_KEY :: */ + /* PS_DICT_CHAR_STRING :: */ + /* PS_DICT_ENCODING_TYPE :: */ + /* PS_DICT_ENCODING_ENTRY :: */ + /* PS_DICT_NUM_SUBRS :: */ + /* PS_DICT_SUBR :: */ + /* PS_DICT_STD_HW :: */ + /* PS_DICT_STD_VW :: */ + /* PS_DICT_NUM_BLUE_VALUES :: */ + /* PS_DICT_BLUE_VALUE :: */ + /* PS_DICT_BLUE_FUZZ :: */ + /* PS_DICT_NUM_OTHER_BLUES :: */ + /* PS_DICT_OTHER_BLUE :: */ + /* PS_DICT_NUM_FAMILY_BLUES :: */ + /* PS_DICT_FAMILY_BLUE :: */ + /* PS_DICT_NUM_FAMILY_OTHER_BLUES :: */ + /* PS_DICT_FAMILY_OTHER_BLUE :: */ + /* PS_DICT_BLUE_SCALE :: */ + /* PS_DICT_BLUE_SHIFT :: */ + /* PS_DICT_NUM_STEM_SNAP_H :: */ + /* PS_DICT_STEM_SNAP_H :: */ + /* PS_DICT_NUM_STEM_SNAP_V :: */ + /* PS_DICT_STEM_SNAP_V :: */ + /* PS_DICT_FORCE_BOLD :: */ + /* PS_DICT_RND_STEM_UP :: */ + /* PS_DICT_MIN_FEATURE :: */ + /* PS_DICT_LEN_IV :: */ + /* PS_DICT_PASSWORD :: */ + /* PS_DICT_LANGUAGE_GROUP :: */ + /* PS_DICT_VERSION :: */ + /* PS_DICT_NOTICE :: */ + /* PS_DICT_FULL_NAME :: */ + /* PS_DICT_FAMILY_NAME :: */ + /* PS_DICT_WEIGHT :: */ + /* PS_DICT_IS_FIXED_PITCH :: */ + /* PS_DICT_UNDERLINE_POSITION :: */ + /* PS_DICT_UNDERLINE_THICKNESS :: */ + /* PS_DICT_FS_TYPE :: */ + /* PS_DICT_ITALIC_ANGLE :: */ + /* */ typedef enum PS_Dict_Keys_ { /* conventionally in the font dictionary */ @@ -691,7 +681,7 @@ FT_BEGIN_HEADER } PS_Dict_Keys; - /************************************************************************** + /************************************************************************ * * @function: * FT_Get_PS_Font_Value @@ -701,60 +691,57 @@ FT_BEGIN_HEADER * * @input: * face :: - * PostScript face handle. + * PostScript face handle. * * key :: - * An enumeration value representing the dictionary key to retrieve. + * An enumeration value representing the dictionary key to retrieve. * * idx :: - * For array values, this specifies the index to be returned. + * For array values, this specifies the index to be returned. * * value :: - * A pointer to memory into which to write the value. + * A pointer to memory into which to write the value. * * valen_len :: - * The size, in bytes, of the memory supplied for the value. + * The size, in bytes, of the memory supplied for the value. * * @output: * value :: - * The value matching the above key, if it exists. + * The value matching the above key, if it exists. * * @return: - * The amount of memory (in bytes) required to hold the requested value - * (if it exists, -1 otherwise). + * The amount of memory (in bytes) required to hold the requested + * value (if it exists, -1 otherwise). * * @note: * The values returned are not pointers into the internal structures of - * the face, but are 'fresh' copies, so that the memory containing them + * the face, but are `fresh' copies, so that the memory containing them * belongs to the calling application. This also enforces the - * 'read-only' nature of these values, i.e., this function cannot be + * `read-only' nature of these values, i.e., this function cannot be * used to manipulate the face. * - * `value` is a void pointer because the values returned can be of + * `value' is a void pointer because the values returned can be of * various types. * - * If either `value` is `NULL` or `value_len` is too small, just the + * If either `value' is NULL or `value_len' is too small, just the * required memory size for the requested entry is returned. * - * The `idx` parameter is used, not only to retrieve elements of, for + * The `idx' parameter is used, not only to retrieve elements of, for * example, the FontMatrix or FontBBox, but also to retrieve name keys * from the CharStrings dictionary, and the charstrings themselves. It * is ignored for atomic values. * - * `PS_DICT_BLUE_SCALE` returns a value that is scaled up by 1000. To - * get the value as in the font stream, you need to divide by 65536000.0 - * (to remove the FT_Fixed scale, and the x1000 scale). + * PS_DICT_BLUE_SCALE returns a value that is scaled up by 1000. To + * get the value as in the font stream, you need to divide by + * 65536000.0 (to remove the FT_Fixed scale, and the x1000 scale). * * IMPORTANT: Only key/value pairs read by the FreeType interpreter can - * be retrieved. So, for example, PostScript procedures such as NP, ND, - * and RD are not available. Arbitrary keys are, obviously, not be + * be retrieved. So, for example, PostScript procedures such as NP, + * ND, and RD are not available. Arbitrary keys are, obviously, not be * available either. * * If the font's format is not PostScript-based, this function returns - * the `FT_Err_Invalid_Argument` error code. - * - * @since: - * 2.4.8 + * the `FT_Err_Invalid_Argument' error code. * */ FT_EXPORT( FT_Long ) diff --git a/android/x86_64/include/freetype/ttnameid.h b/android/x86_64/include/freetype/ttnameid.h index 669dc4ad..ce707f16 100644 --- a/android/x86_64/include/freetype/ttnameid.h +++ b/android/x86_64/include/freetype/ttnameid.h @@ -1,79 +1,78 @@ -/**************************************************************************** - * - * ttnameid.h - * - * TrueType name ID definitions (specification only). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* ttnameid.h */ +/* */ +/* TrueType name ID definitions (specification only). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef TTNAMEID_H_ #define TTNAMEID_H_ -#include "ft2build.h" +#include <ft2build.h> FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * truetype_tables - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* truetype_tables */ + /* */ - /************************************************************************** - * - * Possible values for the 'platform' identifier code in the name records - * of an SFNT 'name' table. - * - */ + /*************************************************************************/ + /* */ + /* Possible values for the `platform' identifier code in the name */ + /* records of the TTF `name' table. */ + /* */ + /*************************************************************************/ - /************************************************************************** + /*********************************************************************** * * @enum: * TT_PLATFORM_XXX * * @description: - * A list of valid values for the `platform_id` identifier code in + * A list of valid values for the `platform_id' identifier code in * @FT_CharMapRec and @FT_SfntName structures. * * @values: * TT_PLATFORM_APPLE_UNICODE :: * Used by Apple to indicate a Unicode character map and/or name entry. - * See @TT_APPLE_ID_XXX for corresponding `encoding_id` values. Note + * See @TT_APPLE_ID_XXX for corresponding `encoding_id' values. Note * that name entries in this format are coded as big-endian UCS-2 * character codes _only_. * * TT_PLATFORM_MACINTOSH :: - * Used by Apple to indicate a MacOS-specific charmap and/or name - * entry. See @TT_MAC_ID_XXX for corresponding `encoding_id` values. - * Note that most TrueType fonts contain an Apple roman charmap to be - * usable on MacOS systems (even if they contain a Microsoft charmap as - * well). + * Used by Apple to indicate a MacOS-specific charmap and/or name entry. + * See @TT_MAC_ID_XXX for corresponding `encoding_id' values. Note that + * most TrueType fonts contain an Apple roman charmap to be usable on + * MacOS systems (even if they contain a Microsoft charmap as well). * * TT_PLATFORM_ISO :: - * This value was used to specify ISO/IEC 10646 charmaps. It is - * however now deprecated. See @TT_ISO_ID_XXX for a list of - * corresponding `encoding_id` values. + * This value was used to specify ISO/IEC 10646 charmaps. It is however + * now deprecated. See @TT_ISO_ID_XXX for a list of corresponding + * `encoding_id' values. * * TT_PLATFORM_MICROSOFT :: * Used by Microsoft to indicate Windows-specific charmaps. See - * @TT_MS_ID_XXX for a list of corresponding `encoding_id` values. + * @TT_MS_ID_XXX for a list of corresponding `encoding_id' values. * Note that most fonts contain a Unicode charmap using - * (`TT_PLATFORM_MICROSOFT`, @TT_MS_ID_UNICODE_CS). + * (TT_PLATFORM_MICROSOFT, @TT_MS_ID_UNICODE_CS). * * TT_PLATFORM_CUSTOM :: * Used to indicate application-specific charmaps. @@ -92,13 +91,13 @@ FT_BEGIN_HEADER #define TT_PLATFORM_ADOBE 7 /* artificial */ - /************************************************************************** + /*********************************************************************** * * @enum: * TT_APPLE_ID_XXX * * @description: - * A list of valid values for the `encoding_id` for + * A list of valid values for the `encoding_id' for * @TT_PLATFORM_APPLE_UNICODE charmaps and name entries. * * @values: @@ -118,31 +117,62 @@ FT_BEGIN_HEADER * Unicode 3.1 and beyond, using UTF-32. * * TT_APPLE_ID_VARIANT_SELECTOR :: - * From Adobe, not Apple. Not a normal cmap. Specifies variations on - * a real cmap. - * - * TT_APPLE_ID_FULL_UNICODE :: - * Used for fallback fonts that provide complete Unicode coverage with - * a type~13 cmap. + * From Adobe, not Apple. Not a normal cmap. Specifies variations + * on a real cmap. */ -#define TT_APPLE_ID_DEFAULT 0 /* Unicode 1.0 */ -#define TT_APPLE_ID_UNICODE_1_1 1 /* specify Hangul at U+34xx */ -#define TT_APPLE_ID_ISO_10646 2 /* deprecated */ -#define TT_APPLE_ID_UNICODE_2_0 3 /* or later */ +#define TT_APPLE_ID_DEFAULT 0 /* Unicode 1.0 */ +#define TT_APPLE_ID_UNICODE_1_1 1 /* specify Hangul at U+34xx */ +#define TT_APPLE_ID_ISO_10646 2 /* deprecated */ +#define TT_APPLE_ID_UNICODE_2_0 3 /* or later */ #define TT_APPLE_ID_UNICODE_32 4 /* 2.0 or later, full repertoire */ -#define TT_APPLE_ID_VARIANT_SELECTOR 5 /* variation selector data */ -#define TT_APPLE_ID_FULL_UNICODE 6 /* used with type 13 cmaps */ +#define TT_APPLE_ID_VARIANT_SELECTOR 5 /* variation selector data */ - /************************************************************************** + /*********************************************************************** * * @enum: * TT_MAC_ID_XXX * * @description: - * A list of valid values for the `encoding_id` for + * A list of valid values for the `encoding_id' for * @TT_PLATFORM_MACINTOSH charmaps and name entries. + * + * @values: + * TT_MAC_ID_ROMAN :: + * TT_MAC_ID_JAPANESE :: + * TT_MAC_ID_TRADITIONAL_CHINESE :: + * TT_MAC_ID_KOREAN :: + * TT_MAC_ID_ARABIC :: + * TT_MAC_ID_HEBREW :: + * TT_MAC_ID_GREEK :: + * TT_MAC_ID_RUSSIAN :: + * TT_MAC_ID_RSYMBOL :: + * TT_MAC_ID_DEVANAGARI :: + * TT_MAC_ID_GURMUKHI :: + * TT_MAC_ID_GUJARATI :: + * TT_MAC_ID_ORIYA :: + * TT_MAC_ID_BENGALI :: + * TT_MAC_ID_TAMIL :: + * TT_MAC_ID_TELUGU :: + * TT_MAC_ID_KANNADA :: + * TT_MAC_ID_MALAYALAM :: + * TT_MAC_ID_SINHALESE :: + * TT_MAC_ID_BURMESE :: + * TT_MAC_ID_KHMER :: + * TT_MAC_ID_THAI :: + * TT_MAC_ID_LAOTIAN :: + * TT_MAC_ID_GEORGIAN :: + * TT_MAC_ID_ARMENIAN :: + * TT_MAC_ID_MALDIVIAN :: + * TT_MAC_ID_SIMPLIFIED_CHINESE :: + * TT_MAC_ID_TIBETAN :: + * TT_MAC_ID_MONGOLIAN :: + * TT_MAC_ID_GEEZ :: + * TT_MAC_ID_SLAVIC :: + * TT_MAC_ID_VIETNAMESE :: + * TT_MAC_ID_SINDHI :: + * TT_MAC_ID_UNINTERP :: */ #define TT_MAC_ID_ROMAN 0 @@ -181,14 +211,14 @@ FT_BEGIN_HEADER #define TT_MAC_ID_UNINTERP 32 - /************************************************************************** + /*********************************************************************** * * @enum: * TT_ISO_ID_XXX * * @description: - * A list of valid values for the `encoding_id` for @TT_PLATFORM_ISO - * charmaps and name entries. + * A list of valid values for the `encoding_id' for + * @TT_PLATFORM_ISO charmaps and name entries. * * Their use is now deprecated. * @@ -206,66 +236,64 @@ FT_BEGIN_HEADER #define TT_ISO_ID_8859_1 2 - /************************************************************************** + /*********************************************************************** * * @enum: * TT_MS_ID_XXX * * @description: - * A list of valid values for the `encoding_id` for + * A list of valid values for the `encoding_id' for * @TT_PLATFORM_MICROSOFT charmaps and name entries. * * @values: * TT_MS_ID_SYMBOL_CS :: - * Microsoft symbol encoding. See @FT_ENCODING_MS_SYMBOL. + * Corresponds to Microsoft symbol encoding. See + * @FT_ENCODING_MS_SYMBOL. * * TT_MS_ID_UNICODE_CS :: - * Microsoft WGL4 charmap, matching Unicode. See @FT_ENCODING_UNICODE. + * Corresponds to a Microsoft WGL4 charmap, matching Unicode. See + * @FT_ENCODING_UNICODE. * * TT_MS_ID_SJIS :: - * Shift JIS Japanese encoding. See @FT_ENCODING_SJIS. + * Corresponds to SJIS Japanese encoding. See @FT_ENCODING_SJIS. * - * TT_MS_ID_PRC :: - * Chinese encodings as used in the People's Republic of China (PRC). - * This means the encodings GB~2312 and its supersets GBK and GB~18030. - * See @FT_ENCODING_PRC. + * TT_MS_ID_GB2312 :: + * Corresponds to Simplified Chinese as used in Mainland China. See + * @FT_ENCODING_GB2312. * * TT_MS_ID_BIG_5 :: - * Traditional Chinese as used in Taiwan and Hong Kong. See - * @FT_ENCODING_BIG5. + * Corresponds to Traditional Chinese as used in Taiwan and Hong Kong. + * See @FT_ENCODING_BIG5. * * TT_MS_ID_WANSUNG :: - * Korean Extended Wansung encoding. See @FT_ENCODING_WANSUNG. + * Corresponds to Korean Wansung encoding. See @FT_ENCODING_WANSUNG. * * TT_MS_ID_JOHAB :: - * Korean Johab encoding. See @FT_ENCODING_JOHAB. + * Corresponds to Johab encoding. See @FT_ENCODING_JOHAB. * * TT_MS_ID_UCS_4 :: - * UCS-4 or UTF-32 charmaps. This has been added to the OpenType - * specification version 1.4 (mid-2001). + * Corresponds to UCS-4 or UTF-32 charmaps. This has been added to + * the OpenType specification version 1.4 (mid-2001.) */ #define TT_MS_ID_SYMBOL_CS 0 #define TT_MS_ID_UNICODE_CS 1 #define TT_MS_ID_SJIS 2 -#define TT_MS_ID_PRC 3 +#define TT_MS_ID_GB2312 3 #define TT_MS_ID_BIG_5 4 #define TT_MS_ID_WANSUNG 5 #define TT_MS_ID_JOHAB 6 #define TT_MS_ID_UCS_4 10 - /* this value is deprecated */ -#define TT_MS_ID_GB2312 TT_MS_ID_PRC - - /************************************************************************** + /*********************************************************************** * * @enum: * TT_ADOBE_ID_XXX * * @description: - * A list of valid values for the `encoding_id` for @TT_PLATFORM_ADOBE - * charmaps. This is a FreeType-specific extension! + * A list of valid values for the `encoding_id' for + * @TT_PLATFORM_ADOBE charmaps. This is a FreeType-specific extension! * * @values: * TT_ADOBE_ID_STANDARD :: @@ -284,22 +312,17 @@ FT_BEGIN_HEADER #define TT_ADOBE_ID_LATIN_1 3 - /************************************************************************** - * - * @enum: - * TT_MAC_LANGID_XXX - * - * @description: - * Possible values of the language identifier field in the name records - * of the SFNT 'name' table if the 'platform' identifier code is - * @TT_PLATFORM_MACINTOSH. These values are also used as return values - * for function @FT_Get_CMap_Language_ID. - * - * The canonical source for Apple's IDs is - * - * https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6name.html - */ - + /*************************************************************************/ + /* */ + /* Possible values of the language identifier field in the name records */ + /* of the TTF `name' table if the `platform' identifier code is */ + /* TT_PLATFORM_MACINTOSH. These values are also used as return values */ + /* for function @FT_Get_CMap_Language_ID. */ + /* */ + /* The canonical source for the Apple assigned Language ID's is at */ + /* */ + /* https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6name.html */ + /* */ #define TT_MAC_LANGID_ENGLISH 0 #define TT_MAC_LANGID_FRENCH 1 #define TT_MAC_LANGID_GERMAN 2 @@ -410,6 +433,15 @@ FT_BEGIN_HEADER #define TT_MAC_LANGID_JAVANESE 138 #define TT_MAC_LANGID_SUNDANESE 139 + +#if 0 /* these seem to be errors that have been dropped */ + +#define TT_MAC_LANGID_SCOTTISH_GAELIC 140 +#define TT_MAC_LANGID_IRISH_GAELIC 141 + +#endif + + /* The following codes are new as of 2000-03-10 */ #define TT_MAC_LANGID_GALICIAN 140 #define TT_MAC_LANGID_AFRIKAANS 141 @@ -424,30 +456,18 @@ FT_BEGIN_HEADER #define TT_MAC_LANGID_AZERBAIJANI_ROMAN_SCRIPT 150 - /************************************************************************** - * - * @enum: - * TT_MS_LANGID_XXX - * - * @description: - * Possible values of the language identifier field in the name records - * of the SFNT 'name' table if the 'platform' identifier code is - * @TT_PLATFORM_MICROSOFT. These values are also used as return values - * for function @FT_Get_CMap_Language_ID. - * - * The canonical source for Microsoft's IDs is - * - * https://docs.microsoft.com/en-us/windows/desktop/Intl/language-identifier-constants-and-strings , - * - * however, we only provide macros for language identifiers present in - * the OpenType specification: Microsoft has abandoned the concept of - * LCIDs (language code identifiers), and format~1 of the 'name' table - * provides a better mechanism for languages not covered here. - * - * More legacy values not listed in the reference can be found in the - * @FT_TRUETYPE_IDS_H header file. - */ + /*************************************************************************/ + /* */ + /* Possible values of the language identifier field in the name records */ + /* of the TTF `name' table if the `platform' identifier code is */ + /* TT_PLATFORM_MICROSOFT. */ + /* */ + /* The canonical source for the MS assigned LCIDs is */ + /* */ + /* http://www.microsoft.com/globaldev/reference/lcid-all.mspx */ + /* */ +#define TT_MS_LANGID_ARABIC_GENERAL 0x0001 #define TT_MS_LANGID_ARABIC_SAUDI_ARABIA 0x0401 #define TT_MS_LANGID_ARABIC_IRAQ 0x0801 #define TT_MS_LANGID_ARABIC_EGYPT 0x0C01 @@ -465,20 +485,39 @@ FT_BEGIN_HEADER #define TT_MS_LANGID_ARABIC_BAHRAIN 0x3C01 #define TT_MS_LANGID_ARABIC_QATAR 0x4001 #define TT_MS_LANGID_BULGARIAN_BULGARIA 0x0402 -#define TT_MS_LANGID_CATALAN_CATALAN 0x0403 +#define TT_MS_LANGID_CATALAN_SPAIN 0x0403 +#define TT_MS_LANGID_CHINESE_GENERAL 0x0004 #define TT_MS_LANGID_CHINESE_TAIWAN 0x0404 #define TT_MS_LANGID_CHINESE_PRC 0x0804 #define TT_MS_LANGID_CHINESE_HONG_KONG 0x0C04 #define TT_MS_LANGID_CHINESE_SINGAPORE 0x1004 -#define TT_MS_LANGID_CHINESE_MACAO 0x1404 + +#if 1 /* this looks like the correct value */ +#define TT_MS_LANGID_CHINESE_MACAU 0x1404 +#else /* but beware, Microsoft may change its mind... + the most recent Word reference has the following: */ +#define TT_MS_LANGID_CHINESE_MACAU TT_MS_LANGID_CHINESE_HONG_KONG +#endif + +#if 0 /* used only with .NET `cultures'; commented out */ +#define TT_MS_LANGID_CHINESE_TRADITIONAL 0x7C04 +#endif + #define TT_MS_LANGID_CZECH_CZECH_REPUBLIC 0x0405 #define TT_MS_LANGID_DANISH_DENMARK 0x0406 #define TT_MS_LANGID_GERMAN_GERMANY 0x0407 #define TT_MS_LANGID_GERMAN_SWITZERLAND 0x0807 #define TT_MS_LANGID_GERMAN_AUSTRIA 0x0C07 #define TT_MS_LANGID_GERMAN_LUXEMBOURG 0x1007 -#define TT_MS_LANGID_GERMAN_LIECHTENSTEIN 0x1407 +#define TT_MS_LANGID_GERMAN_LIECHTENSTEI 0x1407 #define TT_MS_LANGID_GREEK_GREECE 0x0408 + + /* don't ask what this one means... It is commented out currently. */ +#if 0 +#define TT_MS_LANGID_GREEK_GREECE2 0x2008 +#endif + +#define TT_MS_LANGID_ENGLISH_GENERAL 0x0009 #define TT_MS_LANGID_ENGLISH_UNITED_STATES 0x0409 #define TT_MS_LANGID_ENGLISH_UNITED_KINGDOM 0x0809 #define TT_MS_LANGID_ENGLISH_AUSTRALIA 0x0C09 @@ -492,12 +531,14 @@ FT_BEGIN_HEADER #define TT_MS_LANGID_ENGLISH_TRINIDAD 0x2C09 #define TT_MS_LANGID_ENGLISH_ZIMBABWE 0x3009 #define TT_MS_LANGID_ENGLISH_PHILIPPINES 0x3409 +#define TT_MS_LANGID_ENGLISH_INDONESIA 0x3809 +#define TT_MS_LANGID_ENGLISH_HONG_KONG 0x3C09 #define TT_MS_LANGID_ENGLISH_INDIA 0x4009 #define TT_MS_LANGID_ENGLISH_MALAYSIA 0x4409 #define TT_MS_LANGID_ENGLISH_SINGAPORE 0x4809 #define TT_MS_LANGID_SPANISH_SPAIN_TRADITIONAL_SORT 0x040A #define TT_MS_LANGID_SPANISH_MEXICO 0x080A -#define TT_MS_LANGID_SPANISH_SPAIN_MODERN_SORT 0x0C0A +#define TT_MS_LANGID_SPANISH_SPAIN_INTERNATIONAL_SORT 0x0C0A #define TT_MS_LANGID_SPANISH_GUATEMALA 0x100A #define TT_MS_LANGID_SPANISH_COSTA_RICA 0x140A #define TT_MS_LANGID_SPANISH_PANAMA 0x180A @@ -516,6 +557,9 @@ FT_BEGIN_HEADER #define TT_MS_LANGID_SPANISH_NICARAGUA 0x4C0A #define TT_MS_LANGID_SPANISH_PUERTO_RICO 0x500A #define TT_MS_LANGID_SPANISH_UNITED_STATES 0x540A + /* The following ID blatantly violate MS specs by using a */ + /* sublanguage > 0x1F. */ +#define TT_MS_LANGID_SPANISH_LATIN_AMERICA 0xE40AU #define TT_MS_LANGID_FINNISH_FINLAND 0x040B #define TT_MS_LANGID_FRENCH_FRANCE 0x040C #define TT_MS_LANGID_FRENCH_BELGIUM 0x080C @@ -523,13 +567,27 @@ FT_BEGIN_HEADER #define TT_MS_LANGID_FRENCH_SWITZERLAND 0x100C #define TT_MS_LANGID_FRENCH_LUXEMBOURG 0x140C #define TT_MS_LANGID_FRENCH_MONACO 0x180C +#define TT_MS_LANGID_FRENCH_WEST_INDIES 0x1C0C +#define TT_MS_LANGID_FRENCH_REUNION 0x200C +#define TT_MS_LANGID_FRENCH_CONGO 0x240C + /* which was formerly: */ +#define TT_MS_LANGID_FRENCH_ZAIRE TT_MS_LANGID_FRENCH_CONGO +#define TT_MS_LANGID_FRENCH_SENEGAL 0x280C +#define TT_MS_LANGID_FRENCH_CAMEROON 0x2C0C +#define TT_MS_LANGID_FRENCH_COTE_D_IVOIRE 0x300C +#define TT_MS_LANGID_FRENCH_MALI 0x340C +#define TT_MS_LANGID_FRENCH_MOROCCO 0x380C +#define TT_MS_LANGID_FRENCH_HAITI 0x3C0C + /* and another violation of the spec (see 0xE40AU) */ +#define TT_MS_LANGID_FRENCH_NORTH_AFRICA 0xE40CU #define TT_MS_LANGID_HEBREW_ISRAEL 0x040D #define TT_MS_LANGID_HUNGARIAN_HUNGARY 0x040E #define TT_MS_LANGID_ICELANDIC_ICELAND 0x040F #define TT_MS_LANGID_ITALIAN_ITALY 0x0410 #define TT_MS_LANGID_ITALIAN_SWITZERLAND 0x0810 #define TT_MS_LANGID_JAPANESE_JAPAN 0x0411 -#define TT_MS_LANGID_KOREAN_KOREA 0x0412 +#define TT_MS_LANGID_KOREAN_EXTENDED_WANSUNG_KOREA 0x0412 +#define TT_MS_LANGID_KOREAN_JOHAB_KOREA 0x0812 #define TT_MS_LANGID_DUTCH_NETHERLANDS 0x0413 #define TT_MS_LANGID_DUTCH_BELGIUM 0x0813 #define TT_MS_LANGID_NORWEGIAN_NORWAY_BOKMAL 0x0414 @@ -537,17 +595,26 @@ FT_BEGIN_HEADER #define TT_MS_LANGID_POLISH_POLAND 0x0415 #define TT_MS_LANGID_PORTUGUESE_BRAZIL 0x0416 #define TT_MS_LANGID_PORTUGUESE_PORTUGAL 0x0816 -#define TT_MS_LANGID_ROMANSH_SWITZERLAND 0x0417 +#define TT_MS_LANGID_RHAETO_ROMANIC_SWITZERLAND 0x0417 #define TT_MS_LANGID_ROMANIAN_ROMANIA 0x0418 +#define TT_MS_LANGID_MOLDAVIAN_MOLDAVIA 0x0818 #define TT_MS_LANGID_RUSSIAN_RUSSIA 0x0419 +#define TT_MS_LANGID_RUSSIAN_MOLDAVIA 0x0819 #define TT_MS_LANGID_CROATIAN_CROATIA 0x041A #define TT_MS_LANGID_SERBIAN_SERBIA_LATIN 0x081A #define TT_MS_LANGID_SERBIAN_SERBIA_CYRILLIC 0x0C1A + +#if 0 /* this used to be this value, but it looks like we were wrong */ +#define TT_MS_LANGID_BOSNIAN_BOSNIA_HERZEGOVINA 0x101A +#else /* current sources say */ #define TT_MS_LANGID_CROATIAN_BOSNIA_HERZEGOVINA 0x101A #define TT_MS_LANGID_BOSNIAN_BOSNIA_HERZEGOVINA 0x141A + /* and XPsp2 Platform SDK added (2004-07-26) */ + /* Names are shortened to be significant within 40 chars. */ #define TT_MS_LANGID_SERBIAN_BOSNIA_HERZ_LATIN 0x181A -#define TT_MS_LANGID_SERBIAN_BOSNIA_HERZ_CYRILLIC 0x1C1A -#define TT_MS_LANGID_BOSNIAN_BOSNIA_HERZ_CYRILLIC 0x201A +#define TT_MS_LANGID_SERBIAN_BOSNIA_HERZ_CYRILLIC 0x181A +#endif + #define TT_MS_LANGID_SLOVAK_SLOVAKIA 0x041B #define TT_MS_LANGID_ALBANIAN_ALBANIA 0x041C #define TT_MS_LANGID_SWEDISH_SWEDEN 0x041D @@ -555,30 +622,36 @@ FT_BEGIN_HEADER #define TT_MS_LANGID_THAI_THAILAND 0x041E #define TT_MS_LANGID_TURKISH_TURKEY 0x041F #define TT_MS_LANGID_URDU_PAKISTAN 0x0420 +#define TT_MS_LANGID_URDU_INDIA 0x0820 #define TT_MS_LANGID_INDONESIAN_INDONESIA 0x0421 #define TT_MS_LANGID_UKRAINIAN_UKRAINE 0x0422 #define TT_MS_LANGID_BELARUSIAN_BELARUS 0x0423 -#define TT_MS_LANGID_SLOVENIAN_SLOVENIA 0x0424 +#define TT_MS_LANGID_SLOVENE_SLOVENIA 0x0424 #define TT_MS_LANGID_ESTONIAN_ESTONIA 0x0425 #define TT_MS_LANGID_LATVIAN_LATVIA 0x0426 #define TT_MS_LANGID_LITHUANIAN_LITHUANIA 0x0427 +#define TT_MS_LANGID_CLASSIC_LITHUANIAN_LITHUANIA 0x0827 #define TT_MS_LANGID_TAJIK_TAJIKISTAN 0x0428 +#define TT_MS_LANGID_FARSI_IRAN 0x0429 #define TT_MS_LANGID_VIETNAMESE_VIET_NAM 0x042A #define TT_MS_LANGID_ARMENIAN_ARMENIA 0x042B #define TT_MS_LANGID_AZERI_AZERBAIJAN_LATIN 0x042C #define TT_MS_LANGID_AZERI_AZERBAIJAN_CYRILLIC 0x082C -#define TT_MS_LANGID_BASQUE_BASQUE 0x042D -#define TT_MS_LANGID_UPPER_SORBIAN_GERMANY 0x042E -#define TT_MS_LANGID_LOWER_SORBIAN_GERMANY 0x082E +#define TT_MS_LANGID_BASQUE_SPAIN 0x042D +#define TT_MS_LANGID_SORBIAN_GERMANY 0x042E #define TT_MS_LANGID_MACEDONIAN_MACEDONIA 0x042F -#define TT_MS_LANGID_SETSWANA_SOUTH_AFRICA 0x0432 -#define TT_MS_LANGID_ISIXHOSA_SOUTH_AFRICA 0x0434 -#define TT_MS_LANGID_ISIZULU_SOUTH_AFRICA 0x0435 +#define TT_MS_LANGID_SUTU_SOUTH_AFRICA 0x0430 +#define TT_MS_LANGID_TSONGA_SOUTH_AFRICA 0x0431 +#define TT_MS_LANGID_TSWANA_SOUTH_AFRICA 0x0432 +#define TT_MS_LANGID_VENDA_SOUTH_AFRICA 0x0433 +#define TT_MS_LANGID_XHOSA_SOUTH_AFRICA 0x0434 +#define TT_MS_LANGID_ZULU_SOUTH_AFRICA 0x0435 #define TT_MS_LANGID_AFRIKAANS_SOUTH_AFRICA 0x0436 #define TT_MS_LANGID_GEORGIAN_GEORGIA 0x0437 #define TT_MS_LANGID_FAEROESE_FAEROE_ISLANDS 0x0438 #define TT_MS_LANGID_HINDI_INDIA 0x0439 #define TT_MS_LANGID_MALTESE_MALTA 0x043A + /* Added by XPsp2 Platform SDK (2004-07-26) */ #define TT_MS_LANGID_SAMI_NORTHERN_NORWAY 0x043B #define TT_MS_LANGID_SAMI_NORTHERN_SWEDEN 0x083B #define TT_MS_LANGID_SAMI_NORTHERN_FINLAND 0x0C3B @@ -588,21 +661,37 @@ FT_BEGIN_HEADER #define TT_MS_LANGID_SAMI_SOUTHERN_SWEDEN 0x1C3B #define TT_MS_LANGID_SAMI_SKOLT_FINLAND 0x203B #define TT_MS_LANGID_SAMI_INARI_FINLAND 0x243B -#define TT_MS_LANGID_IRISH_IRELAND 0x083C + /* ... and we also keep our old identifier... */ +#define TT_MS_LANGID_SAAMI_LAPONIA 0x043B + +#if 0 /* this seems to be a previous inversion */ +#define TT_MS_LANGID_IRISH_GAELIC_IRELAND 0x043C +#define TT_MS_LANGID_SCOTTISH_GAELIC_UNITED_KINGDOM 0x083C +#else +#define TT_MS_LANGID_SCOTTISH_GAELIC_UNITED_KINGDOM 0x083C +#define TT_MS_LANGID_IRISH_GAELIC_IRELAND 0x043C +#endif + +#define TT_MS_LANGID_YIDDISH_GERMANY 0x043D #define TT_MS_LANGID_MALAY_MALAYSIA 0x043E #define TT_MS_LANGID_MALAY_BRUNEI_DARUSSALAM 0x083E -#define TT_MS_LANGID_KAZAKH_KAZAKHSTAN 0x043F -#define TT_MS_LANGID_KYRGYZ_KYRGYZSTAN /* Cyrillic*/ 0x0440 -#define TT_MS_LANGID_KISWAHILI_KENYA 0x0441 +#define TT_MS_LANGID_KAZAK_KAZAKSTAN 0x043F +#define TT_MS_LANGID_KIRGHIZ_KIRGHIZSTAN /* Cyrillic*/ 0x0440 + /* alias declared in Windows 2000 */ +#define TT_MS_LANGID_KIRGHIZ_KIRGHIZ_REPUBLIC \ + TT_MS_LANGID_KIRGHIZ_KIRGHIZSTAN + +#define TT_MS_LANGID_SWAHILI_KENYA 0x0441 #define TT_MS_LANGID_TURKMEN_TURKMENISTAN 0x0442 #define TT_MS_LANGID_UZBEK_UZBEKISTAN_LATIN 0x0443 #define TT_MS_LANGID_UZBEK_UZBEKISTAN_CYRILLIC 0x0843 -#define TT_MS_LANGID_TATAR_RUSSIA 0x0444 +#define TT_MS_LANGID_TATAR_TATARSTAN 0x0444 #define TT_MS_LANGID_BENGALI_INDIA 0x0445 #define TT_MS_LANGID_BENGALI_BANGLADESH 0x0845 #define TT_MS_LANGID_PUNJABI_INDIA 0x0446 +#define TT_MS_LANGID_PUNJABI_ARABIC_PAKISTAN 0x0846 #define TT_MS_LANGID_GUJARATI_INDIA 0x0447 -#define TT_MS_LANGID_ODIA_INDIA 0x0448 +#define TT_MS_LANGID_ORIYA_INDIA 0x0448 #define TT_MS_LANGID_TAMIL_INDIA 0x0449 #define TT_MS_LANGID_TELUGU_INDIA 0x044A #define TT_MS_LANGID_KANNADA_INDIA 0x044B @@ -611,241 +700,142 @@ FT_BEGIN_HEADER #define TT_MS_LANGID_MARATHI_INDIA 0x044E #define TT_MS_LANGID_SANSKRIT_INDIA 0x044F #define TT_MS_LANGID_MONGOLIAN_MONGOLIA /* Cyrillic */ 0x0450 -#define TT_MS_LANGID_MONGOLIAN_PRC 0x0850 -#define TT_MS_LANGID_TIBETAN_PRC 0x0451 -#define TT_MS_LANGID_WELSH_UNITED_KINGDOM 0x0452 +#define TT_MS_LANGID_MONGOLIAN_MONGOLIA_MONGOLIAN 0x0850 +#define TT_MS_LANGID_TIBETAN_CHINA 0x0451 + /* Don't use the next constant! It has */ + /* (1) the wrong spelling (Dzonghka) */ + /* (2) Microsoft doesn't officially define it -- */ + /* at least it is not in the List of Local */ + /* ID Values. */ + /* (3) Dzongkha is not the same language as */ + /* Tibetan, so merging it is wrong anyway. */ + /* */ + /* TT_MS_LANGID_TIBETAN_BHUTAN is correct, BTW. */ +#define TT_MS_LANGID_DZONGHKA_BHUTAN 0x0851 + +#if 0 + /* the following used to be defined */ +#define TT_MS_LANGID_TIBETAN_BHUTAN 0x0451 + /* ... but it was changed; */ +#else + /* So we will continue to #define it, but with the correct value */ +#define TT_MS_LANGID_TIBETAN_BHUTAN TT_MS_LANGID_DZONGHKA_BHUTAN +#endif + +#define TT_MS_LANGID_WELSH_WALES 0x0452 #define TT_MS_LANGID_KHMER_CAMBODIA 0x0453 #define TT_MS_LANGID_LAO_LAOS 0x0454 -#define TT_MS_LANGID_GALICIAN_GALICIAN 0x0456 +#define TT_MS_LANGID_BURMESE_MYANMAR 0x0455 +#define TT_MS_LANGID_GALICIAN_SPAIN 0x0456 #define TT_MS_LANGID_KONKANI_INDIA 0x0457 +#define TT_MS_LANGID_MANIPURI_INDIA /* Bengali */ 0x0458 +#define TT_MS_LANGID_SINDHI_INDIA /* Arabic */ 0x0459 +#define TT_MS_LANGID_SINDHI_PAKISTAN 0x0859 + /* Missing a LCID for Sindhi in Devanagari script */ #define TT_MS_LANGID_SYRIAC_SYRIA 0x045A -#define TT_MS_LANGID_SINHALA_SRI_LANKA 0x045B +#define TT_MS_LANGID_SINHALESE_SRI_LANKA 0x045B +#define TT_MS_LANGID_CHEROKEE_UNITED_STATES 0x045C #define TT_MS_LANGID_INUKTITUT_CANADA 0x045D -#define TT_MS_LANGID_INUKTITUT_CANADA_LATIN 0x085D #define TT_MS_LANGID_AMHARIC_ETHIOPIA 0x045E -#define TT_MS_LANGID_TAMAZIGHT_ALGERIA 0x085F +#define TT_MS_LANGID_TAMAZIGHT_MOROCCO /* Arabic */ 0x045F +#define TT_MS_LANGID_TAMAZIGHT_MOROCCO_LATIN 0x085F + /* Missing a LCID for Tifinagh script */ +#define TT_MS_LANGID_KASHMIRI_PAKISTAN /* Arabic */ 0x0460 + /* Spelled this way by XPsp2 Platform SDK (2004-07-26) */ + /* script is yet unclear... might be Arabic, Nagari or Sharada */ +#define TT_MS_LANGID_KASHMIRI_SASIA 0x0860 + /* ... and aliased (by MS) for compatibility reasons. */ +#define TT_MS_LANGID_KASHMIRI_INDIA TT_MS_LANGID_KASHMIRI_SASIA #define TT_MS_LANGID_NEPALI_NEPAL 0x0461 +#define TT_MS_LANGID_NEPALI_INDIA 0x0861 #define TT_MS_LANGID_FRISIAN_NETHERLANDS 0x0462 #define TT_MS_LANGID_PASHTO_AFGHANISTAN 0x0463 #define TT_MS_LANGID_FILIPINO_PHILIPPINES 0x0464 #define TT_MS_LANGID_DHIVEHI_MALDIVES 0x0465 + /* alias declared in Windows 2000 */ +#define TT_MS_LANGID_DIVEHI_MALDIVES TT_MS_LANGID_DHIVEHI_MALDIVES +#define TT_MS_LANGID_EDO_NIGERIA 0x0466 +#define TT_MS_LANGID_FULFULDE_NIGERIA 0x0467 #define TT_MS_LANGID_HAUSA_NIGERIA 0x0468 +#define TT_MS_LANGID_IBIBIO_NIGERIA 0x0469 #define TT_MS_LANGID_YORUBA_NIGERIA 0x046A #define TT_MS_LANGID_QUECHUA_BOLIVIA 0x046B #define TT_MS_LANGID_QUECHUA_ECUADOR 0x086B #define TT_MS_LANGID_QUECHUA_PERU 0x0C6B -#define TT_MS_LANGID_SESOTHO_SA_LEBOA_SOUTH_AFRICA 0x046C -#define TT_MS_LANGID_BASHKIR_RUSSIA 0x046D -#define TT_MS_LANGID_LUXEMBOURGISH_LUXEMBOURG 0x046E -#define TT_MS_LANGID_GREENLANDIC_GREENLAND 0x046F -#define TT_MS_LANGID_IGBO_NIGERIA 0x0470 -#define TT_MS_LANGID_YI_PRC 0x0478 -#define TT_MS_LANGID_MAPUDUNGUN_CHILE 0x047A -#define TT_MS_LANGID_MOHAWK_MOHAWK 0x047C -#define TT_MS_LANGID_BRETON_FRANCE 0x047E -#define TT_MS_LANGID_UIGHUR_PRC 0x0480 -#define TT_MS_LANGID_MAORI_NEW_ZEALAND 0x0481 -#define TT_MS_LANGID_OCCITAN_FRANCE 0x0482 -#define TT_MS_LANGID_CORSICAN_FRANCE 0x0483 -#define TT_MS_LANGID_ALSATIAN_FRANCE 0x0484 -#define TT_MS_LANGID_YAKUT_RUSSIA 0x0485 -#define TT_MS_LANGID_KICHE_GUATEMALA 0x0486 -#define TT_MS_LANGID_KINYARWANDA_RWANDA 0x0487 -#define TT_MS_LANGID_WOLOF_SENEGAL 0x0488 -#define TT_MS_LANGID_DARI_AFGHANISTAN 0x048C - - /* */ - - - /* legacy macro definitions not present in OpenType 1.8.1 */ -#define TT_MS_LANGID_ARABIC_GENERAL 0x0001 -#define TT_MS_LANGID_CATALAN_SPAIN \ - TT_MS_LANGID_CATALAN_CATALAN -#define TT_MS_LANGID_CHINESE_GENERAL 0x0004 -#define TT_MS_LANGID_CHINESE_MACAU \ - TT_MS_LANGID_CHINESE_MACAO -#define TT_MS_LANGID_GERMAN_LIECHTENSTEI \ - TT_MS_LANGID_GERMAN_LIECHTENSTEIN -#define TT_MS_LANGID_ENGLISH_GENERAL 0x0009 -#define TT_MS_LANGID_ENGLISH_INDONESIA 0x3809 -#define TT_MS_LANGID_ENGLISH_HONG_KONG 0x3C09 -#define TT_MS_LANGID_SPANISH_SPAIN_INTERNATIONAL_SORT \ - TT_MS_LANGID_SPANISH_SPAIN_MODERN_SORT -#define TT_MS_LANGID_SPANISH_LATIN_AMERICA 0xE40AU -#define TT_MS_LANGID_FRENCH_WEST_INDIES 0x1C0C -#define TT_MS_LANGID_FRENCH_REUNION 0x200C -#define TT_MS_LANGID_FRENCH_CONGO 0x240C - /* which was formerly: */ -#define TT_MS_LANGID_FRENCH_ZAIRE \ - TT_MS_LANGID_FRENCH_CONGO -#define TT_MS_LANGID_FRENCH_SENEGAL 0x280C -#define TT_MS_LANGID_FRENCH_CAMEROON 0x2C0C -#define TT_MS_LANGID_FRENCH_COTE_D_IVOIRE 0x300C -#define TT_MS_LANGID_FRENCH_MALI 0x340C -#define TT_MS_LANGID_FRENCH_MOROCCO 0x380C -#define TT_MS_LANGID_FRENCH_HAITI 0x3C0C -#define TT_MS_LANGID_FRENCH_NORTH_AFRICA 0xE40CU -#define TT_MS_LANGID_KOREAN_EXTENDED_WANSUNG_KOREA \ - TT_MS_LANGID_KOREAN_KOREA -#define TT_MS_LANGID_KOREAN_JOHAB_KOREA 0x0812 -#define TT_MS_LANGID_RHAETO_ROMANIC_SWITZERLAND \ - TT_MS_LANGID_ROMANSH_SWITZERLAND -#define TT_MS_LANGID_MOLDAVIAN_MOLDAVIA 0x0818 -#define TT_MS_LANGID_RUSSIAN_MOLDAVIA 0x0819 -#define TT_MS_LANGID_URDU_INDIA 0x0820 -#define TT_MS_LANGID_CLASSIC_LITHUANIAN_LITHUANIA 0x0827 -#define TT_MS_LANGID_SLOVENE_SLOVENIA \ - TT_MS_LANGID_SLOVENIAN_SLOVENIA -#define TT_MS_LANGID_FARSI_IRAN 0x0429 -#define TT_MS_LANGID_BASQUE_SPAIN \ - TT_MS_LANGID_BASQUE_BASQUE -#define TT_MS_LANGID_SORBIAN_GERMANY \ - TT_MS_LANGID_UPPER_SORBIAN_GERMANY -#define TT_MS_LANGID_SUTU_SOUTH_AFRICA 0x0430 -#define TT_MS_LANGID_TSONGA_SOUTH_AFRICA 0x0431 -#define TT_MS_LANGID_TSWANA_SOUTH_AFRICA \ - TT_MS_LANGID_SETSWANA_SOUTH_AFRICA -#define TT_MS_LANGID_VENDA_SOUTH_AFRICA 0x0433 -#define TT_MS_LANGID_XHOSA_SOUTH_AFRICA \ - TT_MS_LANGID_ISIXHOSA_SOUTH_AFRICA -#define TT_MS_LANGID_ZULU_SOUTH_AFRICA \ - TT_MS_LANGID_ISIZULU_SOUTH_AFRICA -#define TT_MS_LANGID_SAAMI_LAPONIA 0x043B - /* the next two values are incorrectly inverted */ -#define TT_MS_LANGID_IRISH_GAELIC_IRELAND 0x043C -#define TT_MS_LANGID_SCOTTISH_GAELIC_UNITED_KINGDOM 0x083C -#define TT_MS_LANGID_YIDDISH_GERMANY 0x043D -#define TT_MS_LANGID_KAZAK_KAZAKSTAN \ - TT_MS_LANGID_KAZAKH_KAZAKHSTAN -#define TT_MS_LANGID_KIRGHIZ_KIRGHIZ_REPUBLIC \ - TT_MS_LANGID_KYRGYZ_KYRGYZSTAN -#define TT_MS_LANGID_KIRGHIZ_KIRGHIZSTAN \ - TT_MS_LANGID_KYRGYZ_KYRGYZSTAN -#define TT_MS_LANGID_SWAHILI_KENYA \ - TT_MS_LANGID_KISWAHILI_KENYA -#define TT_MS_LANGID_TATAR_TATARSTAN \ - TT_MS_LANGID_TATAR_RUSSIA -#define TT_MS_LANGID_PUNJABI_ARABIC_PAKISTAN 0x0846 -#define TT_MS_LANGID_ORIYA_INDIA \ - TT_MS_LANGID_ODIA_INDIA -#define TT_MS_LANGID_MONGOLIAN_MONGOLIA_MONGOLIAN \ - TT_MS_LANGID_MONGOLIAN_PRC -#define TT_MS_LANGID_TIBETAN_CHINA \ - TT_MS_LANGID_TIBETAN_PRC -#define TT_MS_LANGID_DZONGHKA_BHUTAN 0x0851 -#define TT_MS_LANGID_TIBETAN_BHUTAN \ - TT_MS_LANGID_DZONGHKA_BHUTAN -#define TT_MS_LANGID_WELSH_WALES \ - TT_MS_LANGID_WELSH_UNITED_KINGDOM -#define TT_MS_LANGID_BURMESE_MYANMAR 0x0455 -#define TT_MS_LANGID_GALICIAN_SPAIN \ - TT_MS_LANGID_GALICIAN_GALICIAN -#define TT_MS_LANGID_MANIPURI_INDIA /* Bengali */ 0x0458 -#define TT_MS_LANGID_SINDHI_INDIA /* Arabic */ 0x0459 -#define TT_MS_LANGID_SINDHI_PAKISTAN 0x0859 -#define TT_MS_LANGID_SINHALESE_SRI_LANKA \ - TT_MS_LANGID_SINHALA_SRI_LANKA -#define TT_MS_LANGID_CHEROKEE_UNITED_STATES 0x045C -#define TT_MS_LANGID_TAMAZIGHT_MOROCCO /* Arabic */ 0x045F -#define TT_MS_LANGID_TAMAZIGHT_MOROCCO_LATIN \ - TT_MS_LANGID_TAMAZIGHT_ALGERIA -#define TT_MS_LANGID_KASHMIRI_PAKISTAN /* Arabic */ 0x0460 -#define TT_MS_LANGID_KASHMIRI_SASIA 0x0860 -#define TT_MS_LANGID_KASHMIRI_INDIA \ - TT_MS_LANGID_KASHMIRI_SASIA -#define TT_MS_LANGID_NEPALI_INDIA 0x0861 -#define TT_MS_LANGID_DIVEHI_MALDIVES \ - TT_MS_LANGID_DHIVEHI_MALDIVES -#define TT_MS_LANGID_EDO_NIGERIA 0x0466 -#define TT_MS_LANGID_FULFULDE_NIGERIA 0x0467 -#define TT_MS_LANGID_IBIBIO_NIGERIA 0x0469 -#define TT_MS_LANGID_SEPEDI_SOUTH_AFRICA \ - TT_MS_LANGID_SESOTHO_SA_LEBOA_SOUTH_AFRICA +#define TT_MS_LANGID_SEPEDI_SOUTH_AFRICA 0x046C + /* Also spelled by XPsp2 Platform SDK (2004-07-26) */ #define TT_MS_LANGID_SOTHO_SOUTHERN_SOUTH_AFRICA \ - TT_MS_LANGID_SESOTHO_SA_LEBOA_SOUTH_AFRICA + TT_MS_LANGID_SEPEDI_SOUTH_AFRICA + /* language codes 0x046D, 0x046E and 0x046F are (still) unknown. */ +#define TT_MS_LANGID_IGBO_NIGERIA 0x0470 #define TT_MS_LANGID_KANURI_NIGERIA 0x0471 #define TT_MS_LANGID_OROMO_ETHIOPIA 0x0472 #define TT_MS_LANGID_TIGRIGNA_ETHIOPIA 0x0473 #define TT_MS_LANGID_TIGRIGNA_ERYTHREA 0x0873 -#define TT_MS_LANGID_TIGRIGNA_ERYTREA \ - TT_MS_LANGID_TIGRIGNA_ERYTHREA + /* also spelled in the `Passport SDK' list as: */ +#define TT_MS_LANGID_TIGRIGNA_ERYTREA TT_MS_LANGID_TIGRIGNA_ERYTHREA #define TT_MS_LANGID_GUARANI_PARAGUAY 0x0474 #define TT_MS_LANGID_HAWAIIAN_UNITED_STATES 0x0475 #define TT_MS_LANGID_LATIN 0x0476 #define TT_MS_LANGID_SOMALI_SOMALIA 0x0477 -#define TT_MS_LANGID_YI_CHINA \ - TT_MS_LANGID_YI_PRC + /* Note: Yi does not have a (proper) ISO 639-2 code, since it is mostly */ + /* not written (but OTOH the peculiar writing system is worth */ + /* studying). */ +#define TT_MS_LANGID_YI_CHINA 0x0478 #define TT_MS_LANGID_PAPIAMENTU_NETHERLANDS_ANTILLES 0x0479 -#define TT_MS_LANGID_UIGHUR_CHINA \ - TT_MS_LANGID_UIGHUR_PRC + /* language codes from 0x047A to 0x047F are (still) unknown. */ +#define TT_MS_LANGID_UIGHUR_CHINA 0x0480 +#define TT_MS_LANGID_MAORI_NEW_ZEALAND 0x0481 + +#if 0 /* not deemed useful for fonts */ +#define TT_MS_LANGID_HUMAN_INTERFACE_DEVICE 0x04FF +#endif - /************************************************************************** - * - * @enum: - * TT_NAME_ID_XXX - * - * @description: - * Possible values of the 'name' identifier field in the name records of - * an SFNT 'name' table. These values are platform independent. - */ - -#define TT_NAME_ID_COPYRIGHT 0 -#define TT_NAME_ID_FONT_FAMILY 1 -#define TT_NAME_ID_FONT_SUBFAMILY 2 -#define TT_NAME_ID_UNIQUE_ID 3 -#define TT_NAME_ID_FULL_NAME 4 -#define TT_NAME_ID_VERSION_STRING 5 -#define TT_NAME_ID_PS_NAME 6 -#define TT_NAME_ID_TRADEMARK 7 + /*************************************************************************/ + /* */ + /* Possible values of the `name' identifier field in the name records of */ + /* the TTF `name' table. These values are platform independent. */ + /* */ +#define TT_NAME_ID_COPYRIGHT 0 +#define TT_NAME_ID_FONT_FAMILY 1 +#define TT_NAME_ID_FONT_SUBFAMILY 2 +#define TT_NAME_ID_UNIQUE_ID 3 +#define TT_NAME_ID_FULL_NAME 4 +#define TT_NAME_ID_VERSION_STRING 5 +#define TT_NAME_ID_PS_NAME 6 +#define TT_NAME_ID_TRADEMARK 7 /* the following values are from the OpenType spec */ -#define TT_NAME_ID_MANUFACTURER 8 -#define TT_NAME_ID_DESIGNER 9 -#define TT_NAME_ID_DESCRIPTION 10 -#define TT_NAME_ID_VENDOR_URL 11 -#define TT_NAME_ID_DESIGNER_URL 12 -#define TT_NAME_ID_LICENSE 13 -#define TT_NAME_ID_LICENSE_URL 14 +#define TT_NAME_ID_MANUFACTURER 8 +#define TT_NAME_ID_DESIGNER 9 +#define TT_NAME_ID_DESCRIPTION 10 +#define TT_NAME_ID_VENDOR_URL 11 +#define TT_NAME_ID_DESIGNER_URL 12 +#define TT_NAME_ID_LICENSE 13 +#define TT_NAME_ID_LICENSE_URL 14 /* number 15 is reserved */ -#define TT_NAME_ID_TYPOGRAPHIC_FAMILY 16 -#define TT_NAME_ID_TYPOGRAPHIC_SUBFAMILY 17 -#define TT_NAME_ID_MAC_FULL_NAME 18 +#define TT_NAME_ID_PREFERRED_FAMILY 16 +#define TT_NAME_ID_PREFERRED_SUBFAMILY 17 +#define TT_NAME_ID_MAC_FULL_NAME 18 /* The following code is new as of 2000-01-21 */ -#define TT_NAME_ID_SAMPLE_TEXT 19 +#define TT_NAME_ID_SAMPLE_TEXT 19 /* This is new in OpenType 1.3 */ -#define TT_NAME_ID_CID_FINDFONT_NAME 20 +#define TT_NAME_ID_CID_FINDFONT_NAME 20 /* This is new in OpenType 1.5 */ -#define TT_NAME_ID_WWS_FAMILY 21 -#define TT_NAME_ID_WWS_SUBFAMILY 22 - - /* This is new in OpenType 1.7 */ -#define TT_NAME_ID_LIGHT_BACKGROUND 23 -#define TT_NAME_ID_DARK_BACKGROUND 24 - - /* This is new in OpenType 1.8 */ -#define TT_NAME_ID_VARIATIONS_PREFIX 25 - - /* these two values are deprecated */ -#define TT_NAME_ID_PREFERRED_FAMILY TT_NAME_ID_TYPOGRAPHIC_FAMILY -#define TT_NAME_ID_PREFERRED_SUBFAMILY TT_NAME_ID_TYPOGRAPHIC_SUBFAMILY +#define TT_NAME_ID_WWS_FAMILY 21 +#define TT_NAME_ID_WWS_SUBFAMILY 22 - /************************************************************************** - * - * @enum: - * TT_UCR_XXX - * - * @description: - * Possible bit mask values for the `ulUnicodeRangeX` fields in an SFNT - * 'OS/2' table. - */ - - /* ulUnicodeRange1 */ - /* --------------- */ + /*************************************************************************/ + /* */ + /* Bit mask values for the Unicode Ranges from the TTF `OS2 ' table. */ + /* */ + /* Updated 08-Nov-2008. */ + /* */ /* Bit 0 Basic Latin */ #define TT_UCR_BASIC_LATIN (1L << 0) /* U+0020-U+007E */ @@ -867,7 +857,7 @@ FT_BEGIN_HEADER /* U+A700-U+A71F */ /* Bit 6 Combining Diacritical Marks */ /* Combining Diacritical Marks Supplement */ -#define TT_UCR_COMBINING_DIACRITICAL_MARKS (1L << 6) /* U+0300-U+036F */ +#define TT_UCR_COMBINING_DIACRITICS (1L << 6) /* U+0300-U+036F */ /* U+1DC0-U+1DFF */ /* Bit 7 Greek and Coptic */ #define TT_UCR_GREEK (1L << 7) /* U+0370-U+03FF */ @@ -935,17 +925,12 @@ FT_BEGIN_HEADER /* Supplemental Punctuation */ #define TT_UCR_GENERAL_PUNCTUATION (1L << 31) /* U+2000-U+206F */ /* U+2E00-U+2E7F */ - - /* ulUnicodeRange2 */ - /* --------------- */ - /* Bit 32 Superscripts And Subscripts */ #define TT_UCR_SUPERSCRIPTS_SUBSCRIPTS (1L << 0) /* U+2070-U+209F */ /* Bit 33 Currency Symbols */ #define TT_UCR_CURRENCY_SYMBOLS (1L << 1) /* U+20A0-U+20CF */ /* Bit 34 Combining Diacritical Marks For Symbols */ -#define TT_UCR_COMBINING_DIACRITICAL_MARKS_SYMB \ - (1L << 2) /* U+20D0-U+20FF */ +#define TT_UCR_COMBINING_DIACRITICS_SYMB (1L << 2) /* U+20D0-U+20FF */ /* Bit 35 Letterlike Symbols */ #define TT_UCR_LETTERLIKE_SYMBOLS (1L << 3) /* U+2100-U+214F */ /* Bit 36 Number Forms */ @@ -1011,13 +996,13 @@ FT_BEGIN_HEADER /* Bit 57 High Surrogates */ /* High Private Use Surrogates */ /* Low Surrogates */ - + /* */ /* According to OpenType specs v.1.3+, */ /* setting bit 57 implies that there is */ /* at least one codepoint beyond the */ /* Basic Multilingual Plane that is */ /* supported by this font. So it really */ - /* means >= U+10000. */ + /* means >= U+10000 */ #define TT_UCR_SURROGATES (1L << 25) /* U+D800-U+DB7F */ /* U+DB80-U+DBFF */ /* U+DC00-U+DFFF */ @@ -1049,11 +1034,7 @@ FT_BEGIN_HEADER /* Bit 62 Alphabetic Presentation Forms */ #define TT_UCR_ALPHABETIC_PRESENTATION_FORMS (1L << 30) /* U+FB00-U+FB4F */ /* Bit 63 Arabic Presentation Forms-A */ -#define TT_UCR_ARABIC_PRESENTATION_FORMS_A (1L << 31) /* U+FB50-U+FDFF */ - - /* ulUnicodeRange3 */ - /* --------------- */ - +#define TT_UCR_ARABIC_PRESENTATIONS_A (1L << 31) /* U+FB50-U+FDFF */ /* Bit 64 Combining Half Marks */ #define TT_UCR_COMBINING_HALF_MARKS (1L << 0) /* U+FE20-U+FE2F */ /* Bit 65 Vertical forms */ @@ -1063,7 +1044,7 @@ FT_BEGIN_HEADER /* Bit 66 Small Form Variants */ #define TT_UCR_SMALL_FORM_VARIANTS (1L << 2) /* U+FE50-U+FE6F */ /* Bit 67 Arabic Presentation Forms-B */ -#define TT_UCR_ARABIC_PRESENTATION_FORMS_B (1L << 3) /* U+FE70-U+FEFE */ +#define TT_UCR_ARABIC_PRESENTATIONS_B (1L << 3) /* U+FE70-U+FEFE */ /* Bit 68 Halfwidth and Fullwidth Forms */ #define TT_UCR_HALFWIDTH_FULLWIDTH_FORMS (1L << 4) /* U+FF00-U+FFEF */ /* Bit 69 Specials */ @@ -1142,10 +1123,6 @@ FT_BEGIN_HEADER #define TT_UCR_TAI_LE (1L << 30) /* U+1950-U+197F */ /* Bit 95 New Tai Lue */ #define TT_UCR_NEW_TAI_LUE (1L << 31) /* U+1980-U+19DF */ - - /* ulUnicodeRange4 */ - /* --------------- */ - /* Bit 96 Buginese */ #define TT_UCR_BUGINESE (1L << 0) /* U+1A00-U+1A1F */ /* Bit 97 Glagolitic */ @@ -1214,18 +1191,42 @@ FT_BEGIN_HEADER /*U+1F000-U+1F02F*/ /* Bit 123-127 Reserved for process-internal usage */ - /* */ - /* for backward compatibility with older FreeType versions */ -#define TT_UCR_ARABIC_PRESENTATION_A \ - TT_UCR_ARABIC_PRESENTATION_FORMS_A -#define TT_UCR_ARABIC_PRESENTATION_B \ - TT_UCR_ARABIC_PRESENTATION_FORMS_B + /*************************************************************************/ + /* */ + /* Some compilers have a very limited length of identifiers. */ + /* */ +#if defined( __TURBOC__ ) && __TURBOC__ < 0x0410 || defined( __PACIFIC__ ) +#define HAVE_LIMIT_ON_IDENTS +#endif -#define TT_UCR_COMBINING_DIACRITICS \ - TT_UCR_COMBINING_DIACRITICAL_MARKS -#define TT_UCR_COMBINING_DIACRITICS_SYMB \ - TT_UCR_COMBINING_DIACRITICAL_MARKS_SYMB + +#ifndef HAVE_LIMIT_ON_IDENTS + + + /*************************************************************************/ + /* */ + /* Here some alias #defines in order to be clearer. */ + /* */ + /* These are not always #defined to stay within the 31~character limit, */ + /* which some compilers have. */ + /* */ + /* Credits go to Dave Hoo <dhoo@flash.net> for pointing out that modern */ + /* Borland compilers (read: from BC++ 3.1 on) can increase this limit. */ + /* If you get a warning with such a compiler, use the -i40 switch. */ + /* */ +#define TT_UCR_ARABIC_PRESENTATION_FORMS_A \ + TT_UCR_ARABIC_PRESENTATIONS_A +#define TT_UCR_ARABIC_PRESENTATION_FORMS_B \ + TT_UCR_ARABIC_PRESENTATIONS_B + +#define TT_UCR_COMBINING_DIACRITICAL_MARKS \ + TT_UCR_COMBINING_DIACRITICS +#define TT_UCR_COMBINING_DIACRITICAL_MARKS_SYMB \ + TT_UCR_COMBINING_DIACRITICS_SYMB + + +#endif /* !HAVE_LIMIT_ON_IDENTS */ FT_END_HEADER diff --git a/android/x86_64/include/freetype/tttables.h b/android/x86_64/include/freetype/tttables.h index 01821589..dfe3bcb1 100644 --- a/android/x86_64/include/freetype/tttables.h +++ b/android/x86_64/include/freetype/tttables.h @@ -1,27 +1,27 @@ -/**************************************************************************** - * - * tttables.h - * - * Basic SFNT/TrueType tables definitions and interface - * (specification only). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* tttables.h */ +/* */ +/* Basic SFNT/TrueType tables definitions and interface */ +/* (specification only). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef TTTABLES_H_ #define TTTABLES_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -33,55 +33,52 @@ FT_BEGIN_HEADER - /************************************************************************** - * - * @section: - * truetype_tables - * - * @title: - * TrueType Tables - * - * @abstract: - * TrueType-specific table types and functions. - * - * @description: - * This section contains definitions of some basic tables specific to - * TrueType and OpenType as well as some routines used to access and - * process them. - * - * @order: - * TT_Header - * TT_HoriHeader - * TT_VertHeader - * TT_OS2 - * TT_Postscript - * TT_PCLT - * TT_MaxProfile - * - * FT_Sfnt_Tag - * FT_Get_Sfnt_Table - * FT_Load_Sfnt_Table - * FT_Sfnt_Table_Info - * - * FT_Get_CMap_Language_ID - * FT_Get_CMap_Format - * - * FT_PARAM_TAG_UNPATENTED_HINTING - * - */ + /*************************************************************************/ + /* */ + /* <Section> */ + /* truetype_tables */ + /* */ + /* <Title> */ + /* TrueType Tables */ + /* */ + /* <Abstract> */ + /* TrueType specific table types and functions. */ + /* */ + /* <Description> */ + /* This section contains the definition of TrueType-specific tables */ + /* as well as some routines used to access and process them. */ + /* */ + /* <Order> */ + /* TT_Header */ + /* TT_HoriHeader */ + /* TT_VertHeader */ + /* TT_OS2 */ + /* TT_Postscript */ + /* TT_PCLT */ + /* TT_MaxProfile */ + /* */ + /* FT_Sfnt_Tag */ + /* FT_Get_Sfnt_Table */ + /* FT_Load_Sfnt_Table */ + /* FT_Sfnt_Table_Info */ + /* */ + /* FT_Get_CMap_Language_ID */ + /* FT_Get_CMap_Format */ + /* */ + /* FT_PARAM_TAG_UNPATENTED_HINTING */ + /* */ + /*************************************************************************/ - /************************************************************************** - * - * @struct: - * TT_Header - * - * @description: - * A structure to model a TrueType font header table. All fields follow - * the OpenType specification. The 64-bit timestamps are stored in - * two-element arrays `Created` and `Modified`, first the upper then - * the lower 32~bits. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* TT_Header */ + /* */ + /* <Description> */ + /* A structure used to model a TrueType font header table. All */ + /* fields follow the TrueType specification. */ + /* */ typedef struct TT_Header_ { FT_Fixed Table_Version; @@ -93,8 +90,8 @@ FT_BEGIN_HEADER FT_UShort Flags; FT_UShort Units_Per_EM; - FT_ULong Created [2]; - FT_ULong Modified[2]; + FT_Long Created [2]; + FT_Long Modified[2]; FT_Short xMin; FT_Short yMin; @@ -111,93 +108,94 @@ FT_BEGIN_HEADER } TT_Header; - /************************************************************************** - * - * @struct: - * TT_HoriHeader - * - * @description: - * A structure to model a TrueType horizontal header, the 'hhea' table, - * as well as the corresponding horizontal metrics table, 'hmtx'. - * - * @fields: - * Version :: - * The table version. - * - * Ascender :: - * The font's ascender, i.e., the distance from the baseline to the - * top-most of all glyph points found in the font. - * - * This value is invalid in many fonts, as it is usually set by the - * font designer, and often reflects only a portion of the glyphs found - * in the font (maybe ASCII). - * - * You should use the `sTypoAscender` field of the 'OS/2' table instead - * if you want the correct one. - * - * Descender :: - * The font's descender, i.e., the distance from the baseline to the - * bottom-most of all glyph points found in the font. It is negative. - * - * This value is invalid in many fonts, as it is usually set by the - * font designer, and often reflects only a portion of the glyphs found - * in the font (maybe ASCII). - * - * You should use the `sTypoDescender` field of the 'OS/2' table - * instead if you want the correct one. - * - * Line_Gap :: - * The font's line gap, i.e., the distance to add to the ascender and - * descender to get the BTB, i.e., the baseline-to-baseline distance - * for the font. - * - * advance_Width_Max :: - * This field is the maximum of all advance widths found in the font. - * It can be used to compute the maximum width of an arbitrary string - * of text. - * - * min_Left_Side_Bearing :: - * The minimum left side bearing of all glyphs within the font. - * - * min_Right_Side_Bearing :: - * The minimum right side bearing of all glyphs within the font. - * - * xMax_Extent :: - * The maximum horizontal extent (i.e., the 'width' of a glyph's - * bounding box) for all glyphs in the font. - * - * caret_Slope_Rise :: - * The rise coefficient of the cursor's slope of the cursor - * (slope=rise/run). - * - * caret_Slope_Run :: - * The run coefficient of the cursor's slope. - * - * caret_Offset :: - * The cursor's offset for slanted fonts. - * - * Reserved :: - * 8~reserved bytes. - * - * metric_Data_Format :: - * Always~0. - * - * number_Of_HMetrics :: - * Number of HMetrics entries in the 'hmtx' table -- this value can be - * smaller than the total number of glyphs in the font. - * - * long_metrics :: - * A pointer into the 'hmtx' table. - * - * short_metrics :: - * A pointer into the 'hmtx' table. - * - * @note: - * For an OpenType variation font, the values of the following fields can - * change after a call to @FT_Set_Var_Design_Coordinates (and friends) if - * the font contains an 'MVAR' table: `caret_Slope_Rise`, - * `caret_Slope_Run`, and `caret_Offset`. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* TT_HoriHeader */ + /* */ + /* <Description> */ + /* A structure used to model a TrueType horizontal header, the `hhea' */ + /* table, as well as the corresponding horizontal metrics table, */ + /* i.e., the `hmtx' table. */ + /* */ + /* <Fields> */ + /* Version :: The table version. */ + /* */ + /* Ascender :: The font's ascender, i.e., the distance */ + /* from the baseline to the top-most of all */ + /* glyph points found in the font. */ + /* */ + /* This value is invalid in many fonts, as */ + /* it is usually set by the font designer, */ + /* and often reflects only a portion of the */ + /* glyphs found in the font (maybe ASCII). */ + /* */ + /* You should use the `sTypoAscender' field */ + /* of the OS/2 table instead if you want */ + /* the correct one. */ + /* */ + /* Descender :: The font's descender, i.e., the distance */ + /* from the baseline to the bottom-most of */ + /* all glyph points found in the font. It */ + /* is negative. */ + /* */ + /* This value is invalid in many fonts, as */ + /* it is usually set by the font designer, */ + /* and often reflects only a portion of the */ + /* glyphs found in the font (maybe ASCII). */ + /* */ + /* You should use the `sTypoDescender' */ + /* field of the OS/2 table instead if you */ + /* want the correct one. */ + /* */ + /* Line_Gap :: The font's line gap, i.e., the distance */ + /* to add to the ascender and descender to */ + /* get the BTB, i.e., the */ + /* baseline-to-baseline distance for the */ + /* font. */ + /* */ + /* advance_Width_Max :: This field is the maximum of all advance */ + /* widths found in the font. It can be */ + /* used to compute the maximum width of an */ + /* arbitrary string of text. */ + /* */ + /* min_Left_Side_Bearing :: The minimum left side bearing of all */ + /* glyphs within the font. */ + /* */ + /* min_Right_Side_Bearing :: The minimum right side bearing of all */ + /* glyphs within the font. */ + /* */ + /* xMax_Extent :: The maximum horizontal extent (i.e., the */ + /* `width' of a glyph's bounding box) for */ + /* all glyphs in the font. */ + /* */ + /* caret_Slope_Rise :: The rise coefficient of the cursor's */ + /* slope of the cursor (slope=rise/run). */ + /* */ + /* caret_Slope_Run :: The run coefficient of the cursor's */ + /* slope. */ + /* */ + /* Reserved :: 8~reserved bytes. */ + /* */ + /* metric_Data_Format :: Always~0. */ + /* */ + /* number_Of_HMetrics :: Number of HMetrics entries in the `hmtx' */ + /* table -- this value can be smaller than */ + /* the total number of glyphs in the font. */ + /* */ + /* long_metrics :: A pointer into the `hmtx' table. */ + /* */ + /* short_metrics :: A pointer into the `hmtx' table. */ + /* */ + /* <Note> */ + /* IMPORTANT: The TT_HoriHeader and TT_VertHeader structures should */ + /* be identical except for the names of their fields, */ + /* which are different. */ + /* */ + /* This ensures that a single function in the `ttload' */ + /* module is able to read both the horizontal and vertical */ + /* headers. */ + /* */ typedef struct TT_HoriHeader_ { FT_Fixed Version; @@ -219,9 +217,9 @@ FT_BEGIN_HEADER FT_Short metric_Data_Format; FT_UShort number_Of_HMetrics; - /* The following fields are not defined by the OpenType specification */ + /* The following fields are not defined by the TrueType specification */ /* but they are used to connect the metrics header to the relevant */ - /* 'hmtx' table. */ + /* `HMTX' table. */ void* long_metrics; void* short_metrics; @@ -229,93 +227,101 @@ FT_BEGIN_HEADER } TT_HoriHeader; - /************************************************************************** - * - * @struct: - * TT_VertHeader - * - * @description: - * A structure used to model a TrueType vertical header, the 'vhea' - * table, as well as the corresponding vertical metrics table, 'vmtx'. - * - * @fields: - * Version :: - * The table version. - * - * Ascender :: - * The font's ascender, i.e., the distance from the baseline to the - * top-most of all glyph points found in the font. - * - * This value is invalid in many fonts, as it is usually set by the - * font designer, and often reflects only a portion of the glyphs found - * in the font (maybe ASCII). - * - * You should use the `sTypoAscender` field of the 'OS/2' table instead - * if you want the correct one. - * - * Descender :: - * The font's descender, i.e., the distance from the baseline to the - * bottom-most of all glyph points found in the font. It is negative. - * - * This value is invalid in many fonts, as it is usually set by the - * font designer, and often reflects only a portion of the glyphs found - * in the font (maybe ASCII). - * - * You should use the `sTypoDescender` field of the 'OS/2' table - * instead if you want the correct one. - * - * Line_Gap :: - * The font's line gap, i.e., the distance to add to the ascender and - * descender to get the BTB, i.e., the baseline-to-baseline distance - * for the font. - * - * advance_Height_Max :: - * This field is the maximum of all advance heights found in the font. - * It can be used to compute the maximum height of an arbitrary string - * of text. - * - * min_Top_Side_Bearing :: - * The minimum top side bearing of all glyphs within the font. - * - * min_Bottom_Side_Bearing :: - * The minimum bottom side bearing of all glyphs within the font. - * - * yMax_Extent :: - * The maximum vertical extent (i.e., the 'height' of a glyph's - * bounding box) for all glyphs in the font. - * - * caret_Slope_Rise :: - * The rise coefficient of the cursor's slope of the cursor - * (slope=rise/run). - * - * caret_Slope_Run :: - * The run coefficient of the cursor's slope. - * - * caret_Offset :: - * The cursor's offset for slanted fonts. - * - * Reserved :: - * 8~reserved bytes. - * - * metric_Data_Format :: - * Always~0. - * - * number_Of_VMetrics :: - * Number of VMetrics entries in the 'vmtx' table -- this value can be - * smaller than the total number of glyphs in the font. - * - * long_metrics :: - * A pointer into the 'vmtx' table. - * - * short_metrics :: - * A pointer into the 'vmtx' table. - * - * @note: - * For an OpenType variation font, the values of the following fields can - * change after a call to @FT_Set_Var_Design_Coordinates (and friends) if - * the font contains an 'MVAR' table: `Ascender`, `Descender`, - * `Line_Gap`, `caret_Slope_Rise`, `caret_Slope_Run`, and `caret_Offset`. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* TT_VertHeader */ + /* */ + /* <Description> */ + /* A structure used to model a TrueType vertical header, the `vhea' */ + /* table, as well as the corresponding vertical metrics table, i.e., */ + /* the `vmtx' table. */ + /* */ + /* <Fields> */ + /* Version :: The table version. */ + /* */ + /* Ascender :: The font's ascender, i.e., the distance */ + /* from the baseline to the top-most of */ + /* all glyph points found in the font. */ + /* */ + /* This value is invalid in many fonts, as */ + /* it is usually set by the font designer, */ + /* and often reflects only a portion of */ + /* the glyphs found in the font (maybe */ + /* ASCII). */ + /* */ + /* You should use the `sTypoAscender' */ + /* field of the OS/2 table instead if you */ + /* want the correct one. */ + /* */ + /* Descender :: The font's descender, i.e., the */ + /* distance from the baseline to the */ + /* bottom-most of all glyph points found */ + /* in the font. It is negative. */ + /* */ + /* This value is invalid in many fonts, as */ + /* it is usually set by the font designer, */ + /* and often reflects only a portion of */ + /* the glyphs found in the font (maybe */ + /* ASCII). */ + /* */ + /* You should use the `sTypoDescender' */ + /* field of the OS/2 table instead if you */ + /* want the correct one. */ + /* */ + /* Line_Gap :: The font's line gap, i.e., the distance */ + /* to add to the ascender and descender to */ + /* get the BTB, i.e., the */ + /* baseline-to-baseline distance for the */ + /* font. */ + /* */ + /* advance_Height_Max :: This field is the maximum of all */ + /* advance heights found in the font. It */ + /* can be used to compute the maximum */ + /* height of an arbitrary string of text. */ + /* */ + /* min_Top_Side_Bearing :: The minimum top side bearing of all */ + /* glyphs within the font. */ + /* */ + /* min_Bottom_Side_Bearing :: The minimum bottom side bearing of all */ + /* glyphs within the font. */ + /* */ + /* yMax_Extent :: The maximum vertical extent (i.e., the */ + /* `height' of a glyph's bounding box) for */ + /* all glyphs in the font. */ + /* */ + /* caret_Slope_Rise :: The rise coefficient of the cursor's */ + /* slope of the cursor (slope=rise/run). */ + /* */ + /* caret_Slope_Run :: The run coefficient of the cursor's */ + /* slope. */ + /* */ + /* caret_Offset :: The cursor's offset for slanted fonts. */ + /* This value is `reserved' in vmtx */ + /* version 1.0. */ + /* */ + /* Reserved :: 8~reserved bytes. */ + /* */ + /* metric_Data_Format :: Always~0. */ + /* */ + /* number_Of_HMetrics :: Number of VMetrics entries in the */ + /* `vmtx' table -- this value can be */ + /* smaller than the total number of glyphs */ + /* in the font. */ + /* */ + /* long_metrics :: A pointer into the `vmtx' table. */ + /* */ + /* short_metrics :: A pointer into the `vmtx' table. */ + /* */ + /* <Note> */ + /* IMPORTANT: The TT_HoriHeader and TT_VertHeader structures should */ + /* be identical except for the names of their fields, */ + /* which are different. */ + /* */ + /* This ensures that a single function in the `ttload' */ + /* module is able to read both the horizontal and vertical */ + /* headers. */ + /* */ typedef struct TT_VertHeader_ { FT_Fixed Version; @@ -325,9 +331,9 @@ FT_BEGIN_HEADER FT_UShort advance_Height_Max; /* advance height maximum */ - FT_Short min_Top_Side_Bearing; /* minimum top-sb */ - FT_Short min_Bottom_Side_Bearing; /* minimum bottom-sb */ - FT_Short yMax_Extent; /* ymax extents */ + FT_Short min_Top_Side_Bearing; /* minimum left-sb or top-sb */ + FT_Short min_Bottom_Side_Bearing; /* minimum right-sb or bottom-sb */ + FT_Short yMax_Extent; /* xmax or ymax extents */ FT_Short caret_Slope_Rise; FT_Short caret_Slope_Run; FT_Short caret_Offset; @@ -337,9 +343,9 @@ FT_BEGIN_HEADER FT_Short metric_Data_Format; FT_UShort number_Of_VMetrics; - /* The following fields are not defined by the OpenType specification */ - /* but they are used to connect the metrics header to the relevant */ - /* 'vmtx' table. */ + /* The following fields are not defined by the TrueType specification */ + /* but they're used to connect the metrics header to the relevant */ + /* `HMTX' or `VMTX' table. */ void* long_metrics; void* short_metrics; @@ -347,32 +353,18 @@ FT_BEGIN_HEADER } TT_VertHeader; - /************************************************************************** - * - * @struct: - * TT_OS2 - * - * @description: - * A structure to model a TrueType 'OS/2' table. All fields comply to - * the OpenType specification. - * - * Note that we now support old Mac fonts that do not include an 'OS/2' - * table. In this case, the `version` field is always set to 0xFFFF. - * - * @note: - * For an OpenType variation font, the values of the following fields can - * change after a call to @FT_Set_Var_Design_Coordinates (and friends) if - * the font contains an 'MVAR' table: `sCapHeight`, `sTypoAscender`, - * `sTypoDescender`, `sTypoLineGap`, `sxHeight`, `usWinAscent`, - * `usWinDescent`, `yStrikeoutPosition`, `yStrikeoutSize`, - * `ySubscriptXOffset`, `ySubScriptXSize`, `ySubscriptYOffset`, - * `ySubscriptYSize`, `ySuperscriptXOffset`, `ySuperscriptXSize`, - * `ySuperscriptYOffset`, and `ySuperscriptYSize`. - * - * Possible values for bits in the `ulUnicodeRangeX` fields are given by - * the @TT_UCR_XXX macros. - */ - + /*************************************************************************/ + /* */ + /* <Struct> */ + /* TT_OS2 */ + /* */ + /* <Description> */ + /* A structure used to model a TrueType OS/2 table. All fields */ + /* comply to the OpenType specification. */ + /* */ + /* Note that we now support old Mac fonts that do not include an OS/2 */ + /* table. In this case, the `version' field is always set to 0xFFFF. */ + /* */ typedef struct TT_OS2_ { FT_UShort version; /* 0x0001 - more or 0xFFFF */ @@ -431,23 +423,17 @@ FT_BEGIN_HEADER } TT_OS2; - /************************************************************************** - * - * @struct: - * TT_Postscript - * - * @description: - * A structure to model a TrueType 'post' table. All fields comply to - * the OpenType specification. This structure does not reference a - * font's PostScript glyph names; use @FT_Get_Glyph_Name to retrieve - * them. - * - * @note: - * For an OpenType variation font, the values of the following fields can - * change after a call to @FT_Set_Var_Design_Coordinates (and friends) if - * the font contains an 'MVAR' table: `underlinePosition` and - * `underlineThickness`. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* TT_Postscript */ + /* */ + /* <Description> */ + /* A structure used to model a TrueType PostScript table. All fields */ + /* comply to the TrueType specification. This structure does not */ + /* reference the PostScript glyph names, which can be nevertheless */ + /* accessed with the `ttpost' module. */ + /* */ typedef struct TT_Postscript_ { FT_Fixed FormatType; @@ -460,21 +446,21 @@ FT_BEGIN_HEADER FT_ULong minMemType1; FT_ULong maxMemType1; - /* Glyph names follow in the 'post' table, but we don't */ - /* load them by default. */ + /* Glyph names follow in the file, but we don't */ + /* load them by default. See the ttpost.c file. */ } TT_Postscript; - /************************************************************************** - * - * @struct: - * TT_PCLT - * - * @description: - * A structure to model a TrueType 'PCLT' table. All fields comply to - * the OpenType specification. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* TT_PCLT */ + /* */ + /* <Description> */ + /* A structure used to model a TrueType PCLT table. All fields */ + /* comply to the TrueType specification. */ + /* */ typedef struct TT_PCLT_ { FT_Fixed Version; @@ -496,75 +482,72 @@ FT_BEGIN_HEADER } TT_PCLT; - /************************************************************************** - * - * @struct: - * TT_MaxProfile - * - * @description: - * The maximum profile ('maxp') table contains many max values, which can - * be used to pre-allocate arrays for speeding up glyph loading and - * hinting. - * - * @fields: - * version :: - * The version number. - * - * numGlyphs :: - * The number of glyphs in this TrueType font. - * - * maxPoints :: - * The maximum number of points in a non-composite TrueType glyph. See - * also `maxCompositePoints`. - * - * maxContours :: - * The maximum number of contours in a non-composite TrueType glyph. - * See also `maxCompositeContours`. - * - * maxCompositePoints :: - * The maximum number of points in a composite TrueType glyph. See - * also `maxPoints`. - * - * maxCompositeContours :: - * The maximum number of contours in a composite TrueType glyph. See - * also `maxContours`. - * - * maxZones :: - * The maximum number of zones used for glyph hinting. - * - * maxTwilightPoints :: - * The maximum number of points in the twilight zone used for glyph - * hinting. - * - * maxStorage :: - * The maximum number of elements in the storage area used for glyph - * hinting. - * - * maxFunctionDefs :: - * The maximum number of function definitions in the TrueType bytecode - * for this font. - * - * maxInstructionDefs :: - * The maximum number of instruction definitions in the TrueType - * bytecode for this font. - * - * maxStackElements :: - * The maximum number of stack elements used during bytecode - * interpretation. - * - * maxSizeOfInstructions :: - * The maximum number of TrueType opcodes used for glyph hinting. - * - * maxComponentElements :: - * The maximum number of simple (i.e., non-composite) glyphs in a - * composite glyph. - * - * maxComponentDepth :: - * The maximum nesting depth of composite glyphs. - * - * @note: - * This structure is only used during font loading. - */ + /*************************************************************************/ + /* */ + /* <Struct> */ + /* TT_MaxProfile */ + /* */ + /* <Description> */ + /* The maximum profile is a table containing many max values, which */ + /* can be used to pre-allocate arrays. This ensures that no memory */ + /* allocation occurs during a glyph load. */ + /* */ + /* <Fields> */ + /* version :: The version number. */ + /* */ + /* numGlyphs :: The number of glyphs in this TrueType */ + /* font. */ + /* */ + /* maxPoints :: The maximum number of points in a */ + /* non-composite TrueType glyph. See also */ + /* the structure element */ + /* `maxCompositePoints'. */ + /* */ + /* maxContours :: The maximum number of contours in a */ + /* non-composite TrueType glyph. See also */ + /* the structure element */ + /* `maxCompositeContours'. */ + /* */ + /* maxCompositePoints :: The maximum number of points in a */ + /* composite TrueType glyph. See also the */ + /* structure element `maxPoints'. */ + /* */ + /* maxCompositeContours :: The maximum number of contours in a */ + /* composite TrueType glyph. See also the */ + /* structure element `maxContours'. */ + /* */ + /* maxZones :: The maximum number of zones used for */ + /* glyph hinting. */ + /* */ + /* maxTwilightPoints :: The maximum number of points in the */ + /* twilight zone used for glyph hinting. */ + /* */ + /* maxStorage :: The maximum number of elements in the */ + /* storage area used for glyph hinting. */ + /* */ + /* maxFunctionDefs :: The maximum number of function */ + /* definitions in the TrueType bytecode for */ + /* this font. */ + /* */ + /* maxInstructionDefs :: The maximum number of instruction */ + /* definitions in the TrueType bytecode for */ + /* this font. */ + /* */ + /* maxStackElements :: The maximum number of stack elements used */ + /* during bytecode interpretation. */ + /* */ + /* maxSizeOfInstructions :: The maximum number of TrueType opcodes */ + /* used for glyph hinting. */ + /* */ + /* maxComponentElements :: The maximum number of simple (i.e., non- */ + /* composite) glyphs in a composite glyph. */ + /* */ + /* maxComponentDepth :: The maximum nesting depth of composite */ + /* glyphs. */ + /* */ + /* <Note> */ + /* This structure is only used during font loading. */ + /* */ typedef struct TT_MaxProfile_ { FT_Fixed version; @@ -586,38 +569,30 @@ FT_BEGIN_HEADER } TT_MaxProfile; - /************************************************************************** - * - * @enum: - * FT_Sfnt_Tag - * - * @description: - * An enumeration to specify indices of SFNT tables loaded and parsed by - * FreeType during initialization of an SFNT font. Used in the - * @FT_Get_Sfnt_Table API function. - * - * @values: - * FT_SFNT_HEAD :: - * To access the font's @TT_Header structure. - * - * FT_SFNT_MAXP :: - * To access the font's @TT_MaxProfile structure. - * - * FT_SFNT_OS2 :: - * To access the font's @TT_OS2 structure. - * - * FT_SFNT_HHEA :: - * To access the font's @TT_HoriHeader structure. - * - * FT_SFNT_VHEA :: - * To access the font's @TT_VertHeader structure. - * - * FT_SFNT_POST :: - * To access the font's @TT_Postscript structure. - * - * FT_SFNT_PCLT :: - * To access the font's @TT_PCLT structure. - */ + /*************************************************************************/ + /* */ + /* <Enum> */ + /* FT_Sfnt_Tag */ + /* */ + /* <Description> */ + /* An enumeration used to specify the index of an SFNT table. */ + /* Used in the @FT_Get_Sfnt_Table API function. */ + /* */ + /* <Values> */ + /* FT_SFNT_HEAD :: To access the font's @TT_Header structure. */ + /* */ + /* FT_SFNT_MAXP :: To access the font's @TT_MaxProfile structure. */ + /* */ + /* FT_SFNT_OS2 :: To access the font's @TT_OS2 structure. */ + /* */ + /* FT_SFNT_HHEA :: To access the font's @TT_HoriHeader structure. */ + /* */ + /* FT_SFNT_VHEA :: To access the font's @TT_VertHeader struture. */ + /* */ + /* FT_SFNT_POST :: To access the font's @TT_Postscript structure. */ + /* */ + /* FT_SFNT_PCLT :: To access the font's @TT_PCLT structure. */ + /* */ typedef enum FT_Sfnt_Tag_ { FT_SFNT_HEAD, @@ -632,7 +607,7 @@ FT_BEGIN_HEADER } FT_Sfnt_Tag; - /* these constants are deprecated; use the corresponding `FT_Sfnt_Tag` */ + /* these constants are deprecated; use the corresponding `FT_Sfnt_Tag' */ /* values instead */ #define ft_sfnt_head FT_SFNT_HEAD #define ft_sfnt_maxp FT_SFNT_MAXP @@ -643,115 +618,113 @@ FT_BEGIN_HEADER #define ft_sfnt_pclt FT_SFNT_PCLT - /************************************************************************** - * - * @function: - * FT_Get_Sfnt_Table - * - * @description: - * Return a pointer to a given SFNT table stored within a face. - * - * @input: - * face :: - * A handle to the source. - * - * tag :: - * The index of the SFNT table. - * - * @return: - * A type-less pointer to the table. This will be `NULL` in case of - * error, or if the corresponding table was not found **OR** loaded from - * the file. - * - * Use a typecast according to `tag` to access the structure elements. - * - * @note: - * The table is owned by the face object and disappears with it. - * - * This function is only useful to access SFNT tables that are loaded by - * the sfnt, truetype, and opentype drivers. See @FT_Sfnt_Tag for a - * list. - * - * @example: - * Here is an example demonstrating access to the 'vhea' table. - * - * ``` - * TT_VertHeader* vert_header; - * - * - * vert_header = - * (TT_VertHeader*)FT_Get_Sfnt_Table( face, FT_SFNT_VHEA ); - * ``` - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_Sfnt_Table */ + /* */ + /* <Description> */ + /* Return a pointer to a given SFNT table within a face. */ + /* */ + /* <Input> */ + /* face :: A handle to the source. */ + /* */ + /* tag :: The index of the SFNT table. */ + /* */ + /* <Return> */ + /* A type-less pointer to the table. This will be~0 in case of */ + /* error, or if the corresponding table was not found *OR* loaded */ + /* from the file. */ + /* */ + /* Use a typecast according to `tag' to access the structure */ + /* elements. */ + /* */ + /* <Note> */ + /* The table is owned by the face object and disappears with it. */ + /* */ + /* This function is only useful to access SFNT tables that are loaded */ + /* by the sfnt, truetype, and opentype drivers. See @FT_Sfnt_Tag for */ + /* a list. */ + /* */ + /* Here an example how to access the `vhea' table: */ + /* */ + /* { */ + /* TT_VertHeader* vert_header; */ + /* */ + /* */ + /* vert_header = */ + /* (TT_VertHeader*)FT_Get_Sfnt_Table( face, FT_SFNT_VHEA ); */ + /* } */ + /* */ FT_EXPORT( void* ) FT_Get_Sfnt_Table( FT_Face face, FT_Sfnt_Tag tag ); - /************************************************************************** - * - * @function: - * FT_Load_Sfnt_Table - * - * @description: - * Load any SFNT font table into client memory. - * - * @input: - * face :: - * A handle to the source face. - * - * tag :: - * The four-byte tag of the table to load. Use value~0 if you want to - * access the whole font file. Otherwise, you can use one of the - * definitions found in the @FT_TRUETYPE_TAGS_H file, or forge a new - * one with @FT_MAKE_TAG. - * - * offset :: - * The starting offset in the table (or file if tag~==~0). - * - * @output: - * buffer :: - * The target buffer address. The client must ensure that the memory - * array is big enough to hold the data. - * - * @inout: - * length :: - * If the `length` parameter is `NULL`, try to load the whole table. - * Return an error code if it fails. - * - * Else, if `*length` is~0, exit immediately while returning the - * table's (or file) full size in it. - * - * Else the number of bytes to read from the table or file, from the - * starting offset. - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * If you need to determine the table's length you should first call this - * function with `*length` set to~0, as in the following example: - * - * ``` - * FT_ULong length = 0; - * - * - * error = FT_Load_Sfnt_Table( face, tag, 0, NULL, &length ); - * if ( error ) { ... table does not exist ... } - * - * buffer = malloc( length ); - * if ( buffer == NULL ) { ... not enough memory ... } - * - * error = FT_Load_Sfnt_Table( face, tag, 0, buffer, &length ); - * if ( error ) { ... could not load table ... } - * ``` - * - * Note that structures like @TT_Header or @TT_OS2 can't be used with - * this function; they are limited to @FT_Get_Sfnt_Table. Reason is that - * those structures depend on the processor architecture, with varying - * size (e.g. 32bit vs. 64bit) or order (big endian vs. little endian). - * - */ + /************************************************************************** + * + * @function: + * FT_Load_Sfnt_Table + * + * @description: + * Load any font table into client memory. + * + * @input: + * face :: + * A handle to the source face. + * + * tag :: + * The four-byte tag of the table to load. Use the value~0 if you want + * to access the whole font file. Otherwise, you can use one of the + * definitions found in the @FT_TRUETYPE_TAGS_H file, or forge a new + * one with @FT_MAKE_TAG. + * + * offset :: + * The starting offset in the table (or file if tag == 0). + * + * @output: + * buffer :: + * The target buffer address. The client must ensure that the memory + * array is big enough to hold the data. + * + * @inout: + * length :: + * If the `length' parameter is NULL, then try to load the whole table. + * Return an error code if it fails. + * + * Else, if `*length' is~0, exit immediately while returning the + * table's (or file) full size in it. + * + * Else the number of bytes to read from the table or file, from the + * starting offset. + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * If you need to determine the table's length you should first call this + * function with `*length' set to~0, as in the following example: + * + * { + * FT_ULong length = 0; + * + * + * error = FT_Load_Sfnt_Table( face, tag, 0, NULL, &length ); + * if ( error ) { ... table does not exist ... } + * + * buffer = malloc( length ); + * if ( buffer == NULL ) { ... not enough memory ... } + * + * error = FT_Load_Sfnt_Table( face, tag, 0, buffer, &length ); + * if ( error ) { ... could not load table ... } + * } + * + * Note that structures like @TT_Header or @TT_OS2 can't be used with + * this function; they are limited to @FT_Get_Sfnt_Table. Reason is that + * those structures depend on the processor architecture, with varying + * size (e.g. 32bit vs. 64bit) or order (big endian vs. little endian). + * + */ FT_EXPORT( FT_Error ) FT_Load_Sfnt_Table( FT_Face face, FT_ULong tag, @@ -760,41 +733,41 @@ FT_BEGIN_HEADER FT_ULong* length ); - /************************************************************************** - * - * @function: - * FT_Sfnt_Table_Info - * - * @description: - * Return information on an SFNT table. - * - * @input: - * face :: - * A handle to the source face. - * - * table_index :: - * The index of an SFNT table. The function returns - * FT_Err_Table_Missing for an invalid value. - * - * @inout: - * tag :: - * The name tag of the SFNT table. If the value is `NULL`, - * `table_index` is ignored, and `length` returns the number of SFNT - * tables in the font. - * - * @output: - * length :: - * The length of the SFNT table (or the number of SFNT tables, - * depending on `tag`). - * - * @return: - * FreeType error code. 0~means success. - * - * @note: - * While parsing fonts, FreeType handles SFNT tables with length zero as - * missing. - * - */ + /************************************************************************** + * + * @function: + * FT_Sfnt_Table_Info + * + * @description: + * Return information on an SFNT table. + * + * @input: + * face :: + * A handle to the source face. + * + * table_index :: + * The index of an SFNT table. The function returns + * FT_Err_Table_Missing for an invalid value. + * + * @inout: + * tag :: + * The name tag of the SFNT table. If the value is NULL, `table_index' + * is ignored, and `length' returns the number of SFNT tables in the + * font. + * + * @output: + * length :: + * The length of the SFNT table (or the number of SFNT tables, depending + * on `tag'). + * + * @return: + * FreeType error code. 0~means success. + * + * @note: + * While parsing fonts, FreeType handles SFNT tables with length zero as + * missing. + * + */ FT_EXPORT( FT_Error ) FT_Sfnt_Table_Info( FT_Face face, FT_UInt table_index, @@ -802,46 +775,46 @@ FT_BEGIN_HEADER FT_ULong *length ); - /************************************************************************** - * - * @function: - * FT_Get_CMap_Language_ID - * - * @description: - * Return cmap language ID as specified in the OpenType standard. - * Definitions of language ID values are in file @FT_TRUETYPE_IDS_H. - * - * @input: - * charmap :: - * The target charmap. - * - * @return: - * The language ID of `charmap`. If `charmap` doesn't belong to an SFNT - * face, just return~0 as the default value. - * - * For a format~14 cmap (to access Unicode IVS), the return value is - * 0xFFFFFFFF. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_CMap_Language_ID */ + /* */ + /* <Description> */ + /* Return TrueType/sfnt specific cmap language ID. Definitions of */ + /* language ID values are in `ttnameid.h'. */ + /* */ + /* <Input> */ + /* charmap :: */ + /* The target charmap. */ + /* */ + /* <Return> */ + /* The language ID of `charmap'. If `charmap' doesn't belong to a */ + /* TrueType/sfnt face, just return~0 as the default value. */ + /* */ + /* For a format~14 cmap (to access Unicode IVS), the return value is */ + /* 0xFFFFFFFF. */ + /* */ FT_EXPORT( FT_ULong ) FT_Get_CMap_Language_ID( FT_CharMap charmap ); - /************************************************************************** - * - * @function: - * FT_Get_CMap_Format - * - * @description: - * Return the format of an SFNT 'cmap' table. - * - * @input: - * charmap :: - * The target charmap. - * - * @return: - * The format of `charmap`. If `charmap` doesn't belong to an SFNT face, - * return -1. - */ + /*************************************************************************/ + /* */ + /* <Function> */ + /* FT_Get_CMap_Format */ + /* */ + /* <Description> */ + /* Return TrueType/sfnt specific cmap format. */ + /* */ + /* <Input> */ + /* charmap :: */ + /* The target charmap. */ + /* */ + /* <Return> */ + /* The format of `charmap'. If `charmap' doesn't belong to a */ + /* TrueType/sfnt face, return -1. */ + /* */ FT_EXPORT( FT_Long ) FT_Get_CMap_Format( FT_CharMap charmap ); diff --git a/android/x86_64/include/freetype/tttags.h b/android/x86_64/include/freetype/tttags.h index aeb4ef6e..f3c9aa5f 100644 --- a/android/x86_64/include/freetype/tttags.h +++ b/android/x86_64/include/freetype/tttags.h @@ -1,26 +1,26 @@ -/**************************************************************************** - * - * tttags.h - * - * Tags for TrueType and OpenType tables (specification only). - * - * Copyright (C) 1996-2019 by - * David Turner, Robert Wilhelm, and Werner Lemberg. - * - * This file is part of the FreeType project, and may only be used, - * modified, and distributed under the terms of the FreeType project - * license, LICENSE.TXT. By continuing to use, modify, or distribute - * this file you indicate that you have read the license and - * understand and accept it fully. - * - */ +/***************************************************************************/ +/* */ +/* tttags.h */ +/* */ +/* Tags for TrueType and OpenType tables (specification only). */ +/* */ +/* Copyright 1996-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ #ifndef TTAGS_H_ #define TTAGS_H_ -#include "ft2build.h" +#include <ft2build.h> #include FT_FREETYPE_H #ifdef FREETYPE_H @@ -43,11 +43,8 @@ FT_BEGIN_HEADER #define TTAG_CBDT FT_MAKE_TAG( 'C', 'B', 'D', 'T' ) #define TTAG_CBLC FT_MAKE_TAG( 'C', 'B', 'L', 'C' ) #define TTAG_CFF FT_MAKE_TAG( 'C', 'F', 'F', ' ' ) -#define TTAG_CFF2 FT_MAKE_TAG( 'C', 'F', 'F', '2' ) #define TTAG_CID FT_MAKE_TAG( 'C', 'I', 'D', ' ' ) #define TTAG_cmap FT_MAKE_TAG( 'c', 'm', 'a', 'p' ) -#define TTAG_COLR FT_MAKE_TAG( 'C', 'O', 'L', 'R' ) -#define TTAG_CPAL FT_MAKE_TAG( 'C', 'P', 'A', 'L' ) #define TTAG_cvar FT_MAKE_TAG( 'c', 'v', 'a', 'r' ) #define TTAG_cvt FT_MAKE_TAG( 'c', 'v', 't', ' ' ) #define TTAG_DSIG FT_MAKE_TAG( 'D', 'S', 'I', 'G' ) @@ -64,7 +61,6 @@ FT_BEGIN_HEADER #define TTAG_GPOS FT_MAKE_TAG( 'G', 'P', 'O', 'S' ) #define TTAG_GSUB FT_MAKE_TAG( 'G', 'S', 'U', 'B' ) #define TTAG_gvar FT_MAKE_TAG( 'g', 'v', 'a', 'r' ) -#define TTAG_HVAR FT_MAKE_TAG( 'H', 'V', 'A', 'R' ) #define TTAG_hdmx FT_MAKE_TAG( 'h', 'd', 'm', 'x' ) #define TTAG_head FT_MAKE_TAG( 'h', 'e', 'a', 'd' ) #define TTAG_hhea FT_MAKE_TAG( 'h', 'h', 'e', 'a' ) @@ -83,7 +79,6 @@ FT_BEGIN_HEADER #define TTAG_MMSD FT_MAKE_TAG( 'M', 'M', 'S', 'D' ) #define TTAG_mort FT_MAKE_TAG( 'm', 'o', 'r', 't' ) #define TTAG_morx FT_MAKE_TAG( 'm', 'o', 'r', 'x' ) -#define TTAG_MVAR FT_MAKE_TAG( 'M', 'V', 'A', 'R' ) #define TTAG_name FT_MAKE_TAG( 'n', 'a', 'm', 'e' ) #define TTAG_opbd FT_MAKE_TAG( 'o', 'p', 'b', 'd' ) #define TTAG_OS2 FT_MAKE_TAG( 'O', 'S', '/', '2' ) @@ -105,15 +100,8 @@ FT_BEGIN_HEADER #define TTAG_VDMX FT_MAKE_TAG( 'V', 'D', 'M', 'X' ) #define TTAG_vhea FT_MAKE_TAG( 'v', 'h', 'e', 'a' ) #define TTAG_vmtx FT_MAKE_TAG( 'v', 'm', 't', 'x' ) -#define TTAG_VVAR FT_MAKE_TAG( 'V', 'V', 'A', 'R' ) #define TTAG_wOFF FT_MAKE_TAG( 'w', 'O', 'F', 'F' ) -/* used by "Keyboard.dfont" on legacy Mac OS X */ -#define TTAG_0xA5kbd FT_MAKE_TAG( 0xA5, 'k', 'b', 'd' ) - -/* used by "LastResort.dfont" on legacy Mac OS X */ -#define TTAG_0xA5lst FT_MAKE_TAG( 0xA5, 'l', 's', 't' ) - FT_END_HEADER diff --git a/android/x86_64/include/freetype/ttunpat.h b/android/x86_64/include/freetype/ttunpat.h new file mode 100644 index 00000000..ca4676ba --- /dev/null +++ b/android/x86_64/include/freetype/ttunpat.h @@ -0,0 +1,63 @@ +/***************************************************************************/ +/* */ +/* ttunpat.h */ +/* */ +/* Definitions for the unpatented TrueType hinting system. */ +/* Obsolete, retained for backwards compatibility. */ +/* */ +/* Copyright 2003-2016 by */ +/* David Turner, Robert Wilhelm, and Werner Lemberg. */ +/* */ +/* Written by Graham Asher <graham.asher@btinternet.com> */ +/* */ +/* This file is part of the FreeType project, and may only be used, */ +/* modified, and distributed under the terms of the FreeType project */ +/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ +/* this file you indicate that you have read the license and */ +/* understand and accept it fully. */ +/* */ +/***************************************************************************/ + + +#ifndef TTUNPAT_H_ +#define TTUNPAT_H_ + + +#include <ft2build.h> +#include FT_FREETYPE_H + +#ifdef FREETYPE_H +#error "freetype.h of FreeType 1 has been loaded!" +#error "Please fix the directory search order for header files" +#error "so that freetype.h of FreeType 2 is found first." +#endif + + +FT_BEGIN_HEADER + + + /*************************************************************************** + * + * @constant: + * FT_PARAM_TAG_UNPATENTED_HINTING + * + * @description: + * Deprecated. + * + * Previously: A constant used as the tag of an @FT_Parameter structure to + * indicate that unpatented methods only should be used by the TrueType + * bytecode interpreter for a typeface opened by @FT_Open_Face. + * + */ +#define FT_PARAM_TAG_UNPATENTED_HINTING FT_MAKE_TAG( 'u', 'n', 'p', 'a' ) + + /* */ + + +FT_END_HEADER + + +#endif /* TTUNPAT_H_ */ + + +/* END */ diff --git a/android/x86_64/include/jpeg/jconfig.h b/android/x86_64/include/jpeg/jconfig.h index 2d05a3b0..966b1d51 100644 --- a/android/x86_64/include/jpeg/jconfig.h +++ b/android/x86_64/include/jpeg/jconfig.h @@ -18,17 +18,11 @@ /* Define this if you get warnings about undefined structures. */ /* #undef INCOMPLETE_TYPES_BROKEN */ -/* Define "boolean" as unsigned char, not enum, on Windows systems. */ +/* Define "boolean" as unsigned char, not int, on Windows systems. */ #ifdef _WIN32 #ifndef __RPCNDR_H__ /* don't conflict if rpcndr.h already read */ typedef unsigned char boolean; #endif -#ifndef FALSE /* in case these macros already exist */ -#define FALSE 0 /* values of boolean */ -#endif -#ifndef TRUE -#define TRUE 1 -#endif #define HAVE_BOOLEAN /* prevent jmorecfg.h from redefining it */ #endif diff --git a/android/x86_64/include/jpeg/jmorecfg.h b/android/x86_64/include/jpeg/jmorecfg.h index 679d68bd..2407edbe 100644 --- a/android/x86_64/include/jpeg/jmorecfg.h +++ b/android/x86_64/include/jpeg/jmorecfg.h @@ -2,7 +2,7 @@ * jmorecfg.h * * Copyright (C) 1991-1997, Thomas G. Lane. - * Modified 1997-2013 by Guido Vollbeding. + * Modified 1997-2012 by Guido Vollbeding. * This file is part of the Independent JPEG Group's software. * For conditions of distribution and use, see the accompanying README file. * @@ -15,22 +15,13 @@ /* * Define BITS_IN_JSAMPLE as either * 8 for 8-bit sample values (the usual setting) - * 9 for 9-bit sample values - * 10 for 10-bit sample values - * 11 for 11-bit sample values * 12 for 12-bit sample values - * Only 8, 9, 10, 11, and 12 bits sample data precision are supported for - * full-feature DCT processing. Further depths up to 16-bit may be added - * later for the lossless modes of operation. - * Run-time selection and conversion of data precision will be added later - * and are currently not supported, sorry. - * Exception: The transcoding part (jpegtran) supports all settings in a - * single instance, since it operates on the level of DCT coefficients and - * not sample values. The DCT coefficients are of the same type (16 bits) - * in all cases (see below). + * Only 8 and 12 are legal data precisions for lossy JPEG according to the + * JPEG standard, and the IJG code does not support anything else! + * We do not support run-time selection of data precision, sorry. */ -#define BITS_IN_JSAMPLE 8 /* use 8, 9, 10, 11, or 12 */ +#define BITS_IN_JSAMPLE 8 /* use 8 or 12 */ /* @@ -86,48 +77,6 @@ typedef char JSAMPLE; #endif /* BITS_IN_JSAMPLE == 8 */ -#if BITS_IN_JSAMPLE == 9 -/* JSAMPLE should be the smallest type that will hold the values 0..511. - * On nearly all machines "short" will do nicely. - */ - -typedef short JSAMPLE; -#define GETJSAMPLE(value) ((int) (value)) - -#define MAXJSAMPLE 511 -#define CENTERJSAMPLE 256 - -#endif /* BITS_IN_JSAMPLE == 9 */ - - -#if BITS_IN_JSAMPLE == 10 -/* JSAMPLE should be the smallest type that will hold the values 0..1023. - * On nearly all machines "short" will do nicely. - */ - -typedef short JSAMPLE; -#define GETJSAMPLE(value) ((int) (value)) - -#define MAXJSAMPLE 1023 -#define CENTERJSAMPLE 512 - -#endif /* BITS_IN_JSAMPLE == 10 */ - - -#if BITS_IN_JSAMPLE == 11 -/* JSAMPLE should be the smallest type that will hold the values 0..2047. - * On nearly all machines "short" will do nicely. - */ - -typedef short JSAMPLE; -#define GETJSAMPLE(value) ((int) (value)) - -#define MAXJSAMPLE 2047 -#define CENTERJSAMPLE 1024 - -#endif /* BITS_IN_JSAMPLE == 11 */ - - #if BITS_IN_JSAMPLE == 12 /* JSAMPLE should be the smallest type that will hold the values 0..4095. * On nearly all machines "short" will do nicely. @@ -303,10 +252,7 @@ typedef void noreturn_t; * Defining HAVE_BOOLEAN before including jpeglib.h should make it work. */ -#ifndef HAVE_BOOLEAN -#if defined FALSE || defined TRUE || defined QGLOBAL_H -/* Qt3 defines FALSE and TRUE as "const" variables in qglobal.h */ -typedef int boolean; +#ifdef HAVE_BOOLEAN #ifndef FALSE /* in case these macros already exist */ #define FALSE 0 /* values of boolean */ #endif @@ -316,7 +262,6 @@ typedef int boolean; #else typedef enum { FALSE = 0, TRUE = 1 } boolean; #endif -#endif /* @@ -354,12 +299,11 @@ typedef enum { FALSE = 0, TRUE = 1 } boolean; #define C_PROGRESSIVE_SUPPORTED /* Progressive JPEG? (Requires MULTISCAN)*/ #define DCT_SCALING_SUPPORTED /* Input rescaling via DCT? (Requires DCT_ISLOW)*/ #define ENTROPY_OPT_SUPPORTED /* Optimization of entropy coding parms? */ -/* Note: if you selected more than 8-bit data precision, it is dangerous to - * turn off ENTROPY_OPT_SUPPORTED. The standard Huffman tables are only - * good for 8-bit precision, so arithmetic coding is recommended for higher - * precision. The Huffman encoder normally uses entropy optimization to - * compute usable tables for higher precision. Otherwise, you'll have to - * supply different default Huffman tables. +/* Note: if you selected 12-bit data precision, it is dangerous to turn off + * ENTROPY_OPT_SUPPORTED. The standard Huffman tables are only good for 8-bit + * precision, so jchuff.c normally uses entropy optimization to compute + * usable tables for higher precision. If you don't want to do optimization, + * you'll have to supply different default Huffman tables. * The exact same statements apply for progressive JPEG: the default tables * don't work for progressive mode. (This may get fixed, however.) */ @@ -370,7 +314,7 @@ typedef enum { FALSE = 0, TRUE = 1 } boolean; #define D_ARITH_CODING_SUPPORTED /* Arithmetic coding back end? */ #define D_MULTISCAN_FILES_SUPPORTED /* Multiple-scan JPEG files? */ #define D_PROGRESSIVE_SUPPORTED /* Progressive JPEG? (Requires MULTISCAN)*/ -#define IDCT_SCALING_SUPPORTED /* Output rescaling via IDCT? (Requires DCT_ISLOW)*/ +#define IDCT_SCALING_SUPPORTED /* Output rescaling via IDCT? */ #define SAVE_MARKERS_SUPPORTED /* jpeg_save_markers() needed? */ #define BLOCK_SMOOTHING_SUPPORTED /* Block smoothing? (Progressive only) */ #undef UPSAMPLE_SCALING_SUPPORTED /* Output rescaling at upsample stage? */ diff --git a/android/x86_64/include/jpeg/jpeglib.h b/android/x86_64/include/jpeg/jpeglib.h index 939b50be..0a6dac44 100644 --- a/android/x86_64/include/jpeg/jpeglib.h +++ b/android/x86_64/include/jpeg/jpeglib.h @@ -2,7 +2,7 @@ * jpeglib.h * * Copyright (C) 1991-1998, Thomas G. Lane. - * Modified 2002-2015 by Guido Vollbeding. + * Modified 2002-2012 by Guido Vollbeding. * This file is part of the Independent JPEG Group's software. * For conditions of distribution and use, see the accompanying README file. * @@ -39,12 +39,12 @@ extern "C" { #define JPEG_LIB_VERSION 90 /* Compatibility version 9.0 */ #define JPEG_LIB_VERSION_MAJOR 9 -#define JPEG_LIB_VERSION_MINOR 2 +#define JPEG_LIB_VERSION_MINOR 0 /* Various constants determining the sizes of things. - * All of these are specified by the JPEG standard, - * so don't change them if you want to be compatible. + * All of these are specified by the JPEG standard, so don't change them + * if you want to be compatible. */ #define DCTSIZE 8 /* The basic DCT block is 8x8 coefficients */ @@ -157,21 +157,16 @@ typedef struct { /* The downsampled dimensions are the component's actual, unpadded number * of samples at the main buffer (preprocessing/compression interface); * DCT scaling is included, so - * downsampled_width = - * ceil(image_width * Hi/Hmax * DCT_h_scaled_size/block_size) + * downsampled_width = ceil(image_width * Hi/Hmax * DCT_h_scaled_size/DCTSIZE) * and similarly for height. */ JDIMENSION downsampled_width; /* actual width in samples */ JDIMENSION downsampled_height; /* actual height in samples */ - /* For decompression, in cases where some of the components will be - * ignored (eg grayscale output from YCbCr image), we can skip most - * computations for the unused components. - * For compression, some of the components will need further quantization - * scale by factor of 2 after DCT (eg BG_YCC output from normal RGB input). - * The field is first set TRUE for decompression, FALSE for compression - * in initial_setup, and then adapted in color conversion setup. + /* This flag is used only for decompression. In cases where some of the + * components will be ignored (eg grayscale output from YCbCr image), + * we can skip most computations for the unused components. */ - boolean component_needed; + boolean component_needed; /* do we need the value of this component? */ /* These values are computed before starting a scan of the component. */ /* The decompressor output side may not use these variables. */ @@ -220,12 +215,10 @@ struct jpeg_marker_struct { typedef enum { JCS_UNKNOWN, /* error/unspecified */ JCS_GRAYSCALE, /* monochrome */ - JCS_RGB, /* red/green/blue, standard RGB (sRGB) */ - JCS_YCbCr, /* Y/Cb/Cr (also known as YUV), standard YCC */ + JCS_RGB, /* red/green/blue */ + JCS_YCbCr, /* Y/Cb/Cr (also known as YUV) */ JCS_CMYK, /* C/M/Y/K */ - JCS_YCCK, /* Y/Cb/Cr/K */ - JCS_BG_RGB, /* big gamut red/green/blue, bg-sRGB */ - JCS_BG_YCC /* big gamut Y/Cb/Cr, bg-sYCC */ + JCS_YCCK /* Y/Cb/Cr/K */ } J_COLOR_SPACE; /* Supported color transforms. */ @@ -979,7 +972,7 @@ EXTERN(void) jpeg_mem_dest JPP((j_compress_ptr cinfo, unsigned char ** outbuffer, unsigned long * outsize)); EXTERN(void) jpeg_mem_src JPP((j_decompress_ptr cinfo, - const unsigned char * inbuffer, + unsigned char * inbuffer, unsigned long insize)); /* Default parameter setup for compression */ diff --git a/android/x86_64/include/png/png.h b/android/x86_64/include/png/png.h index 997130d3..123201d3 100644 --- a/android/x86_64/include/png/png.h +++ b/android/x86_64/include/png/png.h @@ -1,8 +1,9 @@ /* png.h - header file for PNG reference library * - * libpng version 1.6.16, December 22, 2014 - * Copyright (c) 1998-2014 Glenn Randers-Pehrson + * libpng version 1.6.21, January 15, 2016 + * + * Copyright (c) 1998-2002,2004,2006-2016 Glenn Randers-Pehrson * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger) * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.) * @@ -10,17 +11,137 @@ * * Authors and maintainers: * libpng versions 0.71, May 1995, through 0.88, January 1996: Guy Schalnat - * libpng versions 0.89c, June 1996, through 0.96, May 1997: Andreas Dilger - * libpng versions 0.97, January 1998, through 1.6.16, December 22, 2014: Glenn + * libpng versions 0.89, June 1996, through 0.96, May 1997: Andreas Dilger + * libpng versions 0.97, January 1998, through 1.6.21, January 15, 2016: + * Glenn Randers-Pehrson. * See also "Contributing Authors", below. + */ + +/* + * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE: * - * Note about libpng version numbers: + * If you modify libpng you may insert additional notices immediately following + * this sentence. * - * Due to various miscommunications, unforeseen code incompatibilities - * and occasional factors outside the authors' control, version numbering - * on the library has not always been consistent and straightforward. - * The following table summarizes matters since version 0.89c, which was - * the first widely used release: + * This code is released under the libpng license. + * + * libpng versions 1.0.7, July 1, 2000, through 1.6.21, January 15, 2016, are + * Copyright (c) 2000-2002, 2004, 2006-2016 Glenn Randers-Pehrson, are + * derived from libpng-1.0.6, and are distributed according to the same + * disclaimer and license as libpng-1.0.6 with the following individuals + * added to the list of Contributing Authors: + * + * Simon-Pierre Cadieux + * Eric S. Raymond + * Mans Rullgard + * Cosmin Truta + * Gilles Vollant + * James Yu + * + * and with the following additions to the disclaimer: + * + * There is no warranty against interference with your enjoyment of the + * library or against infringement. There is no warranty that our + * efforts or the library will fulfill any of your particular purposes + * or needs. This library is provided with all faults, and the entire + * risk of satisfactory quality, performance, accuracy, and effort is with + * the user. + * + * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are + * Copyright (c) 1998-2000 Glenn Randers-Pehrson, are derived from + * libpng-0.96, and are distributed according to the same disclaimer and + * license as libpng-0.96, with the following individuals added to the list + * of Contributing Authors: + * + * Tom Lane + * Glenn Randers-Pehrson + * Willem van Schaik + * + * libpng versions 0.89, June 1996, through 0.96, May 1997, are + * Copyright (c) 1996-1997 Andreas Dilger, are derived from libpng-0.88, + * and are distributed according to the same disclaimer and license as + * libpng-0.88, with the following individuals added to the list of + * Contributing Authors: + * + * John Bowler + * Kevin Bracey + * Sam Bushell + * Magnus Holmgren + * Greg Roelofs + * Tom Tanner + * + * libpng versions 0.5, May 1995, through 0.88, January 1996, are + * Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc. + * + * For the purposes of this copyright and license, "Contributing Authors" + * is defined as the following set of individuals: + * + * Andreas Dilger + * Dave Martindale + * Guy Eric Schalnat + * Paul Schmidt + * Tim Wegner + * + * The PNG Reference Library is supplied "AS IS". The Contributing Authors + * and Group 42, Inc. disclaim all warranties, expressed or implied, + * including, without limitation, the warranties of merchantability and of + * fitness for any purpose. The Contributing Authors and Group 42, Inc. + * assume no liability for direct, indirect, incidental, special, exemplary, + * or consequential damages, which may result from the use of the PNG + * Reference Library, even if advised of the possibility of such damage. + * + * Permission is hereby granted to use, copy, modify, and distribute this + * source code, or portions hereof, for any purpose, without fee, subject + * to the following restrictions: + * + * 1. The origin of this source code must not be misrepresented. + * + * 2. Altered versions must be plainly marked as such and must not + * be misrepresented as being the original source. + * + * 3. This Copyright notice may not be removed or altered from any + * source or altered source distribution. + * + * The Contributing Authors and Group 42, Inc. specifically permit, without + * fee, and encourage the use of this source code as a component to + * supporting the PNG file format in commercial products. If you use this + * source code in a product, acknowledgment is not required but would be + * appreciated. + * + * END OF COPYRIGHT NOTICE, DISCLAIMER, and LICENSE. + */ + +/* + * A "png_get_copyright" function is available, for convenient use in "about" + * boxes and the like: + * + * printf("%s", png_get_copyright(NULL)); + * + * Also, the PNG logo (in PNG format, of course) is supplied in the + * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31). + */ + +/* + * Libpng is OSI Certified Open Source Software. OSI Certified Open Source is + * a certification mark of the Open Source Initiative. OSI has not addressed + * the additional disclaimers inserted at version 1.0.7. + */ + +/* + * The contributing authors would like to thank all those who helped + * with testing, bug fixes, and patience. This wouldn't have been + * possible without all of you. + * + * Thanks to Frank J. T. Wojcik for helping with the documentation. + */ + +/* Note about libpng version numbers: + * + * Due to various miscommunications, unforeseen code incompatibilities + * and occasional factors outside the authors' control, version numbering + * on the library has not always been consistent and straightforward. + * The following table summarizes matters since version 0.89c, which was + * the first widely used release: * * source png.h png.h shared-lib * version string int version @@ -58,310 +179,48 @@ * 1.0.7beta15-18 1 10007 2.1.0.7beta15-18 (binary compatible) * 1.0.7rc1-2 1 10007 2.1.0.7rc1-2 (binary compatible) * 1.0.7 1 10007 (still compatible) - * 1.0.8beta1-4 1 10008 2.1.0.8beta1-4 - * 1.0.8rc1 1 10008 2.1.0.8rc1 - * 1.0.8 1 10008 2.1.0.8 - * 1.0.9beta1-6 1 10009 2.1.0.9beta1-6 - * 1.0.9rc1 1 10009 2.1.0.9rc1 - * 1.0.9beta7-10 1 10009 2.1.0.9beta7-10 - * 1.0.9rc2 1 10009 2.1.0.9rc2 - * 1.0.9 1 10009 2.1.0.9 - * 1.0.10beta1 1 10010 2.1.0.10beta1 - * 1.0.10rc1 1 10010 2.1.0.10rc1 - * 1.0.10 1 10010 2.1.0.10 - * 1.0.11beta1-3 1 10011 2.1.0.11beta1-3 - * 1.0.11rc1 1 10011 2.1.0.11rc1 - * 1.0.11 1 10011 2.1.0.11 - * 1.0.12beta1-2 2 10012 2.1.0.12beta1-2 - * 1.0.12rc1 2 10012 2.1.0.12rc1 - * 1.0.12 2 10012 2.1.0.12 - * 1.1.0a-f - 10100 2.1.1.0a-f (branch abandoned) - * 1.2.0beta1-2 2 10200 2.1.2.0beta1-2 - * 1.2.0beta3-5 3 10200 3.1.2.0beta3-5 - * 1.2.0rc1 3 10200 3.1.2.0rc1 - * 1.2.0 3 10200 3.1.2.0 - * 1.2.1beta1-4 3 10201 3.1.2.1beta1-4 - * 1.2.1rc1-2 3 10201 3.1.2.1rc1-2 - * 1.2.1 3 10201 3.1.2.1 - * 1.2.2beta1-6 12 10202 12.so.0.1.2.2beta1-6 - * 1.0.13beta1 10 10013 10.so.0.1.0.13beta1 - * 1.0.13rc1 10 10013 10.so.0.1.0.13rc1 - * 1.2.2rc1 12 10202 12.so.0.1.2.2rc1 - * 1.0.13 10 10013 10.so.0.1.0.13 - * 1.2.2 12 10202 12.so.0.1.2.2 - * 1.2.3rc1-6 12 10203 12.so.0.1.2.3rc1-6 - * 1.2.3 12 10203 12.so.0.1.2.3 - * 1.2.4beta1-3 13 10204 12.so.0.1.2.4beta1-3 - * 1.0.14rc1 13 10014 10.so.0.1.0.14rc1 - * 1.2.4rc1 13 10204 12.so.0.1.2.4rc1 - * 1.0.14 10 10014 10.so.0.1.0.14 - * 1.2.4 13 10204 12.so.0.1.2.4 - * 1.2.5beta1-2 13 10205 12.so.0.1.2.5beta1-2 - * 1.0.15rc1-3 10 10015 10.so.0.1.0.15rc1-3 - * 1.2.5rc1-3 13 10205 12.so.0.1.2.5rc1-3 - * 1.0.15 10 10015 10.so.0.1.0.15 - * 1.2.5 13 10205 12.so.0.1.2.5 - * 1.2.6beta1-4 13 10206 12.so.0.1.2.6beta1-4 - * 1.0.16 10 10016 10.so.0.1.0.16 - * 1.2.6 13 10206 12.so.0.1.2.6 - * 1.2.7beta1-2 13 10207 12.so.0.1.2.7beta1-2 - * 1.0.17rc1 10 10017 12.so.0.1.0.17rc1 - * 1.2.7rc1 13 10207 12.so.0.1.2.7rc1 - * 1.0.17 10 10017 12.so.0.1.0.17 - * 1.2.7 13 10207 12.so.0.1.2.7 - * 1.2.8beta1-5 13 10208 12.so.0.1.2.8beta1-5 - * 1.0.18rc1-5 10 10018 12.so.0.1.0.18rc1-5 - * 1.2.8rc1-5 13 10208 12.so.0.1.2.8rc1-5 - * 1.0.18 10 10018 12.so.0.1.0.18 - * 1.2.8 13 10208 12.so.0.1.2.8 - * 1.2.9beta1-3 13 10209 12.so.0.1.2.9beta1-3 - * 1.2.9beta4-11 13 10209 12.so.0.9[.0] - * 1.2.9rc1 13 10209 12.so.0.9[.0] - * 1.2.9 13 10209 12.so.0.9[.0] - * 1.2.10beta1-7 13 10210 12.so.0.10[.0] - * 1.2.10rc1-2 13 10210 12.so.0.10[.0] - * 1.2.10 13 10210 12.so.0.10[.0] - * 1.4.0beta1-5 14 10400 14.so.0.0[.0] - * 1.2.11beta1-4 13 10211 12.so.0.11[.0] - * 1.4.0beta7-8 14 10400 14.so.0.0[.0] - * 1.2.11 13 10211 12.so.0.11[.0] - * 1.2.12 13 10212 12.so.0.12[.0] - * 1.4.0beta9-14 14 10400 14.so.0.0[.0] - * 1.2.13 13 10213 12.so.0.13[.0] - * 1.4.0beta15-36 14 10400 14.so.0.0[.0] - * 1.4.0beta37-87 14 10400 14.so.14.0[.0] - * 1.4.0rc01 14 10400 14.so.14.0[.0] - * 1.4.0beta88-109 14 10400 14.so.14.0[.0] - * 1.4.0rc02-08 14 10400 14.so.14.0[.0] - * 1.4.0 14 10400 14.so.14.0[.0] - * 1.4.1beta01-03 14 10401 14.so.14.1[.0] - * 1.4.1rc01 14 10401 14.so.14.1[.0] - * 1.4.1beta04-12 14 10401 14.so.14.1[.0] - * 1.4.1 14 10401 14.so.14.1[.0] - * 1.4.2 14 10402 14.so.14.2[.0] - * 1.4.3 14 10403 14.so.14.3[.0] - * 1.4.4 14 10404 14.so.14.4[.0] - * 1.5.0beta01-58 15 10500 15.so.15.0[.0] - * 1.5.0rc01-07 15 10500 15.so.15.0[.0] - * 1.5.0 15 10500 15.so.15.0[.0] - * 1.5.1beta01-11 15 10501 15.so.15.1[.0] - * 1.5.1rc01-02 15 10501 15.so.15.1[.0] - * 1.5.1 15 10501 15.so.15.1[.0] - * 1.5.2beta01-03 15 10502 15.so.15.2[.0] - * 1.5.2rc01-03 15 10502 15.so.15.2[.0] - * 1.5.2 15 10502 15.so.15.2[.0] - * 1.5.3beta01-10 15 10503 15.so.15.3[.0] - * 1.5.3rc01-02 15 10503 15.so.15.3[.0] - * 1.5.3beta11 15 10503 15.so.15.3[.0] - * 1.5.3 [omitted] - * 1.5.4beta01-08 15 10504 15.so.15.4[.0] - * 1.5.4rc01 15 10504 15.so.15.4[.0] - * 1.5.4 15 10504 15.so.15.4[.0] - * 1.5.5beta01-08 15 10505 15.so.15.5[.0] - * 1.5.5rc01 15 10505 15.so.15.5[.0] - * 1.5.5 15 10505 15.so.15.5[.0] - * 1.5.6beta01-07 15 10506 15.so.15.6[.0] - * 1.5.6rc01-03 15 10506 15.so.15.6[.0] - * 1.5.6 15 10506 15.so.15.6[.0] - * 1.5.7beta01-05 15 10507 15.so.15.7[.0] - * 1.5.7rc01-03 15 10507 15.so.15.7[.0] - * 1.5.7 15 10507 15.so.15.7[.0] - * 1.6.0beta01-40 16 10600 16.so.16.0[.0] - * 1.6.0rc01-08 16 10600 16.so.16.0[.0] - * 1.6.0 16 10600 16.so.16.0[.0] - * 1.6.1beta01-09 16 10601 16.so.16.1[.0] - * 1.6.1rc01 16 10601 16.so.16.1[.0] - * 1.6.1 16 10601 16.so.16.1[.0] - * 1.6.2beta01 16 10602 16.so.16.2[.0] - * 1.6.2rc01-06 16 10602 16.so.16.2[.0] - * 1.6.2 16 10602 16.so.16.2[.0] - * 1.6.3beta01-11 16 10603 16.so.16.3[.0] - * 1.6.3rc01 16 10603 16.so.16.3[.0] - * 1.6.3 16 10603 16.so.16.3[.0] - * 1.6.4beta01-02 16 10604 16.so.16.4[.0] - * 1.6.4rc01 16 10604 16.so.16.4[.0] - * 1.6.4 16 10604 16.so.16.4[.0] - * 1.6.5 16 10605 16.so.16.5[.0] - * 1.6.6 16 10606 16.so.16.6[.0] - * 1.6.7beta01-04 16 10607 16.so.16.7[.0] - * 1.6.7rc01-03 16 10607 16.so.16.7[.0] - * 1.6.7 16 10607 16.so.16.7[.0] - * 1.6.8beta01-02 16 10608 16.so.16.8[.0] - * 1.6.8rc01-02 16 10608 16.so.16.8[.0] - * 1.6.8 16 10608 16.so.16.8[.0] - * 1.6.9beta01-04 16 10609 16.so.16.9[.0] - * 1.6.9rc01-02 16 10609 16.so.16.9[.0] - * 1.6.9 16 10609 16.so.16.9[.0] - * 1.6.10beta01-03 16 10610 16.so.16.10[.0] - * 1.6.10rc01-03 16 10610 16.so.16.10[.0] - * 1.6.10 16 10610 16.so.16.10[.0] - * 1.6.11beta01-06 16 10611 16.so.16.11[.0] - * 1.6.11rc01-02 16 10611 16.so.16.11[.0] - * 1.6.11 16 10611 16.so.16.11[.0] - * 1.6.12rc01-03 16 10612 16.so.16.12[.0] - * 1.6.12 16 10612 16.so.16.12[.0] - * 1.6.13beta01-04 16 10613 16.so.16.13[.0] - * 1.6.13rc01-02 16 10613 16.so.16.13[.0] - * 1.6.13 16 10613 16.so.16.13[.0] - * 1.6.14beta01-07 16 10614 16.so.16.14[.0] - * 1.6.14rc01-02 16 10614 16.so.16.14[.0] - * 1.6.14 16 10614 16.so.16.14[.0] - * 1.6.15beta01-08 16 10615 16.so.16.15[.0] - * 1.6.15rc01-03 16 10615 16.so.16.15[.0] - * 1.6.15 16 10615 16.so.16.15[.0] - * 1.6.16beta01-03 16 10616 16.so.16.16[.0] - * 1.6.16rc01-02 16 10616 16.so.16.16[.0] - * 1.6.16 16 10616 16.so.16.16[.0] + * ... + * 1.0.19 10 10019 10.so.0.19[.0] + * ... + * 1.2.53 13 10253 12.so.0.53[.0] + * ... + * 1.5.23 15 10523 15.so.15.23[.0] + * ... + * 1.6.21 16 10621 16.so.16.21[.0] * - * Henceforth the source version will match the shared-library major - * and minor numbers; the shared-library major version number will be - * used for changes in backward compatibility, as it is intended. The - * PNG_LIBPNG_VER macro, which is not used within libpng but is available - * for applications, is an unsigned integer of the form xyyzz corresponding - * to the source version x.y.z (leading zeros in y and z). Beta versions - * were given the previous public release number plus a letter, until - * version 1.0.6j; from then on they were given the upcoming public - * release number plus "betaNN" or "rcNN". + * Henceforth the source version will match the shared-library major + * and minor numbers; the shared-library major version number will be + * used for changes in backward compatibility, as it is intended. The + * PNG_LIBPNG_VER macro, which is not used within libpng but is available + * for applications, is an unsigned integer of the form xyyzz corresponding + * to the source version x.y.z (leading zeros in y and z). Beta versions + * were given the previous public release number plus a letter, until + * version 1.0.6j; from then on they were given the upcoming public + * release number plus "betaNN" or "rcNN". * - * Binary incompatibility exists only when applications make direct access - * to the info_ptr or png_ptr members through png.h, and the compiled - * application is loaded with a different version of the library. + * Binary incompatibility exists only when applications make direct access + * to the info_ptr or png_ptr members through png.h, and the compiled + * application is loaded with a different version of the library. * - * DLLNUM will change each time there are forward or backward changes - * in binary compatibility (e.g., when a new feature is added). + * DLLNUM will change each time there are forward or backward changes + * in binary compatibility (e.g., when a new feature is added). * - * See libpng-manual.txt or libpng.3 for more information. The PNG - * specification is available as a W3C Recommendation and as an ISO - * Specification, <http://www.w3.org/TR/2003/REC-PNG-20031110/ - */ - -/* - * COPYRIGHT NOTICE, DISCLAIMER, and LICENSE: - * - * If you modify libpng you may insert additional notices immediately following - * this sentence. - * - * This code is released under the libpng license. - * - * libpng versions 1.2.6, August 15, 2004, through 1.6.16, December 22, 2014, are - * Copyright (c) 2004, 2006-2014 Glenn Randers-Pehrson, and are - * distributed according to the same disclaimer and license as libpng-1.2.5 - * with the following individual added to the list of Contributing Authors: - * - * Cosmin Truta - * - * libpng versions 1.0.7, July 1, 2000, through 1.2.5, October 3, 2002, are - * Copyright (c) 2000-2002 Glenn Randers-Pehrson, and are - * distributed according to the same disclaimer and license as libpng-1.0.6 - * with the following individuals added to the list of Contributing Authors: - * - * Simon-Pierre Cadieux - * Eric S. Raymond - * Gilles Vollant - * - * and with the following additions to the disclaimer: - * - * There is no warranty against interference with your enjoyment of the - * library or against infringement. There is no warranty that our - * efforts or the library will fulfill any of your particular purposes - * or needs. This library is provided with all faults, and the entire - * risk of satisfactory quality, performance, accuracy, and effort is with - * the user. - * - * libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are - * Copyright (c) 1998, 1999, 2000 Glenn Randers-Pehrson, and are - * distributed according to the same disclaimer and license as libpng-0.96, - * with the following individuals added to the list of Contributing Authors: - * - * Tom Lane - * Glenn Randers-Pehrson - * Willem van Schaik - * - * libpng versions 0.89, June 1996, through 0.96, May 1997, are - * Copyright (c) 1996, 1997 Andreas Dilger - * Distributed according to the same disclaimer and license as libpng-0.88, - * with the following individuals added to the list of Contributing Authors: - * - * John Bowler - * Kevin Bracey - * Sam Bushell - * Magnus Holmgren - * Greg Roelofs - * Tom Tanner - * - * libpng versions 0.5, May 1995, through 0.88, January 1996, are - * Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc. - * - * For the purposes of this copyright and license, "Contributing Authors" - * is defined as the following set of individuals: - * - * Andreas Dilger - * Dave Martindale - * Guy Eric Schalnat - * Paul Schmidt - * Tim Wegner - * - * The PNG Reference Library is supplied "AS IS". The Contributing Authors - * and Group 42, Inc. disclaim all warranties, expressed or implied, - * including, without limitation, the warranties of merchantability and of - * fitness for any purpose. The Contributing Authors and Group 42, Inc. - * assume no liability for direct, indirect, incidental, special, exemplary, - * or consequential damages, which may result from the use of the PNG - * Reference Library, even if advised of the possibility of such damage. - * - * Permission is hereby granted to use, copy, modify, and distribute this - * source code, or portions hereof, for any purpose, without fee, subject - * to the following restrictions: - * - * 1. The origin of this source code must not be misrepresented. - * - * 2. Altered versions must be plainly marked as such and must not - * be misrepresented as being the original source. - * - * 3. This Copyright notice may not be removed or altered from - * any source or altered source distribution. - * - * The Contributing Authors and Group 42, Inc. specifically permit, without - * fee, and encourage the use of this source code as a component to - * supporting the PNG file format in commercial products. If you use this - * source code in a product, acknowledgment is not required but would be - * appreciated. - */ - -/* - * A "png_get_copyright" function is available, for convenient use in "about" - * boxes and the like: - * - * printf("%s", png_get_copyright(NULL)); - * - * Also, the PNG logo (in PNG format, of course) is supplied in the - * files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31). - */ - -/* - * Libpng is OSI Certified Open Source Software. OSI Certified is a - * certification mark of the Open Source Initiative. - */ - -/* - * The contributing authors would like to thank all those who helped - * with testing, bug fixes, and patience. This wouldn't have been - * possible without all of you. - * - * Thanks to Frank J. T. Wojcik for helping with the documentation. + * See libpng.txt or libpng.3 for more information. The PNG specification + * is available as a W3C Recommendation and as an ISO Specification, + * <http://www.w3.org/TR/2003/REC-PNG-20031110/ */ /* * Y2K compliance in libpng: * ========================= * - * December 22, 2014 + * January 15, 2016 * * Since the PNG Development group is an ad-hoc body, we can't make * an official declaration. * * This is your unofficial assurance that libpng from version 0.71 and - * upward through 1.6.16 are Y2K compliant. It is my belief that + * upward through 1.6.21 are Y2K compliant. It is my belief that * earlier versions were also Y2K compliant. * * Libpng only has two year fields. One is a 2-byte unsigned integer @@ -423,9 +282,9 @@ */ /* Version information for png.h - this should match the version in png.c */ -#define PNG_LIBPNG_VER_STRING "1.6.16" +#define PNG_LIBPNG_VER_STRING "1.6.21" #define PNG_HEADER_VERSION_STRING \ - " libpng version 1.6.16 - December 22, 2014\n" + " libpng version 1.6.21 - January 15, 2016\n" #define PNG_LIBPNG_VER_SONUM 16 #define PNG_LIBPNG_VER_DLLNUM 16 @@ -433,7 +292,7 @@ /* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */ #define PNG_LIBPNG_VER_MAJOR 1 #define PNG_LIBPNG_VER_MINOR 6 -#define PNG_LIBPNG_VER_RELEASE 16 +#define PNG_LIBPNG_VER_RELEASE 21 /* This should match the numeric part of the final component of * PNG_LIBPNG_VER_STRING, omitting any leading zero: @@ -464,7 +323,7 @@ * version 1.0.0 was mis-numbered 100 instead of 10000). From * version 1.0.1 it's xxyyzz, where x=major, y=minor, z=release */ -#define PNG_LIBPNG_VER 10616 /* 1.6.16 */ +#define PNG_LIBPNG_VER 10621 /* 1.6.21 */ /* Library configuration: these options cannot be changed after * the library has been built. @@ -521,17 +380,22 @@ extern "C" { /* This file is arranged in several sections: * - * 1. Any configuration options that can be specified by for the application + * 1. [omitted] + * 2. Any configuration options that can be specified by for the application * code when it is built. (Build time configuration is in pnglibconf.h) - * 2. Type definitions (base types are defined in pngconf.h), structure + * 3. Type definitions (base types are defined in pngconf.h), structure * definitions. - * 3. Exported library functions. - * 4. Simplified API. + * 4. Exported library functions. + * 5. Simplified API. + * 6. Implementation options. * * The library source code has additional files (principally pngpriv.h) that * allow configuration of the library. */ -/* Section 1: run time configuration + +/* Section 1: [omitted] */ + +/* Section 2: run time configuration * See pnglibconf.h for build time configuration * * Run time configuration allows the application to choose between @@ -561,7 +425,7 @@ extern "C" { * Otherwise the calls are mapped to png_error. */ -/* Section 2: type definitions, including structures and compile time +/* Section 3: type definitions, including structures and compile time * constants. * See pngconf.h for base types that vary by machine/system */ @@ -569,7 +433,7 @@ extern "C" { /* This triggers a compiler error in png.c, if png.c and png.h * do not agree upon the version number. */ -typedef char* png_libpng_version_1_6_16; +typedef char* png_libpng_version_1_6_21; /* Basic control structions. Read libpng-manual.txt or libpng.3 for more info. * @@ -885,7 +749,9 @@ typedef png_unknown_chunk * * png_unknown_chunkpp; #define PNG_INFO_iCCP 0x1000 /* ESR, 1.0.6 */ #define PNG_INFO_sPLT 0x2000 /* ESR, 1.0.6 */ #define PNG_INFO_sCAL 0x4000 /* ESR, 1.0.6 */ +#if INT_MAX >= 0x8000 /* else this might break */ #define PNG_INFO_IDAT 0x8000 /* ESR, 1.0.6 */ +#endif /* This is used for the transformation routines, as some of them * change these values for the row. It also should enable using @@ -989,7 +855,9 @@ PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), PNGARG((jmp_buf, int)), typedef); #define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */ /* Added to libpng-1.5.4 */ #define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */ +#if INT_MAX >= 0x8000 /* else this might break */ #define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */ +#endif /* Flags for MNG supported features */ #define PNG_FLAG_MNG_EMPTY_PLTE 0x01 @@ -1006,7 +874,7 @@ typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp, png_alloc_size_t)); typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp)); -/* Section 3: exported functions +/* Section 4: exported functions * Here are the function definitions most commonly used. This is not * the place to find out how to use libpng. See libpng-manual.txt for the * full explanation, see example.c for the summary. This just provides @@ -1379,13 +1247,13 @@ PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr)); #endif #if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED) -/* Add a filler byte to 8-bit Gray or 24-bit RGB images. */ +/* Add a filler byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */ PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler, int flags)); /* The values of the PNG_FILLER_ defines should NOT be changed */ # define PNG_FILLER_BEFORE 0 # define PNG_FILLER_AFTER 1 -/* Add an alpha byte to 8-bit Gray or 24-bit RGB images. */ +/* Add an alpha byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */ PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr, png_uint_32 filler, int flags)); #endif /* READ_FILLER || WRITE_FILLER */ @@ -1578,6 +1446,7 @@ PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action, #define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */ #define PNG_CRC_NO_CHANGE 5 /* use current value use current value */ +#ifdef PNG_WRITE_SUPPORTED /* These functions give the user control over the scan-line filtering in * libpng and the compression methods used by zlib. These functions are * mainly useful for testing, as the defaults should work with most users. @@ -1591,6 +1460,7 @@ PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action, */ PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method, int filters)); +#endif /* WRITE */ /* Flags for png_set_filter() to say which filters to use. The flags * are chosen so that they don't conflict with real filter types @@ -1616,35 +1486,8 @@ PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method, #define PNG_FILTER_VALUE_PAETH 4 #define PNG_FILTER_VALUE_LAST 5 -#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* EXPERIMENTAL */ -/* The "heuristic_method" is given by one of the PNG_FILTER_HEURISTIC_ - * defines, either the default (minimum-sum-of-absolute-differences), or - * the experimental method (weighted-minimum-sum-of-absolute-differences). - * - * Weights are factors >= 1.0, indicating how important it is to keep the - * filter type consistent between rows. Larger numbers mean the current - * filter is that many times as likely to be the same as the "num_weights" - * previous filters. This is cumulative for each previous row with a weight. - * There needs to be "num_weights" values in "filter_weights", or it can be - * NULL if the weights aren't being specified. Weights have no influence on - * the selection of the first row filter. Well chosen weights can (in theory) - * improve the compression for a given image. - * - * Costs are factors >= 1.0 indicating the relative decoding costs of a - * filter type. Higher costs indicate more decoding expense, and are - * therefore less likely to be selected over a filter with lower computational - * costs. There needs to be a value in "filter_costs" for each valid filter - * type (given by PNG_FILTER_VALUE_LAST), or it can be NULL if you aren't - * setting the costs. Costs try to improve the speed of decompression without - * unduly increasing the compressed image size. - * - * A negative weight or cost indicates the default value is to be used, and - * values in the range [0.0, 1.0) indicate the value is to remain unchanged. - * The default values for both weights and costs are currently 1.0, but may - * change if good general weighting/cost heuristics can be found. If both - * the weights and costs are set to 1.0, this degenerates the WEIGHTED method - * to the UNWEIGHTED method, but with added encoding time/computation. - */ +#ifdef PNG_WRITE_SUPPORTED +#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* DEPRECATED */ PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr, int heuristic_method, int num_weights, png_const_doublep filter_weights, png_const_doublep filter_costs)) @@ -1654,15 +1497,12 @@ PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed, png_const_fixed_point_p filter_costs)) #endif /* WRITE_WEIGHTED_FILTER */ -/* Heuristic used for row filter selection. These defines should NOT be - * changed. - */ +/* The following are no longer used and will be removed from libpng-1.7: */ #define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */ #define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */ #define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */ #define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */ -#ifdef PNG_WRITE_SUPPORTED /* Set the library compression level. Currently, valid values range from * 0 - 9, corresponding directly to the zlib compression levels 0 - 9 * (0 - no compression, 9 - "maximal" compression). Note that tests have @@ -1670,6 +1510,7 @@ PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed, * for PNG images, and do considerably fewer caclulations. In the future, * these values may not correspond directly to the zlib compression levels. */ +#ifdef PNG_WRITE_CUSTOMIZE_COMPRESSION_SUPPORTED PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr, int level)); @@ -1687,7 +1528,7 @@ PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr, PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr, int method)); -#endif +#endif /* WRITE_CUSTOMIZE_COMPRESSION */ #ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED /* Also set zlib parameters for compressing non-IDAT chunks */ @@ -1709,6 +1550,7 @@ PNG_EXPORT(225, void, png_set_text_compression_window_bits, PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr, int method)); #endif /* WRITE_CUSTOMIZE_ZTXT_COMPRESSION */ +#endif /* WRITE */ /* These next functions are called for input/output, memory, and error * handling. They are in the file pngrio.c, pngwio.c, and pngerror.c, @@ -1819,7 +1661,7 @@ PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp)); * * The integer return from the callback function is interpreted thus: * - * negative: An error occured, png_chunk_error will be called. + * negative: An error occurred; png_chunk_error will be called. * zero: The chunk was not handled, the chunk will be saved. A critical * chunk will cause an error at this point unless it is to be saved. * positive: The chunk was handled, libpng will ignore/discard it. @@ -2664,26 +2506,28 @@ PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type, * (png_uint_16)(alpha) \ + (png_uint_16)(bg)*(png_uint_16)(255 \ - (png_uint_16)(alpha)) + 128); \ - (composite) = (png_byte)((temp + (temp >> 8)) >> 8); } + (composite) = (png_byte)(((temp + (temp >> 8)) >> 8) & 0xff); } # define png_composite_16(composite, fg, alpha, bg) \ { png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \ * (png_uint_32)(alpha) \ + (png_uint_32)(bg)*(65535 \ - (png_uint_32)(alpha)) + 32768); \ - (composite) = (png_uint_16)((temp + (temp >> 16)) >> 16); } + (composite) = (png_uint_16)(0xffff & ((temp + (temp >> 16)) >> 16)); } #else /* Standard method using integer division */ -# define png_composite(composite, fg, alpha, bg) \ - (composite) = (png_byte)(((png_uint_16)(fg) * (png_uint_16)(alpha) + \ - (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \ - 127) / 255) +# define png_composite(composite, fg, alpha, bg) \ + (composite) = \ + (png_byte)(0xff & (((png_uint_16)(fg) * (png_uint_16)(alpha) + \ + (png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \ + 127) / 255)) # define png_composite_16(composite, fg, alpha, bg) \ - (composite) = (png_uint_16)(((png_uint_32)(fg) * (png_uint_32)(alpha) + \ - (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \ - 32767) / 65535) + (composite) = \ + (png_uint_16)(0xffff & (((png_uint_32)(fg) * (png_uint_32)(alpha) + \ + (png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \ + 32767) / 65535)) #endif /* READ_COMPOSITE_NODIV */ #ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED @@ -2734,7 +2578,7 @@ PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i)); # define PNG_get_int_32(buf) \ ((png_int_32)((*(buf) & 0x80) \ - ? -((png_int_32)((png_get_uint_32(buf) ^ 0xffffffffL) + 1)) \ + ? -((png_int_32)(((png_get_uint_32(buf)^0xffffffffU)+1U)&0x7fffffffU)) \ : (png_int_32)png_get_uint_32(buf))) /* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h, @@ -2754,10 +2598,17 @@ PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i)); # endif #endif -#if defined(PNG_SIMPLIFIED_READ_SUPPORTED) || \ - defined(PNG_SIMPLIFIED_WRITE_SUPPORTED) +#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED +PNG_EXPORT(242, void, png_set_check_for_invalid_index, + (png_structrp png_ptr, int allowed)); +# ifdef PNG_GET_PALETTE_MAX_SUPPORTED +PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr, + png_const_infop info_ptr)); +# endif +#endif /* CHECK_FOR_INVALID_INDEX */ + /******************************************************************************* - * SIMPLIFIED API + * Section 5: SIMPLIFIED API ******************************************************************************* * * Please read the documentation in libpng-manual.txt (TODO: write said @@ -2773,8 +2624,9 @@ PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i)); * * To read a PNG file using the simplified API: * - * 1) Declare a 'png_image' structure (see below) on the stack and set the - * version field to PNG_IMAGE_VERSION. + * 1) Declare a 'png_image' structure (see below) on the stack, set the + * version field to PNG_IMAGE_VERSION and the 'opaque' pointer to NULL + * (this is REQUIRED, your program may crash if you don't do it.) * 2) Call the appropriate png_image_begin_read... function. * 3) Set the png_image 'format' member to the required sample format. * 4) Allocate a buffer for the image and, if required, the color-map. @@ -2801,6 +2653,9 @@ PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i)); * when it is being read or defines the in-memory format of an image that you * need to write: */ +#if defined(PNG_SIMPLIFIED_READ_SUPPORTED) || \ + defined(PNG_SIMPLIFIED_WRITE_SUPPORTED) + #define PNG_IMAGE_VERSION 1 typedef struct png_control *png_controlp; @@ -2900,7 +2755,7 @@ typedef struct * called to read or write the color-map and set the format correctly for the * image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly! * - * NOTE: libpng can be built with particular features disabled, if you see + * NOTE: libpng can be built with particular features disabled. If you see * compiler errors because the definition of one of the following flags has been * compiled out it is because libpng does not have the required support. It is * possible, however, for the libpng configuration to enable the format on just @@ -2912,7 +2767,7 @@ typedef struct */ #define PNG_FORMAT_FLAG_ALPHA 0x01U /* format with an alpha channel */ #define PNG_FORMAT_FLAG_COLOR 0x02U /* color format: otherwise grayscale */ -#define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2 byte channels else 1 byte */ +#define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2-byte channels else 1-byte */ #define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */ #ifdef PNG_FORMAT_BGR_SUPPORTED @@ -3199,9 +3054,11 @@ PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file, * * With all APIs row_stride is handled as in the read APIs - it is the spacing * from one row to the next in component sized units (1 or 2 bytes) and if - * negative indicates a bottom-up row layout in the buffer. + * negative indicates a bottom-up row layout in the buffer. If row_stride is zero, + * libpng will calculate it for you from the image width and number of channels. * - * Note that the write API does not support interlacing or sub-8-bit pixels. + * Note that the write API does not support interlacing, sub-8-bit pixels, indexed + * PNG (color_type 3) or most ancillary chunks. */ #endif /* STDIO */ #endif /* SIMPLIFIED_WRITE */ @@ -3210,17 +3067,8 @@ PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file, ******************************************************************************/ #endif /* SIMPLIFIED_{READ|WRITE} */ -#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED -PNG_EXPORT(242, void, png_set_check_for_invalid_index, - (png_structrp png_ptr, int allowed)); -# ifdef PNG_GET_PALETTE_MAX_SUPPORTED -PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr, - png_const_infop info_ptr)); -# endif -#endif /* CHECK_FOR_INVALID_INDEX */ - /******************************************************************************* - * IMPLEMENTATION OPTIONS + * Section 6: IMPLEMENTATION OPTIONS ******************************************************************************* * * Support for arbitrary implementation-specific optimizations. The API allows diff --git a/android/x86_64/include/png/pngconf.h b/android/x86_64/include/png/pngconf.h index 03615f0e..93446545 100644 --- a/android/x86_64/include/png/pngconf.h +++ b/android/x86_64/include/png/pngconf.h @@ -1,9 +1,9 @@ /* pngconf.h - machine configurable file for libpng * - * libpng version 1.6.16,December 22, 2014 + * libpng version 1.6.21, January 15, 2016 * - * Copyright (c) 1998-2014 Glenn Randers-Pehrson + * Copyright (c) 1998-2002,2004,2006-2015 Glenn Randers-Pehrson * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger) * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.) * @@ -11,9 +11,7 @@ * For conditions of distribution and use, see the disclaimer * and license in png.h * - */ - -/* Any machine specific code is near the front of this file, so if you + * Any machine specific code is near the front of this file, so if you * are configuring libpng for a machine, you may want to read the section * starting here down to where it starts to typedef png_color, png_text, * and png_info. @@ -22,26 +20,6 @@ #ifndef PNGCONF_H #define PNGCONF_H -/* To do: Do all of this in scripts/pnglibconf.dfa */ -#ifdef PNG_SAFE_LIMITS_SUPPORTED -# ifdef PNG_USER_WIDTH_MAX -# undef PNG_USER_WIDTH_MAX -# define PNG_USER_WIDTH_MAX 1000000L -# endif -# ifdef PNG_USER_HEIGHT_MAX -# undef PNG_USER_HEIGHT_MAX -# define PNG_USER_HEIGHT_MAX 1000000L -# endif -# ifdef PNG_USER_CHUNK_MALLOC_MAX -# undef PNG_USER_CHUNK_MALLOC_MAX -# define PNG_USER_CHUNK_MALLOC_MAX 4000000L -# endif -# ifdef PNG_USER_CHUNK_CACHE_MAX -# undef PNG_USER_CHUNK_CACHE_MAX -# define PNG_USER_CHUNK_CACHE_MAX 128 -# endif -#endif - #ifndef PNG_BUILDING_SYMBOL_TABLE /* else includes may cause problems */ /* From libpng 1.6.0 libpng requires an ANSI X3.159-1989 ("ISOC90") compliant C @@ -85,7 +63,7 @@ */ #define PNG_CONST const /* backward compatibility only */ -/* This controls optimization of the reading of 16 and 32 bit values +/* This controls optimization of the reading of 16-bit and 32-bit values * from PNG files. It can be set on a per-app-file basis - it * just changes whether a macro is used when the function is called. * The library builder sets the default; if read functions are not @@ -317,11 +295,11 @@ * table entries, so we discard it here. See the .dfn files in the * scripts directory. */ -#ifndef PNG_EXPORTA -# define PNG_EXPORTA(ordinal, type, name, args, attributes)\ - PNG_FUNCTION(PNG_EXPORT_TYPE(type),(PNGAPI name),PNGARG(args), \ - extern attributes) +#ifndef PNG_EXPORTA +# define PNG_EXPORTA(ordinal, type, name, args, attributes) \ + PNG_FUNCTION(PNG_EXPORT_TYPE(type), (PNGAPI name), PNGARG(args), \ + PNG_LINKAGE_API attributes) #endif /* ANSI-C (C90) does not permit a macro to be invoked with an empty argument, @@ -329,7 +307,7 @@ */ #define PNG_EMPTY /*empty list*/ -#define PNG_EXPORT(ordinal, type, name, args)\ +#define PNG_EXPORT(ordinal, type, name, args) \ PNG_EXPORTA(ordinal, type, name, args, PNG_EMPTY) /* Use PNG_REMOVED to comment out a removed interface. */ @@ -502,7 +480,7 @@ #if CHAR_BIT == 8 && UCHAR_MAX == 255 typedef unsigned char png_byte; #else -# error "libpng requires 8 bit bytes" +# error "libpng requires 8-bit bytes" #endif #if INT_MIN == -32768 && INT_MAX == 32767 @@ -510,7 +488,7 @@ #elif SHRT_MIN == -32768 && SHRT_MAX == 32767 typedef short png_int_16; #else -# error "libpng requires a signed 16 bit type" +# error "libpng requires a signed 16-bit type" #endif #if UINT_MAX == 65535 @@ -518,7 +496,7 @@ #elif USHRT_MAX == 65535 typedef unsigned short png_uint_16; #else -# error "libpng requires an unsigned 16 bit type" +# error "libpng requires an unsigned 16-bit type" #endif #if INT_MIN < -2147483646 && INT_MAX > 2147483646 @@ -526,7 +504,7 @@ #elif LONG_MIN < -2147483646 && LONG_MAX > 2147483646 typedef long int png_int_32; #else -# error "libpng requires a signed 32 bit (or more) type" +# error "libpng requires a signed 32-bit (or more) type" #endif #if UINT_MAX > 4294967294 @@ -534,7 +512,7 @@ #elif ULONG_MAX > 4294967294 typedef unsigned long int png_uint_32; #else -# error "libpng requires an unsigned 32 bit (or more) type" +# error "libpng requires an unsigned 32-bit (or more) type" #endif /* Prior to 1.6.0 it was possible to disable the use of size_t, 1.6.0, however, diff --git a/android/x86_64/include/png/pnglibconf.h b/android/x86_64/include/png/pnglibconf.h index 42a195b7..c0005678 100644 --- a/android/x86_64/include/png/pnglibconf.h +++ b/android/x86_64/include/png/pnglibconf.h @@ -1,8 +1,8 @@ /* pnglibconf.h - library build configuration */ -/* libpng version 1.6.16,December 22, 2014 */ +/* libpng version 1.6.21, January 15, 2016 */ -/* Copyright (c) 1998-2014 Glenn Randers-Pehrson */ +/* Copyright (c) 1998-2016 Glenn Randers-Pehrson */ /* This code is released under the libpng license. */ /* For conditions of distribution and use, see the disclaimer */ @@ -95,13 +95,10 @@ #define PNG_READ_tIME_SUPPORTED #define PNG_READ_tRNS_SUPPORTED #define PNG_READ_zTXt_SUPPORTED -/*#undef PNG_SAFE_LIMITS_SUPPORTED*/ #define PNG_SAVE_INT_32_SUPPORTED #define PNG_SAVE_UNKNOWN_CHUNKS_SUPPORTED #define PNG_SEQUENTIAL_READ_SUPPORTED #define PNG_SETJMP_SUPPORTED -#define PNG_SET_CHUNK_CACHE_LIMIT_SUPPORTED -#define PNG_SET_CHUNK_MALLOC_LIMIT_SUPPORTED #define PNG_SET_OPTION_SUPPORTED #define PNG_SET_UNKNOWN_CHUNKS_SUPPORTED #define PNG_SET_USER_LIMITS_SUPPORTED @@ -127,6 +124,7 @@ #define PNG_WRITE_BGR_SUPPORTED #define PNG_WRITE_CHECK_FOR_INVALID_INDEX_SUPPORTED #define PNG_WRITE_COMPRESSED_TEXT_SUPPORTED +#define PNG_WRITE_CUSTOMIZE_COMPRESSION_SUPPORTED #define PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED #define PNG_WRITE_FILLER_SUPPORTED #define PNG_WRITE_FILTER_SUPPORTED @@ -185,18 +183,24 @@ /* end of options */ /* settings */ #define PNG_API_RULE 0 -#define PNG_COST_SHIFT 3 #define PNG_DEFAULT_READ_MACROS 1 #define PNG_GAMMA_THRESHOLD_FIXED 5000 #define PNG_IDAT_READ_SIZE PNG_ZBUF_SIZE #define PNG_INFLATE_BUF_SIZE 1024 +#define PNG_LINKAGE_API extern +#define PNG_LINKAGE_CALLBACK extern +#define PNG_LINKAGE_DATA extern +#define PNG_LINKAGE_FUNCTION extern #define PNG_MAX_GAMMA_8 11 #define PNG_QUANTIZE_BLUE_BITS 5 #define PNG_QUANTIZE_GREEN_BITS 5 #define PNG_QUANTIZE_RED_BITS 5 #define PNG_TEXT_Z_DEFAULT_COMPRESSION (-1) #define PNG_TEXT_Z_DEFAULT_STRATEGY 0 -#define PNG_WEIGHT_SHIFT 8 +#define PNG_USER_CHUNK_CACHE_MAX 1000 +#define PNG_USER_CHUNK_MALLOC_MAX 8000000 +#define PNG_USER_HEIGHT_MAX 1000000 +#define PNG_USER_WIDTH_MAX 1000000 #define PNG_ZBUF_SIZE 8192 #define PNG_ZLIB_VERNUM 0x1280 #define PNG_Z_DEFAULT_COMPRESSION (-1) diff --git a/android/x86_64/libfreetype.a b/android/x86_64/libfreetype.a index f93bcf07..87be0d4f 100644 Binary files a/android/x86_64/libfreetype.a and b/android/x86_64/libfreetype.a differ diff --git a/android/x86_64/libjpeg.a b/android/x86_64/libjpeg.a index e99f563c..8dd05435 100644 Binary files a/android/x86_64/libjpeg.a and b/android/x86_64/libjpeg.a differ diff --git a/android/x86_64/libpng.a b/android/x86_64/libpng.a index f866f33e..bba1cd63 100644 Binary files a/android/x86_64/libpng.a and b/android/x86_64/libpng.a differ