freetype2/freetype/ftcid.h

0001 /****************************************************************************
0002  *
0003  * ftcid.h
0004  *
0005  *   FreeType API for accessing CID font information (specification).
0006  *
0007  * Copyright (C) 2007-2023 by
0008  * Dereg Clegg and Michael Toftdal.
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 FTCID_H_
0020 #define FTCID_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    *   cid_fonts
0038    *
0039    * @title:
0040    *   CID Fonts
0041    *
0042    * @abstract:
0043    *   CID-keyed font-specific API.
0044    *
0045    * @description:
0046    *   This section contains the declaration of CID-keyed font-specific
0047    *   functions.
0048    *
0049    */
0050
0051
0052   /**************************************************************************
0053    *
0054    * @function:
0055    *    FT_Get_CID_Registry_Ordering_Supplement
0056    *
0057    * @description:
0058    *    Retrieve the Registry/Ordering/Supplement triple (also known as the
0059    *    "R/O/S") from a CID-keyed font.
0060    *
0061    * @input:
0062    *    face ::
0063    *      A handle to the input face.
0064    *
0065    * @output:
0066    *    registry ::
0067    *      The registry, as a C~string, owned by the face.
0068    *
0069    *    ordering ::
0070    *      The ordering, as a C~string, owned by the face.
0071    *
0072    *    supplement ::
0073    *      The supplement.
0074    *
0075    * @return:
0076    *    FreeType error code.  0~means success.
0077    *
0078    * @note:
0079    *    This function only works with CID faces, returning an error
0080    *    otherwise.
0081    *
0082    * @since:
0083    *    2.3.6
0084    */
0085   FT_EXPORT( FT_Error )
0086   FT_Get_CID_Registry_Ordering_Supplement( FT_Face       face,
0087                                            const char*  *registry,
0088                                            const char*  *ordering,
0089                                            FT_Int       *supplement );
0090
0091
0092   /**************************************************************************
0093    *
0094    * @function:
0095    *    FT_Get_CID_Is_Internally_CID_Keyed
0096    *
0097    * @description:
0098    *    Retrieve the type of the input face, CID keyed or not.  In contrast
0099    *    to the @FT_IS_CID_KEYED macro this function returns successfully also
0100    *    for CID-keyed fonts in an SFNT wrapper.
0101    *
0102    * @input:
0103    *    face ::
0104    *      A handle to the input face.
0105    *
0106    * @output:
0107    *    is_cid ::
0108    *      The type of the face as an @FT_Bool.
0109    *
0110    * @return:
0111    *    FreeType error code.  0~means success.
0112    *
0113    * @note:
0114    *    This function only works with CID faces and OpenType fonts, returning
0115    *    an error otherwise.
0116    *
0117    * @since:
0118    *    2.3.9
0119    */
0120   FT_EXPORT( FT_Error )
0121   FT_Get_CID_Is_Internally_CID_Keyed( FT_Face   face,
0122                                       FT_Bool  *is_cid );
0123
0124
0125   /**************************************************************************
0126    *
0127    * @function:
0128    *    FT_Get_CID_From_Glyph_Index
0129    *
0130    * @description:
0131    *    Retrieve the CID of the input glyph index.
0132    *
0133    * @input:
0134    *    face ::
0135    *      A handle to the input face.
0136    *
0137    *    glyph_index ::
0138    *      The input glyph index.
0139    *
0140    * @output:
0141    *    cid ::
0142    *      The CID as an @FT_UInt.
0143    *
0144    * @return:
0145    *    FreeType error code.  0~means success.
0146    *
0147    * @note:
0148    *    This function only works with CID faces and OpenType fonts, returning
0149    *    an error otherwise.
0150    *
0151    * @since:
0152    *    2.3.9
0153    */
0154   FT_EXPORT( FT_Error )
0155   FT_Get_CID_From_Glyph_Index( FT_Face   face,
0156                                FT_UInt   glyph_index,
0157                                FT_UInt  *cid );
0158
0159   /* */
0160
0161
0162 FT_END_HEADER
0163
0164 #endif /* FTCID_H_ */
0165
0166
0167 /* END */