/***************************************************************************//*                                                                         *//*  ftcache.h                                                              *//*                                                                         *//*    FreeType Cache subsystem (specification).                            *//*                                                                         *//*  Copyright 1996-2001 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.                                        *//*                                                                         *//***************************************************************************/  /*************************************************************************/  /*************************************************************************/  /*************************************************************************/  /*************************************************************************/  /*************************************************************************/  /*********                                                       *********/  /*********             WARNING, THIS IS BETA CODE.               *********/  /*********                                                       *********/  /*************************************************************************/  /*************************************************************************/  /*************************************************************************/  /*************************************************************************/  /*************************************************************************/#ifndef __FTCACHE_H__#define __FTCACHE_H__#include <ft2build.h>#include FT_GLYPH_HFT_BEGIN_HEADER  /*************************************************************************/  /*                                                                       */  /* <Section>                                                             */  /*    cache_subsystem                                                    */  /*                                                                       */  /* <Title>                                                               */  /*    Cache Sub-System                                                   */  /*                                                                       */  /* <Abstract>                                                            */  /*    How to cache face, size, and glyph data with FreeType 2.           */  /*                                                                       */  /* <Description>                                                         */  /*   This section describes the FreeType 2 cache sub-system which is     */  /*   stile in beta.                                                      */  /*                                                                       */  /* <Order>                                                               */  /*   FTC_Manager                                                         */  /*   FTC_FaceID                                                          */  /*   FTC_Face_Requester                                                  */  /*                                                                       */  /*   FTC_Manager_New                                                     */  /*   FTC_Manager_Lookup_Face                                             */  /*   FTC_Manager_Lookup_Size                                             */  /*                                                                       */  /*   FTC_Node                                                            */  /*   FTC_Node_Ref                                                        */  /*   FTC_Node_Unref                                                      */  /*                                                                       */  /*   FTC_Font                                                            */  /*   FTC_ImageDesc                                                       */  /*   FTC_ImageCache                                                      */  /*   FTC_ImageCache_New                                                  */  /*   FTC_ImageCache_Lookup                                               */  /*                                                                       */  /*   FTC_SBit                                                            */  /*   FTC_SBitCache                                                       */  /*   FTC_SBitCache_New                                                   */  /*   FTC_SBitCache_Lookup                                                */  /*                                                                       */  /*                                                                       */  /*   FTC_Image_Desc                                                      */  /*   FTC_Image_Cache                                                     */  /*   FTC_Image_Cache_Lookup                                              */  /*                                                                       */  /*   FTC_SBit_Cache                                                      */  /*   FTC_SBit_Cache_Lookup                                               */  /*                                                                       */  /*************************************************************************/  /*************************************************************************/  /*************************************************************************/  /*************************************************************************/  /*****                                                               *****/  /*****                    BASIC TYPE DEFINITIONS                     *****/  /*****                                                               *****/  /*************************************************************************/  /*************************************************************************/  /*************************************************************************/  /*************************************************************************/  /*                                                                       */  /* <Type>                                                                */  /*    FTC_FaceID                                                         */  /*                                                                       */  /* <Description>                                                         */  /*    A generic pointer type that is used to identity face objects.  The */  /*    contents of such objects is application-dependent.                 */  /*                                                                       */  typedef FT_Pointer  FTC_FaceID;  /*************************************************************************/  /*                                                                       */  /* <FuncType>                                                            */  /*    FTC_Face_Requester                                                 */  /*                                                                       */  /* <Description>                                                         */  /*    A callback function provided by client applications.  It is used   */  /*    to translate a given @FTC_FaceID into a new valid @FT_Face object. */  /*                                                                       */  /* <Input>                                                               */  /*    face_id :: The face ID to resolve.                                 */  /*                                                                       */  /*    library :: A handle to a FreeType library object.                  */  /*                                                                       */  /*    data    :: Application-provided request data.                      */  /*                                                                       */  /* <Output>                                                              */  /*    aface   :: A new @FT_Face handle.                                  */  /*                                                                       */  /* <Return>                                                              */  /*    FreeType error code.  0 means success.                             */  /*                                                                       */  /* <Note>                                                                */  /*    The face requester should not perform funny things on the returned */  /*    face object, like creating a new @FT_Size for it, or setting a     */  /*    transformation through @FT_Set_Transform!                          */  /*                                                                       */  typedef FT_Error  (*FTC_Face_Requester)( FTC_FaceID  face_id,                         FT_Library  library,                         FT_Pointer  request_data,                         FT_Face*    aface );  /*************************************************************************/  /*                                                                       */  /* <Struct>                                                              */  /*    FTC_FontRec                                                        */  /*                                                                       */  /* <Description>                                                         */  /*    A simple structure used to describe a given `font' to the cache    */  /*    manager.  Note that a `font' is the combination of a given face    */  /*    with a given character size.                                       */  /*                                                                       */  /* <Fields>                                                              */  /*    face_id    :: The ID of the face to use.                           */  /*                                                                       */  /*    pix_width  :: The character width in integer pixels.               */  /*                                                                       */  /*    pix_height :: The character height in integer pixels.              */  /*                                                                       */  typedef struct  FTC_FontRec_  {    FTC_FaceID  face_id;    FT_UShort   pix_width;    FT_UShort   pix_height;  } FTC_FontRec;  /* */#define FTC_FONT_COMPARE( f1, f2 )                  \          ( (f1)->face_id    == (f2)->face_id    && \            (f1)->pix_width  == (f2)->pix_width  && \            (f1)->pix_height == (f2)->pix_height )#define FTC_FACE_ID_HASH( i )  ((FT_UInt32)(FT_Pointer)( i ))#define FTC_FONT_HASH( f )                              \          (FT_UInt32)( FTC_FACE_ID_HASH((f)->face_id) ^ \                       ((f)->pix_width << 8)          ^ \                       ((f)->pix_height)              )  /*************************************************************************/  /*                                                                       */  /* <Type>                                                                */  /*    FTC_Font                                                           */  /*                                                                       */  /* <Description>                                                         */  /*    A simple handle to an @FTC_FontRec structure.                      */  /*                                                                       */  typedef FTC_FontRec*  FTC_Font;  /*************************************************************************/  /*************************************************************************/