modules/freetype2/include/ftcid.h

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0 1 /***************************************************************************/
michael@0 2 /* */
michael@0 3 /* ftcid.h */
michael@0 4 /* */
michael@0 5 /* FreeType API for accessing CID font information (specification). */
michael@0 6 /* */
michael@0 7 /* Copyright 2007, 2009 by Dereg Clegg, Michael Toftdal. */
michael@0 8 /* */
michael@0 9 /* This file is part of the FreeType project, and may only be used, */
michael@0 10 /* modified, and distributed under the terms of the FreeType project */
michael@0 11 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
michael@0 12 /* this file you indicate that you have read the license and */
michael@0 13 /* understand and accept it fully. */
michael@0 14 /* */
michael@0 15 /***************************************************************************/
michael@0 16
michael@0 17
michael@0 18 #ifndef __FTCID_H__
michael@0 19 #define __FTCID_H__
michael@0 20
michael@0 21 #include <ft2build.h>
michael@0 22 #include FT_FREETYPE_H
michael@0 23
michael@0 24 #ifdef FREETYPE_H
michael@0 25 #error "freetype.h of FreeType 1 has been loaded!"
michael@0 26 #error "Please fix the directory search order for header files"
michael@0 27 #error "so that freetype.h of FreeType 2 is found first."
michael@0 28 #endif
michael@0 29
michael@0 30
michael@0 31 FT_BEGIN_HEADER
michael@0 32
michael@0 33
michael@0 34 /*************************************************************************/
michael@0 35 /* */
michael@0 36 /* <Section> */
michael@0 37 /* cid_fonts */
michael@0 38 /* */
michael@0 39 /* <Title> */
michael@0 40 /* CID Fonts */
michael@0 41 /* */
michael@0 42 /* <Abstract> */
michael@0 43 /* CID-keyed font specific API. */
michael@0 44 /* */
michael@0 45 /* <Description> */
michael@0 46 /* This section contains the declaration of CID-keyed font specific */
michael@0 47 /* functions. */
michael@0 48 /* */
michael@0 49 /*************************************************************************/
michael@0 50
michael@0 51
michael@0 52 /**********************************************************************
michael@0 53 *
michael@0 54 * @function:
michael@0 55 * FT_Get_CID_Registry_Ordering_Supplement
michael@0 56 *
michael@0 57 * @description:
michael@0 58 * Retrieve the Registry/Ordering/Supplement triple (also known as the
michael@0 59 * "R/O/S") from a CID-keyed font.
michael@0 60 *
michael@0 61 * @input:
michael@0 62 * face ::
michael@0 63 * A handle to the input face.
michael@0 64 *
michael@0 65 * @output:
michael@0 66 * registry ::
michael@0 67 * The registry, as a C~string, owned by the face.
michael@0 68 *
michael@0 69 * ordering ::
michael@0 70 * The ordering, as a C~string, owned by the face.
michael@0 71 *
michael@0 72 * supplement ::
michael@0 73 * The supplement.
michael@0 74 *
michael@0 75 * @return:
michael@0 76 * FreeType error code. 0~means success.
michael@0 77 *
michael@0 78 * @note:
michael@0 79 * This function only works with CID faces, returning an error
michael@0 80 * otherwise.
michael@0 81 *
michael@0 82 * @since:
michael@0 83 * 2.3.6
michael@0 84 */
michael@0 85 FT_EXPORT( FT_Error )
michael@0 86 FT_Get_CID_Registry_Ordering_Supplement( FT_Face face,
michael@0 87 const char* *registry,
michael@0 88 const char* *ordering,
michael@0 89 FT_Int *supplement);
michael@0 90
michael@0 91
michael@0 92 /**********************************************************************
michael@0 93 *
michael@0 94 * @function:
michael@0 95 * FT_Get_CID_Is_Internally_CID_Keyed
michael@0 96 *
michael@0 97 * @description:
michael@0 98 * Retrieve the type of the input face, CID keyed or not. In
michael@0 99 * constrast to the @FT_IS_CID_KEYED macro this function returns
michael@0 100 * successfully also for CID-keyed fonts in an SNFT wrapper.
michael@0 101 *
michael@0 102 * @input:
michael@0 103 * face ::
michael@0 104 * A handle to the input face.
michael@0 105 *
michael@0 106 * @output:
michael@0 107 * is_cid ::
michael@0 108 * The type of the face as an @FT_Bool.
michael@0 109 *
michael@0 110 * @return:
michael@0 111 * FreeType error code. 0~means success.
michael@0 112 *
michael@0 113 * @note:
michael@0 114 * This function only works with CID faces and OpenType fonts,
michael@0 115 * returning an error otherwise.
michael@0 116 *
michael@0 117 * @since:
michael@0 118 * 2.3.9
michael@0 119 */
michael@0 120 FT_EXPORT( FT_Error )
michael@0 121 FT_Get_CID_Is_Internally_CID_Keyed( FT_Face face,
michael@0 122 FT_Bool *is_cid );
michael@0 123
michael@0 124
michael@0 125 /**********************************************************************
michael@0 126 *
michael@0 127 * @function:
michael@0 128 * FT_Get_CID_From_Glyph_Index
michael@0 129 *
michael@0 130 * @description:
michael@0 131 * Retrieve the CID of the input glyph index.
michael@0 132 *
michael@0 133 * @input:
michael@0 134 * face ::
michael@0 135 * A handle to the input face.
michael@0 136 *
michael@0 137 * glyph_index ::
michael@0 138 * The input glyph index.
michael@0 139 *
michael@0 140 * @output:
michael@0 141 * cid ::
michael@0 142 * The CID as an @FT_UInt.
michael@0 143 *
michael@0 144 * @return:
michael@0 145 * FreeType error code. 0~means success.
michael@0 146 *
michael@0 147 * @note:
michael@0 148 * This function only works with CID faces and OpenType fonts,
michael@0 149 * returning an error otherwise.
michael@0 150 *
michael@0 151 * @since:
michael@0 152 * 2.3.9
michael@0 153 */
michael@0 154 FT_EXPORT( FT_Error )
michael@0 155 FT_Get_CID_From_Glyph_Index( FT_Face face,
michael@0 156 FT_UInt glyph_index,
michael@0 157 FT_UInt *cid );
michael@0 158
michael@0 159 /* */
michael@0 160
michael@0 161 FT_END_HEADER
michael@0 162
michael@0 163 #endif /* __FTCID_H__ */
michael@0 164
michael@0 165
michael@0 166 /* END */

mercurial