www.pudn.com > freetype.rar > ftdriver.h


/***************************************************************************/ 
/*                                                                         */ 
/*  ftdriver.h                                                             */ 
/*                                                                         */ 
/*    FreeType font driver interface (specification).                      */ 
/*                                                                         */ 
/*  Copyright 1996-2001, 2002 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.                                        */ 
/*                                                                         */ 
/***************************************************************************/ 
 
 
#ifndef __FTDRIVER_H__ 
#define __FTDRIVER_H__ 
 
 
#include "ft2build.h" 
#include "freetype/ftmodule.h" 
 
 
FT_BEGIN_HEADER 
 
 
  typedef FT_Error 
  (*FT_Face_InitFunc)( FT_Stream      stream, 
                       FT_Face        face, 
                       FT_Int         typeface_index, 
                       FT_Int         num_params, 
                       FT_Parameter*  parameters ); 
 
  typedef void 
  (*FT_Face_DoneFunc)( FT_Face  face ); 
 
 
  typedef FT_Error 
  (*FT_Size_InitFunc)( FT_Size  size ); 
 
  typedef void 
  (*FT_Size_DoneFunc)( FT_Size  size ); 
 
 
  typedef FT_Error 
  (*FT_Slot_InitFunc)( FT_GlyphSlot  slot ); 
 
  typedef void 
  (*FT_Slot_DoneFunc)( FT_GlyphSlot  slot ); 
 
 
  typedef FT_Error 
  (*FT_Size_ResetPointsFunc)( FT_Size     size, 
                              FT_F26Dot6  char_width, 
                              FT_F26Dot6  char_height, 
                              FT_UInt     horz_resolution, 
                              FT_UInt     vert_resolution ); 
 
  typedef FT_Error 
  (*FT_Size_ResetPixelsFunc)( FT_Size  size, 
                              FT_UInt  pixel_width, 
                              FT_UInt  pixel_height ); 
 
  typedef FT_Error 
  (*FT_Slot_LoadFunc)( FT_GlyphSlot  slot, 
                       FT_Size       size, 
                       FT_UInt       glyph_index, 
                       FT_Int32      load_flags ); 
 
 
  typedef FT_UInt 
  (*FT_CharMap_CharIndexFunc)( FT_CharMap  charmap, 
                               FT_Long     charcode ); 
 
  typedef FT_Long 
  (*FT_CharMap_CharNextFunc)( FT_CharMap  charmap, 
                              FT_Long     charcode ); 
 
  typedef FT_Error 
  (*FT_Face_GetKerningFunc)( FT_Face     face, 
                             FT_UInt     left_glyph, 
                             FT_UInt     right_glyph, 
                             FT_Vector*  kerning ); 
 
 
  typedef FT_Error 
  (*FT_Face_AttachFunc)( FT_Face    face, 
                         FT_Stream  stream ); 
 
 
  typedef FT_Error 
  (*FT_Face_GetAdvancesFunc)( FT_Face     face, 
                              FT_UInt     first, 
                              FT_UInt     count, 
                              FT_Bool     vertical, 
                              FT_UShort*  advances ); 
 
 
  /*************************************************************************/ 
  /*                                                                       */ 
  /*                                                               */ 
  /*    FT_Driver_ClassRec                                                 */ 
  /*                                                                       */ 
  /*                                                          */ 
  /*    The font driver class.  This structure mostly contains pointers to */ 
  /*    driver methods.                                                    */ 
  /*                                                                       */ 
  /*                                                               */ 
  /*    root             :: The parent module.                             */ 
  /*                                                                       */ 
  /*    face_object_size :: The size of a face object in bytes.            */ 
  /*                                                                       */ 
  /*    size_object_size :: The size of a size object in bytes.            */ 
  /*                                                                       */ 
  /*    slot_object_size :: The size of a glyph object in bytes.           */ 
  /*                                                                       */ 
  /*    init_face        :: The format-specific face constructor.          */ 
  /*                                                                       */ 
  /*    done_face        :: The format-specific face destructor.           */ 
  /*                                                                       */ 
  /*    init_size        :: The format-specific size constructor.          */ 
  /*                                                                       */ 
  /*    done_size        :: The format-specific size destructor.           */ 
  /*                                                                       */ 
  /*    init_slot        :: The format-specific slot constructor.          */ 
  /*                                                                       */ 
  /*    done_slot        :: The format-specific slot destructor.           */ 
  /*                                                                       */ 
  /*    set_char_sizes   :: A handle to a function used to set the new     */ 
  /*                        character size in points + resolution.  Can be */ 
  /*                        set to 0 to indicate default behaviour.        */ 
  /*                                                                       */ 
  /*    set_pixel_sizes  :: A handle to a function used to set the new     */ 
  /*                        character size in pixels.  Can be set to 0 to  */ 
  /*                        indicate default behaviour.                    */ 
  /*                                                                       */ 
  /*    load_glyph       :: A function handle to load a given glyph image  */ 
  /*                        in a slot.  This field is mandatory!           */ 
  /*                                                                       */ 
  /*    get_char_index   :: A function handle to return the glyph index of */ 
  /*                        a given character for a given charmap.  This   */ 
  /*                        field is mandatory!                            */ 
  /*                                                                       */ 
  /*    get_kerning      :: A function handle to return the unscaled       */ 
  /*                        kerning for a given pair of glyphs.  Can be    */ 
  /*                        set to 0 if the format doesn't support         */ 
  /*                        kerning.                                       */ 
  /*                                                                       */ 
  /*    attach_file      :: This function handle is used to read           */ 
  /*                        additional data for a face from another        */ 
  /*                        file/stream.  For example, this can be used to */ 
  /*                        add data from AFM or PFM files on a Type 1     */ 
  /*                        face, or a CIDMap on a CID-keyed face.         */ 
  /*                                                                       */ 
  /*    get_advances     :: A function handle used to return the advances  */ 
  /*                        of 'count' glyphs, starting at `index'.  the   */ 
  /*                        `vertical' flags must be set when vertical     */ 
  /*                        advances are queried.  The advances buffer is  */ 
  /*                        caller-allocated.                              */ 
  /*                                                                       */ 
  /*                                                                 */ 
  /*    Most function pointers, with the exception of `load_glyph' and     */ 
  /*    `get_char_index' can be set to 0 to indicate a default behaviour.  */ 
  /*                                                                       */ 
  typedef struct  FT_Driver_ClassRec_ 
  { 
    FT_Module_Class           root; 
 
    FT_Int                    face_object_size; 
    FT_Int                    size_object_size; 
    FT_Int                    slot_object_size; 
 
    FT_Face_InitFunc          init_face; 
    FT_Face_DoneFunc          done_face; 
 
    FT_Size_InitFunc          init_size; 
    FT_Size_DoneFunc          done_size; 
 
    FT_Slot_InitFunc          init_slot; 
    FT_Slot_DoneFunc          done_slot; 
 
    FT_Size_ResetPointsFunc   set_char_sizes; 
    FT_Size_ResetPixelsFunc   set_pixel_sizes; 
 
    FT_Slot_LoadFunc          load_glyph; 
 
    FT_Face_GetKerningFunc    get_kerning; 
    FT_Face_AttachFunc        attach_file; 
    FT_Face_GetAdvancesFunc   get_advances; 
 
  } FT_Driver_ClassRec, *FT_Driver_Class; 
 
 
FT_END_HEADER 
 
#endif /* __FTDRIVER_H__ */ 
 
 
/* END */