ftglyph.h File Reference

#include <freetype/freetype.h>

Include dependency graph for ftglyph.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	FT_GlyphRec_
struct	FT_BitmapGlyphRec_
struct	FT_OutlineGlyphRec_

Macros
#define	ft_glyph_bbox_unscaled   FT_GLYPH_BBOX_UNSCALED
#define	ft_glyph_bbox_subpixels   FT_GLYPH_BBOX_SUBPIXELS
#define	ft_glyph_bbox_gridfit   FT_GLYPH_BBOX_GRIDFIT
#define	ft_glyph_bbox_truncate   FT_GLYPH_BBOX_TRUNCATE
#define	ft_glyph_bbox_pixels   FT_GLYPH_BBOX_PIXELS

Typedefs
typedef typedefFT_BEGIN_HEADER struct FT_Glyph_Class_	FT_Glyph_Class
typedef struct FT_GlyphRec_ *	FT_Glyph
typedef struct FT_GlyphRec_	FT_GlyphRec
typedef struct FT_BitmapGlyphRec_ *	FT_BitmapGlyph
typedef struct FT_BitmapGlyphRec_	FT_BitmapGlyphRec
typedef struct FT_OutlineGlyphRec_ *	FT_OutlineGlyph
typedef struct FT_OutlineGlyphRec_	FT_OutlineGlyphRec
typedef enum FT_Glyph_BBox_Mode_	FT_Glyph_BBox_Mode

Enumerations
enum	FT_Glyph_BBox_Mode_ {   FT_GLYPH_BBOX_UNSCALED = 0 , FT_GLYPH_BBOX_SUBPIXELS = 0 , FT_GLYPH_BBOX_GRIDFIT = 1 , FT_GLYPH_BBOX_TRUNCATE = 2 ,   FT_GLYPH_BBOX_PIXELS = 3 }

Functions
	FT_New_Glyph (FT_Library library, FT_Glyph_Format format, FT_Glyph *aglyph)
	FT_Get_Glyph (FT_GlyphSlot slot, FT_Glyph *aglyph)
	FT_Glyph_Copy (FT_Glyph source, FT_Glyph *target)
	FT_Glyph_Transform (FT_Glyph glyph, FT_Matrix *matrix, FT_Vector *delta)
	FT_Glyph_Get_CBox (FT_Glyph glyph, FT_UInt bbox_mode, FT_BBox *acbox)
	FT_Glyph_To_Bitmap (FT_Glyph *the_glyph, FT_Render_Mode render_mode, FT_Vector *origin, FT_Bool destroy)
	FT_Done_Glyph (FT_Glyph glyph)
	FT_Matrix_Multiply (const FT_Matrix *a, FT_Matrix *b)
	FT_Matrix_Invert (FT_Matrix *matrix)

Macro Definition Documentation

ft_glyph_bbox_gridfit

#define ft_glyph_bbox_gridfit   FT_GLYPH_BBOX_GRIDFIT

Definition at line 384 of file ftglyph.h.

ft_glyph_bbox_pixels

#define ft_glyph_bbox_pixels   FT_GLYPH_BBOX_PIXELS

Definition at line 386 of file ftglyph.h.

ft_glyph_bbox_subpixels

#define ft_glyph_bbox_subpixels   FT_GLYPH_BBOX_SUBPIXELS

Definition at line 383 of file ftglyph.h.

ft_glyph_bbox_truncate

#define ft_glyph_bbox_truncate   FT_GLYPH_BBOX_TRUNCATE

Definition at line 385 of file ftglyph.h.

ft_glyph_bbox_unscaled

#define ft_glyph_bbox_unscaled   FT_GLYPH_BBOX_UNSCALED

Definition at line 382 of file ftglyph.h.

Typedef Documentation

FT_BitmapGlyph

typedef struct FT_BitmapGlyphRec_* FT_BitmapGlyph

Definition at line 131 of file ftglyph.h.

FT_BitmapGlyphRec

typedef struct FT_BitmapGlyphRec_ FT_BitmapGlyphRec

FT_Glyph

typedef struct FT_GlyphRec_* FT_Glyph

Definition at line 87 of file ftglyph.h.

FT_Glyph_BBox_Mode

typedef enum FT_Glyph_BBox_Mode_ FT_Glyph_BBox_Mode

FT_Glyph_Class

typedef typedefFT_BEGIN_HEADER struct FT_Glyph_Class_ FT_Glyph_Class

Definition at line 69 of file ftglyph.h.

FT_GlyphRec

typedef struct FT_GlyphRec_ FT_GlyphRec

FT_OutlineGlyph

typedef struct FT_OutlineGlyphRec_* FT_OutlineGlyph

Definition at line 186 of file ftglyph.h.

FT_OutlineGlyphRec

typedef struct FT_OutlineGlyphRec_ FT_OutlineGlyphRec

Enumeration Type Documentation

FT_Glyph_BBox_Mode_

enum FT_Glyph_BBox_Mode_

Enumerator
FT_GLYPH_BBOX_UNSCALED
FT_GLYPH_BBOX_SUBPIXELS
FT_GLYPH_BBOX_GRIDFIT
FT_GLYPH_BBOX_TRUNCATE
FT_GLYPH_BBOX_PIXELS

Definition at line 369 of file ftglyph.h.

  {
    FT_GLYPH_BBOX_UNSCALED  = 0,
    FT_GLYPH_BBOX_SUBPIXELS = 0,
    FT_GLYPH_BBOX_GRIDFIT   = 1,
    FT_GLYPH_BBOX_TRUNCATE  = 2,
    FT_GLYPH_BBOX_PIXELS    = 3
 
  } FT_Glyph_BBox_Mode;

Function Documentation

FT_Done_Glyph()

FT_Done_Glyph

(

FT_Glyph

glyph

)

Definition at line 641 of file ftglyph.c.

  {
    if ( glyph )
    {
      FT_Memory              memory = glyph->library->memory;
      const FT_Glyph_Class*  clazz  = glyph->clazz;
 
 
      if ( clazz->glyph_done )
        clazz->glyph_done( glyph );
 
      FT_FREE( glyph );
    }
  }

Referenced by FT_Get_Glyph(), FT_Glyph_Copy(), FT_Glyph_Stroke(), FT_Glyph_StrokeBorder(), FT_Glyph_To_Bitmap(), ftc_inode_free(), IntGetBitmapGlyphWithCache(), and RemoveCachedEntry().

FT_Get_Glyph()

FT_Get_Glyph	(	FT_GlyphSlot	slot,
		FT_Glyph *	aglyph
	)

Definition at line 401 of file ftglyph.c.

  {
    FT_Error  error;
    FT_Glyph  glyph;
 
 
    if ( !slot )
      return FT_THROW( Invalid_Slot_Handle );
 
    if ( !aglyph )
      return FT_THROW( Invalid_Argument );
 
    /* create FT_Glyph object */
    error = FT_New_Glyph( slot->library, slot->format, &glyph );
    if ( error )
      goto Exit;
 
    /* copy advance while converting 26.6 to 16.16 format */
    if ( slot->advance.x >=  0x8000L * 64 ||
         slot->advance.x <= -0x8000L * 64 )
    {
      FT_ERROR(( "FT_Get_Glyph: advance width too large\n" ));
      error = FT_THROW( Invalid_Argument );
      goto Exit2;
    }
    if ( slot->advance.y >=  0x8000L * 64 ||
         slot->advance.y <= -0x8000L * 64 )
    {
      FT_ERROR(( "FT_Get_Glyph: advance height too large\n" ));
      error = FT_THROW( Invalid_Argument );
      goto Exit2;
    }
 
    glyph->advance.x = slot->advance.x * 1024;
    glyph->advance.y = slot->advance.y * 1024;
 
    /* now import the image from the glyph slot */
    error = glyph->clazz->glyph_init( glyph, slot );
 
  Exit2:
    /* if an error occurred, destroy the glyph */
    if ( error )
      FT_Done_Glyph( glyph );
    else
      *aglyph = glyph;
 
  Exit:
    return error;
  }

Referenced by ftc_basic_family_load_glyph(), and IntGetBitmapGlyphWithCache().

FT_Glyph_Copy()

FT_Glyph_Copy	(	FT_Glyph	source,
		FT_Glyph *	target
	)

Definition at line 316 of file ftglyph.c.

  {
    FT_Glyph               copy;
    FT_Error               error;
    const FT_Glyph_Class*  clazz;
 
 
    /* check arguments */
    if ( !target || !source || !source->clazz )
    {
      error = FT_THROW( Invalid_Argument );
      goto Exit;
    }
 
    *target = NULL;
 
    if ( !source || !source->clazz )
    {
      error = FT_THROW( Invalid_Argument );
      goto Exit;
    }
 
    clazz = source->clazz;
    error = ft_new_glyph( source->library, clazz, &copy );
    if ( error )
      goto Exit;
 
    copy->advance = source->advance;
    copy->format  = source->format;
 
    if ( clazz->glyph_copy )
      error = clazz->glyph_copy( source, copy );
 
    if ( error )
      FT_Done_Glyph( copy );
    else
      *target = copy;
 
  Exit:
    return error;
  }

Referenced by FT_Glyph_Stroke(), and FT_Glyph_StrokeBorder().

FT_Glyph_Get_CBox()

FT_Glyph_Get_CBox	(	FT_Glyph	glyph,
		FT_UInt	bbox_mode,
		FT_BBox *	acbox
	)

Definition at line 489 of file ftglyph.c.

  {
    const FT_Glyph_Class*  clazz;
 
 
    if ( !acbox )
      return;
 
    acbox->xMin = acbox->yMin = acbox->xMax = acbox->yMax = 0;
 
    if ( !glyph || !glyph->clazz )
      return;
 
    clazz = glyph->clazz;
    if ( !clazz->glyph_bbox )
      return;
 
    /* retrieve bbox in 26.6 coordinates */
    clazz->glyph_bbox( glyph, acbox );
 
    /* perform grid fitting if needed */
    if ( bbox_mode == FT_GLYPH_BBOX_GRIDFIT ||
         bbox_mode == FT_GLYPH_BBOX_PIXELS  )
    {
      acbox->xMin = FT_PIX_FLOOR( acbox->xMin );
      acbox->yMin = FT_PIX_FLOOR( acbox->yMin );
      acbox->xMax = FT_PIX_CEIL_LONG( acbox->xMax );
      acbox->yMax = FT_PIX_CEIL_LONG( acbox->yMax );
    }
 
    /* convert to integer pixels if needed */
    if ( bbox_mode == FT_GLYPH_BBOX_TRUNCATE ||
         bbox_mode == FT_GLYPH_BBOX_PIXELS   )
    {
      acbox->xMin >>= 6;
      acbox->yMin >>= 6;
      acbox->xMax >>= 6;
      acbox->yMax >>= 6;
    }
  }

FT_Glyph_To_Bitmap()

FT_Glyph_To_Bitmap	(	FT_Glyph *	the_glyph,
		FT_Render_Mode	render_mode,
		FT_Vector *	origin,
		FT_Bool	destroy
	)

Definition at line 536 of file ftglyph.c.

  {
    FT_GlyphSlotRec           dummy;
    FT_GlyphSlot_InternalRec  dummy_internal;
    FT_Error                  error = FT_Err_Ok;
    FT_Glyph                  b, glyph;
    FT_BitmapGlyph            bitmap = NULL;
    const FT_Glyph_Class*     clazz;
 
    FT_Library                library;
 
 
    /* check argument */
    if ( !the_glyph )
      goto Bad;
    glyph = *the_glyph;
    if ( !glyph )
      goto Bad;
 
    clazz   = glyph->clazz;
    library = glyph->library;
    if ( !library || !clazz )
      goto Bad;
 
    /* when called with a bitmap glyph, do nothing and return successfully */
    if ( clazz == &ft_bitmap_glyph_class )
      goto Exit;
 
    if ( !clazz->glyph_prepare )
      goto Bad;
 
    /* we render the glyph into a glyph bitmap using a `dummy' glyph slot */
    /* then calling FT_Render_Glyph_Internal()                            */
 
    FT_ZERO( &dummy );
    FT_ZERO( &dummy_internal );
    dummy.internal = &dummy_internal;
    dummy.library  = library;
    dummy.format   = clazz->glyph_format;
 
    /* create result bitmap glyph */
    error = ft_new_glyph( library, &ft_bitmap_glyph_class, &b );
    if ( error )
      goto Exit;
    bitmap = (FT_BitmapGlyph)b;
 
#if 1
    /* if `origin' is set, translate the glyph image */
    if ( origin )
      FT_Glyph_Transform( glyph, 0, origin );
#else
    FT_UNUSED( origin );
#endif
 
    /* prepare dummy slot for rendering */
    error = clazz->glyph_prepare( glyph, &dummy );
    if ( !error )
      error = FT_Render_Glyph_Internal( glyph->library, &dummy, render_mode );
 
#if 1
    if ( !destroy && origin )
    {
      FT_Vector  v;
 
 
      v.x = -origin->x;
      v.y = -origin->y;
      FT_Glyph_Transform( glyph, 0, &v );
    }
#endif
 
    if ( error )
      goto Exit;
 
    /* in case of success, copy the bitmap to the glyph bitmap */
    error = ft_bitmap_glyph_init( (FT_Glyph)bitmap, &dummy );
    if ( error )
      goto Exit;
 
    /* copy advance */
    bitmap->root.advance = glyph->advance;
 
    if ( destroy )
      FT_Done_Glyph( glyph );
 
    *the_glyph = FT_GLYPH( bitmap );
 
  Exit:
    if ( error && bitmap )
      FT_Done_Glyph( FT_GLYPH( bitmap ) );
 
    return error;
 
  Bad:
    error = FT_THROW( Invalid_Argument );
    goto Exit;
  }

Referenced by IntGetBitmapGlyphWithCache().

FT_Glyph_Transform()

FT_Glyph_Transform	(	FT_Glyph	glyph,
		FT_Matrix *	matrix,
		FT_Vector *	delta
	)

Definition at line 456 of file ftglyph.c.

  {
    FT_Error  error = FT_Err_Ok;
 
 
    if ( !glyph || !glyph->clazz )
      error = FT_THROW( Invalid_Argument );
    else
    {
      const FT_Glyph_Class*  clazz = glyph->clazz;
 
 
      if ( clazz->glyph_transform )
      {
        /* transform glyph image */
        clazz->glyph_transform( glyph, matrix, delta );
 
        /* transform advance vector */
        if ( matrix )
          FT_Vector_Transform( &glyph->advance, matrix );
      }
      else
        error = FT_THROW( Invalid_Glyph_Format );
    }
    return error;
  }

Referenced by FT_Glyph_To_Bitmap().

FT_Matrix_Invert()

FT_Matrix_Invert

(

FT_Matrix *

matrix

)

Definition at line 688 of file ftcalc.c.

  {
    FT_Pos  delta, xx, yy;
 
 
    if ( !matrix )
      return FT_THROW( Invalid_Argument );
 
    /* compute discriminant */
    delta = FT_MulFix( matrix->xx, matrix->yy ) -
            FT_MulFix( matrix->xy, matrix->yx );
 
    if ( !delta )
      return FT_THROW( Invalid_Argument );  /* matrix can't be inverted */
 
    matrix->xy = -FT_DivFix( matrix->xy, delta );
    matrix->yx = -FT_DivFix( matrix->yx, delta );
 
    xx = matrix->xx;
    yy = matrix->yy;
 
    matrix->xx = FT_DivFix( yy, delta );
    matrix->yy = FT_DivFix( xx, delta );
 
    return FT_Err_Ok;
  }

Referenced by af_loader_load_glyph().

FT_Matrix_Multiply()

FT_Matrix_Multiply	(	const FT_Matrix *	a,
		FT_Matrix *	b
	)

Definition at line 660 of file ftcalc.c.

  {
    FT_Fixed  xx, xy, yx, yy;
 
 
    if ( !a || !b )
      return;
 
    xx = ADD_LONG( FT_MulFix( a->xx, b->xx ),
                   FT_MulFix( a->xy, b->yx ) );
    xy = ADD_LONG( FT_MulFix( a->xx, b->xy ),
                   FT_MulFix( a->xy, b->yy ) );
    yx = ADD_LONG( FT_MulFix( a->yx, b->xx ),
                   FT_MulFix( a->yy, b->yx ) );
    yy = ADD_LONG( FT_MulFix( a->yx, b->xy ),
                   FT_MulFix( a->yy, b->yy ) );
 
    b->xx = xx;
    b->xy = xy;
    b->yx = yx;
    b->yy = yy;
  }

Referenced by ftGdiGetGlyphOutline(), and IntExtTextOutW().

FT_New_Glyph()

FT_New_Glyph	(	FT_Library	library,
		FT_Glyph_Format	format,
		FT_Glyph *	aglyph
	)

Definition at line 363 of file ftglyph.c.

  {
    const FT_Glyph_Class*  clazz = NULL;
 
    if ( !library || !aglyph )
      return FT_THROW( Invalid_Argument );
 
    /* if it is a bitmap, that's easy :-) */
    if ( format == FT_GLYPH_FORMAT_BITMAP )
      clazz = &ft_bitmap_glyph_class;
 
    /* if it is an outline */
    else if ( format == FT_GLYPH_FORMAT_OUTLINE )
      clazz = &ft_outline_glyph_class;
 
    else
    {
      /* try to find a renderer that supports the glyph image format */
      FT_Renderer  render = FT_Lookup_Renderer( library, format, 0 );
 
 
      if ( render )
        clazz = &render->glyph_class;
    }
 
    if ( !clazz )
      return FT_THROW( Invalid_Glyph_Format );
 
    /* create FT_Glyph object */
    return ft_new_glyph( library, clazz, aglyph );
  }

Referenced by FT_Get_Glyph().