freetype2/freetype/ftfntfmt.h

0001 /****************************************************************************
0002  *
0003  * ftfntfmt.h
0004  *
0005  *   Support functions for font formats.
0006  *
0007  * Copyright (C) 2002-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 FTFNTFMT_H_
0020 #define FTFNTFMT_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    *  font_formats
0038    *
0039    * @title:
0040    *  Font Formats
0041    *
0042    * @abstract:
0043    *  Getting the font format.
0044    *
0045    * @description:
0046    *  The single function in this section can be used to get the font format.
0047    *  Note that this information is not needed normally; however, there are
0048    *  special cases (like in PDF devices) where it is important to
0049    *  differentiate, in spite of FreeType's uniform API.
0050    *
0051    */
0052
0053
0054   /**************************************************************************
0055    *
0056    * @function:
0057    *  FT_Get_Font_Format
0058    *
0059    * @description:
0060    *  Return a string describing the format of a given face.  Possible values
0061    *  are 'TrueType', 'Type~1', 'BDF', 'PCF', 'Type~42', 'CID~Type~1', 'CFF',
0062    *  'PFR', and 'Windows~FNT'.
0063    *
0064    *  The return value is suitable to be used as an X11 FONT_PROPERTY.
0065    *
0066    * @input:
0067    *  face ::
0068    *    Input face handle.
0069    *
0070    * @return:
0071    *  Font format string.  `NULL` in case of error.
0072    *
0073    * @note:
0074    *  A deprecated name for the same function is `FT_Get_X11_Font_Format`.
0075    */
0076   FT_EXPORT( const char* )
0077   FT_Get_Font_Format( FT_Face  face );
0078
0079
0080   /* deprecated */
0081   FT_EXPORT( const char* )
0082   FT_Get_X11_Font_Format( FT_Face  face );
0083
0084
0085   /* */
0086
0087
0088 FT_END_HEADER
0089
0090 #endif /* FTFNTFMT_H_ */
0091
0092
0093 /* END */