summaryrefslogtreecommitdiff
path: root/include/freetype/cache/ftcsbits.h
diff options
context:
space:
mode:
authorWerner Lemberg <wl@gnu.org>2001-01-11 09:27:49 +0000
committerWerner Lemberg <wl@gnu.org>2001-01-11 09:27:49 +0000
commit6e07332f948283abc36f8d2fe8289e8c0310f41a (patch)
tree9e607ee7d93d9d3ebd921a74c8f61e0d82c13f92 /include/freetype/cache/ftcsbits.h
parentdec12f44fa6bf339e6dabdc55454f603ff79f8d4 (diff)
downloadfreetype2-6e07332f948283abc36f8d2fe8289e8c0310f41a.tar.gz
* docs/docmaker.py: Minor improvements to reduce unwanted spaces
and empty lines in output. * docs/docmaker.py: Improved script to generate table of contents and index pages. It also supports wildcards on non Unix systems. * include/freetype/*.h, include/freetype/cache/*.h: Updated comments to include section definitions/delimitations for the API Reference generator. * include/freetype/freetype.h: Moved declaration of `FT_Generic_Finalizer' and the `FT_Generic' structure to... * include/freetype/fttypes.h: here.
Diffstat (limited to 'include/freetype/cache/ftcsbits.h')
-rw-r--r--include/freetype/cache/ftcsbits.h206
1 files changed, 112 insertions, 94 deletions
diff --git a/include/freetype/cache/ftcsbits.h b/include/freetype/cache/ftcsbits.h
index e86ea9d37..a5555d965 100644
--- a/include/freetype/cache/ftcsbits.h
+++ b/include/freetype/cache/ftcsbits.h
@@ -26,63 +26,76 @@
#include FT_CACHE_IMAGE_H
-
FT_BEGIN_HEADER
- /***
- * <Section> cache_subsystem
- */
-
- /***********************************************************************
- *
- * <Type> FTC_SBit
- *
- * <Description>
- * handle to a small bitmap descriptor. see the FTC_SBitRec
- * structure for details..
- */
+
+ /*************************************************************************/
+ /* */
+ /* <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;
- /***********************************************************************
- *
- * <Type> FTC_SBit_Cache
- *
- * <Description>
- * 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_Image_Cache
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Type> */
+ /* FTC_SBit_Cache */
+ /* */
+ /* <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_Image_Cache. */
+ /* */
typedef struct FTC_SBit_CacheRec_* FTC_SBit_Cache;
- /***********************************************************************
- *
- * <Struct> FTC_SBitRec
- *
- * <Description>
- * a very compact structure used to describe a small glyph bitmap
- *
- * <Fields>
- * width :: bitmap width in pixels
- * height :: bitmap height in pixels
- *
- * left :: horizontal distance from pen position to left bitmap
- * border (a.k.a. "left side bearing", or "lsb")
- *
- * top :: vertical distance from 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 :: format of glyph bitmap (mono or gray)
- *
- * pitch :: number of bytes per bitmap lines. may be positive or
- * negative
- *
- * xadvance :: horizontal advance width in pixels
- * yadvance :: vertical advance height in pixels
- *
- * buffer :: pointer to bitmap pixels
- */
+
+ /*************************************************************************/
+ /* */
+ /* <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). */
+ /* */
+ /* 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;
@@ -100,59 +113,64 @@ FT_BEGIN_HEADER
} FTC_SBitRec;
- /*************************************************************************
- *
- * <Section> FTC_SBit_Cache_New
- *
- * <Description>
- * Create a new cache to store small glyph bitmaps
- *
- * <Input>
- * manager :: handle to source cache manager
- *
- * <Output>
- * acache :: handle to new sbit cache. NULL in case of error
- *
- * <Return>
- * error code. 0 means success
- */
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FTC_SBit_Cache_New */
+ /* */
+ /* <Description> */
+ /* Creates a new cache to store small glyph bitmaps. */
+ /* */
+ /* <Input> */
+ /* manager :: A handle to the source cache manager. */
+ /* */
+ /* <Output> */
+ /* acache :: A handle to the new sbit cache. NULL in case of error. */
+ /* */
+ /* <Return> */
+ /* FreeType error code. 0 means success. */
+ /* */
FT_EXPORT( FT_Error ) FTC_SBit_Cache_New( FTC_Manager manager,
FTC_SBit_Cache *acache );
- /*************************************************************************
- *
- * <Section> FTC_SBit_Cache_Lookup
- *
- * <Description>
- * Lookup a given small glyph bitmap in a given sbit cache
- *
- * <Input>
- * cache :: handle to source sbit cache
- * desc :: pointer to glyph image descriptor
- * gindex :: glyph index
- *
- * <Output>
- * sbit :: handle to a small bitmap descriptor
- *
- * <Return>
- * error code. 0 means success
- *
- * <Note>
- * the small bitmap descriptor, and its bit buffer are owned by the
- * cache and should never be freed by the application. They might
- * as well disappear from memory on the next cache lookup, so don't
- * treat them like persistent data..
- *
- * the descriptor's "buffer" field is set to 0 to indicate a missing
- * glyph bitmap.
- */
+
+ /*************************************************************************/
+ /* */
+ /* <Function> */
+ /* FTC_SBit_Cache_Lookup */
+ /* */
+ /* <Description> */
+ /* Looks up a given small glyph bitmap in a given sbit cache. */
+ /* */
+ /* <Input> */
+ /* cache :: A handle to the source sbit cache. */
+ /* desc :: A pointer to the glyph image descriptor. */
+ /* gindex :: The glyph index. */
+ /* */
+ /* <Output> */
+ /* sbit :: A handle to a small bitmap descriptor. */
+ /* */
+ /* <Return> */
+ /* FreeType error code. 0 means success. */
+ /* */
+ /* <Note> */
+ /* The small bitmap descriptor and its bit buffer are owned by the */
+ /* cache and should never be freed by the application. They might */
+ /* as well disappear from memory on the next cache lookup, so don't */
+ /* treat them as persistent data. */
+ /* */
+ /* The descriptor's `buffer' field is set to 0 to indicate a missing */
+ /* glyph bitmap. */
+ /* */
FT_EXPORT( FT_Error ) FTC_SBit_Cache_Lookup( FTC_SBit_Cache cache,
FTC_Image_Desc* desc,
FT_UInt gindex,
FTC_SBit *sbit );
+
/* */
+
FT_END_HEADER
#endif /* __FTCSBITS_H__ */
View Lorry Controller Status