freetype2/freetype/ftparams.h

0001 /****************************************************************************
0002  *
0003  * ftparams.h
0004  *
0005  *   FreeType API for possible FT_Parameter tags (specification only).
0006  *
0007  * Copyright (C) 2017-2023 by
0008  * David Turner, Robert Wilhelm, and Werner Lemberg.
0009  *
0010  * This file is part of the FreeType project, and may only be used,
0011  * modified, and distributed under the terms of the FreeType project
0012  * license, LICENSE.TXT.  By continuing to use, modify, or distribute
0013  * this file you indicate that you have read the license and
0014  * understand and accept it fully.
0015  *
0016  */
0017
0018
0019 #ifndef FTPARAMS_H_
0020 #define FTPARAMS_H_
0021
0022 #include <freetype/freetype.h>
0023
0024 #ifdef FREETYPE_H
0025 #error "freetype.h of FreeType 1 has been loaded!"
0026 #error "Please fix the directory search order for header files"
0027 #error "so that freetype.h of FreeType 2 is found first."
0028 #endif
0029
0030
0031 FT_BEGIN_HEADER
0032
0033
0034   /**************************************************************************
0035    *
0036    * @section:
0037    *   parameter_tags
0038    *
0039    * @title:
0040    *   Parameter Tags
0041    *
0042    * @abstract:
0043    *   Macros for driver property and font loading parameter tags.
0044    *
0045    * @description:
0046    *   This section contains macros for the @FT_Parameter structure that are
0047    *   used with various functions to activate some special functionality or
0048    *   different behaviour of various components of FreeType.
0049    *
0050    */
0051
0052
0053   /**************************************************************************
0054    *
0055    * @enum:
0056    *   FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY
0057    *
0058    * @description:
0059    *   A tag for @FT_Parameter to make @FT_Open_Face ignore typographic
0060    *   family names in the 'name' table (introduced in OpenType version 1.4).
0061    *   Use this for backward compatibility with legacy systems that have a
0062    *   four-faces-per-family restriction.
0063    *
0064    * @since:
0065    *   2.8
0066    *
0067    */
0068 #define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY \
0069           FT_MAKE_TAG( 'i', 'g', 'p', 'f' )
0070
0071
0072   /* this constant is deprecated */
0073 #define FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY \
0074           FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY
0075
0076
0077   /**************************************************************************
0078    *
0079    * @enum:
0080    *   FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY
0081    *
0082    * @description:
0083    *   A tag for @FT_Parameter to make @FT_Open_Face ignore typographic
0084    *   subfamily names in the 'name' table (introduced in OpenType version
0085    *   1.4).  Use this for backward compatibility with legacy systems that
0086    *   have a four-faces-per-family restriction.
0087    *
0088    * @since:
0089    *   2.8
0090    *
0091    */
0092 #define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY \
0093           FT_MAKE_TAG( 'i', 'g', 'p', 's' )
0094
0095
0096   /* this constant is deprecated */
0097 #define FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY \
0098           FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY
0099
0100
0101   /**************************************************************************
0102    *
0103    * @enum:
0104    *   FT_PARAM_TAG_INCREMENTAL
0105    *
0106    * @description:
0107    *   An @FT_Parameter tag to be used with @FT_Open_Face to indicate
0108    *   incremental glyph loading.
0109    *
0110    */
0111 #define FT_PARAM_TAG_INCREMENTAL \
0112           FT_MAKE_TAG( 'i', 'n', 'c', 'r' )
0113
0114
0115   /**************************************************************************
0116    *
0117    * @enum:
0118    *   FT_PARAM_TAG_IGNORE_SBIX
0119    *
0120    * @description:
0121    *   A tag for @FT_Parameter to make @FT_Open_Face ignore an 'sbix' table
0122    *   while loading a font.  Use this if @FT_FACE_FLAG_SBIX is set and you
0123    *   want to access the outline glyphs in the font.
0124    *
0125    */
0126 #define FT_PARAM_TAG_IGNORE_SBIX \
0127           FT_MAKE_TAG( 'i', 's', 'b', 'x' )
0128
0129
0130   /**************************************************************************
0131    *
0132    * @enum:
0133    *   FT_PARAM_TAG_LCD_FILTER_WEIGHTS
0134    *
0135    * @description:
0136    *   An @FT_Parameter tag to be used with @FT_Face_Properties.  The
0137    *   corresponding argument specifies the five LCD filter weights for a
0138    *   given face (if using @FT_LOAD_TARGET_LCD, for example), overriding the
0139    *   global default values or the values set up with
0140    *   @FT_Library_SetLcdFilterWeights.
0141    *
0142    * @since:
0143    *   2.8
0144    *
0145    */
0146 #define FT_PARAM_TAG_LCD_FILTER_WEIGHTS \
0147           FT_MAKE_TAG( 'l', 'c', 'd', 'f' )
0148
0149
0150   /**************************************************************************
0151    *
0152    * @enum:
0153    *   FT_PARAM_TAG_RANDOM_SEED
0154    *
0155    * @description:
0156    *   An @FT_Parameter tag to be used with @FT_Face_Properties.  The
0157    *   corresponding 32bit signed integer argument overrides the font
0158    *   driver's random seed value with a face-specific one; see @random-seed.
0159    *
0160    * @since:
0161    *   2.8
0162    *
0163    */
0164 #define FT_PARAM_TAG_RANDOM_SEED \
0165           FT_MAKE_TAG( 's', 'e', 'e', 'd' )
0166
0167
0168   /**************************************************************************
0169    *
0170    * @enum:
0171    *   FT_PARAM_TAG_STEM_DARKENING
0172    *
0173    * @description:
0174    *   An @FT_Parameter tag to be used with @FT_Face_Properties.  The
0175    *   corresponding Boolean argument specifies whether to apply stem
0176    *   darkening, overriding the global default values or the values set up
0177    *   with @FT_Property_Set (see @no-stem-darkening).
0178    *
0179    *   This is a passive setting that only takes effect if the font driver or
0180    *   autohinter honors it, which the CFF, Type~1, and CID drivers always
0181    *   do, but the autohinter only in 'light' hinting mode (as of version
0182    *   2.9).
0183    *
0184    * @since:
0185    *   2.8
0186    *
0187    */
0188 #define FT_PARAM_TAG_STEM_DARKENING \
0189           FT_MAKE_TAG( 'd', 'a', 'r', 'k' )
0190
0191
0192   /**************************************************************************
0193    *
0194    * @enum:
0195    *   FT_PARAM_TAG_UNPATENTED_HINTING
0196    *
0197    * @description:
0198    *   Deprecated, no effect.
0199    *
0200    *   Previously: A constant used as the tag of an @FT_Parameter structure
0201    *   to indicate that unpatented methods only should be used by the
0202    *   TrueType bytecode interpreter for a typeface opened by @FT_Open_Face.
0203    *
0204    */
0205 #define FT_PARAM_TAG_UNPATENTED_HINTING \
0206           FT_MAKE_TAG( 'u', 'n', 'p', 'a' )
0207
0208
0209   /* */
0210
0211
0212 FT_END_HEADER
0213
0214
0215 #endif /* FTPARAMS_H_ */
0216
0217
0218 /* END */