/***************************************************************************//*                                                                         *//*  ftcsbits.h                                                             *//*                                                                         *//*    A small-bitmap cache (specification).                                *//*                                                                         *//*  Copyright 2000-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.                                        *//*                                                                         *//***************************************************************************/#ifndef __FTCSBITS_H__#define __FTCSBITS_H__#include <ft2build.h>#include FT_CACHE_H#include FT_CACHE_IMAGE_HFT_BEGIN_HEADER  /*************************************************************************/  /*                                                                       */  /* <Section>                                                             */  /*    cache_subsystem                                                    */  /*                                                                       */  /*************************************************************************/  /*************************************************************************/  /*                                                                       */  /* <Type>                                                                */  /*    FTC_SBit                                                           */  /*                                                                       */  /* <Description>                                                         */  /*    A handle to a small bitmap descriptor.  See the @FTC_SBitRec       */  /*    structure for details.                                             */  /*                                                                       */  typedef struct FTC_SBitRec_*  FTC_SBit;  /*************************************************************************/  /*                                                                       */  /* <Struct>                                                              */  /*    FTC_SBitRec                                                        */  /*                                                                       */  /* <Description>                                                         */  /*    A very compact structure used to describe a small glyph bitmap.    */  /*                                                                       */  /* <Fields>                                                              */  /*    width     :: The bitmap width in pixels.                           */  /*                                                                       */  /*    height    :: The bitmap height in pixels.                          */  /*                                                                       */  /*    left      :: The horizontal distance from the pen position to the  */  /*                 left bitmap border (a.k.a. `left side bearing', or    */  /*                 `lsb').                                               */  /*                                                                       */  /*    top       :: The vertical distance from the pen position (on the   */  /*                 baseline) to the upper bitmap border (a.k.a. `top     */  /*                 side bearing').  The distance is positive for upwards */  /*                 Y coordinates.                                        */  /*                                                                       */  /*    format    :: The format of the glyph bitmap (monochrome or gray).  */  /*                                                                       */  /*    num_grays :: The number of gray levels.                            */  /*                                                                       */  /*    pitch     :: The number of bytes per bitmap line.  May be positive */  /*                 or negative.                                          */  /*                                                                       */  /*    xadvance  :: The horizontal advance width in pixels.               */  /*                                                                       */  /*    yadvance  :: The vertical advance height in pixels.                */  /*                                                                       */  /*    buffer   :: A pointer to the bitmap pixels.                        */  /*                                                                       */  typedef struct  FTC_SBitRec_  {    FT_Byte   width;    FT_Byte   height;    FT_Char   left;    FT_Char   top;    FT_Byte   format;    FT_Short  num_grays;    /* XXX: Should be FT_Byte.  See ftcsbits.c */    FT_Char   pitch;    FT_Char   xadvance;    FT_Char   yadvance;    FT_Byte*  buffer;  } FTC_SBitRec;  /*************************************************************************/  /*                                                                       */  /* <Type>                                                                */  /*    FTC_SBitCache                                                      */  /*                                                                       */  /* <Description>                                                         */  /*    A handle to a small bitmap cache.  These are special cache objects */  /*    used to store small glyph bitmaps (and anti-aliased pixmaps) in a  */  /*    much more efficient way than the traditional glyph image cache     */  /*    implemented by @FTC_ImageCache.                                    */  /*                                                                       */  typedef struct FTC_SBitCacheRec_*  FTC_SBitCache;    /*************************************************************************/  /*                                                                       */  /* <Type>                                                                */  /*    FTC_SBit_Cache                                                     */  /*                                                                       */  /* <Description>                                                         */  /*    DEPRECATED.  Use @FTC_SBitCache instead.                           */  /*                                                                       */  typedef FTC_SBitCache  FTC_SBit_Cache;  /*************************************************************************/  /*                                                                       */  /* <Function>                                                            */  /*    FTC_SBitCache_New                                                  */  /*                                                                       */  /* <Description>                                                         */  /*    Creates a new cache to store small glyph bitmaps.                  */  /*                                                                       */  /* <Input>                                                               */  /*    manager :: A handle to the source cache manager.                   */