1ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/***************************************************************************/ 2ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* */ 3ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* ftincrem.h */ 4ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* */ 5ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* FreeType incremental loading (specification). */ 6ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* */ 7ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* Copyright 2002, 2003, 2006, 2007, 2008, 2010 by */ 8ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* David Turner, Robert Wilhelm, and Werner Lemberg. */ 9ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* */ 10ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* This file is part of the FreeType project, and may only be used, */ 11ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* modified, and distributed under the terms of the FreeType project */ 12ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ 13ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* this file you indicate that you have read the license and */ 14ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* understand and accept it fully. */ 15ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* */ 16ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/***************************************************************************/ 17ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 18ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 19ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#ifndef __FTINCREM_H__ 20ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define __FTINCREM_H__ 21ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 22ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#include "../ft2build.h" 23ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#include "freetype.h" 24ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 25ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#ifdef FREETYPE_H 26ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#error "freetype.h of FreeType 1 has been loaded!" 27ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#error "Please fix the directory search order for header files" 28ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#error "so that freetype.h of FreeType 2 is found first." 29ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#endif 30ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 31ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 32ee451cb395940862dad63c85adfe8f2fd55e864cSvet GanovFT_BEGIN_HEADER 33ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 34ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************** 35ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 36ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @section: 37ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * incremental 38ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 39ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @title: 40ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Incremental Loading 41ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 42ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @abstract: 43ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Custom Glyph Loading. 44ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 45ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 46ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * This section contains various functions used to perform so-called 47ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * `incremental' glyph loading. This is a mode where all glyphs loaded 48ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * from a given @FT_Face are provided by the client application, 49ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 50ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Apart from that, all other tables are loaded normally from the font 51ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * file. This mode is useful when FreeType is used within another 52ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * engine, e.g., a PostScript Imaging Processor. 53ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 54ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * To enable this mode, you must use @FT_Open_Face, passing an 55ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @FT_Parameter with the @FT_PARAM_TAG_INCREMENTAL tag and an 56ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @FT_Incremental_Interface value. See the comments for 57ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @FT_Incremental_InterfaceRec for an example. 58ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 59ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 60ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 61ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 62ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************** 63ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 64ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @type: 65ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Incremental 66ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 67ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 68ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * An opaque type describing a user-provided object used to implement 69ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * `incremental' glyph loading within FreeType. This is used to support 70ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * embedded fonts in certain environments (e.g., PostScript interpreters), 71ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * where the glyph data isn't in the font file, or must be overridden by 72ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * different values. 73ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 74ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @note: 75ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * It is up to client applications to create and implement @FT_Incremental 76ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * objects, as long as they provide implementations for the methods 77ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @FT_Incremental_GetGlyphDataFunc, @FT_Incremental_FreeGlyphDataFunc 78ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * and @FT_Incremental_GetGlyphMetricsFunc. 79ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 80ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * See the description of @FT_Incremental_InterfaceRec to understand how 81ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * to use incremental objects with FreeType. 82ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 83ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 84ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef struct FT_IncrementalRec_* FT_Incremental; 85ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 86ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 87ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************** 88ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 89ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @struct: 90ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Incremental_MetricsRec 91ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 92ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 93ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A small structure used to contain the basic glyph metrics returned 94ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * by the @FT_Incremental_GetGlyphMetricsFunc method. 95ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 96ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @fields: 97ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * bearing_x :: 98ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Left bearing, in font units. 99ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 100ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * bearing_y :: 101ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Top bearing, in font units. 102ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 103ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * advance :: 104ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Horizontal component of glyph advance, in font units. 105ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 106ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * advance_v :: 107ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Vertical component of glyph advance, in font units. 108ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 109ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @note: 110ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * These correspond to horizontal or vertical metrics depending on the 111ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * value of the `vertical' argument to the function 112ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @FT_Incremental_GetGlyphMetricsFunc. 113ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 114ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 115ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef struct FT_Incremental_MetricsRec_ 116ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov { 117ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Long bearing_x; 118ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Long bearing_y; 119ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Long advance; 120ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Long advance_v; /* since 2.3.12 */ 121ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 122ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov } FT_Incremental_MetricsRec; 123ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 124ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 125ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************** 126ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 127ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @struct: 128ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Incremental_Metrics 129ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 130ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 131ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A handle to an @FT_Incremental_MetricsRec structure. 132ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 133ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 134ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef struct FT_Incremental_MetricsRec_* FT_Incremental_Metrics; 135ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 136ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 137ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************** 138ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 139ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @type: 140ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Incremental_GetGlyphDataFunc 141ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 142ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 143ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A function called by FreeType to access a given glyph's data bytes 144ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * during @FT_Load_Glyph or @FT_Load_Char if incremental loading is 145ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * enabled. 146ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 147ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Note that the format of the glyph's data bytes depends on the font 148ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * file format. For TrueType, it must correspond to the raw bytes within 149ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * the `glyf' table. For PostScript formats, it must correspond to the 150ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * *unencrypted* charstring bytes, without any `lenIV' header. It is 151ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * undefined for any other format. 152ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 153ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @input: 154ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * incremental :: 155ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Handle to an opaque @FT_Incremental handle provided by the client 156ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * application. 157ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 158ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * glyph_index :: 159ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Index of relevant glyph. 160ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 161ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @output: 162ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * adata :: 163ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A structure describing the returned glyph data bytes (which will be 164ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * accessed as a read-only byte block). 165ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 166ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @return: 167ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FreeType error code. 0~means success. 168ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 169ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @note: 170ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * If this function returns successfully the method 171ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @FT_Incremental_FreeGlyphDataFunc will be called later to release 172ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * the data bytes. 173ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 174ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Nested calls to @FT_Incremental_GetGlyphDataFunc can happen for 175ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * compound glyphs. 176ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 177ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 178ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef FT_Error 179ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov (*FT_Incremental_GetGlyphDataFunc)( FT_Incremental incremental, 180ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_UInt glyph_index, 181ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Data* adata ); 182ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 183ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 184ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************** 185ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 186ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @type: 187ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Incremental_FreeGlyphDataFunc 188ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 189ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 190ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A function used to release the glyph data bytes returned by a 191ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * successful call to @FT_Incremental_GetGlyphDataFunc. 192ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 193ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @input: 194ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * incremental :: 195ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A handle to an opaque @FT_Incremental handle provided by the client 196ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * application. 197ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 198ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * data :: 199ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A structure describing the glyph data bytes (which will be accessed 200ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * as a read-only byte block). 201ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 202ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 203ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef void 204ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov (*FT_Incremental_FreeGlyphDataFunc)( FT_Incremental incremental, 205ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Data* data ); 206ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 207ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 208ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************** 209ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 210ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @type: 211ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Incremental_GetGlyphMetricsFunc 212ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 213ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 214ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A function used to retrieve the basic metrics of a given glyph index 215ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * before accessing its data. This is necessary because, in certain 216ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * formats like TrueType, the metrics are stored in a different place from 217ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * the glyph images proper. 218ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 219ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @input: 220ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * incremental :: 221ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A handle to an opaque @FT_Incremental handle provided by the client 222ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * application. 223ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 224ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * glyph_index :: 225ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * Index of relevant glyph. 226ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 227ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * vertical :: 228ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * If true, return vertical metrics. 229ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 230ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * ametrics :: 231ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * This parameter is used for both input and output. 232ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * The original glyph metrics, if any, in font units. If metrics are 233ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * not available all the values must be set to zero. 234ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 235ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @output: 236ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * ametrics :: 237ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * The replacement glyph metrics in font units. 238ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 239ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 240ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef FT_Error 241ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov (*FT_Incremental_GetGlyphMetricsFunc) 242ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov ( FT_Incremental incremental, 243ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_UInt glyph_index, 244ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Bool vertical, 245ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Incremental_MetricsRec *ametrics ); 246ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 247ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 248ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /************************************************************************** 249ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 250ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @struct: 251ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Incremental_FuncsRec 252ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 253ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 254ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A table of functions for accessing fonts that load data 255ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * incrementally. Used in @FT_Incremental_InterfaceRec. 256ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 257ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @fields: 258ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * get_glyph_data :: 259ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * The function to get glyph data. Must not be null. 260ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 261ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * free_glyph_data :: 262ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * The function to release glyph data. Must not be null. 263ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 264ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * get_glyph_metrics :: 265ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * The function to get glyph metrics. May be null if the font does 266ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * not provide overriding glyph metrics. 267ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 268ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 269ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef struct FT_Incremental_FuncsRec_ 270ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov { 271ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Incremental_GetGlyphDataFunc get_glyph_data; 272ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Incremental_FreeGlyphDataFunc free_glyph_data; 273ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Incremental_GetGlyphMetricsFunc get_glyph_metrics; 274ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 275ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov } FT_Incremental_FuncsRec; 276ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 277ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 278ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************** 279ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 280ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @struct: 281ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Incremental_InterfaceRec 282ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 283ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 284ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A structure to be used with @FT_Open_Face to indicate that the user 285ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * wants to support incremental glyph loading. You should use it with 286ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @FT_PARAM_TAG_INCREMENTAL as in the following example: 287ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 288ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * { 289ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Incremental_InterfaceRec inc_int; 290ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Parameter parameter; 291ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Open_Args open_args; 292ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 293ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 294ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * // set up incremental descriptor 295ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * inc_int.funcs = my_funcs; 296ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * inc_int.object = my_object; 297ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 298ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * // set up optional parameter 299ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * parameter.tag = FT_PARAM_TAG_INCREMENTAL; 300ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * parameter.data = &inc_int; 301ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 302ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * // set up FT_Open_Args structure 303ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * open_args.flags = FT_OPEN_PATHNAME | FT_OPEN_PARAMS; 304ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * open_args.pathname = my_font_pathname; 305ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * open_args.num_params = 1; 306ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * open_args.params = ¶meter; // we use one optional argument 307ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 308ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * // open the font 309ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * error = FT_Open_Face( library, &open_args, index, &face ); 310ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * ... 311ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * } 312ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 313ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 314ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef struct FT_Incremental_InterfaceRec_ 315ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov { 316ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov const FT_Incremental_FuncsRec* funcs; 317ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov FT_Incremental object; 318ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 319ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov } FT_Incremental_InterfaceRec; 320ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 321ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 322ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************** 323ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 324ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @type: 325ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_Incremental_Interface 326ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 327ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 328ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A pointer to an @FT_Incremental_InterfaceRec structure. 329ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 330ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 331ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov typedef FT_Incremental_InterfaceRec* FT_Incremental_Interface; 332ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 333ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 334ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /*************************************************************************** 335ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 336ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @constant: 337ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * FT_PARAM_TAG_INCREMENTAL 338ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 339ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * @description: 340ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * A constant used as the tag of @FT_Parameter structures to indicate 341ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * an incremental loading object to be used by FreeType. 342ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov * 343ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov */ 344ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#define FT_PARAM_TAG_INCREMENTAL FT_MAKE_TAG( 'i', 'n', 'c', 'r' ) 345ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 346ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov /* */ 347ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 348ee451cb395940862dad63c85adfe8f2fd55e864cSvet GanovFT_END_HEADER 349ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 350ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov#endif /* __FTINCREM_H__ */ 351ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 352ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov 353ee451cb395940862dad63c85adfe8f2fd55e864cSvet Ganov/* END */ 354