More formatting.
Synchronizing docu in include/freetype with src/base.
This commit is contained in:
parent
b48a6094b2
commit
97b2de5898
|
@ -1977,7 +1977,7 @@
|
||||||
/* An enumeration used to specify which kerning values to return in */
|
/* An enumeration used to specify which kerning values to return in */
|
||||||
/* FT_Get_Kerning(). */
|
/* FT_Get_Kerning(). */
|
||||||
/* */
|
/* */
|
||||||
/* <Field> */
|
/* <Fields> */
|
||||||
/* ft_kerning_default :: Return scaled and grid-fitted kerning */
|
/* ft_kerning_default :: Return scaled and grid-fitted kerning */
|
||||||
/* distances (value is 0). */
|
/* distances (value is 0). */
|
||||||
/* */
|
/* */
|
||||||
|
|
|
@ -7,22 +7,28 @@
|
||||||
/* Copyright 1996-2000 by */
|
/* Copyright 1996-2000 by */
|
||||||
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
|
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
|
||||||
/* */
|
/* */
|
||||||
/* This file is part of the FreeType project, and may only be used */
|
/* This file is part of the FreeType project, and may only be used, */
|
||||||
/* modified and distributed under the terms of the FreeType project */
|
/* modified, and distributed under the terms of the FreeType project */
|
||||||
/* license, LICENSE.TXT. By continuing to use, modify, or distribute */
|
/* license, LICENSE.TXT. By continuing to use, modify, or distribute */
|
||||||
/* this file you indicate that you have read the license and */
|
/* this file you indicate that you have read the license and */
|
||||||
/* understand and accept it fully. */
|
/* understand and accept it fully. */
|
||||||
/* */
|
/* */
|
||||||
/* This file contains the definition of several convenience functions */
|
|
||||||
/* that can be used by client applications to easily retrieve glyph */
|
|
||||||
/* bitmaps and outlines from a given face. */
|
|
||||||
/* */
|
|
||||||
/* These functions should be optional if you're writing a font server */
|
|
||||||
/* or text layout engine on top of FreeType. However, they are pretty */
|
|
||||||
/* handy for many other simple uses of the library.. */
|
|
||||||
/* */
|
|
||||||
/***************************************************************************/
|
/***************************************************************************/
|
||||||
|
|
||||||
|
|
||||||
|
/*************************************************************************/
|
||||||
|
/* */
|
||||||
|
/* This file contains the definition of several convenience functions */
|
||||||
|
/* that can be used by client applications to easily retrieve glyph */
|
||||||
|
/* bitmaps and outlines from a given face. */
|
||||||
|
/* */
|
||||||
|
/* These functions should be optional if you are writing a font server */
|
||||||
|
/* or text layout engine on top of FreeType. However, they are pretty */
|
||||||
|
/* handy for many other simple uses of the library. */
|
||||||
|
/* */
|
||||||
|
/*************************************************************************/
|
||||||
|
|
||||||
|
|
||||||
#ifndef FTGLYPH_H
|
#ifndef FTGLYPH_H
|
||||||
#define FTGLYPH_H
|
#define FTGLYPH_H
|
||||||
|
|
||||||
|
@ -35,24 +41,26 @@
|
||||||
/* forward declaration to a private type */
|
/* forward declaration to a private type */
|
||||||
typedef struct FT_Glyph_Class_ FT_Glyph_Class;
|
typedef struct FT_Glyph_Class_ FT_Glyph_Class;
|
||||||
|
|
||||||
/***********************************************************************
|
|
||||||
*
|
|
||||||
* <Struct>
|
|
||||||
* FT_GlyphRec
|
|
||||||
*
|
|
||||||
* <Description>
|
|
||||||
* The root glyph structure contains a given glyph image plus its
|
|
||||||
* advance width in 16.16 fixed float format..
|
|
||||||
*
|
|
||||||
* <Field>
|
|
||||||
* library :: a handle to the FreeType library object.
|
|
||||||
* clazz :: a pointer to the glyph's class. Private.
|
|
||||||
* format :: the format of the glyph's image
|
|
||||||
* advance :: a 16.16 vector that gives the glyph's advance width
|
|
||||||
*
|
|
||||||
***********************************************************************/
|
|
||||||
|
|
||||||
typedef struct FT_GlyphRec_
|
/*************************************************************************/
|
||||||
|
/* */
|
||||||
|
/* <Struct> */
|
||||||
|
/* FT_GlyphRec */
|
||||||
|
/* */
|
||||||
|
/* <Description> */
|
||||||
|
/* The root glyph structure contains a given glyph image plus its */
|
||||||
|
/* advance width in 16.16 fixed float format. */
|
||||||
|
/* */
|
||||||
|
/* <Fields> */
|
||||||
|
/* library :: A handle to the FreeType library object. */
|
||||||
|
/* */
|
||||||
|
/* clazz :: A pointer to the glyph's class. Private. */
|
||||||
|
/* */
|
||||||
|
/* format :: The format of the glyph's image. */
|
||||||
|
/* */
|
||||||
|
/* advance :: A 16.16 vector that gives the glyph's advance width. */
|
||||||
|
/* */
|
||||||
|
typedef struct FT_GlyphRec_
|
||||||
{
|
{
|
||||||
FT_Library library;
|
FT_Library library;
|
||||||
const FT_Glyph_Class* clazz;
|
const FT_Glyph_Class* clazz;
|
||||||
|
@ -62,36 +70,37 @@
|
||||||
} FT_GlyphRec, *FT_Glyph;
|
} FT_GlyphRec, *FT_Glyph;
|
||||||
|
|
||||||
|
|
||||||
/***********************************************************************
|
/*************************************************************************/
|
||||||
*
|
/* */
|
||||||
* <Struct>
|
/* <Struct> */
|
||||||
* FT_BitmapGlyphRec
|
/* FT_BitmapGlyphRec */
|
||||||
*
|
/* */
|
||||||
* <Description>
|
/* <Description> */
|
||||||
* A structure used for bitmap glyph images.. This really is
|
/* A structure used for bitmap glyph images. This really is a */
|
||||||
* a "sub-class" of "FT_GlyphRec".
|
/* `sub-class' of `FT_GlyphRec'. */
|
||||||
*
|
/* */
|
||||||
* <Field>
|
/* <Fields> */
|
||||||
* root :: the root FT_Glyph fields
|
/* root :: The root FT_Glyph fields. */
|
||||||
* left :: left-side bearing, i.e. the horizontal distance from
|
/* */
|
||||||
* the current pen position to the left border of the glyph
|
/* left :: The left-side bearing, i.e., the horizontal distance */
|
||||||
* bitmap.
|
/* from the current pen position to the left border of the */
|
||||||
* top :: top-side bearing, i.e. the vertical distance from the
|
/* glyph bitmap. */
|
||||||
* current pen position to the top border of the glyph bitmap
|
/* */
|
||||||
* this distance is positive for upwards-y !!
|
/* top :: The top-side bearing, i.e., the vertical distance from */
|
||||||
* bitmap :: a descriptor for the bitmap.
|
/* the current pen position to the top border of the glyph */
|
||||||
*
|
/* bitmap. This distance is positive for upwards-y! */
|
||||||
* <Note>
|
/* */
|
||||||
* You can typecast a FT_Glyph to FT_BitmapGlyph when you have
|
/* bitmap :: A descriptor for the bitmap. */
|
||||||
* glyph->format == ft_glyph_format_bitmap. This lets you access
|
/* */
|
||||||
* the bitmap's content easily..
|
/* <Note> */
|
||||||
*
|
/* You can typecast FT_Glyph to FT_BitmapGlyph if you have */
|
||||||
* the corresponding pixel buffer is always owned by the BitmapGlyph
|
/* glyph->format == ft_glyph_format_bitmap. This lets you access */
|
||||||
* and is thus created and destroyed with it..
|
/* the bitmap's contents easily. */
|
||||||
*
|
/* */
|
||||||
***********************************************************************/
|
/* The corresponding pixel buffer is always owned by the BitmapGlyph */
|
||||||
|
/* and is thus created and destroyed with it. */
|
||||||
typedef struct FT_BitmapGlyphRec_
|
/* */
|
||||||
|
typedef struct FT_BitmapGlyphRec_
|
||||||
{
|
{
|
||||||
FT_GlyphRec root;
|
FT_GlyphRec root;
|
||||||
FT_Int left;
|
FT_Int left;
|
||||||
|
@ -101,34 +110,33 @@
|
||||||
} FT_BitmapGlyphRec, *FT_BitmapGlyph;
|
} FT_BitmapGlyphRec, *FT_BitmapGlyph;
|
||||||
|
|
||||||
|
|
||||||
/***********************************************************************
|
/*************************************************************************/
|
||||||
*
|
/* */
|
||||||
* <Struct>
|
/* <Struct> */
|
||||||
* FT_OutlineGlyphRec
|
/* FT_OutlineGlyphRec */
|
||||||
*
|
/* */
|
||||||
* <Description>
|
/* <Description> */
|
||||||
* A structure used for outline (vectorial) glyph images..
|
/* A structure used for outline (vectorial) glyph images. This */
|
||||||
* This really is a "sub-class" of FT_GlyphRec.
|
/* really is a `sub-class' of `FT_GlyphRec'. */
|
||||||
*
|
/* */
|
||||||
* <Field>
|
/* <Fields> */
|
||||||
* root :: the root FT_Glyph fields.
|
/* root :: The root FT_Glyph fields. */
|
||||||
* outline :: a descriptor for the outline
|
/* */
|
||||||
*
|
/* outline :: A descriptor for the outline. */
|
||||||
* <Note>
|
/* */
|
||||||
* You can typecast a FT_Glyph to FT_OutlineGlyph when you have
|
/* <Note> */
|
||||||
* glyph->format == ft_glyph_format_outline. This lets you access
|
/* You can typecast FT_Glyph to FT_OutlineGlyph if you have */
|
||||||
* the outline's content easily..
|
/* glyph->format == ft_glyph_format_outline. This lets you access */
|
||||||
*
|
/* the outline's content easily. */
|
||||||
* As the outline is extracted from a glyph slot, its coordinates
|
/* */
|
||||||
* are expressed normally in 26.6 pixels, unless the flag
|
/* As the outline is extracted from a glyph slot, its coordinates are */
|
||||||
* FT_LOAD_NO_SCALE was used in FT_Load_Glyph / FT_Load_Char..
|
/* expressed normally in 26.6 pixels, unless the flag */
|
||||||
*
|
/* FT_LOAD_NO_SCALE was used in FT_Load_Glyph() or FT_Load_Char(). */
|
||||||
* the outline's tables are always owned by the object and are
|
/* */
|
||||||
* destroyed with it..
|
/* The outline's tables are always owned by the object and are */
|
||||||
*
|
/* destroyed with it. */
|
||||||
***********************************************************************/
|
/* */
|
||||||
|
typedef struct FT_OutlineGlyphRec_
|
||||||
typedef struct FT_OutlineGlyphRec_
|
|
||||||
{
|
{
|
||||||
FT_GlyphRec root;
|
FT_GlyphRec root;
|
||||||
FT_Outline outline;
|
FT_Outline outline;
|
||||||
|
@ -136,128 +144,78 @@
|
||||||
} FT_OutlineGlyphRec, *FT_OutlineGlyph;
|
} FT_OutlineGlyphRec, *FT_OutlineGlyph;
|
||||||
|
|
||||||
|
|
||||||
|
/*************************************************************************/
|
||||||
/***********************************************************************
|
/* */
|
||||||
*
|
/* <Function> */
|
||||||
* <Function>
|
/* FT_Get_Glyph */
|
||||||
* FT_Get_Glyph
|
/* */
|
||||||
*
|
/* <Description> */
|
||||||
* <Description>
|
/* A function used to extract a glyph image from a slot. */
|
||||||
* A function used to extract one glyph image from a slot..
|
/* */
|
||||||
*
|
/* <Input> */
|
||||||
* <Input>
|
/* slot :: A handle to the source glyph slot. */
|
||||||
* slot :: handle to source glyph slot.
|
/* */
|
||||||
*
|
/* <Output> */
|
||||||
* <Output>
|
/* aglyph :: A handle to the glyph object. */
|
||||||
* aglyph :: handle to the glyph object.
|
/* */
|
||||||
*
|
/* <Return> */
|
||||||
* <Return>
|
/* FreeType error code. 0 means success. */
|
||||||
* Error code. 0 means success.
|
/* */
|
||||||
*
|
FT_EXPORT_DEF( FT_Error ) FT_Get_Glyph( FT_GlyphSlot slot,
|
||||||
* <Note>
|
FT_Glyph* aglyph );
|
||||||
*
|
|
||||||
*
|
|
||||||
***********************************************************************/
|
|
||||||
|
|
||||||
FT_EXPORT_DEF(FT_Error) FT_Get_Glyph( FT_GlyphSlot slot,
|
|
||||||
FT_Glyph *aglyph );
|
|
||||||
|
|
||||||
/***********************************************************************
|
|
||||||
*
|
|
||||||
* <Function>
|
|
||||||
* FT_Glyph_Copy
|
|
||||||
*
|
|
||||||
* <Description>
|
|
||||||
* A function used to copy one glyph image.
|
|
||||||
*
|
|
||||||
* <Input>
|
|
||||||
* source :: handle to source glyph object
|
|
||||||
*
|
|
||||||
* <Output>
|
|
||||||
* target :: handle to target glyph object. 0 in case of error
|
|
||||||
*
|
|
||||||
* <Return>
|
|
||||||
* Error code. 0 means success.
|
|
||||||
*
|
|
||||||
***********************************************************************/
|
|
||||||
|
|
||||||
FT_EXPORT_DEF(FT_Error) FT_Glyph_Copy( FT_Glyph source,
|
|
||||||
FT_Glyph *target );
|
|
||||||
|
|
||||||
|
|
||||||
/***********************************************************************
|
/*************************************************************************/
|
||||||
*
|
/* */
|
||||||
* <Function>
|
/* <Function> */
|
||||||
* FT_Glyph_Transform
|
/* FT_Glyph_Copy */
|
||||||
*
|
/* */
|
||||||
* <Description>
|
/* <Description> */
|
||||||
* Transforms a glyph image, when it's format is scalable
|
/* A function used to copy a glyph image. */
|
||||||
*
|
/* */
|
||||||
* <Input>
|
/* <Input> */
|
||||||
* glyph :: handle to target glyph object
|
/* source :: A handle to the source glyph object. */
|
||||||
*
|
/* */
|
||||||
* matrix :: pointer to 2x2 matrix to apply
|
/* <Output> */
|
||||||
*
|
/* target :: A handle to the target glyph object. 0 in case of */
|
||||||
* delta :: pointer to a 2d vector to apply. coordinates are
|
/* error. */
|
||||||
* expressed in 1/64th of a pixel..
|
/* */
|
||||||
*
|
/* <Return> */
|
||||||
* <Return>
|
/* FreeType error code. 0 means success. */
|
||||||
* error code (is not 0, the glyph format is not scalable).
|
/* */
|
||||||
*
|
FT_EXPORT_DEF( FT_Error ) FT_Glyph_Copy( FT_Glyph source,
|
||||||
* <Note>
|
FT_Glyph* target );
|
||||||
* the 2x2 transform matrix is also applied to the glyph's
|
|
||||||
* advance vector
|
|
||||||
*
|
/*************************************************************************/
|
||||||
***********************************************************************/
|
/* */
|
||||||
|
/* <Function> */
|
||||||
|
/* FT_Glyph_Transform */
|
||||||
|
/* */
|
||||||
|
/* <Description> */
|
||||||
|
/* Transforms a glyph image if its format is scalable. */
|
||||||
|
/* */
|
||||||
|
/* <Input> */
|
||||||
|
/* glyph :: A handle to the target glyph object. */
|
||||||
|
/* */
|
||||||
|
/* matrix :: A pointer to a 2x2 matrix to apply. */
|
||||||
|
/* */
|
||||||
|
/* delta :: A pointer to a 2d vector to apply. Coordinates are */
|
||||||
|
/* expressed in 1/64th of a pixel. */
|
||||||
|
/* */
|
||||||
|
/* <Return> */
|
||||||
|
/* FreeType error code (the glyph format is not scalable if it is */
|
||||||
|
/* not zero). */
|
||||||
|
/* */
|
||||||
|
/* <Note> */
|
||||||
|
/* The 2x2 transformation matrix is also applied to the glyph's */
|
||||||
|
/* advance vector. */
|
||||||
|
/* */
|
||||||
|
FT_EXPORT_DEF( FT_Error ) FT_Glyph_Transform( FT_Glyph glyph,
|
||||||
|
FT_Matrix* matrix,
|
||||||
|
FT_Vector* delta );
|
||||||
|
|
||||||
FT_EXPORT_DEF(FT_Error) FT_Glyph_Transform( FT_Glyph glyph,
|
|
||||||
FT_Matrix* matrix,
|
|
||||||
FT_Vector* delta );
|
|
||||||
|
|
||||||
/***********************************************************************
|
|
||||||
*
|
|
||||||
* <Function>
|
|
||||||
* FT_Glyph_Get_CBox
|
|
||||||
*
|
|
||||||
* <Description>
|
|
||||||
* Returns the glyph image's bounding box.
|
|
||||||
*
|
|
||||||
* <Input>
|
|
||||||
* glyph :: handle to source glyph object
|
|
||||||
* mode :: a set of bit flags that indicate how to interpret
|
|
||||||
* the meaning of the box's coordinates
|
|
||||||
*
|
|
||||||
* <Output>
|
|
||||||
* box :: the glyph bounding box. Coordinates are expressed in
|
|
||||||
* 1/64th of pixels, it is grid-fitted..
|
|
||||||
*
|
|
||||||
* <Note>
|
|
||||||
* Coordinates are relative to the glyph origin, using the Y-upwards
|
|
||||||
* convention..
|
|
||||||
*
|
|
||||||
* if 'ft_glyph_bbox_subpixels' is set in "mode", the bbox coordinates
|
|
||||||
* are returned in 26.6 pixels (i.e. 1/64th of pixels).
|
|
||||||
*
|
|
||||||
* otherwise, coordinates are in integer pixels.
|
|
||||||
*
|
|
||||||
* note that the maximum coordinates are exclusive, which means that
|
|
||||||
* once can compute the width and height of the glyph image (be it
|
|
||||||
* in integer or 26.6 pixels) as:
|
|
||||||
*
|
|
||||||
* width = bbox.xMax - bbox.xMin;
|
|
||||||
* height = bbox.yMax - bbox.yMin;
|
|
||||||
*
|
|
||||||
* Note also that for 26.6 coordinates, if the 'ft_glyph_bbox_gridfit'
|
|
||||||
* flag is set in "mode", the coordinates will also be grid-fitted,
|
|
||||||
* which corresponds to:
|
|
||||||
*
|
|
||||||
* bbox.xMin = FLOOR(bbox.xMin);
|
|
||||||
* bbox.yMin = FLOOR(bbox.yMin);
|
|
||||||
* bbox.xMax = CEILING(bbox.xMax);
|
|
||||||
* bbox.yMax = CEILING(bbox.yMax);
|
|
||||||
*
|
|
||||||
***********************************************************************/
|
|
||||||
|
|
||||||
enum
|
enum
|
||||||
{
|
{
|
||||||
ft_glyph_bbox_pixels = 0,
|
ft_glyph_bbox_pixels = 0,
|
||||||
|
@ -265,98 +223,150 @@
|
||||||
ft_glyph_bbox_gridfit = 2
|
ft_glyph_bbox_gridfit = 2
|
||||||
};
|
};
|
||||||
|
|
||||||
FT_EXPORT_DEF(void) FT_Glyph_Get_CBox( FT_Glyph glyph,
|
|
||||||
FT_UInt bbox_mode,
|
/*************************************************************************/
|
||||||
FT_BBox *cbox );
|
/* */
|
||||||
|
/* <Function> */
|
||||||
|
/* FT_Glyph_Get_CBox */
|
||||||
|
/* */
|
||||||
|
/* <Description> */
|
||||||
|
/* Returns the glyph image's bounding box. */
|
||||||
|
/* */
|
||||||
|
/* <Input> */
|
||||||
|
/* glyph :: A handle to the source glyph object. */
|
||||||
|
/* */
|
||||||
|
/* mode :: A set of bit flags that indicate how to interpret the */
|
||||||
|
/* returned bounding box values. */
|
||||||
|
/* */
|
||||||
|
/* <Output> */
|
||||||
|
/* box :: The glyph bounding box. Coordinates are expressed in */
|
||||||
|
/* 1/64th of pixels if it is grid-fitted. */
|
||||||
|
/* */
|
||||||
|
/* <Note> */
|
||||||
|
/* Coordinates are relative to the glyph origin, using the Y-upwards */
|
||||||
|
/* convention. */
|
||||||
|
/* */
|
||||||
|
/* If `ft_glyph_bbox_subpixels' is set in `mode', the bbox */
|
||||||
|
/* coordinates are returned in 26.6 pixels (i.e. 1/64th of pixels). */
|
||||||
|
/* Otherwise, coordinates are expressed in integer pixels. */
|
||||||
|
/* */
|
||||||
|
/* Note that the maximum coordinates are exclusive, which means that */
|
||||||
|
/* one can compute the width and height of the glyph image (be it in */
|
||||||
|
/* integer or 26.6 pixels) as: */
|
||||||
|
/* */
|
||||||
|
/* width = bbox.xMax - bbox.xMin; */
|
||||||
|
/* height = bbox.yMax - bbox.yMin; */
|
||||||
|
/* */
|
||||||
|
/* Note also that for 26.6 coordinates, if the */
|
||||||
|
/* `ft_glyph_bbox_gridfit' flag is set in `mode;, the coordinates */
|
||||||
|
/* will also be grid-fitted, which corresponds to: */
|
||||||
|
/* */
|
||||||
|
/* bbox.xMin = FLOOR(bbox.xMin); */
|
||||||
|
/* bbox.yMin = FLOOR(bbox.yMin); */
|
||||||
|
/* bbox.xMax = CEILING(bbox.xMax); */
|
||||||
|
/* bbox.yMax = CEILING(bbox.yMax); */
|
||||||
|
/* */
|
||||||
|
/* The default value (0) for `bbox_mode' is `ft_glyph_bbox_pixels'. */
|
||||||
|
/* */
|
||||||
|
FT_EXPORT_DEF( void ) FT_Glyph_Get_CBox( FT_Glyph glyph,
|
||||||
|
FT_UInt bbox_mode,
|
||||||
|
FT_BBox* cbox );
|
||||||
|
|
||||||
|
|
||||||
/***********************************************************************
|
/*************************************************************************/
|
||||||
*
|
/* */
|
||||||
* <Function>
|
/* <Function> */
|
||||||
* FT_Glyph_To_Bitmap
|
/* FT_Glyph_To_Bitmap */
|
||||||
*
|
/* */
|
||||||
* <Description>
|
/* <Description> */
|
||||||
* converts a given glyph object to a bitmap glyph object
|
/* Converts a given glyph object to a bitmap glyph object. */
|
||||||
*
|
/* */
|
||||||
* <InOut>
|
/* <InOut> */
|
||||||
* glyph :: pointer to a handle to the target glyph
|
/* glyph :: A pointer to a handle to the target glyph. */
|
||||||
*
|
/* */
|
||||||
* <Input>
|
/* <Input> */
|
||||||
* render_mode :: a set of bit flags that describe how
|
/* render_mode :: A set of bit flags that describe how the data is */
|
||||||
*
|
/* */
|
||||||
* origin :: pointer to a vector used to translate the glyph image
|
/* */
|
||||||
* before rendering. Can be 0 (for no translation). The
|
/* origin :: A pointer to a vector used to translate the glyph */
|
||||||
* origin is expressed in 26.6 pixels..
|
/* image before rendering. Can be 0 (if no */
|
||||||
*
|
/* translation). The origin is expressed in */
|
||||||
* destroy :: a boolean that indicates that the original glyph image
|
/* 26.6 pixels. */
|
||||||
* should be destroyed by this function. The glyph is
|
/* */
|
||||||
* never destroyed in case of error..
|
/* destroy :: A boolean that indicates that the original glyph */
|
||||||
*
|
/* image should be destroyed by this function. It is */
|
||||||
* <Return>
|
/* never destroyed in case of error. */
|
||||||
* Error code. 0 means success
|
/* */
|
||||||
*
|
/* <Return> */
|
||||||
* <Note>
|
/* FreeType error code. 0 means success. */
|
||||||
* the glyph image is translated with the "origin" vector before
|
/* */
|
||||||
* rendering.. In case of error, it it translated back to its original
|
/* <Note> */
|
||||||
* position and the glyph is untouched..
|
/* The glyph image is translated with the `origin' vector before */
|
||||||
*
|
/* rendering. In case of error, it it translated back to its */
|
||||||
* The first parameter is a pointer to a FT_Glyph handle, that
|
/* original position and the glyph is left untouched. */
|
||||||
* will be replaced by this function. Typically, you would use:
|
/* */
|
||||||
*
|
/* The first parameter is a pointer to a FT_Glyph handle, that will */
|
||||||
* {
|
/* be replaced by this function. Typically, you would use (omitting */
|
||||||
* FT_Glyph glyph;
|
/* error handling): */
|
||||||
* FT_BitmapGlyph glyph_bitmap;
|
/* */
|
||||||
*
|
/* */
|
||||||
* // load glyph
|
/* { */
|
||||||
* error = FT_Load_Char( face, glyph_index, FT_LOAD_DEFAUT );
|
/* FT_Glyph glyph; */
|
||||||
*
|
/* FT_BitmapGlyph glyph_bitmap; */
|
||||||
* // extract glyph image
|
/* */
|
||||||
* error = FT_Get_Glyph( face->glyph, &glyph );
|
/* */
|
||||||
*
|
/* // load glyph */
|
||||||
* // convert to a bitmap (default render mode + destroy old)
|
/* error = FT_Load_Char( face, glyph_index, FT_LOAD_DEFAUT ); */
|
||||||
* if (glyph->format != ft_glyph_format_bitmap)
|
/* */
|
||||||
* {
|
/* // extract glyph image */
|
||||||
* error = FT_Glyph_To_Bitmap( &glyph, ft_render_mode_default, 0, 1 );
|
/* error = FT_Get_Glyph( face->glyph, &glyph ); */
|
||||||
* if (error) // glyph unchanged..
|
/* */
|
||||||
* }
|
/* // convert to a bitmap (default render mode + destroy old) */
|
||||||
*
|
/* if ( glyph->format != ft_glyph_format_bitmap ) */
|
||||||
* // access bitmap content by typecasting
|
/* { */
|
||||||
* glyph_bitmap = (FT_BitmapGlyph)glyph;
|
/* error = FT_Glyph_To_Bitmap( &glyph, ft_render_mode_default, */
|
||||||
*
|
/* 0, 1 ); */
|
||||||
* // do funny stuff with it, like blitting/drawing
|
/* if ( error ) // glyph unchanged */
|
||||||
* ....
|
/* ... */
|
||||||
*
|
/* } */
|
||||||
* // discard glyph image (bitmap or not)
|
/* */
|
||||||
* FT_Done_Glyph( glyph );
|
/* // access bitmap content by typecasting */
|
||||||
*
|
/* glyph_bitmap = (FT_BitmapGlyph)glyph; */
|
||||||
*
|
/* */
|
||||||
* This function will always fail if the glyph's format isn't scalable
|
/* // do funny stuff with it, like blitting/drawing */
|
||||||
*
|
/* ... */
|
||||||
***********************************************************************/
|
/* */
|
||||||
|
/* // discard glyph image (bitmap or not) */
|
||||||
FT_EXPORT_DEF(FT_Error) FT_Glyph_To_Bitmap( FT_Glyph *the_glyph,
|
/* FT_Done_Glyph( glyph ); */
|
||||||
FT_ULong render_mode,
|
/* } */
|
||||||
FT_Vector* origin,
|
/* */
|
||||||
FT_Bool destroy );
|
/* */
|
||||||
|
/* This function will always fail if the glyph's format isn't */
|
||||||
|
/* scalable. */
|
||||||
|
/* */
|
||||||
|
FT_EXPORT_DEF( FT_Error ) FT_Glyph_To_Bitmap( FT_Glyph* the_glyph,
|
||||||
|
FT_ULong render_mode,
|
||||||
|
FT_Vector* origin,
|
||||||
|
FT_Bool destroy );
|
||||||
|
|
||||||
/***********************************************************************
|
|
||||||
*
|
|
||||||
* <Function>
|
|
||||||
* FT_Done_Glyph
|
|
||||||
*
|
|
||||||
* <Description>
|
|
||||||
* Destroys a given glyph..
|
|
||||||
*
|
|
||||||
* <Input>
|
|
||||||
* glyph :: handle to target glyph object
|
|
||||||
*
|
|
||||||
***********************************************************************/
|
|
||||||
|
|
||||||
FT_EXPORT_DEF(void) FT_Done_Glyph( FT_Glyph glyph );
|
/*************************************************************************/
|
||||||
|
/* */
|
||||||
|
/* <Function> */
|
||||||
|
/* FT_Done_Glyph */
|
||||||
|
/* */
|
||||||
|
/* <Description> */
|
||||||
|
/* Destroys a given glyph. */
|
||||||
|
/* */
|
||||||
|
/* <Input> */
|
||||||
|
/* glyph :: A handle to the target glyph object. */
|
||||||
|
/* */
|
||||||
|
FT_EXPORT_DEF( void ) FT_Done_Glyph( FT_Glyph glyph );
|
||||||
|
|
||||||
|
|
||||||
/* other helpful functions */
|
/* other helpful functions */
|
||||||
|
|
||||||
|
|
||||||
/*************************************************************************/
|
/*************************************************************************/
|
||||||
/* */
|
/* */
|
||||||
/* <Function> */
|
/* <Function> */
|
||||||
|
@ -374,8 +384,11 @@
|
||||||
/* <MT-Note> */
|
/* <MT-Note> */
|
||||||
/* Yes. */
|
/* Yes. */
|
||||||
/* */
|
/* */
|
||||||
FT_EXPORT_DEF(void) FT_Matrix_Multiply( FT_Matrix* a,
|
/* <Note> */
|
||||||
FT_Matrix* b );
|
/* The result is undefined if either `a' or `b' is zero. */
|
||||||
|
/* */
|
||||||
|
FT_EXPORT_DEF( void ) FT_Matrix_Multiply( FT_Matrix* a,
|
||||||
|
FT_Matrix* b );
|
||||||
|
|
||||||
|
|
||||||
/*************************************************************************/
|
/*************************************************************************/
|
||||||
|
@ -396,7 +409,7 @@
|
||||||
/* <MT-Note> */
|
/* <MT-Note> */
|
||||||
/* Yes. */
|
/* Yes. */
|
||||||
/* */
|
/* */
|
||||||
FT_EXPORT_DEF(FT_Error) FT_Matrix_Invert( FT_Matrix* matrix );
|
FT_EXPORT_DEF( FT_Error ) FT_Matrix_Invert( FT_Matrix* matrix );
|
||||||
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
|
@ -404,3 +417,6 @@
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#endif /* FTGLYPH_H */
|
#endif /* FTGLYPH_H */
|
||||||
|
|
||||||
|
|
||||||
|
/* END */
|
||||||
|
|
|
@ -163,7 +163,7 @@
|
||||||
* this structure holds pointers to the functions used to load and
|
* this structure holds pointers to the functions used to load and
|
||||||
* free the basic tables that are required in a `sfnt' font file.
|
* free the basic tables that are required in a `sfnt' font file.
|
||||||
*
|
*
|
||||||
* <Field>
|
* <Fields>
|
||||||
* unicode_value :: a function used to convert a glyph name into
|
* unicode_value :: a function used to convert a glyph name into
|
||||||
* a Unicode character code
|
* a Unicode character code
|
||||||
*
|
*
|
||||||
|
|
|
@ -633,6 +633,8 @@
|
||||||
/* bbox.xMax = CEILING(bbox.xMax); */
|
/* bbox.xMax = CEILING(bbox.xMax); */
|
||||||
/* bbox.yMax = CEILING(bbox.yMax); */
|
/* bbox.yMax = CEILING(bbox.yMax); */
|
||||||
/* */
|
/* */
|
||||||
|
/* The default value (0) for `bbox_mode' is `ft_glyph_bbox_pixels'. */
|
||||||
|
/* */
|
||||||
FT_EXPORT_FUNC( void ) FT_Glyph_Get_CBox( FT_Glyph glyph,
|
FT_EXPORT_FUNC( void ) FT_Glyph_Get_CBox( FT_Glyph glyph,
|
||||||
FT_UInt bbox_mode,
|
FT_UInt bbox_mode,
|
||||||
FT_BBox* cbox )
|
FT_BBox* cbox )
|
||||||
|
|
Loading…
Reference in New Issue