Content-type: text/html Manpage of FT_Get_Kerning

FT_Get_Kerning

Section: Misc. Reference Manual Pages (3)
Index Return to Main Contents
 

NAME

FT_Get_Kerning  

DESCRIPTION

Returns the kerning vector between two glyphs of a same face.

Input:

face :: A handle to a source face object.

left_glyph :: The index of the left glyph in the kern pair.

right_glyph :: The index of the right glyph in the kern pair.

kern_mode :: See FT_Kerning_Mode() for more information. Determines the scale/dimension of the returned kerning vector.

Output:

akerning :: The kerning vector. This is in font units for scalable formats, and in pixels for fixed-sizes formats. Returns the kerning vector between two glyphs of a same face.

Input:

face :: A handle to a source face object.

left_glyph :: The index of the left glyph in the kern pair.

right_glyph :: The index of the right glyph in the kern pair.

kern_mode :: See FT_Kerning_Mode() for more information. Determines the scale/dimension of the returned kerning vector.

Output:

akerning :: The kerning vector. This is in font units for scalable formats, and in pixels for fixed-sizes formats.

Notes: Only horizontal layouts (left-to-right & right-to-left) are supported by this method. Other layouts, or more sophisticated kernings, are out of the scope of this API function -- they can be implemented through format-specific interfaces. FT_EXPORT( FT_Error ) FT_Get_Kerning( FT_Face face, FT_UInt left_glyph, FT_UInt right_glyph, FT_UInt kern_mode, FT_Vector *akerning );  

RETURNS

FreeType error code. 0 means success.  

VERSION

This documentation was generated for Freetype 2.0.4 by autodocbook (http://www.stillhq.com). Autodocbook is (c) Michael Still 2001.
      

AUTHOR

Copyright 1996-2000 by David Turner, Robert Wilhelm, and Werner Lemberg.
    

This file is part of the FreeType project, and may only be used, modified, and distributed under the terms of the FreeType project license, LICENSE.TXT. By continuing to use, modify, or distribute this file you indicate that you have read the license and understand and accept it fully.  

BUGS

Please report errors in this documentation, and Freetype itself to freetype@freetype.org


 

Index

NAME
DESCRIPTION
RETURNS
VERSION
AUTHOR
BUGS

This document was created by man2html, using the manual pages.
Time: 04:44:37 GMT, July 26, 2001