vrshoot

annotate libs/ft2static/freetype/ftcid.h @ 0:b2f14e535253

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