nuclear@0: /***************************************************************************/ nuclear@0: /* */ nuclear@0: /* ftpfr.h */ nuclear@0: /* */ nuclear@0: /* FreeType API for accessing PFR-specific data (specification only). */ nuclear@0: /* */ nuclear@0: /* Copyright 2002, 2003, 2004, 2006, 2008, 2009 by */ nuclear@0: /* David Turner, Robert Wilhelm, and Werner Lemberg. */ nuclear@0: /* */ nuclear@0: /* This file is part of the FreeType project, and may only be used, */ nuclear@0: /* modified, and distributed under the terms of the FreeType project */ nuclear@0: /* license, LICENSE.TXT. By continuing to use, modify, or distribute */ nuclear@0: /* this file you indicate that you have read the license and */ nuclear@0: /* understand and accept it fully. */ nuclear@0: /* */ nuclear@0: /***************************************************************************/ nuclear@0: nuclear@0: nuclear@0: #ifndef __FTPFR_H__ nuclear@0: #define __FTPFR_H__ nuclear@0: nuclear@0: #include nuclear@0: #include FT_FREETYPE_H nuclear@0: nuclear@0: #ifdef FREETYPE_H nuclear@0: #error "freetype.h of FreeType 1 has been loaded!" nuclear@0: #error "Please fix the directory search order for header files" nuclear@0: #error "so that freetype.h of FreeType 2 is found first." nuclear@0: #endif nuclear@0: nuclear@0: nuclear@0: FT_BEGIN_HEADER nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /*
*/ nuclear@0: /* pfr_fonts */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* PFR Fonts */ nuclear@0: /* */ nuclear@0: /* <Abstract> */ nuclear@0: /* PFR/TrueDoc specific API. */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* This section contains the declaration of PFR-specific functions. */ nuclear@0: /* */ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: /********************************************************************** nuclear@0: * nuclear@0: * @function: nuclear@0: * FT_Get_PFR_Metrics nuclear@0: * nuclear@0: * @description: nuclear@0: * Return the outline and metrics resolutions of a given PFR face. nuclear@0: * nuclear@0: * @input: nuclear@0: * face :: Handle to the input face. It can be a non-PFR face. nuclear@0: * nuclear@0: * @output: nuclear@0: * aoutline_resolution :: nuclear@0: * Outline resolution. This is equivalent to `face->units_per_EM' nuclear@0: * for non-PFR fonts. Optional (parameter can be NULL). nuclear@0: * nuclear@0: * ametrics_resolution :: nuclear@0: * Metrics resolution. This is equivalent to `outline_resolution' nuclear@0: * for non-PFR fonts. Optional (parameter can be NULL). nuclear@0: * nuclear@0: * ametrics_x_scale :: nuclear@0: * A 16.16 fixed-point number used to scale distance expressed nuclear@0: * in metrics units to device sub-pixels. This is equivalent to nuclear@0: * `face->size->x_scale', but for metrics only. Optional (parameter nuclear@0: * can be NULL). nuclear@0: * nuclear@0: * ametrics_y_scale :: nuclear@0: * Same as `ametrics_x_scale' but for the vertical direction. nuclear@0: * optional (parameter can be NULL). nuclear@0: * nuclear@0: * @return: nuclear@0: * FreeType error code. 0~means success. nuclear@0: * nuclear@0: * @note: nuclear@0: * If the input face is not a PFR, this function will return an error. nuclear@0: * However, in all cases, it will return valid values. nuclear@0: */ nuclear@0: FT_EXPORT( FT_Error ) nuclear@0: FT_Get_PFR_Metrics( FT_Face face, nuclear@0: FT_UInt *aoutline_resolution, nuclear@0: FT_UInt *ametrics_resolution, nuclear@0: FT_Fixed *ametrics_x_scale, nuclear@0: FT_Fixed *ametrics_y_scale ); nuclear@0: nuclear@0: nuclear@0: /********************************************************************** nuclear@0: * nuclear@0: * @function: nuclear@0: * FT_Get_PFR_Kerning nuclear@0: * nuclear@0: * @description: nuclear@0: * Return the kerning pair corresponding to two glyphs in a PFR face. nuclear@0: * The distance is expressed in metrics units, unlike the result of nuclear@0: * @FT_Get_Kerning. nuclear@0: * nuclear@0: * @input: nuclear@0: * face :: A handle to the input face. nuclear@0: * nuclear@0: * left :: Index of the left glyph. nuclear@0: * nuclear@0: * right :: Index of the right glyph. nuclear@0: * nuclear@0: * @output: nuclear@0: * avector :: A kerning vector. nuclear@0: * nuclear@0: * @return: nuclear@0: * FreeType error code. 0~means success. nuclear@0: * nuclear@0: * @note: nuclear@0: * This function always return distances in original PFR metrics nuclear@0: * units. This is unlike @FT_Get_Kerning with the @FT_KERNING_UNSCALED nuclear@0: * mode, which always returns distances converted to outline units. nuclear@0: * nuclear@0: * You can use the value of the `x_scale' and `y_scale' parameters nuclear@0: * returned by @FT_Get_PFR_Metrics to scale these to device sub-pixels. nuclear@0: */ nuclear@0: FT_EXPORT( FT_Error ) nuclear@0: FT_Get_PFR_Kerning( FT_Face face, nuclear@0: FT_UInt left, nuclear@0: FT_UInt right, nuclear@0: FT_Vector *avector ); nuclear@0: nuclear@0: nuclear@0: /********************************************************************** nuclear@0: * nuclear@0: * @function: nuclear@0: * FT_Get_PFR_Advance nuclear@0: * nuclear@0: * @description: nuclear@0: * Return a given glyph advance, expressed in original metrics units, nuclear@0: * from a PFR font. nuclear@0: * nuclear@0: * @input: nuclear@0: * face :: A handle to the input face. nuclear@0: * nuclear@0: * gindex :: The glyph index. nuclear@0: * nuclear@0: * @output: nuclear@0: * aadvance :: The glyph advance in metrics units. nuclear@0: * nuclear@0: * @return: nuclear@0: * FreeType error code. 0~means success. nuclear@0: * nuclear@0: * @note: nuclear@0: * You can use the `x_scale' or `y_scale' results of @FT_Get_PFR_Metrics nuclear@0: * to convert the advance to device sub-pixels (i.e., 1/64th of pixels). nuclear@0: */ nuclear@0: FT_EXPORT( FT_Error ) nuclear@0: FT_Get_PFR_Advance( FT_Face face, nuclear@0: FT_UInt gindex, nuclear@0: FT_Pos *aadvance ); nuclear@0: nuclear@0: /* */ nuclear@0: nuclear@0: nuclear@0: FT_END_HEADER nuclear@0: nuclear@0: #endif /* __FTPFR_H__ */ nuclear@0: nuclear@0: nuclear@0: /* END */