Chiebot-Mirror
/
freetype
mirror of https://github.com/freetype/freetype.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

Change documentation markup tags to lowercase.

Browse Source 
Implemented as per discussion in

  http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html

No change in functionality, of course.
parthw-pk-vf
Nikhil Ramakrishnan 7 years ago
parent d573a46f77
commit e13599a036
53 changed files with 1651 additions and 1651 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 20
      include/freetype/config/ftconfig.h
  2. 8
      include/freetype/config/ftheader.h
  3. 750
      include/freetype/freetype.h
  4. 26
      include/freetype/ftadvanc.h
  5. 14
      include/freetype/ftbbox.h
  6. 8
      include/freetype/ftbdf.h
  7. 84
      include/freetype/ftbitmap.h
  8. 8
      include/freetype/ftbzip2.h
  9. 180
      include/freetype/ftcache.h
  10. 42
      include/freetype/ftchapters.h
  11. 8
      include/freetype/ftcid.h
  12. 2
      include/freetype/ftcolor.h
  13. 10
      include/freetype/fterrdef.h
  14. 8
      include/freetype/fterrors.h
  15. 18
      include/freetype/ftfntfmt.h
  16. 132
      include/freetype/ftglyph.h
  17. 10
      include/freetype/ftgxval.h
  18. 8
      include/freetype/ftgzip.h
  19. 204
      include/freetype/ftimage.h
  20. 72
      include/freetype/ftlist.h
  21. 8
      include/freetype/ftlzw.h
  22. 80
      include/freetype/ftmac.h
  23. 170
      include/freetype/ftmm.h
  24. 124
      include/freetype/ftmodapi.h
  25. 10
      include/freetype/ftotval.h
  26. 142
      include/freetype/ftoutln.h
  27. 8
      include/freetype/ftpfr.h
  28. 30
      include/freetype/ftrender.h
  29. 38
      include/freetype/ftsizes.h
  30. 62
      include/freetype/ftsnames.h
  31. 8
      include/freetype/ftsystem.h
  32. 2
      include/freetype/fttrigon.h
  33. 152
      include/freetype/fttypes.h
  34. 16
      include/freetype/ftwinfnt.h
  35. 32
      include/freetype/internal/autohint.h
  36. 12
      include/freetype/internal/cffotypes.h
  37. 6
      include/freetype/internal/cfftypes.h
  38. 18
      include/freetype/internal/ftcalc.h
  39. 18
      include/freetype/internal/ftdebug.h
  40. 16
      include/freetype/internal/ftdrv.h
  41. 4
      include/freetype/internal/ftgloadr.h
  42. 4
      include/freetype/internal/ftmemory.h
  43. 106
      include/freetype/internal/ftobjs.h
  44. 30
      include/freetype/internal/ftrfork.h
  45. 4
      include/freetype/internal/ftserv.h
  46. 42
      include/freetype/internal/psaux.h
  47. 6
      include/freetype/internal/services/svttcmap.h
  48. 180
      include/freetype/internal/sfnt.h
  49. 6
      include/freetype/internal/t1types.h
  50. 188
      include/freetype/internal/tttypes.h
  51. 80
      include/freetype/t1tables.h
  52. 2
      include/freetype/ttnameid.h
  53. 86
      include/freetype/tttables.h

20
include/freetype/config/ftconfig.h
Unescape View File

@ -153,7 +153,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* basic_types
*
*/
@ -161,10 +161,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Int16
*
* @Description:
* @description:
* A typedef for a 16bit signed integer type.
*/
typedef signed short FT_Int16;
@ -172,10 +172,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_UInt16
*
* @Description:
* @description:
* A typedef for a 16bit unsigned integer type.
*/
typedef unsigned short FT_UInt16;
@ -188,10 +188,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Int32
*
* @Description:
* @description:
* A typedef for a 32bit signed integer type. The size depends on
* the configuration.
*/
@ -200,7 +200,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_UInt32
*
* A typedef for a 32bit unsigned integer type. The size depends on
@ -211,7 +211,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Int64
*
* A typedef for a 64bit signed integer type. The size depends on
@ -223,7 +223,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_UInt64
*
* A typedef for a 64bit unsigned integer type. The size depends on

8
include/freetype/config/ftheader.h
Unescape View File

@ -63,16 +63,16 @@
/**************************************************************************
*
* @Section:
* @section:
* header_file_macros
*
* @Title:
* @title:
* Header File Macros
*
* @Abstract:
* @abstract:
* Macro definitions used to #include specific header files.
*
* @Description:
* @description:
* The following macros are defined to the name of specific
* FreeType~2 header files. They can be used directly in #include
* statements as in:

750
include/freetype/freetype.h
View File

File diff suppressed because it is too large Load Diff

26
include/freetype/ftadvanc.h
Unescape View File

@ -61,7 +61,7 @@ FT_BEGIN_HEADER
* @enum:
* FT_ADVANCE_FLAG_FAST_ONLY
*
* @Description:
* @description:
* A bit-flag to be OR-ed with the `flags' parameter of the
* @FT_Get_Advance and @FT_Get_Advances functions.
*
@ -82,14 +82,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Advance
*
* @Description:
* @description:
* Retrieve the advance value of a given glyph outline in an
* @FT_Face.
*
* @Input:
* @input:
* face ::
* The source @FT_Face handle.
*
@ -100,7 +100,7 @@ FT_BEGIN_HEADER
* A set of bit flags similar to those used when
* calling @FT_Load_Glyph, used to determine what kind
* of advances you need.
* @Output:
* @output:
* padvance ::
* The advance value. If scaling is performed (based on
* the value of `load_flags'), the advance value is in
@ -111,10 +111,10 @@ FT_BEGIN_HEADER
* Otherwise, it is the horizontal advance in a
* horizontal layout.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*
* @Note:
* @note:
* This function may fail if you use @FT_ADVANCE_FLAG_FAST_ONLY and
* if the corresponding font backend doesn't have a quick way to
* retrieve the advances.
@ -131,14 +131,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Advances
*
* @Description:
* @description:
* Retrieve the advance values of several glyph outlines in an
* @FT_Face.
*
* @Input:
* @input:
* face ::
* The source @FT_Face handle.
*
@ -152,7 +152,7 @@ FT_BEGIN_HEADER
* A set of bit flags similar to those used when
* calling @FT_Load_Glyph.
*
* @Output:
* @output:
* padvance ::
* The advance values. This array, to be provided by the
* caller, must contain at least `count' elements.
@ -166,10 +166,10 @@ FT_BEGIN_HEADER
* Otherwise, they are the horizontal advances in a
* horizontal layout.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*
* @Note:
* @note:
* This function may fail if you use @FT_ADVANCE_FLAG_FAST_ONLY and
* if the corresponding font backend doesn't have a quick way to
* retrieve the advances.

14
include/freetype/ftbbox.h
Unescape View File

@ -46,7 +46,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* outline_processing
*
*/
@ -54,28 +54,28 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Get_BBox
*
* @Description:
* @description:
* Compute the exact bounding box of an outline. This is slower
* than computing the control box. However, it uses an advanced
* algorithm that returns _very_ quickly when the two boxes
* coincide. Otherwise, the outline Bezier arcs are traversed to
* extract their extrema.
*
* @Input:
* @input:
* outline ::
* A pointer to the source outline.
*
* @Output:
* @output:
* abbox ::
* The outline's exact bounding box.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* If the font is tricky and the glyph has been loaded with
* @FT_LOAD_NO_SCALE, the resulting BBox is meaningless. To get
* reasonable values for the BBox it is necessary to load the glyph

8
include/freetype/ftbdf.h
Unescape View File

@ -34,16 +34,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* bdf_fonts
*
* @Title:
* @title:
* BDF and PCF Files
*
* @Abstract:
* @abstract:
* BDF and PCF specific API.
*
* @Description:
* @description:
* This section contains the declaration of functions specific to BDF
* and PCF fonts.
*

84
include/freetype/ftbitmap.h
Unescape View File

@ -36,16 +36,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* bitmap_handling
*
* @Title:
* @title:
* Bitmap Handling
*
* @Abstract:
* @abstract:
* Handling FT_Bitmap objects.
*
* @Description:
* @description:
* This section contains functions for handling @FT_Bitmap objects.
* Note that none of the functions changes the bitmap's `flow' (as
* indicated by the sign of the `pitch' field in `FT_Bitmap').
@ -55,17 +55,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Bitmap_Init
*
* @Description:
* @description:
* Initialize a pointer to an @FT_Bitmap structure.
*
* @InOut:
* @inout:
* abitmap ::
* A pointer to the bitmap structure.
*
* @Note:
* @note:
* A deprecated name for the same function is `FT_Bitmap_New'.
*/
FT_EXPORT( void )
@ -79,24 +79,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Bitmap_Copy
*
* @Description:
* @description:
* Copy a bitmap into another one.
*
* @Input:
* @input:
* library ::
* A handle to a library object.
*
* source ::
* A handle to the source bitmap.
*
* @Output:
* @output:
* target ::
* A handle to the target bitmap.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -107,15 +107,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Bitmap_Embolden
*
* @Description:
* @description:
* Embolden a bitmap. The new bitmap will be about `xStrength'
* pixels wider and `yStrength' pixels higher. The left and bottom
* borders are kept unchanged.
*
* @Input:
* @input:
* library ::
* A handle to a library object.
*
@ -127,14 +127,14 @@ FT_BEGIN_HEADER
* How strong the glyph is emboldened vertically.
* Expressed in 26.6 pixel format.
*
* @InOut:
* @inout:
* bitmap ::
* A handle to the target bitmap.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The current implementation restricts `xStrength' to be less than
* or equal to~8 if bitmap is of pixel_mode @FT_PIXEL_MODE_MONO.
*
@ -153,15 +153,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Bitmap_Convert
*
* @Description:
* @description:
* Convert a bitmap object with depth 1bpp, 2bpp, 4bpp, 8bpp or 32bpp
* to a bitmap object with depth 8bpp, making the number of used
* bytes per line (a.k.a. the `pitch') a multiple of `alignment'.
*
* @Input:
* @input:
* library ::
* A handle to a library object.
*
@ -172,14 +172,14 @@ FT_BEGIN_HEADER
* The pitch of the bitmap is a multiple of this
* argument. Common values are 1, 2, or 4.
*
* @Output:
* @output:
* target ::
* The target bitmap.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* It is possible to call @FT_Bitmap_Convert multiple times without
* calling @FT_Bitmap_Done (the memory is simply reallocated).
*
@ -197,13 +197,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Bitmap_Blend
*
* @Description:
* @description:
* Blend a bitmap onto another bitmap, using a given color.
*
* @Input:
* @input:
* library ::
* A handle to a library object.
*
@ -217,7 +217,7 @@ FT_BEGIN_HEADER
* color ::
* The color used to draw `source' onto `target'.
*
* @InOut:
* @inout:
* target ::
* A handle to an `FT_Bitmap' object. It should be either initialized
* as empty with a call to @FT_Bitmap_Init, or it should be of type
@ -228,10 +228,10 @@ FT_BEGIN_HEADER
* 26.6 pixel format. It should represent an integer offset; the
* function will set the lowest six bits to zero to enforce that.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* This function doesn't perform clipping.
*
* The bitmap in `target' gets allocated or reallocated as needed; the
@ -241,7 +241,7 @@ FT_BEGIN_HEADER
* `4~*~width'. Both `source' and `target' must have the same bitmap
* flow (as indicated by the sign of the `pitch' field).
*
* @Since:
* @since:
* 2.10
*/
FT_EXPORT( FT_Error )
@ -255,20 +255,20 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_GlyphSlot_Own_Bitmap
*
* @Description:
* @description:
* Make sure that a glyph slot owns `slot->bitmap'.
*
* @Input:
* @input:
* slot ::
* The glyph slot.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* This function is to be used in combination with
* @FT_Bitmap_Embolden.
*/
@ -278,23 +278,23 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Bitmap_Done
*
* @Description:
* @description:
* Destroy a bitmap object initialized with @FT_Bitmap_Init.
*
* @Input:
* @input:
* library ::
* A handle to a library object.
*
* bitmap ::
* The bitmap object to be freed.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The `library' argument is taken to have access to FreeType's
* memory handling functions.
*/

8
include/freetype/ftbzip2.h
Unescape View File

@ -33,16 +33,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* bzip2
*
* @Title:
* @title:
* BZIP2 Streams
*
* @Abstract:
* @abstract:
* Using bzip2-compressed font files.
*
* @Description:
* @description:
* This section contains the declaration of Bzip2-specific functions.
*
*/

180
include/freetype/ftcache.h
Unescape View File

@ -29,16 +29,16 @@ FT_BEGIN_HEADER
/*************************************************************************
*
* @Section:
* @section:
* cache_subsystem
*
* @Title:
* @title:
* Cache Sub-System
*
* @Abstract:
* @abstract:
* How to cache face, size, and glyph data with FreeType~2.
*
* @Description:
* @description:
* This section describes the FreeType~2 cache sub-system, which is used
* to limit the number of concurrently opened @FT_Face and @FT_Size
* objects, as well as caching information like character maps and glyph
@ -100,7 +100,7 @@ FT_BEGIN_HEADER
* We hope to also provide a kerning cache in the near future.
*
*
* @Order:
* @order:
* FTC_Manager
* FTC_FaceID
* FTC_Face_Requester
@ -144,7 +144,7 @@ FT_BEGIN_HEADER
/*************************************************************************
*
* @type: FTC_FaceID
* @type:
*
* @description:
* An opaque pointer type that is used to identity face objects. The
@ -181,7 +181,7 @@ FT_BEGIN_HEADER
* the cache manager to translate a given @FTC_FaceID into a new valid
* @FT_Face object, on demand.
*
* @Input:
* @input:
* face_id ::
* The face ID to resolve.
*
@ -191,14 +191,14 @@ FT_BEGIN_HEADER
* req_data ::
* Application-provided request data (see note below).
*
* @Output:
* @output:
* aface ::
* A new @FT_Face handle.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The third parameter `req_data' is the same as the one passed by the
* client when @FTC_Manager_New is called.
*
@ -228,10 +228,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FTC_Manager
*
* @Description:
* @description:
* This object corresponds to one instance of the cache-subsystem.
* It is used to cache one or more @FT_Face objects, along with
* corresponding @FT_Size objects.
@ -252,10 +252,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FTC_Node
*
* @Description:
* @description:
* An opaque handle to a cache node object. Each cache node is
* reference-counted. A node with a count of~0 might be flushed
* out of a full cache whenever a lookup request is performed.
@ -272,13 +272,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_Manager_New
*
* @Description:
* @description:
* Create a new cache manager.
*
* @Input:
* @input:
* library ::
* The parent FreeType library handle to use.
*
@ -303,12 +303,12 @@ FT_BEGIN_HEADER
* A generic pointer that is passed to the requester
* each time it is called (see @FTC_Face_Requester).
*
* @Output:
* @output:
* amanager ::
* A handle to a new manager object. 0~in case of
* failure.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -323,14 +323,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_Manager_Reset
*
* @Description:
* @description:
* Empty a given cache manager. This simply gets rid of all the
* currently cached @FT_Face and @FT_Size objects within the manager.
*
* @InOut:
* @inout:
* manager ::
* A handle to the manager.
*/
@ -340,13 +340,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_Manager_Done
*
* @Description:
* @description:
* Destroy a given manager after emptying it.
*
* @Input:
* @input:
* manager ::
* A handle to the target cache manager object.
*/
@ -356,28 +356,28 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_Manager_LookupFace
*
* @Description:
* @description:
* Retrieve the @FT_Face object that corresponds to a given face ID
* through a cache manager.
*
* @Input:
* @input:
* manager ::
* A handle to the cache manager.
*
* face_id ::
* The ID of the face object.
*
* @Output:
* @output:
* aface ::
* A handle to the face object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The returned @FT_Face object is always owned by the manager. You
* should never try to discard it yourself.
*
@ -405,15 +405,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FTC_ScalerRec
*
* @Description:
* @description:
* A structure used to describe a given character size in either
* pixels or points to the cache manager. See
* @FTC_Manager_LookupSize.
*
* @Fields:
* @fields:
* face_id ::
* The source face ID.
*
@ -436,7 +436,7 @@ FT_BEGIN_HEADER
* Only used when `pixel' is value~0 to indicate the
* vertical resolution in dpi.
*
* @Note:
* @note:
* This type is mainly used to retrieve @FT_Size objects through the
* cache manager.
*/
@ -454,10 +454,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FTC_Scaler
*
* @Description:
* @description:
* A handle to an @FTC_ScalerRec structure.
*/
typedef struct FTC_ScalerRec_* FTC_Scaler;
@ -465,28 +465,28 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_Manager_LookupSize
*
* @Description:
* @description:
* Retrieve the @FT_Size object that corresponds to a given
* @FTC_ScalerRec pointer through a cache manager.
*
* @Input:
* @input:
* manager ::
* A handle to the cache manager.
*
* scaler ::
* A scaler handle.
*
* @Output:
* @output:
* asize ::
* A handle to the size object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The returned @FT_Size object is always owned by the manager. You
* should never try to discard it by yourself.
*
@ -494,7 +494,7 @@ FT_BEGIN_HEADER
* if you need it. Note that this object is also owned by the
* manager.
*
* @Note:
* @note:
* When you perform a lookup, out-of-memory errors are detected
* _within_ the lookup and force incremental flushes of the cache
* until enough memory is released for the lookup to succeed.
@ -511,15 +511,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_Node_Unref
*
* @Description:
* @description:
* Decrement a cache node's internal reference count. When the count
* reaches 0, it is not destroyed but becomes eligible for subsequent
* cache flushes.
*
* @Input:
* @input:
* node ::
* The cache node handle.
*
@ -705,10 +705,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FTC_ImageCache
*
* @Description:
* @description:
* A handle to a glyph image cache object. They are designed to
* hold many distinct glyph images while not exceeding a certain
* memory threshold.
@ -718,21 +718,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_ImageCache_New
*
* @Description:
* @description:
* Create a new glyph image cache.
*
* @Input:
* @input:
* manager ::
* The parent manager for the image cache.
*
* @Output:
* @output:
* acache ::
* A handle to the new glyph image cache object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -742,13 +742,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_ImageCache_Lookup
*
* @Description:
* @description:
* Retrieve a given glyph image from a glyph image cache.
*
* @Input:
* @input:
* cache ::
* A handle to the source glyph image cache.
*
@ -758,7 +758,7 @@ FT_BEGIN_HEADER
* gindex ::
* The glyph index to retrieve.
*
* @Output:
* @output:
* aglyph ::
* The corresponding @FT_Glyph object. 0~in case of
* failure.
@ -768,10 +768,10 @@ FT_BEGIN_HEADER
* node after incrementing its reference count (see note
* below).
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The returned glyph is owned and managed by the glyph image cache.
* Never try to transform or discard it manually! You can however
* create a copy with @FT_Glyph_Copy and modify the new one.
@ -797,14 +797,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_ImageCache_LookupScaler
*
* @Description:
* @description:
* A variant of @FTC_ImageCache_Lookup that uses an @FTC_ScalerRec
* to specify the face ID and its size.
*
* @Input:
* @input:
* cache ::
* A handle to the source glyph image cache.
*
@ -817,7 +817,7 @@ FT_BEGIN_HEADER
* gindex ::
* The glyph index to retrieve.
*
* @Output:
* @output:
* aglyph ::
* The corresponding @FT_Glyph object. 0~in case of
* failure.
@ -827,10 +827,10 @@ FT_BEGIN_HEADER
* cache node after incrementing its reference count
* (see note below).
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The returned glyph is owned and managed by the glyph image cache.
* Never try to transform or discard it manually! You can however
* create a copy with @FT_Glyph_Copy and modify the new one.
@ -860,10 +860,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FTC_SBit
*
* @Description:
* @description:
* A handle to a small bitmap descriptor. See the @FTC_SBitRec
* structure for details.
*/
@ -872,13 +872,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FTC_SBitRec
*
* @Description:
* @description:
* A very compact structure used to describe a small glyph bitmap.
*
* @Fields:
* @fields:
* width ::
* The bitmap width in pixels.
*
@ -935,10 +935,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FTC_SBitCache
*
* @Description:
* @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
@ -949,21 +949,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_SBitCache_New
*
* @Description:
* @description:
* Create a new cache to store small glyph bitmaps.
*
* @Input:
* @input:
* manager ::
* A handle to the source cache manager.
*
* @Output:
* @output:
* acache ::
* A handle to the new sbit cache. NULL in case of error.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -973,14 +973,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_SBitCache_Lookup
*
* @Description:
* @description:
* Look up a given small glyph bitmap in a given sbit cache and
* `lock' it to prevent its flushing from the cache until needed.
*
* @Input:
* @input:
* cache ::
* A handle to the source sbit cache.
*
@ -990,7 +990,7 @@ FT_BEGIN_HEADER
* gindex ::
* The glyph index.
*
* @Output:
* @output:
* sbit ::
* A handle to a small bitmap descriptor.
*
@ -999,10 +999,10 @@ FT_BEGIN_HEADER
* node after incrementing its reference count (see note
* below).
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @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
@ -1031,14 +1031,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FTC_SBitCache_LookupScaler
*
* @Description:
* @description:
* A variant of @FTC_SBitCache_Lookup that uses an @FTC_ScalerRec
* to specify the face ID and its size.
*
* @Input:
* @input:
* cache ::
* A handle to the source sbit cache.
*
@ -1051,7 +1051,7 @@ FT_BEGIN_HEADER
* gindex ::
* The glyph index.
*
* @Output:
* @output:
* sbit ::
* A handle to a small bitmap descriptor.
*
@ -1060,10 +1060,10 @@ FT_BEGIN_HEADER
* cache node after incrementing its reference count
* (see note below).
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @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

42
include/freetype/ftchapters.h
Unescape View File

@ -8,13 +8,13 @@
/****************************************************************************
*
* @Chapter:
* @chapter:
* general_remarks
*
* @Title:
* @title:
* General Remarks
*
* @Sections:
* @sections:
* header_inclusion
* user_allocation
*
@ -23,13 +23,13 @@
/****************************************************************************
*
* @Chapter:
* @chapter:
* core_api
*
* @Title:
* @title:
* Core API
*
* @Sections:
* @sections:
* version
* basic_types
* base_interface
@ -44,13 +44,13 @@
/****************************************************************************
*
* @Chapter:
* @chapter:
* format_specific
*
* @Title:
* @title:
* Format-Specific API
*
* @Sections:
* @sections:
* multiple_masters
* truetype_tables
* type1_tables
@ -67,13 +67,13 @@
/****************************************************************************
*
* @Chapter:
* @chapter:
* module_specific
*
* @Title:
* @title:
* Controlling FreeType Modules
*
* @Sections:
* @sections:
* auto_hinter
* cff_driver
* t1_cid_driver
@ -88,13 +88,13 @@
/****************************************************************************
*
* @Chapter:
* @chapter:
* cache_subsystem
*
* @Title:
* @title:
* Cache Sub-System
*
* @Sections:
* @sections:
* cache_subsystem
*
*/
@ -102,13 +102,13 @@
/****************************************************************************
*
* @Chapter:
* @chapter:
* support_api
*
* @Title:
* @title:
* Support API
*
* @Sections:
* @sections:
* computations
* list_processing
* outline_processing
@ -127,13 +127,13 @@
/****************************************************************************
*
* @Chapter:
* @chapter:
* error_codes
*
* @Title:
* @title:
* Error Codes
*
* @Sections:
* @sections:
* error_enumerations
* error_code_values
*

8
include/freetype/ftcid.h
Unescape View File

@ -34,16 +34,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* cid_fonts
*
* @Title:
* @title:
* CID Fonts
*
* @Abstract:
* @abstract:
* CID-keyed font specific API.
*
* @Description:
* @description:
* This section contains the declaration of CID-keyed font specific
* functions.
*

2
include/freetype/ftcolor.h
Unescape View File

@ -135,7 +135,7 @@ FT_BEGIN_HEADER
* NULL if the font's `CPAL' table doesn't contain appropriate data.
*
* palette_types ::
* A read-only array of palette types with `num_palettes' elements.
* A read-only array of palette types with `num_palettes' elements.
* Possible values are an ORed combination of
* @FT_PALETTE_USABLE_WITH_LIGHT_BACKGROUND and
* @FT_PALETTE_USABLE_WITH_DARK_BACKGROUND.

10
include/freetype/fterrdef.h
Unescape View File

@ -18,16 +18,16 @@
/**************************************************************************
*
* @Section:
* @section:
* error_code_values
*
* @Title:
* @title:
* Error Code Values
*
* @Abstract:
* @abstract:
* All possible error codes returned by FreeType functions.
*
* @Description:
* @description:
* The list below is taken verbatim from the file `fterrdef.h'
* (loaded automatically by including `FT_FREETYPE_H'). The first
* argument of the `FT_ERROR_DEF_' macro is the error label; by
@ -49,7 +49,7 @@
/**************************************************************************
*
* @Enum:
* @enum:
* FT_Err_XXX
*
*/

8
include/freetype/fterrors.h
Unescape View File

@ -18,16 +18,16 @@
/**************************************************************************
*
* @Section:
* @section:
* error_enumerations
*
* @Title:
* @title:
* Error Enumerations
*
* @Abstract:
* @abstract:
* How to handle errors and error strings.
*
* @Description:
* @description:
* The header file `fterrors.h' (which is automatically included by
* `freetype.h' defines the handling of FreeType's enumeration
* constants. It can also be used to generate error message strings

18
include/freetype/ftfntfmt.h
Unescape View File

@ -34,16 +34,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* font_formats
*
* @Title:
* @title:
* Font Formats
*
* @Abstract:
* @abstract:
* Getting the font format.
*
* @Description:
* @description:
* The single function in this section can be used to get the font
* format. Note that this information is not needed normally;
* however, there are special cases (like in PDF devices) where it is
@ -54,24 +54,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Font_Format
*
* @Description:
* @description:
* Return a string describing the format of a given face. Possible
* values are `TrueType', `Type~1', `BDF', `PCF', `Type~42',
* `CID~Type~1', `CFF', `PFR', and `Windows~FNT'.
*
* The return value is suitable to be used as an X11 FONT_PROPERTY.
*
* @Input:
* @input:
* face ::
* Input face handle.
*
* @Return:
* @return:
* Font format string. NULL in case of error.
*
* @Note:
* @note:
* A deprecated name for the same function is
* `FT_Get_X11_Font_Format'.
*/

132
include/freetype/ftglyph.h
Unescape View File

@ -48,16 +48,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* glyph_management
*
* @Title:
* @title:
* Glyph Management
*
* @Abstract:
* @abstract:
* Generic interface to manage individual glyph data.
*
* @Description:
* @description:
* This section contains definitions used to manage glyph data
* through generic FT_Glyph objects. Each of them can contain a
* bitmap, a vector outline, or even images in other formats.
@ -71,15 +71,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Glyph
*
* @Description:
* @description:
* Handle to an object used to model generic glyph images. It is a
* pointer to the @FT_GlyphRec structure and can contain a glyph
* bitmap or pointer.
*
* @Note:
* @note:
* Glyph objects are not owned by the library. You must thus release
* them manually (through @FT_Done_Glyph) _before_ calling
* @FT_Done_FreeType.
@ -89,14 +89,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_GlyphRec
*
* @Description:
* @description:
* The root glyph structure contains a given glyph image plus its
* advance width in 16.16 fixed-point format.
*
* @Fields:
* @fields:
* library ::
* A handle to the FreeType library object.
*
@ -121,10 +121,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_BitmapGlyph
*
* @Description:
* @description:
* A handle to an object used to model a bitmap glyph image. This is
* a sub-class of @FT_Glyph, and a pointer to @FT_BitmapGlyphRec.
*/
@ -133,14 +133,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_BitmapGlyphRec
*
* @Description:
* @description:
* A structure used for bitmap glyph images. This really is a
* `sub-class' of @FT_GlyphRec.
*
* @Fields:
* @fields:
* root ::
* The root @FT_Glyph fields.
*
@ -157,7 +157,7 @@ FT_BEGIN_HEADER
* bitmap ::
* A descriptor for the bitmap.
*
* @Note:
* @note:
* You can typecast an @FT_Glyph to @FT_BitmapGlyph if you have
* `glyph->format == FT_GLYPH_FORMAT_BITMAP'. This lets you access
* the bitmap's contents easily.
@ -177,10 +177,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_OutlineGlyph
*
* @Description:
* @description:
* A handle to an object used to model an outline glyph image. This
* is a sub-class of @FT_Glyph, and a pointer to @FT_OutlineGlyphRec.
*/
@ -189,21 +189,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_OutlineGlyphRec
*
* @Description:
* @description:
* A structure used for outline (vectorial) glyph images. This
* really is a `sub-class' of @FT_GlyphRec.
*
* @Fields:
* @fields:
* root ::
* The root @FT_Glyph fields.
*
* outline ::
* A descriptor for the outline.
*
* @Note:
* @note:
* You can typecast an @FT_Glyph to @FT_OutlineGlyph if you have
* `glyph->format == FT_GLYPH_FORMAT_OUTLINE'. This lets you access
* the outline's content easily.
@ -225,25 +225,25 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Glyph
*
* @Description:
* @description:
* A function used to extract a glyph image from a slot. Note that
* the created @FT_Glyph object must be released with @FT_Done_Glyph.
*
* @Input:
* @input:
* slot ::
* A handle to the source glyph slot.
*
* @Output:
* @output:
* aglyph ::
* A handle to the glyph object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* Because `*aglyph->advance.x' and `*aglyph->advance.y' are 16.16
* fixed-point numbers, `slot->advance.x' and `slot->advance.y'
* (which are in 26.6 fixed-point format) must be in the range
@ -256,23 +256,23 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Glyph_Copy
*
* @Description:
* @description:
* A function used to copy a glyph image. Note that the created
* @FT_Glyph object must be released with @FT_Done_Glyph.
*
* @Input:
* @input:
* source ::
* A handle to the source glyph object.
*
* @Output:
* @output:
* target ::
* A handle to the target glyph object. 0~in case of
* error.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -282,17 +282,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Glyph_Transform
*
* @Description:
* @description:
* Transform a glyph image if its format is scalable.
*
* @InOut:
* @inout:
* glyph ::
* A handle to the target glyph object.
*
* @Input:
* @input:
* matrix ::
* A pointer to a 2x2 matrix to apply.
*
@ -300,10 +300,10 @@ FT_BEGIN_HEADER
* A pointer to a 2d vector to apply. Coordinates are
* expressed in 1/64th of a pixel.
*
* @Return:
* @return:
* FreeType error code (if not 0, the glyph format is not scalable).
*
* @Note:
* @note:
* The 2x2 transformation matrix is also applied to the glyph's
* advance vector.
*/
@ -315,13 +315,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Enum:
* @enum:
* FT_Glyph_BBox_Mode
*
* @Description:
* @description:
* The mode how the values of @FT_Glyph_Get_CBox are returned.
*
* @Values:
* @values:
* FT_GLYPH_BBOX_UNSCALED ::
* Return unscaled font units.
*
@ -359,10 +359,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Glyph_Get_CBox
*
* @Description:
* @description:
* Return a glyph's `control box'. The control box encloses all the
* outline's points, including Bezier control points. Though it
* coincides with the exact bounding box for most glyphs, it can be
@ -374,7 +374,7 @@ FT_BEGIN_HEADER
* and arcs in the outline. To get the latter, you can use the
* `ftbbox' component, which is dedicated to this single task.
*
* @Input:
* @input:
* glyph ::
* A handle to the source glyph object.
*
@ -382,12 +382,12 @@ FT_BEGIN_HEADER
* The mode that indicates how to interpret the returned
* bounding box values.
*
* @Output:
* @output:
* acbox ::
* The glyph coordinate bounding box. Coordinates are
* expressed in 1/64th of pixels if it is grid-fitted.
*
* @Note:
* @note:
* Coordinates are relative to the glyph origin, using the y~upwards
* convention.
*
@ -437,17 +437,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Glyph_To_Bitmap
*
* @Description:
* @description:
* Convert a given glyph object to a bitmap glyph object.
*
* @InOut:
* @inout:
* the_glyph ::
* A pointer to a handle to the target glyph.
*
* @Input:
* @input:
* render_mode ::
* An enumeration that describes how the data is
* rendered.
@ -463,10 +463,10 @@ FT_BEGIN_HEADER
* image should be destroyed by this function. It is
* never destroyed in case of error.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* This function does nothing if the glyph format isn't scalable.
*
* The glyph image is translated with the `origin' vector before
@ -554,13 +554,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Done_Glyph
*
* @Description:
* @description:
* Destroy a given glyph.
*
* @Input:
* @input:
* glyph ::
* A handle to the target glyph object.
*/
@ -574,7 +574,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* computations
*
*/
@ -582,21 +582,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Matrix_Multiply
*
* @Description:
* @description:
* Perform the matrix operation `b = a*b'.
*
* @Input:
* @input:
* a ::
* A pointer to matrix `a'.
*
* @InOut:
* @inout:
* b ::
* A pointer to matrix `b'.
*
* @Note:
* @note:
* The result is undefined if either `a' or `b' is zero.
*
* Since the function uses wrap-around arithmetic, results become
@ -609,18 +609,18 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Matrix_Invert
*
* @Description:
* @description:
* Invert a 2x2 matrix. Return an error if it can't be inverted.
*
* @InOut:
* @inout:
* matrix ::
* A pointer to the target matrix. Remains untouched in
* case of error.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )

10
include/freetype/ftgxval.h
Unescape View File

@ -43,21 +43,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* gx_validation
*
* @Title:
* @title:
* TrueTypeGX/AAT Validation
*
* @Abstract:
* @abstract:
* An API to validate TrueTypeGX/AAT tables.
*
* @Description:
* @description:
* This section contains the declaration of functions to validate
* some TrueTypeGX tables (feat, mort, morx, bsln, just, kern, opbd,
* trak, prop, lcar).
*
* @Order:
* @order:
* FT_TrueTypeGX_Validate
* FT_TrueTypeGX_Free
*

8
include/freetype/ftgzip.h
Unescape View File

@ -33,16 +33,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* gzip
*
* @Title:
* @title:
* GZIP Streams
*
* @Abstract:
* @abstract:
* Using gzip-compressed font files.
*
* @Description:
* @description:
* This section contains the declaration of Gzip-specific functions.
*
*/

204
include/freetype/ftimage.h
Unescape View File

@ -39,7 +39,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* basic_types
*
*/
@ -47,10 +47,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Pos
*
* @Description:
* @description:
* The type FT_Pos is used to store vectorial coordinates. Depending
* on the context, these can represent distances in integer font
* units, or 16.16, or 26.6 fixed-point pixel coordinates.
@ -60,14 +60,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Vector
*
* @Description:
* @description:
* A simple structure used to store a 2D vector; coordinates are of
* the FT_Pos type.
*
* @Fields:
* @fields:
* x ::
* The horizontal coordinate.
* y ::
@ -83,15 +83,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_BBox
*
* @Description:
* @description:
* A structure used to hold an outline's bounding box, i.e., the
* coordinates of its extrema in the horizontal and vertical
* directions.
*
* @Fields:
* @fields:
* xMin ::
* The horizontal minimum (left-most).
*
@ -104,7 +104,7 @@ FT_BEGIN_HEADER
* yMax ::
* The vertical maximum (top-most).
*
* @Note:
* @note:
* The bounding box is specified with the coordinates of the lower
* left and the upper right corner. In PostScript, those values are
* often called (llx,lly) and (urx,ury), respectively.
@ -128,15 +128,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Enum:
* @enum:
* FT_Pixel_Mode
*
* @Description:
* @description:
* An enumeration type used to describe the format of pixels in a
* given bitmap. Note that additional formats may be added in the
* future.
*
* @Values:
* @values:
* FT_PIXEL_MODE_NONE ::
* Value~0 is reserved.
*
@ -210,15 +210,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Bitmap
*
* @Description:
* @description:
* A structure used to describe a bitmap or pixmap to the raster.
* Note that we now manage pixmaps of various depths through the
* `pixel_mode' field.
*
* @Fields:
* @fields:
* rows ::
* The number of bitmap rows.
*
@ -288,7 +288,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* outline_processing
*
*/
@ -296,14 +296,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Outline
*
* @Description:
* @description:
* This structure is used to describe an outline to the scan-line
* converter.
*
* @Fields:
* @fields:
* n_contours ::
* The number of contours in the outline.
*
@ -345,7 +345,7 @@ FT_BEGIN_HEADER
* and give hints to the scan-converter and hinter on
* how to convert/grid-fit it. See @FT_OUTLINE_XXX.
*
* @Note:
* @note:
* The B/W rasterizer only checks bit~2 in the `tags' array for the
* first point of each contour. The drop-out mode as given with
* @FT_OUTLINE_IGNORE_DROPOUTS, @FT_OUTLINE_SMART_DROPOUTS, and
@ -374,14 +374,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Enum:
* @enum:
* FT_OUTLINE_XXX
*
* @Description:
* @description:
* A list of bit-field constants use for the flags in an outline's
* `flags' field.
*
* @Values:
* @values:
* FT_OUTLINE_NONE ::
* Value~0 is reserved.
*
@ -432,7 +432,7 @@ FT_BEGIN_HEADER
* a hint that might be completely ignored by a given
* scan-converter.
*
* @Note:
* @note:
* The flags @FT_OUTLINE_IGNORE_DROPOUTS, @FT_OUTLINE_SMART_DROPOUTS,
* and @FT_OUTLINE_INCLUDE_STUBS are ignored by the smooth
* rasterizer.
@ -491,16 +491,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Outline_MoveToFunc
*
* @Description:
* @description:
* A function pointer type used to describe the signature of a `move
* to' function during outline walking/decomposition.
*
* A `move to' is emitted to start a new contour in an outline.
*
* @Input:
* @input:
* to ::
* A pointer to the target point of the `move to'.
*
@ -508,7 +508,7 @@ FT_BEGIN_HEADER
* A typeless pointer, which is passed from the caller of the
* decomposition function.
*
* @Return:
* @return:
* Error code. 0~means success.
*/
typedef int
@ -520,16 +520,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Outline_LineToFunc
*
* @Description:
* @description:
* A function pointer type used to describe the signature of a `line
* to' function during outline walking/decomposition.
*
* A `line to' is emitted to indicate a segment in the outline.
*
* @Input:
* @input:
* to ::
* A pointer to the target point of the `line to'.
*
@ -537,7 +537,7 @@ FT_BEGIN_HEADER
* A typeless pointer, which is passed from the caller of the
* decomposition function.
*
* @Return:
* @return:
* Error code. 0~means success.
*/
typedef int
@ -549,17 +549,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Outline_ConicToFunc
*
* @Description:
* @description:
* A function pointer type used to describe the signature of a `conic
* to' function during outline walking or decomposition.
*
* A `conic to' is emitted to indicate a second-order Bezier arc in
* the outline.
*
* @Input:
* @input:
* control ::
* An intermediate control point between the last position
* and the new target in `to'.
@ -571,7 +571,7 @@ FT_BEGIN_HEADER
* A typeless pointer, which is passed from the caller of
* the decomposition function.
*
* @Return:
* @return:
* Error code. 0~means success.
*/
typedef int
@ -584,16 +584,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Outline_CubicToFunc
*
* @Description:
* @description:
* A function pointer type used to describe the signature of a `cubic
* to' function during outline walking or decomposition.
*
* A `cubic to' is emitted to indicate a third-order Bezier arc.
*
* @Input:
* @input:
* control1 ::
* A pointer to the first Bezier control point.
*
@ -607,7 +607,7 @@ FT_BEGIN_HEADER
* A typeless pointer, which is passed from the caller of
* the decomposition function.
*
* @Return:
* @return:
* Error code. 0~means success.
*/
typedef int
@ -621,14 +621,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Outline_Funcs
*
* @Description:
* @description:
* A structure to hold various function pointers used during outline
* decomposition in order to emit segments, conic, and cubic Beziers.
*
* @Fields:
* @fields:
* move_to ::
* The `move to' emitter.
*
@ -649,7 +649,7 @@ FT_BEGIN_HEADER
* The delta that is applied to coordinates before they
* are sent to the emitter, but after the shift.
*
* @Note:
* @note:
* The point coordinates sent to the emitters are the transformed
* version of the original coordinates (this is important for high
* accuracy during scan-conversion). The transformation is simple:
@ -677,7 +677,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* basic_types
*
*/
@ -685,13 +685,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Macro:
* @macro:
* FT_IMAGE_TAG
*
* @Description:
* @description:
* This macro converts four-letter tags to an unsigned long type.
*
* @Note:
* @note:
* Since many 16-bit compilers don't like 32-bit enumerations, you
* should redefine this macro in case of problems to something like
* this:
@ -713,16 +713,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Enum:
* @enum:
* FT_Glyph_Format
*
* @Description:
* @description:
* An enumeration type used to describe the format of a given glyph
* image. Note that this version of FreeType only supports two image
* formats, even though future font drivers will be able to register
* their own format.
*
* @Values:
* @values:
* FT_GLYPH_FORMAT_NONE ::
* The value~0 is reserved.
*
@ -795,19 +795,19 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* raster
*
* @Title:
* @title:
* Scanline Converter
*
* @Abstract:
* @abstract:
* How vectorial outlines are converted into bitmaps and pixmaps.
*
* @Description:
* @description:
* This section contains technical definitions.
*
* @Order:
* @order:
* FT_Raster
* FT_Span
* FT_SpanFunc
@ -827,10 +827,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Raster
*
* @Description:
* @description:
* An opaque handle (pointer) to a raster object. Each object can be
* used independently to convert an outline into a bitmap or pixmap.
*/
@ -839,14 +839,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Span
*
* @Description:
* @description:
* A structure used to model a single span of gray pixels when
* rendering an anti-aliased bitmap.
*
* @Fields:
* @fields:
* x ::
* The span's horizontal start position.
*
@ -857,7 +857,7 @@ FT_BEGIN_HEADER
* The span color/coverage, ranging from 0 (background)
* to 255 (foreground).
*
* @Note:
* @note:
* This structure is used by the span drawing callback type named
* @FT_SpanFunc that takes the y~coordinate of the span as a
* parameter.
@ -876,15 +876,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_SpanFunc
*
* @Description:
* @description:
* A function used as a call-back by the anti-aliased renderer in
* order to let client applications draw themselves the gray pixel
* spans on each scan line.
*
* @Input:
* @input:
* y ::
* The scanline's y~coordinate.
*
@ -897,7 +897,7 @@ FT_BEGIN_HEADER
* user ::
* User-supplied data that is passed to the callback.
*
* @Note:
* @note:
* This callback allows client applications to directly render the
* gray spans of the anti-aliased bitmap to any kind of surfaces.
*
@ -915,10 +915,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Raster_BitTest_Func
*
* @Description:
* @description:
* Deprecated, unimplemented.
*/
typedef int
@ -929,10 +929,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Raster_BitSet_Func
*
* @Description:
* @description:
* Deprecated, unimplemented.
*/
typedef void
@ -943,14 +943,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Enum:
* @enum:
* FT_RASTER_FLAG_XXX
*
* @Description:
* @description:
* A list of bit flag constants as used in the `flags' field of a
* @FT_Raster_Params structure.
*
* @Values:
* @values:
* FT_RASTER_FLAG_DEFAULT ::
* This value is 0.
*
@ -1000,14 +1000,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Raster_Params
*
* @Description:
* @description:
* A structure to hold the arguments used by a raster's render
* function.
*
* @Fields:
* @fields:
* target ::
* The target bitmap.
*
@ -1040,7 +1040,7 @@ FT_BEGIN_HEADER
* should be expressed in _integer_ pixels (and not in
* 26.6 fixed-point units).
*
* @Note:
* @note:
* An anti-aliased glyph bitmap is drawn if the @FT_RASTER_FLAG_AA
* bit flag is set in the `flags' field, otherwise a monochrome
* bitmap is generated.
@ -1068,24 +1068,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Raster_NewFunc
*
* @Description:
* @description:
* A function used to create a new raster object.
*
* @Input:
* @input:
* memory ::
* A handle to the memory allocator.
*
* @Output:
* @output:
* raster ::
* A handle to the new raster object.
*
* @Return:
* @return:
* Error code. 0~means success.
*
* @Note:
* @note:
* The `memory' parameter is a typeless pointer in order to avoid
* un-wanted dependencies on the rest of the FreeType code. In
* practice, it is an @FT_Memory object, i.e., a handle to the
@ -1101,13 +1101,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Raster_DoneFunc
*
* @Description:
* @description:
* A function used to destroy a given raster object.
*
* @Input:
* @input:
* raster ::
* A handle to the raster object.
*/
@ -1119,17 +1119,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Raster_ResetFunc
*
* @Description:
* @description:
* FreeType used to provide an area of memory called the `render
* pool' available to all registered rasterizers. This was not
* thread safe, however, and now FreeType never allocates this pool.
*
* This function is called after a new raster object is created.
*
* @Input:
* @input:
* raster ::
* A handle to the new raster object.
*
@ -1141,7 +1141,7 @@ FT_BEGIN_HEADER
* Previously, the size in bytes of the render pool.
* Set this to 0.
*
* @Note:
* @note:
* Rasterizers should rely on dynamic or stack allocation if they
* want to (a handle to the memory allocator is passed to the
* rasterizer constructor).
@ -1156,16 +1156,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Raster_SetModeFunc
*
* @Description:
* @description:
* This function is a generic facility to change modes or attributes
* in a given raster. This can be used for debugging purposes, or
* simply to allow implementation-specific `features' in a given
* raster module.
*
* @Input:
* @input:
* raster ::
* A handle to the new raster object.
*
@ -1185,14 +1185,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Raster_RenderFunc
*
* @Description:
* @description:
* Invoke a given raster to scan-convert a given glyph image into a
* target bitmap.
*
* @Input:
* @input:
* raster ::
* A handle to the raster object.
*
@ -1200,10 +1200,10 @@ FT_BEGIN_HEADER
* A pointer to an @FT_Raster_Params structure used to
* store the rendering parameters.
*
* @Return:
* @return:
* Error code. 0~means success.
*
* @Note:
* @note:
* The exact format of the source image depends on the raster's glyph
* format defined in its @FT_Raster_Funcs structure. It can be an
* @FT_Outline or anything else in order to support a large array of
@ -1228,13 +1228,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Raster_Funcs
*
* @Description:
* @description:
* A structure used to describe a given raster class to the library.
*
* @Fields:
* @fields:
* glyph_format ::
* The supported glyph format for this raster.
*

72
include/freetype/ftlist.h
Unescape View File

@ -43,20 +43,20 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* list_processing
*
* @Title:
* @title:
* List Processing
*
* @Abstract:
* @abstract:
* Simple management of lists.
*
* @Description:
* @description:
* This section contains various definitions related to list
* processing using doubly-linked nodes.
*
* @Order:
* @order:
* FT_List
* FT_ListNode
* FT_ListRec
@ -77,19 +77,19 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_List_Find
*
* @Description:
* @description:
* Find the list node for a given listed object.
*
* @Input:
* @input:
* list ::
* A pointer to the parent list.
* data ::
* The address of the listed object.
*
* @Return:
* @return:
* List node. NULL if it wasn't found.
*/
FT_EXPORT( FT_ListNode )
@ -99,13 +99,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_List_Add
*
* @Description:
* @description:
* Append an element to the end of a list.
*
* @InOut:
* @inout:
* list ::
* A pointer to the parent list.
* node ::
@ -118,13 +118,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_List_Insert
*
* @Description:
* @description:
* Insert an element at the head of a list.
*
* @InOut:
* @inout:
* list ::
* A pointer to parent list.
* node ::
@ -137,18 +137,18 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_List_Remove
*
* @Description:
* @description:
* Remove a node from a list. This function doesn't check whether
* the node is in the list!
*
* @Input:
* @input:
* node ::
* The node to remove.
*
* @InOut:
* @inout:
* list ::
* A pointer to the parent list.
*/
@ -159,14 +159,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_List_Up
*
* @Description:
* @description:
* Move a node to the head/top of a list. Used to maintain LRU
* lists.
*
* @InOut:
* @inout:
* list ::
* A pointer to the parent list.
* node ::
@ -179,14 +179,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_List_Iterator
*
* @Description:
* @description:
* An FT_List iterator function that is called during a list parse
* by @FT_List_Iterate.
*
* @Input:
* @input:
* node ::
* The current iteration list node.
*
@ -201,15 +201,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_List_Iterate
*
* @Description:
* @description:
* Parse a list and calls a given iterator function on each element.
* Note that parsing is stopped as soon as one of the iterator calls
* returns a non-zero value.
*
* @Input:
* @input:
* list ::
* A handle to the list.
* iterator ::
@ -218,7 +218,7 @@ FT_BEGIN_HEADER
* A user-supplied field that is passed as the second
* argument to the iterator.
*
* @Return:
* @return:
* The result (a FreeType error code) of the last iterator call.
*/
FT_EXPORT( FT_Error )
@ -229,15 +229,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_List_Destructor
*
* @Description:
* @description:
* An @FT_List iterator function that is called during a list
* finalization by @FT_List_Finalize to destroy all elements in a
* given list.
*
* @Input:
* @input:
* system ::
* The current system object.
*
@ -256,13 +256,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_List_Finalize
*
* @Description:
* @description:
* Destroy all elements in the list as well as the list itself.
*
* @Input:
* @input:
* list ::
* A handle to the list.
*
@ -277,7 +277,7 @@ FT_BEGIN_HEADER
* A user-supplied field that is passed as the last
* argument to the destructor.
*
* @Note:
* @note:
* This function expects that all nodes added by @FT_List_Add or
* @FT_List_Insert have been dynamically allocated.
*/

8
include/freetype/ftlzw.h
Unescape View File

@ -33,16 +33,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* lzw
*
* @Title:
* @title:
* LZW Streams
*
* @Abstract:
* @abstract:
* Using LZW-compressed font files.
*
* @Description:
* @description:
* This section contains the declaration of LZW-specific functions.
*
*/

80
include/freetype/ftmac.h
Unescape View File

@ -49,16 +49,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* mac_specific
*
* @Title:
* @title:
* Mac Specific Interface
*
* @Abstract:
* @abstract:
* Only available on the Macintosh.
*
* @Description:
* @description:
* The following definitions are only available if FreeType is
* compiled on a Macintosh.
*
@ -67,17 +67,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_New_Face_From_FOND
*
* @Description:
* @description:
* Create a new face object from a FOND resource.
*
* @InOut:
* @inout:
* library ::
* A handle to the library resource.
*
* @Input:
* @input:
* fond ::
* A FOND resource.
*
@ -85,14 +85,14 @@ FT_BEGIN_HEADER
* Only supported for the -1 `sanity check' special
* case.
*
* @Output:
* @output:
* aface ::
* A handle to a new face object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* This function can be used to create @FT_Face objects from fonts
* that are installed in the system as follows.
*
@ -111,18 +111,18 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_GetFile_From_Mac_Name
*
* @Description:
* @description:
* Return an FSSpec for the disk file containing the named font.
*
* @Input:
* @input:
* fontName ::
* Mac OS name of the font (e.g., Times New Roman
* Bold).
*
* @Output:
* @output:
* pathSpec ::
* FSSpec to the file. For passing to
* @FT_New_Face_From_FSSpec.
@ -131,7 +131,7 @@ FT_BEGIN_HEADER
* Index of the face. For passing to
* @FT_New_Face_From_FSSpec.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -143,17 +143,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_GetFile_From_Mac_ATS_Name
*
* @Description:
* @description:
* Return an FSSpec for the disk file containing the named font.
*
* @Input:
* @input:
* fontName ::
* Mac OS name of the font in ATS framework.
*
* @Output:
* @output:
* pathSpec ::
* FSSpec to the file. For passing to
* @FT_New_Face_From_FSSpec.
@ -162,7 +162,7 @@ FT_BEGIN_HEADER
* Index of the face. For passing to
* @FT_New_Face_From_FSSpec.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -174,18 +174,18 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_GetFilePath_From_Mac_ATS_Name
*
* @Description:
* @description:
* Return a pathname of the disk file and face index for given font
* name that is handled by ATS framework.
*
* @Input:
* @input:
* fontName ::
* Mac OS name of the font in ATS framework.
*
* @Output:
* @output:
* path ::
* Buffer to store pathname of the file. For passing
* to @FT_New_Face. The client must allocate this
@ -197,7 +197,7 @@ FT_BEGIN_HEADER
* face_index ::
* Index of the face. For passing to @FT_New_Face.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -210,32 +210,32 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_New_Face_From_FSSpec
*
* @Description:
* @description:
* Create a new face object from a given resource and typeface index
* using an FSSpec to the font file.
*
* @InOut:
* @inout:
* library ::
* A handle to the library resource.
*
* @Input:
* @input:
* spec ::
* FSSpec to the font file.
*
* face_index ::
* The index of the face within the resource. The
* first face has index~0.
* @Output:
* @output:
* aface ::
* A handle to a new face object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* @FT_New_Face_From_FSSpec is identical to @FT_New_Face except
* it accepts an FSSpec instead of a path.
*/
@ -249,32 +249,32 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_New_Face_From_FSRef
*
* @Description:
* @description:
* Create a new face object from a given resource and typeface index
* using an FSRef to the font file.
*
* @InOut:
* @inout:
* library ::
* A handle to the library resource.
*
* @Input:
* @input:
* spec ::
* FSRef to the font file.
*
* face_index ::
* The index of the face within the resource. The
* first face has index~0.
* @Output:
* @output:
* aface ::
* A handle to a new face object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* @FT_New_Face_From_FSRef is identical to @FT_New_Face except
* it accepts an FSRef instead of a path.
*/

170
include/freetype/ftmm.h
Unescape View File

@ -29,16 +29,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* multiple_masters
*
* @Title:
* @title:
* Multiple Masters
*
* @Abstract:
* @abstract:
* How to manage Multiple Masters fonts.
*
* @Description:
* @description:
* The following types and functions are used to manage Multiple
* Master fonts, i.e., the selection of specific design instances by
* setting design axis coordinates.
@ -53,17 +53,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_MM_Axis
*
* @Description:
* @description:
* A structure to model a given axis in design space for Multiple
* Masters fonts.
*
* This structure can't be used for TrueType GX or OpenType variation
* fonts.
*
* @Fields:
* @fields:
* name ::
* The axis's name.
*
@ -84,17 +84,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Multi_Master
*
* @Description:
* @description:
* A structure to model the axes and space of a Multiple Masters
* font.
*
* This structure can't be used for TrueType GX or OpenType variation
* fonts.
*
* @Fields:
* @fields:
* num_axis ::
* Number of axes. Cannot exceed~4.
*
@ -118,14 +118,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Var_Axis
*
* @Description:
* @description:
* A structure to model a given axis in design space for Multiple
* Masters, TrueType GX, and OpenType variation fonts.
*
* @Fields:
* @fields:
* name ::
* The axis's name.
* Not always meaningful for TrueType GX or OpenType
@ -153,7 +153,7 @@ FT_BEGIN_HEADER
* field for TrueType GX or OpenType variation fonts. Not
* meaningful for Adobe MM fonts.
*
* @Note:
* @note:
* The fields `minimum', `def', and `maximum' are 16.16 fractional
* values for TrueType GX and OpenType variation fonts. For Adobe MM
* fonts, the values are integers.
@ -174,16 +174,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Var_Named_Style
*
* @Description:
* @description:
* A structure to model a named instance in a TrueType GX or OpenType
* variation font.
*
* This structure can't be used for Adobe MM fonts.
*
* @Fields:
* @fields:
* coords ::
* The design coordinates for this instance.
* This is an array with one entry for each axis.
@ -207,16 +207,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_MM_Var
*
* @Description:
* @description:
* A structure to model the axes and space of an Adobe MM, TrueType
* GX, or OpenType variation font.
*
* Some fields are specific to one format and not to the others.
*
* @Fields:
* @fields:
* num_axis ::
* The number of axes. The maximum value is~4 for
* Adobe MM fonts; no limit in TrueType GX or
@ -267,24 +267,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Multi_Master
*
* @Description:
* @description:
* Retrieve a variation descriptor of a given Adobe MM font.
*
* This function can't be used with TrueType GX or OpenType variation
* fonts.
*
* @Input:
* @input:
* face ::
* A handle to the source face.
*
* @Output:
* @output:
* amaster ::
* The Multiple Masters descriptor.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -294,25 +294,25 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_MM_Var
*
* @Description:
* @description:
* Retrieve a variation descriptor for a given font.
*
* This function works with all supported variation formats.
*
* @Input:
* @input:
* face ::
* A handle to the source face.
*
* @Output:
* @output:
* amaster ::
* The variation descriptor.
* Allocates a data structure, which the user must
* deallocate with a call to @FT_Done_MM_Var after use.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -322,18 +322,18 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Done_MM_Var
*
* @Description:
* @description:
* Free the memory allocated by @FT_Get_MM_Var.
*
* @Input:
* @input:
* library ::
* A handle of the face's parent library object that was
* used in the call to @FT_Get_MM_Var to create `amaster'.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -343,21 +343,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Set_MM_Design_Coordinates
*
* @Description:
* @description:
* For Adobe MM fonts, choose an interpolated font design through
* design coordinates.
*
* This function can't be used with TrueType GX or OpenType variation
* fonts.
*
* @InOut:
* @inout:
* face ::
* A handle to the source face.
*
* @Input:
* @input:
* num_coords ::
* The number of available design coordinates. If it
* is larger than the number of axes, ignore the excess
@ -367,10 +367,10 @@ FT_BEGIN_HEADER
* coords ::
* An array of design coordinates.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* [Since 2.8.1] To reset all axes to the default values, call the
* function with `num_coords' set to zero and `coords' set to NULL.
*
@ -387,19 +387,19 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Set_Var_Design_Coordinates
*
* @Description:
* @description:
* Choose an interpolated font design through design coordinates.
*
* This function works with all supported variation formats.
*
* @InOut:
* @inout:
* face ::
* A handle to the source face.
*
* @Input:
* @input:
* num_coords ::
* The number of available design coordinates. If it
* is larger than the number of axes, ignore the excess
@ -409,10 +409,10 @@ FT_BEGIN_HEADER
* coords ::
* An array of design coordinates.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* [Since 2.8.1] To reset all axes to the default values, call the
* function with `num_coords' set to zero and `coords' set to NULL.
* [Since 2.9] `Default values' means the currently selected named
@ -431,16 +431,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Var_Design_Coordinates
*
* @Description:
* @description:
* Get the design coordinates of the currently selected interpolated
* font.
*
* This function works with all supported variation formats.
*
* @Input:
* @input:
* face ::
* A handle to the source face.
*
@ -449,14 +449,14 @@ FT_BEGIN_HEADER
* is larger than the number of axes, set the excess
* values to~0.
*
* @Output:
* @output:
* coords ::
* The design coordinates array.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Since:
* @since:
* 2.7.1
*/
FT_EXPORT( FT_Error )
@ -467,20 +467,20 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Set_MM_Blend_Coordinates
*
* @Description:
* @description:
* Choose an interpolated font design through normalized blend
* coordinates.
*
* This function works with all supported variation formats.
*
* @InOut:
* @inout:
* face ::
* A handle to the source face.
*
* @Input:
* @input:
* num_coords ::
* The number of available design coordinates. If it
* is larger than the number of axes, ignore the excess
@ -493,10 +493,10 @@ FT_BEGIN_HEADER
* -1.0 and 1.0 for TrueType GX and OpenType variation
* fonts).
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* [Since 2.8.1] To reset all axes to the default values, call the
* function with `num_coords' set to zero and `coords' set to NULL.
* [Since 2.9] `Default values' means the currently selected named
@ -515,16 +515,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_MM_Blend_Coordinates
*
* @Description:
* @description:
* Get the normalized blend coordinates of the currently selected
* interpolated font.
*
* This function works with all supported variation formats.
*
* @Input:
* @input:
* face ::
* A handle to the source face.
*
@ -534,14 +534,14 @@ FT_BEGIN_HEADER
* set the excess values to~0.5 for Adobe MM fonts, and
* to~0 for TrueType GX and OpenType variation fonts.
*
* @Output:
* @output:
* coords ::
* The normalized blend coordinates array.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Since:
* @since:
* 2.7.1
*/
FT_EXPORT( FT_Error )
@ -552,10 +552,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Set_Var_Blend_Coordinates
*
* @Description:
* @description:
* This is another name of @FT_Set_MM_Blend_Coordinates.
*/
FT_EXPORT( FT_Error )
@ -566,13 +566,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Var_Blend_Coordinates
*
* @Description:
* @description:
* This is another name of @FT_Get_MM_Blend_Coordinates.
*
* @Since:
* @since:
* 2.7.1
*/
FT_EXPORT( FT_Error )
@ -583,18 +583,18 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Enum:
* @enum:
* FT_VAR_AXIS_FLAG_XXX
*
* @Description:
* @description:
* A list of bit flags used in the return value of
* @FT_Get_Var_Axis_Flags.
*
* @Values:
* @values:
* FT_VAR_AXIS_FLAG_HIDDEN ::
* The variation axis should not be exposed to user interfaces.
*
* @Since:
* @since:
* 2.8.1
*/
#define FT_VAR_AXIS_FLAG_HIDDEN 1
@ -602,30 +602,30 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Var_Axis_Flags
*
* @Description:
* @description:
* Get the `flags' field of an OpenType Variation Axis Record.
*
* Not meaningful for Adobe MM fonts (`*flags' is always zero).
*
* @Input:
* @input:
* master ::
* The variation descriptor.
*
* axis_index ::
* The index of the requested variation axis.
*
* @Output:
* @output:
* flags ::
* The `flags' field. See @FT_VAR_AXIS_FLAG_XXX for
* possible values.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Since:
* @since:
* 2.8.1
*/
FT_EXPORT( FT_Error )
@ -636,13 +636,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Set_Named_Instance
*
* @Description:
* @description:
* Set or change the current named instance.
*
* @Input:
* @input:
* face ::
* A handle to the source face.
*
@ -652,10 +652,10 @@ FT_BEGIN_HEADER
* switches to font access without a named
* instance.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The function uses the value of `instance_index' to set bits 16-30
* of the face's `face_index' field. It also resets any variation
* applied to the font, and the @FT_FACE_FLAG_VARIATION bit of the
@ -665,7 +665,7 @@ FT_BEGIN_HEADER
* For Adobe MM fonts (which don't have named instances) this
* function simply resets the current face to the default instance.
*
* @Since:
* @since:
* 2.9
*/
FT_EXPORT( FT_Error )

124
include/freetype/ftmodapi.h
Unescape View File

@ -35,16 +35,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* module_management
*
* @Title:
* @title:
* Module Management
*
* @Abstract:
* @abstract:
* How to add, upgrade, remove, and control modules from FreeType.
*
* @Description:
* @description:
* The definitions below are used to manage modules within FreeType.
* Modules can be added, upgraded, and removed at runtime.
* Additionally, some module properties can be controlled also.
@ -75,7 +75,7 @@ FT_BEGIN_HEADER
*
* Note that the FreeType Cache sub-system is not a FreeType module.
*
* @Order:
* @order:
* FT_Module
* FT_Module_Constructor
* FT_Module_Destructor
@ -139,13 +139,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Module_Constructor
*
* @Description:
* @description:
* A function used to initialize (not create) a new module object.
*
* @Input:
* @input:
* module ::
* The module to initialize.
*/
@ -155,13 +155,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Module_Destructor
*
* @Description:
* @description:
* A function used to finalize (not destroy) a given module object.
*
* @Input:
* @input:
* module ::
* The module to finalize.
*/
@ -171,13 +171,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Module_Requester
*
* @Description:
* @description:
* A function used to query a given module for a specific interface.
*
* @Input:
* @input:
* module ::
* The module to be searched.
*
@ -191,13 +191,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Module_Class
*
* @Description:
* @description:
* The module class descriptor.
*
* @Fields:
* @fields:
* module_flags ::
* Bit flags describing the module.
*
@ -245,24 +245,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Add_Module
*
* @Description:
* @description:
* Add a new module to a given library instance.
*
* @InOut:
* @inout:
* library ::
* A handle to the library object.
*
* @Input:
* @input:
* clazz ::
* A pointer to class descriptor for the module.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* An error will be returned if a module already exists by that name,
* or if the module requires a version of FreeType that is too great.
*/
@ -273,23 +273,23 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Module
*
* @Description:
* @description:
* Find a module by its name.
*
* @Input:
* @input:
* library ::
* A handle to the library object.
*
* module_name ::
* The module's name (as an ASCII string).
*
* @Return:
* @return:
* A module handle. 0~if none was found.
*
* @Note:
* @note:
* FreeType's internal modules aren't documented very well, and you
* should look up the source code for details.
*/
@ -300,24 +300,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Remove_Module
*
* @Description:
* @description:
* Remove a given module from a library instance.
*
* @InOut:
* @inout:
* library ::
* A handle to a library object.
*
* @Input:
* @input:
* module ::
* A handle to a module object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The module object is destroyed by the function in case of success.
*/
FT_EXPORT( FT_Error )
@ -456,10 +456,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Set_Default_Properties
*
* @Description:
* @description:
* If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is
* set, this function reads the `FREETYPE_PROPERTIES' environment
* variable to control driver properties. See section @properties
@ -488,11 +488,11 @@ FT_BEGIN_HEADER
* autofitter:warping=1
* }
*
* @InOut:
* @inout:
* library ::
* A handle to a new library object.
*
* @Since:
* @since:
* 2.8
*/
FT_EXPORT( void )
@ -501,10 +501,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Reference_Library
*
* @Description:
* @description:
* A counter gets initialized to~1 at the time an @FT_Library
* structure is created. This function increments the counter.
* @FT_Done_Library then only destroys a library if the counter is~1,
@ -513,14 +513,14 @@ FT_BEGIN_HEADER
* This function helps in managing life-cycles of structures that
* reference @FT_Library objects.
*
* @Input:
* @input:
* library ::
* A handle to a target library object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Since:
* @since:
* 2.4.2
*/
FT_EXPORT( FT_Error )
@ -529,10 +529,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_New_Library
*
* @Description:
* @description:
* This function is used to create a new FreeType library instance
* from a given memory object. It is thus possible to use libraries
* with distinct memory allocators within the same program. Note,
@ -547,18 +547,18 @@ FT_BEGIN_HEADER
* Don't use @FT_Done_FreeType but @FT_Done_Library to destroy a
* library instance.
*
* @Input:
* @input:
* memory ::
* A handle to the original memory object.
*
* @Output:
* @output:
* alibrary ::
* A pointer to handle of a new library object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* See the discussion of reference counters in the description of
* @FT_Reference_Library.
*/
@ -569,21 +569,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Done_Library
*
* @Description:
* @description:
* Discard a given library object. This closes all drivers and
* discards all resource objects.
*
* @Input:
* @input:
* library ::
* A handle to the target library.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* See the discussion of reference counters in the description of
* @FT_Reference_Library.
*/
@ -598,18 +598,18 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Set_Debug_Hook
*
* @Description:
* @description:
* Set a debug hook function for debugging the interpreter of a font
* format.
*
* @InOut:
* @inout:
* library ::
* A handle to the library object.
*
* @Input:
* @input:
* hook_index ::
* The index of the debug hook. You should use the
* values defined in `ftobjs.h', e.g.,
@ -618,7 +618,7 @@ FT_BEGIN_HEADER
* debug_hook ::
* The function used to debug the interpreter.
*
* @Note:
* @note:
* Currently, four debug hook slots are available, but only two (for
* the TrueType and the Type~1 interpreter) are defined.
*
@ -634,15 +634,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Add_Default_Modules
*
* @Description:
* @description:
* Add the set of default drivers to a given library object.
* This is only useful when you create a library object with
* @FT_New_Library (usually to plug a custom memory manager).
*
* @InOut:
* @inout:
* library ::
* A handle to a new library object.
*/

10
include/freetype/ftotval.h
Unescape View File

@ -45,20 +45,20 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* ot_validation
*
* @Title:
* @title:
* OpenType Validation
*
* @Abstract:
* @abstract:
* An API to validate OpenType tables.
*
* @Description:
* @description:
* This section contains the declaration of functions to validate
* some OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH).
*
* @Order:
* @order:
* FT_OpenType_Validate
* FT_OpenType_Free
*

142
include/freetype/ftoutln.h
Unescape View File

@ -36,21 +36,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* outline_processing
*
* @Title:
* @title:
* Outline Processing
*
* @Abstract:
* @abstract:
* Functions to create, transform, and render vectorial glyph images.
*
* @Description:
* @description:
* This section contains routines used to create and destroy scalable
* glyph images known as `outlines'. These can also be measured,
* transformed, and converted into bitmaps and pixmaps.
*
* @Order:
* @order:
* FT_Outline
* FT_Outline_New
* FT_Outline_Done
@ -84,15 +84,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Decompose
*
* @Description:
* @description:
* Walk over an outline's structure to decompose it into individual
* segments and Bezier arcs. This function also emits `move to'
* operations to indicate the start of new contours in the outline.
*
* @Input:
* @input:
* outline ::
* A pointer to the source target.
*
@ -101,17 +101,17 @@ FT_BEGIN_HEADER
* called during decomposition to indicate path
* operations.
*
* @InOut:
* @inout:
* user ::
* A typeless pointer that is passed to each
* emitter during the decomposition. It can be
* used to store the state during the
* decomposition.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* A contour that contains a single point only is represented by a
* `move to' operation followed by `line to' to the same point. In
* most cases, it is best to filter this out before using the
@ -130,13 +130,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_New
*
* @Description:
* @description:
* Create a new outline of a given size.
*
* @Input:
* @input:
* library ::
* A handle to the library object from where the
* outline is allocated. Note however that the new
@ -151,14 +151,14 @@ FT_BEGIN_HEADER
* The maximum number of contours within the outline.
* This value must be in the range 0 to `numPoints'.
*
* @Output:
* @output:
* anoutline ::
* A handle to the new outline.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The reason why this function takes a `library' parameter is simply
* to use the library's memory allocator.
*/
@ -178,13 +178,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Done
*
* @Description:
* @description:
* Destroy an outline created with @FT_Outline_New.
*
* @Input:
* @input:
* library ::
* A handle of the library object used to allocate the
* outline.
@ -192,10 +192,10 @@ FT_BEGIN_HEADER
* outline ::
* A pointer to the outline object to be discarded.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* If the outline's `owner' field is not set, only the outline
* descriptor will be released.
*/
@ -211,20 +211,20 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Check
*
* @Description:
* @description:
* Check the contents of an outline descriptor.
*
* @Input:
* @input:
* outline ::
* A handle to a source outline.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* An empty outline, or an outline with a single point only is also
* valid.
*/
@ -234,10 +234,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Get_CBox
*
* @Description:
* @description:
* Return an outline's `control box'. The control box encloses all
* the outline's points, including Bezier control points. Though it
* coincides with the exact bounding box for most glyphs, it can be
@ -249,15 +249,15 @@ FT_BEGIN_HEADER
* and arcs in the outline. To get the latter, you can use the
* `ftbbox' component, which is dedicated to this single task.
*
* @Input:
* @input:
* outline ::
* A pointer to the source outline descriptor.
*
* @Output:
* @output:
* acbox ::
* The outline's control box.
*
* @Note:
* @note:
* See @FT_Glyph_Get_CBox for a discussion of tricky fonts.
*/
FT_EXPORT( void )
@ -267,17 +267,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Translate
*
* @Description:
* @description:
* Apply a simple translation to the points of an outline.
*
* @InOut:
* @inout:
* outline ::
* A pointer to the target outline descriptor.
*
* @Input:
* @input:
* xOffset ::
* The horizontal offset.
*
@ -292,23 +292,23 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Copy
*
* @Description:
* @description:
* Copy an outline into another one. Both objects must have the
* same sizes (number of points & number of contours) when this
* function is called.
*
* @Input:
* @input:
* source ::
* A handle to the source outline.
*
* @Output:
* @output:
* target ::
* A handle to the target outline.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -318,22 +318,22 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Transform
*
* @Description:
* @description:
* Apply a simple 2x2 matrix to all of an outline's points. Useful
* for applying rotations, slanting, flipping, etc.
*
* @InOut:
* @inout:
* outline ::
* A pointer to the target outline descriptor.
*
* @Input:
* @input:
* matrix ::
* A pointer to the transformation matrix.
*
* @Note:
* @note:
* You can use @FT_Outline_Translate if you need to translate the
* outline's points.
*/
@ -344,10 +344,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Embolden
*
* @Description:
* @description:
* Embolden an outline. The new outline will be at most 4~times
* `strength' pixels wider and higher. You may think of the left and
* bottom borders as unchanged.
@ -355,19 +355,19 @@ FT_BEGIN_HEADER
* Negative `strength' values to reduce the outline thickness are
* possible also.
*
* @InOut:
* @inout:
* outline ::
* A handle to the target outline.
*
* @Input:
* @input:
* strength ::
* How strong the glyph is emboldened. Expressed in
* 26.6 pixel format.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The used algorithm to increase or decrease the thickness of the
* glyph doesn't change the number of points; this means that certain
* situations like acute angles or intersections are sometimes
@ -394,16 +394,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_EmboldenXY
*
* @Description:
* @description:
* Embolden an outline. The new outline will be `xstrength' pixels
* wider and `ystrength' pixels higher. Otherwise, it is similar to
* @FT_Outline_Embolden, which uses the same strength in both
* directions.
*
* @Since:
* @since:
* 2.4.10
*/
FT_EXPORT( FT_Error )
@ -414,18 +414,18 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Reverse
*
* @Description:
* @description:
* Reverse the drawing direction of an outline. This is used to
* ensure consistent fill conventions for mirrored glyphs.
*
* @InOut:
* @inout:
* outline ::
* A pointer to the target outline descriptor.
*
* @Note:
* @note:
* This function toggles the bit flag @FT_OUTLINE_REVERSE_FILL in
* the outline's `flags' field.
*
@ -438,28 +438,28 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Get_Bitmap
*
* @Description:
* @description:
* Render an outline within a bitmap. The outline's image is simply
* OR-ed to the target bitmap.
*
* @Input:
* @input:
* library ::
* A handle to a FreeType library object.
*
* outline ::
* A pointer to the source outline descriptor.
*
* @InOut:
* @inout:
* abitmap ::
* A pointer to the target bitmap descriptor.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* This function does NOT CREATE the bitmap, it only renders an
* outline image within the one you pass to it! Consequently, the
* various fields in `abitmap' should be set accordingly.
@ -478,31 +478,31 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Outline_Render
*
* @Description:
* @description:
* Render an outline within a bitmap using the current scan-convert.
* This function uses an @FT_Raster_Params structure as an argument,
* allowing advanced features like direct composition, translucency,
* etc.
*
* @Input:
* @input:
* library ::
* A handle to a FreeType library object.
*
* outline ::
* A pointer to the source outline descriptor.
*
* @InOut:
* @inout:
* params ::
* A pointer to an @FT_Raster_Params structure used to
* describe the rendering operation.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* You should know what you are doing and how @FT_Raster_Params works
* to use this function.
*

8
include/freetype/ftpfr.h
Unescape View File

@ -34,16 +34,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* pfr_fonts
*
* @Title:
* @title:
* PFR Fonts
*
* @Abstract:
* @abstract:
* PFR/TrueDoc specific API.
*
* @Description:
* @description:
* This section contains the declaration of PFR-specific functions.
*
*/

30
include/freetype/ftrender.h
Unescape View File

@ -30,7 +30,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* module_management
*
*/
@ -118,13 +118,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Renderer_Class
*
* @Description:
* @description:
* The renderer module class descriptor.
*
* @Fields:
* @fields:
* root ::
* The root @FT_Module_Class fields.
*
@ -167,23 +167,23 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Renderer
*
* @Description:
* @description:
* Retrieve the current renderer for a given glyph format.
*
* @Input:
* @input:
* library ::
* A handle to the library object.
*
* format ::
* The glyph format.
*
* @Return:
* @return:
* A renderer handle. 0~if none found.
*
* @Note:
* @note:
* An error will be returned if a module already exists by that name,
* or if the module requires a version of FreeType that is too great.
*
@ -197,17 +197,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Set_Renderer
*
* @Description:
* @description:
* Set the current renderer to use, and set additional mode.
*
* @InOut:
* @inout:
* library ::
* A handle to the library object.
*
* @Input:
* @input:
* renderer ::
* A handle to the renderer object.
*
@ -217,10 +217,10 @@ FT_BEGIN_HEADER
* parameters ::
* Additional parameters.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* In case of success, the renderer will be used to convert glyph
* images in the renderer's known format into bitmaps.
*

38
include/freetype/ftsizes.h
Unescape View File

@ -44,16 +44,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* sizes_management
*
* @Title:
* @title:
* Size Management
*
* @Abstract:
* @abstract:
* Managing multiple sizes per face.
*
* @Description:
* @description:
* When creating a new face object (e.g., with @FT_New_Face), an
* @FT_Size object is automatically created and used to store all
* pixel-size dependent information, available in the `face->size'
@ -76,24 +76,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_New_Size
*
* @Description:
* @description:
* Create a new size object from a given face object.
*
* @Input:
* @input:
* face ::
* A handle to a parent face object.
*
* @Output:
* @output:
* asize ::
* A handle to a new size object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* You need to call @FT_Activate_Size in order to select the new size
* for upcoming calls to @FT_Set_Pixel_Sizes, @FT_Set_Char_Size,
* @FT_Load_Glyph, @FT_Load_Char, etc.
@ -105,19 +105,19 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Done_Size
*
* @Description:
* @description:
* Discard a given size object. Note that @FT_Done_Face
* automatically discards all size objects allocated with
* @FT_New_Size.
*
* @Input:
* @input:
* size ::
* A handle to a target size object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*/
FT_EXPORT( FT_Error )
@ -126,10 +126,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Activate_Size
*
* @Description:
* @description:
* Even though it is possible to create several size objects for a
* given face (see @FT_New_Size for details), functions like
* @FT_Load_Glyph or @FT_Load_Char only use the one that has been
@ -138,14 +138,14 @@ FT_BEGIN_HEADER
* This function can be used to `activate' a previously created size
* object.
*
* @Input:
* @input:
* size ::
* A handle to a target size object.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* If `face' is the size's parent face object, this function changes
* the value of `face->size' to the input size handle.
*/

62
include/freetype/ftsnames.h
Unescape View File

@ -39,16 +39,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* sfnt_names
*
* @Title:
* @title:
* SFNT Names
*
* @Abstract:
* @abstract:
* Access the names embedded in TrueType and OpenType files.
*
* @Description:
* @description:
* The TrueType and OpenType specifications allow the inclusion of
* a special names table (`name') in font files. This table contains
* textual (and internationalized) information regarding the font,
@ -63,13 +63,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_SfntName
*
* @Description:
* @description:
* A structure used to model an SFNT `name' table entry.
*
* @Fields:
* @fields:
* platform_id ::
* The platform ID for `string'.
* See @TT_PLATFORM_XXX for possible values.
@ -105,7 +105,7 @@ FT_BEGIN_HEADER
* string_len ::
* The length of `string' in bytes.
*
* @Note:
* @note:
* Please refer to the TrueType or OpenType specification for more
* details.
*/
@ -124,20 +124,20 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Sfnt_Name_Count
*
* @Description:
* @description:
* Retrieve the number of name strings in the SFNT `name' table.
*
* @Input:
* @input:
* face ::
* A handle to the source face.
*
* @Return:
* @return:
* The number of strings in the `name' table.
*
* @Note:
* @note:
* This function always returns an error if the config macro
* `TT_CONFIG_OPTION_SFNT_NAMES' is not defined in `ftoption.h'.
*/
@ -147,27 +147,27 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Sfnt_Name
*
* @Description:
* @description:
* Retrieve a string of the SFNT `name' table for a given index.
*
* @Input:
* @input:
* face ::
* A handle to the source face.
*
* idx ::
* The index of the `name' string.
*
* @Output:
* @output:
* aname ::
* The indexed @FT_SfntName structure.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The `string' array returned in the `aname' structure is not
* null-terminated. Note that you don't have to deallocate `string'
* by yourself; FreeType takes care of it if you call @FT_Done_Face.
@ -190,14 +190,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_SfntLangTag
*
* @Description:
* @description:
* A structure to model a language tag entry from an SFNT `name'
* table.
*
* @Fields:
* @fields:
* string ::
* The language tag string, encoded in UTF-16BE
* (without trailing NULL bytes).
@ -205,11 +205,11 @@ FT_BEGIN_HEADER
* string_len ::
* The length of `string' in *bytes*.
*
* @Note:
* @note:
* Please refer to the TrueType or OpenType specification for more
* details.
*
* @Since:
* @since:
* 2.8
*/
typedef struct FT_SfntLangTag_
@ -222,14 +222,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Sfnt_LangTag
*
* @Description:
* @description:
* Retrieve the language tag associated with a language ID of an SFNT
* `name' table entry.
*
* @Input:
* @input:
* face ::
* A handle to the source face.
*
@ -237,15 +237,15 @@ FT_BEGIN_HEADER
* The language ID, as returned by @FT_Get_Sfnt_Name.
* This is always a value larger than 0x8000.
*
* @Output:
* @output:
* alangTag ::
* The language tag associated with the `name' table
* entry's language ID.
*
* @Return:
* @return:
* FreeType error code. 0~means success.
*
* @Note:
* @note:
* The `string' array returned in the `alangTag' structure is not
* null-terminated. Note that you don't have to deallocate `string'
* by yourself; FreeType takes care of it if you call @FT_Done_Face.
@ -258,7 +258,7 @@ FT_BEGIN_HEADER
* This function always returns an error if the config macro
* `TT_CONFIG_OPTION_SFNT_NAMES' is not defined in `ftoption.h'.
*
* @Since:
* @since:
* 2.8
*/
FT_EXPORT( FT_Error )

8
include/freetype/ftsystem.h
Unescape View File

@ -28,16 +28,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* system_interface
*
* @Title:
* @title:
* System Interface
*
* @Abstract:
* @abstract:
* How FreeType manages memory and i/o.
*
* @Description:
* @description:
* This section contains various definitions related to memory
* management and i/o access. You need to understand this
* information if you want to use a custom memory manager or you own

2
include/freetype/fttrigon.h
Unescape View File

@ -33,7 +33,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* computations
*
*/

152
include/freetype/fttypes.h
Unescape View File

@ -33,21 +33,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* basic_types
*
* @Title:
* @title:
* Basic Data Types
*
* @Abstract:
* @abstract:
* The basic data types defined by the library.
*
* @Description:
* @description:
* This section contains the basic data types defined by FreeType~2,
* ranging from simple scalar types to bitmap descriptors. More
* font-specific structures are defined in a different section.
*
* @Order:
* @order:
* FT_Byte
* FT_Bytes
* FT_Char
@ -98,10 +98,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Bool
*
* @Description:
* @description:
* A typedef of unsigned char, used for simple booleans. As usual,
* values 1 and~0 represent true and false, respectively.
*/
@ -110,10 +110,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_FWord
*
* @Description:
* @description:
* A signed 16-bit integer used to store a distance in original font
* units.
*/
@ -122,10 +122,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_UFWord
*
* @Description:
* @description:
* An unsigned 16-bit integer used to store a distance in original
* font units.
*/
@ -134,10 +134,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Char
*
* @Description:
* @description:
* A simple typedef for the _signed_ char type.
*/
typedef signed char FT_Char;
@ -145,10 +145,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Byte
*
* @Description:
* @description:
* A simple typedef for the _unsigned_ char type.
*/
typedef unsigned char FT_Byte;
@ -156,10 +156,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Bytes
*
* @Description:
* @description:
* A typedef for constant memory areas.
*/
typedef const FT_Byte* FT_Bytes;
@ -167,10 +167,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Tag
*
* @Description:
* @description:
* A typedef for 32-bit tags (as used in the SFNT format).
*/
typedef FT_UInt32 FT_Tag;
@ -178,10 +178,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_String
*
* @Description:
* @description:
* A simple typedef for the char type, usually used for strings.
*/
typedef char FT_String;
@ -189,10 +189,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Short
*
* @Description:
* @description:
* A typedef for signed short.
*/
typedef signed short FT_Short;
@ -200,10 +200,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_UShort
*
* @Description:
* @description:
* A typedef for unsigned short.
*/
typedef unsigned short FT_UShort;
@ -211,10 +211,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Int
*
* @Description:
* @description:
* A typedef for the int type.
*/
typedef signed int FT_Int;
@ -222,10 +222,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_UInt
*
* @Description:
* @description:
* A typedef for the unsigned int type.
*/
typedef unsigned int FT_UInt;
@ -233,10 +233,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Long
*
* @Description:
* @description:
* A typedef for signed long.
*/
typedef signed long FT_Long;
@ -244,10 +244,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_ULong
*
* @Description:
* @description:
* A typedef for unsigned long.
*/
typedef unsigned long FT_ULong;
@ -255,10 +255,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_F2Dot14
*
* @Description:
* @description:
* A signed 2.14 fixed-point type used for unit vectors.
*/
typedef signed short FT_F2Dot14;
@ -266,10 +266,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_F26Dot6
*
* @Description:
* @description:
* A signed 26.6 fixed-point type used for vectorial pixel
* coordinates.
*/
@ -278,10 +278,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Fixed
*
* @Description:
* @description:
* This type is used to store 16.16 fixed-point values, like scaling
* values or matrix coefficients.
*/
@ -290,10 +290,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Error
*
* @Description:
* @description:
* The FreeType error code type. A value of~0 is always interpreted
* as a successful operation.
*/
@ -302,10 +302,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Pointer
*
* @Description:
* @description:
* A simple typedef for a typeless pointer.
*/
typedef void* FT_Pointer;
@ -313,10 +313,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_Offset
*
* @Description:
* @description:
* This is equivalent to the ANSI~C `size_t' type, i.e., the largest
* _unsigned_ integer type used to express a file size or position,
* or a memory block size.
@ -326,10 +326,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_PtrDist
*
* @Description:
* @description:
* This is equivalent to the ANSI~C `ptrdiff_t' type, i.e., the
* largest _signed_ integer type used to express the distance
* between two pointers.
@ -339,14 +339,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_UnitVector
*
* @Description:
* @description:
* A simple structure used to store a 2D vector unit vector. Uses
* FT_F2Dot14 types.
*
* @Fields:
* @fields:
* x ::
* Horizontal coordinate.
*
@ -363,10 +363,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Matrix
*
* @Description:
* @description:
* A simple structure used to store a 2x2 matrix. Coefficients are
* in 16.16 fixed-point format. The computation performed is:
*
@ -375,7 +375,7 @@ FT_BEGIN_HEADER
* y' = x*yx + y*yy
* }
*
* @Fields:
* @fields:
* xx ::
* Matrix coefficient.
*
@ -398,13 +398,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Data
*
* @Description:
* @description:
* Read-only binary data represented as a pointer and a length.
*
* @Fields:
* @fields:
* pointer ::
* The data.
*
@ -421,15 +421,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_Generic_Finalizer
*
* @Description:
* @description:
* Describe a function used to destroy the `client' data of any
* FreeType object. See the description of the @FT_Generic type for
* details of usage.
*
* @Input:
* @input:
* The address of the FreeType object that is under finalization.
* Its client data is accessed through its `generic' field.
*/
@ -438,10 +438,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Generic
*
* @Description:
* @description:
* Client applications often need to associate their own data to a
* variety of FreeType core objects. For example, a text layout API
* might want to associate a glyph cache to a given size object.
@ -456,7 +456,7 @@ FT_BEGIN_HEADER
* client example would put the address of the glyph cache destructor
* in the `finalizer' field).
*
* @Fields:
* @fields:
* data ::
* A typeless pointer to any client-specified data. This
* field is completely ignored by the FreeType library.
@ -476,14 +476,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Macro:
* @macro:
* FT_MAKE_TAG
*
* @Description:
* @description:
* This macro converts four-letter tags that are used to label
* TrueType tables into an unsigned long, to be used within FreeType.
*
* @Note:
* @note:
* The produced values *must* be 32-bit integers. Don't redefine
* this macro.
*/
@ -506,7 +506,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* list_processing
*
*/
@ -514,10 +514,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_ListNode
*
* @Description:
* @description:
* Many elements and objects in FreeType are listed through an
* @FT_List record (see @FT_ListRec). As its name suggests, an
* FT_ListNode is a handle to a single list element.
@ -527,10 +527,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* FT_List
*
* @Description:
* @description:
* A handle to a list record (see @FT_ListRec).
*/
typedef struct FT_ListRec_* FT_List;
@ -538,13 +538,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_ListNodeRec
*
* @Description:
* @description:
* A structure used to hold a single list element.
*
* @Fields:
* @fields:
* prev ::
* The previous element in the list. NULL if first.
*
@ -565,14 +565,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_ListRec
*
* @Description:
* @description:
* A structure used to hold a simple doubly-linked list. These are
* used in many parts of FreeType.
*
* @Fields:
* @fields:
* head ::
* The head (first element) of doubly-linked list.
*

16
include/freetype/ftwinfnt.h
Unescape View File

@ -34,16 +34,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* winfnt_fonts
*
* @Title:
* @title:
* Window FNT Files
*
* @Abstract:
* @abstract:
* Windows FNT specific API.
*
* @Description:
* @description:
* This section contains the declaration of Windows FNT specific
* functions.
*
@ -175,10 +175,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_WinFNT_HeaderRec
*
* @Description:
* @description:
* Windows FNT Header info.
*/
typedef struct FT_WinFNT_HeaderRec_
@ -225,10 +225,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_WinFNT_Header
*
* @Description:
* @description:
* A handle to an @FT_WinFNT_HeaderRec structure.
*/
typedef struct FT_WinFNT_HeaderRec_* FT_WinFNT_Header;

32
include/freetype/internal/autohint.h
Unescape View File

@ -82,23 +82,23 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_AutoHinter_GlobalGetFunc
*
* @Description:
* @description:
* Retrieve the global hints computed for a given face object. The
* resulting data is dissociated from the face and will survive a
* call to FT_Done_Face(). It must be discarded through the API
* FT_AutoHinter_GlobalDoneFunc().
*
* @Input:
* @input:
* hinter ::
* A handle to the source auto-hinter.
*
* face ::
* A handle to the source face object.
*
* @Output:
* @output:
* global_hints ::
* A typeless pointer to the global hints.
*
@ -114,15 +114,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_AutoHinter_GlobalDoneFunc
*
* @Description:
* @description:
* Discard the global hints retrieved through
* FT_AutoHinter_GlobalGetFunc(). This is the only way these hints
* are freed from memory.
*
* @Input:
* @input:
* hinter ::
* A handle to the auto-hinter module.
*
@ -136,15 +136,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_AutoHinter_GlobalResetFunc
*
* @Description:
* @description:
* This function is used to recompute the global metrics in a given
* font. This is useful when global font data changes (e.g. Multiple
* Masters fonts where blend coordinates change).
*
* @Input:
* @input:
* hinter ::
* A handle to the source auto-hinter.
*
@ -158,14 +158,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* FT_AutoHinter_GlyphLoadFunc
*
* @Description:
* @description:
* This function is used to load, scale, and automatically hint a
* glyph from a given face.
*
* @Input:
* @input:
* face ::
* A handle to the face.
*
@ -175,7 +175,7 @@ FT_BEGIN_HEADER
* load_flags ::
* The load flags.
*
* @Note:
* @note:
* This function is capable of loading composite glyphs by hinting
* each sub-glyph independently (which improves quality).
*
@ -192,10 +192,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_AutoHinter_InterfaceRec
*
* @Description:
* @description:
* The auto-hinter module's interface.
*/
typedef struct FT_AutoHinter_InterfaceRec_

12
include/freetype/internal/cffotypes.h
Unescape View File

@ -35,10 +35,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* CFF_Size
*
* @Description:
* @description:
* A handle to an OpenType size object.
*/
typedef struct CFF_SizeRec_
@ -51,10 +51,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* CFF_GlyphSlot
*
* @Description:
* @description:
* A handle to an OpenType glyph slot object.
*/
typedef struct CFF_GlyphSlotRec_
@ -72,10 +72,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* CFF_Internal
*
* @Description:
* @description:
* The interface to the `internal' field of `FT_Size'.
*/
typedef struct CFF_InternalRec_

6
include/freetype/internal/cfftypes.h
Unescape View File

@ -35,13 +35,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* CFF_IndexRec
*
* @Description:
* @description:
* A structure used to model a CFF Index table.
*
* @Fields:
* @fields:
* stream ::
* The source input stream.
*

18
include/freetype/internal/ftcalc.h
Unescape View File

@ -248,10 +248,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_MulDiv_No_Round
*
* @Description:
* @description:
* A very simple function used to perform the computation `(a*b)/c'
* (without rounding) with maximum accuracy (it uses a 64-bit
* intermediate integer whenever necessary).
@ -259,7 +259,7 @@ FT_BEGIN_HEADER
* This function isn't necessarily as fast as some processor specific
* operations, but is at least completely portable.
*
* @Input:
* @input:
* a ::
* The first multiplier.
* b ::
@ -267,7 +267,7 @@ FT_BEGIN_HEADER
* c ::
* The divisor.
*
* @Return:
* @return:
* The result of `(a*b)/c'. This function never traps when trying to
* divide by zero; it simply returns `MaxInt' or `MinInt' depending
* on the signs of `a' and `b'.
@ -407,20 +407,20 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_SqrtFixed
*
* @Description:
* @description:
* Computes the square root of a 16.16 fixed-point value.
*
* @Input:
* @input:
* x ::
* The value to compute the root for.
*
* @Return:
* @return:
* The result of `sqrt(x)'.
*
* @Note:
* @note:
* This function is not very fast.
*/
FT_BASE( FT_Int32 )

18
include/freetype/internal/ftdebug.h
Unescape View File

@ -99,17 +99,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Trace_Get_Count
*
* @Description:
* @description:
* Return the number of available trace components.
*
* @Return:
* @return:
* The number of trace components. 0 if FreeType 2 is not built with
* FT_DEBUG_LEVEL_TRACE definition.
*
* @Note:
* @note:
* This function may be useful if you want to access elements of
* the internal `ft_trace_levels' array by an index.
*/
@ -119,21 +119,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Trace_Get_Name
*
* @Description:
* @description:
* Return the name of a trace component.
*
* @Input:
* @input:
* The index of the trace component.
*
* @Return:
* @return:
* The name of the trace component. This is a statically allocated
* C string, so do not free it after use. NULL if FreeType 2 is not
* built with FT_DEBUG_LEVEL_TRACE definition.
*
* @Note:
* @note:
* Use @FT_Trace_Get_Count to get the number of available trace
* components.
*

16
include/freetype/internal/ftdrv.h
Unescape View File

@ -89,14 +89,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Driver_ClassRec
*
* @Description:
* @description:
* The font driver class. This structure mostly contains pointers to
* driver methods.
*
* @Fields:
* @fields:
* root ::
* The parent module.
*
@ -166,7 +166,7 @@ FT_BEGIN_HEADER
* @FT_FACE_FLAG_FIXED_SIZES is set. Can be set
* to 0 if the scaling done in the base layer
* suffices.
* @Note:
* @note:
* Most function pointers, with the exception of `load_glyph', can be
* set to 0 to indicate a default behaviour.
*/
@ -202,17 +202,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Macro:
* @macro:
* FT_DECLARE_DRIVER
*
* @Description:
* @description:
* Used to create a forward declaration of an FT_Driver_ClassRec
* struct instance.
*
* @Macro:
* @macro:
* FT_DEFINE_DRIVER
*
* @Description:
* @description:
* Used to initialize an instance of FT_Driver_ClassRec struct.
*
* `ftinit.c' (ft_create_default_module_classes) already contains a

4
include/freetype/internal/ftgloadr.h
Unescape View File

@ -29,10 +29,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_GlyphLoader
*
* @Description:
* @description:
* The glyph loader is an internal object used to load several glyphs
* together (for example, in the case of composites).
*/

4
include/freetype/internal/ftmemory.h
Unescape View File

@ -30,10 +30,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Macro:
* @macro:
* FT_SET_ERROR
*
* @Description:
* @description:
* This macro is used to set an implicit `error' variable to a given
* expression's value (usually a function call), and convert it to a
* boolean which is set whenever the value is != 0.

106
include/freetype/internal/ftobjs.h
Unescape View File

@ -293,15 +293,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Face_InternalRec
*
* @Description:
* @description:
* This structure contains the internal fields of each FT_Face
* object. These fields may change between different releases of
* FreeType.
*
* @Fields:
* @fields:
* max_points ::
* The maximum number of points used to store the vectorial outline
* of any glyph in this face. If this value cannot be known in
@ -386,15 +386,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Slot_InternalRec
*
* @Description:
* @description:
* This structure contains the internal fields of each FT_GlyphSlot
* object. These fields may change between different releases of
* FreeType.
*
* @Fields:
* @fields:
* loader ::
* The glyph loader object used to load outlines
* into the glyph slot.
@ -446,14 +446,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_Size_InternalRec
*
* @Description:
* @description:
* This structure contains the internal fields of each FT_Size
* object.
*
* @Fields:
* @fields:
* module_data ::
* Data specific to a driver module.
*
@ -490,13 +490,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_ModuleRec
*
* @Description:
* @description:
* A module object instance.
*
* @Fields:
* @fields:
* clazz ::
* A pointer to the module's class.
*
@ -550,24 +550,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Module_Interface
*
* @Description:
* @description:
* Finds a module and returns its specific interface as a typeless
* pointer.
*
* @Input:
* @input:
* library ::
* A handle to the library object.
*
* module_name ::
* The module's name (as an ASCII string).
*
* @Return:
* @return:
* A module-specific interface if available, 0 otherwise.
*
* @Note:
* @note:
* You should better be familiar with FreeType internals to know
* which module to look for, and what its interface is :-)
*/
@ -623,24 +623,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_New_GlyphSlot
*
* @Description:
* @description:
* It is sometimes useful to have more than one glyph slot for a
* given face object. This function is used to create additional
* slots. All of them are automatically discarded when the face is
* destroyed.
*
* @Input:
* @input:
* face ::
* A handle to a parent face object.
*
* @Output:
* @output:
* aslot ::
* A handle to a new glyph slot object.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*/
FT_BASE( FT_Error )
@ -650,15 +650,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Done_GlyphSlot
*
* @Description:
* @description:
* Destroys a given glyph slot. Remember however that all slots are
* automatically destroyed with its parent. Using this function is
* not always mandatory.
*
* @Input:
* @input:
* slot ::
* A handle to a target glyph slot.
*/
@ -785,14 +785,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_DriverRec
*
* @Description:
* @description:
* The root font driver class. A font driver is responsible for
* managing and loading font files of a given format.
*
* @Fields:
* @fields:
* root ::
* Contains the fields of the root module class.
*
@ -839,15 +839,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* FT_LibraryRec
*
* @Description:
* @description:
* The FreeType library class. This is the root of all FreeType
* data. Use FT_New_Library() to create a library object, and
* FT_Done_Library() to discard it and all child objects.
*
* @Fields:
* @fields:
* memory ::
* The library's memory object. Manages memory
* allocation.
@ -974,13 +974,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_New_Memory
*
* @Description:
* @description:
* Creates a new memory object.
*
* @Return:
* @return:
* A pointer to the new memory object. 0 in case of error.
*/
FT_BASE( FT_Memory )
@ -989,13 +989,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Done_Memory
*
* @Description:
* @description:
* Discards memory manager.
*
* @Input:
* @input:
* memory ::
* A handle to the memory manager.
*/
@ -1018,10 +1018,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Macro:
* @macro:
* FT_DEFINE_OUTLINE_FUNCS
*
* @Description:
* @description:
* Used to initialize an instance of FT_Outline_Funcs struct.
* The struct will be allocated in the global scope (or the scope
* where the macro is used).
@ -1047,10 +1047,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Macro:
* @macro:
* FT_DEFINE_RASTER_FUNCS
*
* @Description:
* @description:
* Used to initialize an instance of FT_Raster_Funcs struct.
* The struct will be allocated in the global scope (or the scope
* where the macro is used).
@ -1077,10 +1077,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Macro:
* @macro:
* FT_DEFINE_GLYPH
*
* @Description:
* @description:
* The struct will be allocated in the global scope (or the scope
* where the macro is used).
*/
@ -1110,17 +1110,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Macro:
* @macro:
* FT_DECLARE_RENDERER
*
* @Description:
* @description:
* Used to create a forward declaration of a
* FT_Renderer_Class struct instance.
*
* @Macro:
* @macro:
* FT_DEFINE_RENDERER
*
* @Description:
* @description:
* Used to initialize an instance of FT_Renderer_Class struct.
*
* The struct will be allocated in the global scope (or the scope
@ -1171,26 +1171,26 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Macro:
* @macro:
* FT_DECLARE_MODULE
*
* @Description:
* @description:
* Used to create a forward declaration of a
* FT_Module_Class struct instance.
*
* @Macro:
* @macro:
* FT_DEFINE_MODULE
*
* @Description:
* @description:
* Used to initialize an instance of an FT_Module_Class struct.
*
* The struct will be allocated in the global scope (or the scope
* where the macro is used).
*
* @Macro:
* @macro:
* FT_DEFINE_ROOT_MODULE
*
* @Description:
* @description:
* Used to initialize an instance of an FT_Module_Class struct inside
* another struct that contains it or in a function that initializes
* that containing struct.

30
include/freetype/internal/ftrfork.h
Unescape View File

@ -94,17 +94,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Raccess_Guess
*
* @Description:
* @description:
* Guess a file name and offset where the actual resource fork is
* stored. The macro FT_RACCESS_N_RULES holds the number of
* guessing rules; the guessed result for the Nth rule is
* represented as a triplet: a new file name (new_names[N]), a file
* offset (offsets[N]), and an error code (errors[N]).
*
* @Input:
* @input:
* library ::
* A FreeType library instance.
*
@ -115,7 +115,7 @@ FT_BEGIN_HEADER
* The (base) file name of the resource fork used for some
* guessing rules.
*
* @Output:
* @output:
* new_names ::
* An array of guessed file names in which the resource forks may
* exist. If `new_names[N]' is NULL, the guessed file name is
@ -142,16 +142,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Raccess_Get_HeaderInfo
*
* @Description:
* @description:
* Get the information from the header of resource fork. The
* information includes the file offset where the resource map
* starts, and the file offset where the resource data starts.
* `FT_Raccess_Get_DataOffsets' requires these two data.
*
* @Input:
* @input:
* library ::
* A FreeType library instance.
*
@ -161,14 +161,14 @@ FT_BEGIN_HEADER
* rfork_offset ::
* The file offset where the resource fork starts.
*
* @Output:
* @output:
* map_offset ::
* The file offset where the resource map starts.
*
* rdata_pos ::
* The file offset where the resource data starts.
*
* @Return:
* @return:
* FreeType error code. FT_Err_Ok means success.
*/
FT_BASE( FT_Error )
@ -181,15 +181,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Raccess_Get_DataOffsets
*
* @Description:
* @description:
* Get the data offsets for a tag in a resource fork. Offsets are
* stored in an array because, in some cases, resources in a resource
* fork have the same tag.
*
* @Input:
* @input:
* library ::
* A FreeType library instance.
*
@ -212,7 +212,7 @@ FT_BEGIN_HEADER
* may induce a different order of the faces in comparison to that
* by QuickDraw API.
*
* @Output:
* @output:
* offsets ::
* The stream offsets for the resource data specified by `tag'.
* This array is allocated by the function, so you have to call
@ -221,10 +221,10 @@ FT_BEGIN_HEADER
* count ::
* The length of offsets array.
*
* @Return:
* @return:
* FreeType error code. FT_Err_Ok means success.
*
* @Note:
* @note:
* Normally you should use `FT_Raccess_Get_HeaderInfo' to get the
* value for `map_offset' and `rdata_pos'.
*/

4
include/freetype/internal/ftserv.h
Unescape View File

@ -161,7 +161,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Macro:
* @macro:
* FT_DEFINE_SERVICEDESCREC1
* FT_DEFINE_SERVICEDESCREC2
* FT_DEFINE_SERVICEDESCREC3
@ -173,7 +173,7 @@ FT_BEGIN_HEADER
* FT_DEFINE_SERVICEDESCREC9
* FT_DEFINE_SERVICEDESCREC10
*
* @Description:
* @description:
* Used to initialize an array of FT_ServiceDescRec structures.
*
* The array will be allocated in the global scope (or the scope

42
include/freetype/internal/psaux.h
Unescape View File

@ -66,13 +66,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* PS_Table_FuncsRec
*
* @Description:
* @description:
* A set of function pointers to manage PS_Table objects.
*
* @Fields:
* @fields:
* table_init ::
* Used to initialize a table.
*
@ -109,14 +109,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* PS_TableRec
*
* @Description:
* @description:
* A PS_Table is a simple object used to store an array of objects in
* a single memory block.
*
* @Fields:
* @fields:
* block ::
* The address in memory of the growheap's block. This
* can change between two object adds, due to
@ -441,13 +441,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* PS_ParserRec
*
* @Description:
* @description:
* A PS_Parser is an object used to parse a Type 1 font very quickly.
*
* @Fields:
* @fields:
* cursor ::
* The current position in the text.
*
@ -506,13 +506,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* PS_Builder
*
* @Description:
* @description:
* A structure used during glyph loading to store its outline.
*
* @Fields:
* @fields:
* memory ::
* The current memory object.
*
@ -768,13 +768,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* T1_BuilderRec
*
* @Description:
* @description:
* A structure used during glyph loading to store its outline.
*
* @Fields:
* @fields:
* memory ::
* The current memory object.
*
@ -1050,13 +1050,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* CFF_Builder
*
* @Description:
* @description:
* A structure used during glyph loading to store its outline.
*
* @Fields:
* @fields:
* memory ::
* The current memory object.
*
@ -1286,13 +1286,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* AFM_ParserRec
*
* @Description:
* @description:
* An AFM_Parser is a parser for the AFM files.
*
* @Fields:
* @fields:
* memory ::
* The object used for memory operations (alloc and
* realloc).

6
include/freetype/internal/services/svttcmap.h
Unescape View File

@ -34,15 +34,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_CMapInfo
*
* @Description:
* @description:
* A structure used to store TrueType/sfnt specific cmap information
* which is not covered by the generic @FT_CharMap structure. This
* structure can be accessed with the @FT_Get_TT_CMap_Info function.
*
* @Fields:
* @fields:
* language ::
* The language ID used in Mac fonts. Definitions of values are in
* `ttnameid.h'.

180
include/freetype/internal/sfnt.h
Unescape View File

@ -30,15 +30,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Init_Face_Func
*
* @Description:
* @description:
* First part of the SFNT face object initialization. This finds
* the face in a SFNT file or collection, and load its format tag in
* face->format_tag.
*
* @Input:
* @input:
* stream ::
* The input stream.
*
@ -57,10 +57,10 @@ FT_BEGIN_HEADER
* params ::
* Optional additional parameters.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*
* @Note:
* @note:
* The stream cursor must be at the font file's origin.
*
* This function recognizes fonts embedded in a `TrueType
@ -80,15 +80,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Load_Face_Func
*
* @Description:
* @description:
* Second part of the SFNT face object initialization. This loads
* the common SFNT tables (head, OS/2, maxp, metrics, etc.) in the
* face object.
*
* @Input:
* @input:
* stream ::
* The input stream.
*
@ -107,10 +107,10 @@ FT_BEGIN_HEADER
* params ::
* Optional additional parameters.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*
* @Note:
* @note:
* This function must be called after TT_Init_Face_Func().
*/
typedef FT_Error
@ -123,17 +123,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Done_Face_Func
*
* @Description:
* @description:
* A callback used to delete the common SFNT data from a face.
*
* @Input:
* @input:
* face ::
* A handle to the target face object.
*
* @Note:
* @note:
* This function does NOT destroy the face object.
*/
typedef void
@ -142,13 +142,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Load_Any_Func
*
* @Description:
* @description:
* Load any font table into client memory.
*
* @Input:
* @input:
* face ::
* The face object to look for.
*
@ -178,11 +178,11 @@ FT_BEGIN_HEADER
* Loads the next `length' bytes of table or font,
* starting at offset `offset' (in table or font too).
*
* @Output:
* @output:
* buffer ::
* The address of target buffer.
*
* @Return:
* @return:
* TrueType error code. 0 means success.
*/
typedef FT_Error
@ -195,14 +195,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Find_SBit_Image_Func
*
* @Description:
* @description:
* Check whether an embedded bitmap (an `sbit') exists for a given
* glyph, at a given strike.
*
* @Input:
* @input:
* face ::
* The target face object.
*
@ -212,7 +212,7 @@ FT_BEGIN_HEADER
* strike_index ::
* The current strike index.
*
* @Output:
* @output:
* arange ::
* The SBit range containing the glyph index.
*
@ -222,7 +222,7 @@ FT_BEGIN_HEADER
* aglyph_offset ::
* The offset of the glyph data in `EBDT' table.
*
* @Return:
* @return:
* FreeType error code. 0 means success. Returns
* SFNT_Err_Invalid_Argument if no sbit exists for the requested
* glyph.
@ -238,27 +238,27 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Load_SBit_Metrics_Func
*
* @Description:
* @description:
* Get the big metrics for a given embedded bitmap.
*
* @Input:
* @input:
* stream ::
* The input stream.
*
* range ::
* The SBit range containing the glyph.
*
* @Output:
* @output:
* big_metrics ::
* A big SBit metrics structure for the glyph.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*
* @Note:
* @note:
* The stream cursor must be positioned at the glyph's offset within
* the `EBDT' table before the call.
*
@ -274,14 +274,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Load_SBit_Image_Func
*
* @Description:
* @description:
* Load a given glyph sbit image from the font resource. This also
* returns its metrics.
*
* @Input:
* @input:
* face ::
* The target face object.
*
@ -297,18 +297,18 @@ FT_BEGIN_HEADER
* stream ::
* The input stream.
*
* @Output:
* @output:
* amap ::
* The target pixmap.
*
* ametrics ::
* A big sbit metrics structure for the glyph image.
*
* @Return:
* @return:
* FreeType error code. 0 means success. Returns an error if no
* glyph sbit exists for the index.
*
* @Note:
* @note:
* The `map.buffer' field is always freed before the glyph is loaded.
*/
typedef FT_Error
@ -323,24 +323,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Set_SBit_Strike_Func
*
* @Description:
* @description:
* Select an sbit strike for a given size request.
*
* @Input:
* @input:
* face ::
* The target face object.
*
* req ::
* The size request.
*
* @Output:
* @output:
* astrike_index ::
* The index of the sbit strike.
*
* @Return:
* @return:
* FreeType error code. 0 means success. Returns an error if no
* sbit strike exists for the selected ppem values.
*/
@ -352,24 +352,24 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Load_Strike_Metrics_Func
*
* @Description:
* @description:
* Load the metrics of a given strike.
*
* @Input:
* @input:
* face ::
* The target face object.
*
* strike_index ::
* The strike index.
*
* @Output:
* @output:
* metrics ::
* the metrics of the strike.
*
* @Return:
* @return:
* FreeType error code. 0 means success. Returns an error if no
* such sbit strike exists.
*/
@ -381,13 +381,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Get_PS_Name_Func
*
* @Description:
* @description:
* Get the PostScript glyph name of a glyph.
*
* @Input:
* @input:
* idx ::
* The glyph index.
*
@ -397,7 +397,7 @@ FT_BEGIN_HEADER
*
* You must not modify the returned string!
*
* @Output:
* @output:
* FreeType error code. 0 means success.
*/
typedef FT_Error
@ -408,14 +408,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Load_Metrics_Func
*
* @Description:
* @description:
* Load a metrics table, which is a table with a horizontal and a
* vertical version.
*
* @Input:
* @input:
* face ::
* A handle to the target face object.
*
@ -425,7 +425,7 @@ FT_BEGIN_HEADER
* vertical ::
* A boolean flag. If set, load the vertical one.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*/
typedef FT_Error
@ -436,13 +436,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Get_Metrics_Func
*
* @Description:
* @description:
* Load the horizontal or vertical header in a face object.
*
* @Input:
* @input:
* face ::
* A handle to the target face object.
*
@ -452,7 +452,7 @@ FT_BEGIN_HEADER
* gindex ::
* The glyph index.
*
* @Output:
* @output:
* abearing ::
* The horizontal (or vertical) bearing. Set to zero in
* case of error.
@ -471,20 +471,20 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Set_Palette_Func
*
* @Description:
* @description:
* Load the colors into `face->palette' for a given palette index.
*
* @Input:
* @input:
* face ::
* The target face object.
*
* idx ::
* The palette index.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*/
typedef FT_Error
@ -494,13 +494,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Get_Colr_Layer_Func
*
* @Description:
* @description:
* Iteratively get the color layer data of a given glyph index.
*
* @Input:
* @input:
* face ::
* The target face object.
*
@ -534,10 +534,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Blend_Colr_Func
*
* @Description:
* @description:
* Blend the bitmap in `new_glyph' into `base_glyph' using the color
* specified by `color_index'. If `color_index' is 0xFFFF, use
* `face->foreground_color' if `face->have_foreground_color' is set.
@ -546,7 +546,7 @@ FT_BEGIN_HEADER
* 0xFFFFFFFF (white opaque). Otherwise use BGRA value 0x000000FF
* (black opaque).
*
* @Input:
* @input:
* face ::
* The target face object.
*
@ -560,7 +560,7 @@ FT_BEGIN_HEADER
* new_glyph ::
* Slot to be incooperated into `base_glyph'.
*
* @Return:
* @return:
* FreeType error code. 0 means success. Returns an error if
* color_index is invalid or reallocation fails.
*/
@ -573,26 +573,26 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Get_Name_Func
*
* @Description:
* @description:
* From the `name' table, return a given ENGLISH name record in
* ASCII.
*
* @Input:
* @input:
* face ::
* A handle to the source face object.
*
* nameid ::
* The name id of the name record to return.
*
* @InOut:
* @inout:
* name ::
* The address of an allocated string pointer. NULL if
* no name is present.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*/
typedef FT_Error
@ -603,21 +603,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Get_Name_ID_Func
*
* @Description:
* @description:
* Search whether an ENGLISH version for a given name ID is in the
* `name' table.
*
* @Input:
* @input:
* face ::
* A handle to the source face object.
*
* nameid ::
* The name id of the name record to return.
*
* @Output:
* @output:
* win ::
* If non-negative, an index into the `name' table with
* the corresponding (3,1) or (3,0) Windows entry.
@ -626,7 +626,7 @@ FT_BEGIN_HEADER
* If non-negative, an index into the `name' table with
* the corresponding (1,0) Apple entry.
*
* @Return:
* @return:
* 1 if there is either a win or apple entry (or both), 0 otheriwse.
*/
typedef FT_Bool
@ -638,23 +638,23 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Load_Table_Func
*
* @Description:
* @description:
* Load a given TrueType table.
*
* @Input:
* @input:
* face ::
* A handle to the target face object.
*
* stream ::
* The input stream.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*
* @Note:
* @note:
* The function uses `face->goto_table' to seek the stream to the
* start of the table, except while loading the font directory.
*/
@ -665,13 +665,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Free_Table_Func
*
* @Description:
* @description:
* Free a given TrueType table.
*
* @Input:
* @input:
* face ::
* A handle to the target face object.
*/
@ -702,14 +702,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* SFNT_Interface
*
* @Description:
* @description:
* This structure holds pointers to the functions used to load and
* free the basic tables that are required in a `sfnt' font file.
*
* @Fields:
* @fields:
* Check the various xxx_Func() descriptions for details.
*/
typedef struct SFNT_Interface_

6
include/freetype/internal/t1types.h
Unescape View File

@ -47,13 +47,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* T1_EncodingRec
*
* @Description:
* @description:
* A structure modeling a custom encoding.
*
* @Fields:
* @fields:
* num_chars ::
* The number of character codes in the encoding.
* Usually 256.

188
include/freetype/internal/tttypes.h
Unescape View File

@ -49,14 +49,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TTC_HeaderRec
*
* @Description:
* @description:
* TrueType collection header. This table contains the offsets of
* the font headers of each distinct TrueType face in the file.
*
* @Fields:
* @fields:
* tag ::
* Must be `ttc ' to indicate a TrueType collection.
*
@ -84,13 +84,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* SFNT_HeaderRec
*
* @Description:
* @description:
* SFNT file format header.
*
* @Fields:
* @fields:
* format_tag ::
* The font format tag.
*
@ -121,13 +121,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_TableRec
*
* @Description:
* @description:
* This structure describes a given table of a TrueType font.
*
* @Fields:
* @fields:
* Tag ::
* A four-bytes tag describing the table.
*
@ -153,13 +153,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* WOFF_HeaderRec
*
* @Description:
* @description:
* WOFF file format header.
*
* @Fields:
* @fields:
* See
*
* https://www.w3.org/TR/WOFF/#WOFFHeader
@ -185,13 +185,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* WOFF_TableRec
*
* @Description:
* @description:
* This structure describes a given table of a WOFF font.
*
* @Fields:
* @fields:
* Tag ::
* A four-bytes tag describing the table.
*
@ -228,14 +228,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_LongMetricsRec
*
* @Description:
* @description:
* A structure modeling the long metrics of the `hmtx' and `vmtx'
* TrueType tables. The values are expressed in font units.
*
* @Fields:
* @fields:
* advance ::
* The advance width or height for the glyph.
*
@ -252,10 +252,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* TT_ShortMetrics
*
* @Description:
* @description:
* A simple type to model the short metrics of the `hmtx' and `vmtx'
* tables.
*/
@ -264,16 +264,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_NameRec
*
* @Description:
* @description:
* A structure modeling TrueType name records. Name records are used
* to store important strings like family name, style name,
* copyright, etc. in _localized_ versions (i.e., language, encoding,
* etc).
*
* @Fields:
* @fields:
* platformID ::
* The ID of the name's encoding platform.
*
@ -315,14 +315,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_LangTagRec
*
* @Description:
* @description:
* A structure modeling language tag records in SFNT `name' tables,
* introduced in OpenType version 1.6.
*
* @Fields:
* @fields:
* stringLength ::
* The length of the string in bytes.
*
@ -348,13 +348,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_NameTableRec
*
* @Description:
* @description:
* A structure modeling the TrueType name table.
*
* @Fields:
* @fields:
* format ::
* The format of the name table.
*
@ -405,14 +405,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_GaspRangeRec
*
* @Description:
* @description:
* A tiny structure used to model a gasp range according to the
* TrueType specification.
*
* @Fields:
* @fields:
* maxPPEM ::
* The maximum ppem value to which `gaspFlag' applies.
*
@ -434,14 +434,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_GaspRec
*
* @Description:
* @description:
* A structure modeling the TrueType `gasp' table used to specify
* grid-fitting and anti-aliasing behaviour.
*
* @Fields:
* @fields:
* version ::
* The version number.
*
@ -475,15 +475,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_SBit_MetricsRec
*
* @Description:
* @description:
* A structure used to hold the big metrics of a given glyph bitmap
* in a TrueType or OpenType font. These are usually found in the
* `EBDT' (Microsoft) or `bloc' (Apple) table.
*
* @Fields:
* @fields:
* height ::
* The glyph height in pixels.
*
@ -526,15 +526,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_SBit_SmallMetricsRec
*
* @Description:
* @description:
* A structure used to hold the small metrics of a given glyph bitmap
* in a TrueType or OpenType font. These are usually found in the
* `EBDT' (Microsoft) or the `bdat' (Apple) table.
*
* @Fields:
* @fields:
* height ::
* The glyph height in pixels.
*
@ -564,14 +564,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_SBit_LineMetricsRec
*
* @Description:
* @description:
* A structure used to describe the text line metrics of a given
* bitmap strike, for either a horizontal or vertical layout.
*
* @Fields:
* @fields:
* ascender ::
* The ascender in pixels.
*
@ -643,14 +643,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_SBit_RangeRec
*
* @Description:
* @description:
* A TrueType/OpenType subIndexTable as defined in the `EBLC'
* (Microsoft) or `bloc' (Apple) tables.
*
* @Fields:
* @fields:
* first_glyph ::
* The first glyph index in the range.
*
@ -712,14 +712,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_SBit_StrikeRec
*
* @Description:
* @description:
* A structure used describe a given bitmap strike in the `EBLC'
* (Microsoft) or `bloc' (Apple) tables.
*
* @Fields:
* @fields:
* num_index_ranges ::
* The number of index ranges.
*
@ -787,13 +787,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_SBit_ComponentRec
*
* @Description:
* @description:
* A simple structure to describe a compound sbit element.
*
* @Fields:
* @fields:
* glyph_code ::
* The element's glyph index.
*
@ -814,14 +814,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_SBit_ScaleRec
*
* @Description:
* @description:
* A structure used describe a given bitmap scaling table, as defined
* in the `EBSC' table.
*
* @Fields:
* @fields:
* hori ::
* The horizontal line metrics.
*
@ -869,14 +869,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_Post_20Rec
*
* @Description:
* @description:
* Postscript names sub-table, format 2.0. Stores the PS name of
* each glyph in the font face.
*
* @Fields:
* @fields:
* num_glyphs ::
* The number of named glyphs in the table.
*
@ -901,14 +901,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_Post_25Rec
*
* @Description:
* @description:
* Postscript names sub-table, format 2.5. Stores the PS name of
* each glyph in the font face.
*
* @Fields:
* @fields:
* num_glyphs ::
* The number of glyphs in the table.
*
@ -926,13 +926,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_Post_NamesRec
*
* @Description:
* @description:
* Postscript names table, either format 2.0 or 2.5.
*
* @Fields:
* @fields:
* loaded ::
* A flag to indicate whether the PS names are loaded.
*
@ -1066,15 +1066,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* TT_Face
*
* @Description:
* @description:
* A handle to a TrueType face/font object. A TT_Face encapsulates
* the resolution and scaling independent parts of a TrueType font
* resource.
*
* @Note:
* @note:
* The TT_Face structure is also used as a `parent class' for the
* OpenType-CFF class (T2_Face).
*/
@ -1091,13 +1091,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Loader_GotoTableFunc
*
* @Description:
* @description:
* Seeks a stream to the start of a given TrueType table.
*
* @Input:
* @input:
* face ::
* A handle to the target face object.
*
@ -1107,15 +1107,15 @@ FT_BEGIN_HEADER
* stream ::
* The input stream.
*
* @Output:
* @output:
* length ::
* The length of the table in bytes. Set to 0 if not
* needed.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*
* @Note:
* @note:
* The stream cursor must be at the font file's origin.
*/
typedef FT_Error
@ -1127,14 +1127,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Loader_StartGlyphFunc
*
* @Description:
* @description:
* Seeks a stream to the start of a given glyph element, and opens a
* frame for it.
*
* @Input:
* @input:
* loader ::
* The current TrueType glyph loader object.
*
@ -1147,10 +1147,10 @@ FT_BEGIN_HEADER
* byte_count ::
* The size of the frame in bytes.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*
* @Note:
* @note:
* This function is normally equivalent to FT_STREAM_SEEK(offset)
* followed by FT_FRAME_ENTER(byte_count) with the loader's stream,
* but alternative formats (e.g. compressed ones) might use something
@ -1165,18 +1165,18 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Loader_ReadGlyphFunc
*
* @Description:
* @description:
* Reads one glyph element (its header, a simple glyph, or a
* composite) from the loader's current stream frame.
*
* @Input:
* @input:
* loader ::
* The current TrueType glyph loader object.
*
* @Return:
* @return:
* FreeType error code. 0 means success.
*/
typedef FT_Error
@ -1185,13 +1185,13 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @FuncType:
* @functype:
* TT_Loader_EndGlyphFunc
*
* @Description:
* @description:
* Closes the current loader stream frame for the glyph.
*
* @Input:
* @input:
* loader ::
* The current TrueType glyph loader object.
*/
@ -1245,14 +1245,14 @@ FT_BEGIN_HEADER
*
* TrueType Face Type
*
* @Struct:
* @struct:
* TT_Face
*
* @Description:
* @description:
* The TrueType face class. These objects model the resolution and
* point-size independent data found in a TrueType font file.
*
* @Fields:
* @fields:
* root ::
* The base FT_Face structure, managed by the
* base layer.
@ -1791,14 +1791,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_GlyphZoneRec
*
* @Description:
* @description:
* A glyph zone is used to load, scale and hint glyph outline
* coordinates.
*
* @Fields:
* @fields:
* memory ::
* A handle to the memory manager.
*
@ -1856,10 +1856,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Type:
* @type:
* TT_Size
*
* @Description:
* @description:
* A handle to a TrueType size object.
*/
typedef struct TT_SizeRec_* TT_Size;

80
include/freetype/t1tables.h
Unescape View File

@ -36,20 +36,20 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* type1_tables
*
* @Title:
* @title:
* Type 1 Tables
*
* @Abstract:
* @abstract:
* Type~1 (PostScript) specific font tables.
*
* @Description:
* @description:
* This section contains the definition of Type 1-specific tables,
* including structures related to other PostScript font formats.
*
* @Order:
* @order:
* PS_FontInfoRec
* PS_FontInfo
* PS_PrivateRec
@ -78,10 +78,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* PS_FontInfoRec
*
* @Description:
* @description:
* A structure used to model a Type~1 or Type~2 FontInfo dictionary.
* Note that for Multiple Master fonts, each instance has its own
* FontInfo dictionary.
@ -103,10 +103,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* PS_FontInfo
*
* @Description:
* @description:
* A handle to a @PS_FontInfoRec structure.
*/
typedef struct PS_FontInfoRec_* PS_FontInfo;
@ -114,10 +114,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* T1_FontInfo
*
* @Description:
* @description:
* This type is equivalent to @PS_FontInfoRec. It is deprecated but
* kept to maintain source compatibility between various versions of
* FreeType.
@ -127,10 +127,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* PS_PrivateRec
*
* @Description:
* @description:
* A structure used to model a Type~1 or Type~2 private dictionary.
* Note that for Multiple Master fonts, each instance has its own
* Private dictionary.
@ -178,10 +178,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* PS_Private
*
* @Description:
* @description:
* A handle to a @PS_PrivateRec structure.
*/
typedef struct PS_PrivateRec_* PS_Private;
@ -189,10 +189,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* T1_Private
*
* @Description:
* @description:
* This type is equivalent to @PS_PrivateRec. It is deprecated but
* kept to maintain source compatibility between various versions of
* FreeType.
@ -202,15 +202,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Enum:
* @enum:
* T1_Blend_Flags
*
* @Description:
* @description:
* A set of flags used to indicate which fields are present in a
* given blend dictionary (font info or private). Used to support
* Multiple Masters fonts.
*
* @Values:
* @values:
* T1_BLEND_UNDERLINE_POSITION ::
* T1_BLEND_UNDERLINE_THICKNESS ::
* T1_BLEND_ITALIC_ANGLE ::
@ -332,10 +332,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* CID_FaceDictRec
*
* @Description:
* @description:
* A structure used to represent data in a CID top-level dictionary.
*/
typedef struct CID_FaceDictRec_
@ -361,10 +361,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* CID_FaceDict
*
* @Description:
* @description:
* A handle to a @CID_FaceDictRec structure.
*/
typedef struct CID_FaceDictRec_* CID_FaceDict;
@ -372,10 +372,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* CID_FontDict
*
* @Description:
* @description:
* This type is equivalent to @CID_FaceDictRec. It is deprecated but
* kept to maintain source compatibility between various versions of
* FreeType.
@ -385,10 +385,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* CID_FaceInfoRec
*
* @Description:
* @description:
* A structure used to represent CID Face information.
*/
typedef struct CID_FaceInfoRec_
@ -423,10 +423,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* CID_FaceInfo
*
* @Description:
* @description:
* A handle to a @CID_FaceInfoRec structure.
*/
typedef struct CID_FaceInfoRec_* CID_FaceInfo;
@ -434,10 +434,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* CID_Info
*
* @Description:
* @description:
* This type is equivalent to @CID_FaceInfoRec. It is deprecated but
* kept to maintain source compatibility between various versions of
* FreeType.
@ -540,21 +540,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Enum:
* @enum:
* T1_EncodingType
*
* @Description:
* @description:
* An enumeration describing the `Encoding' entry in a Type 1
* dictionary.
*
* @Values:
* @values:
* T1_ENCODING_TYPE_NONE ::
* T1_ENCODING_TYPE_ARRAY ::
* T1_ENCODING_TYPE_STANDARD ::
* T1_ENCODING_TYPE_ISOLATIN1 ::
* T1_ENCODING_TYPE_EXPERT ::
*
* @Since:
* @since:
* 2.4.8
*/
typedef enum T1_EncodingType_
@ -570,14 +570,14 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Enum:
* @enum:
* PS_Dict_Keys
*
* @Description:
* @description:
* An enumeration used in calls to @FT_Get_PS_Font_Value to identify
* the Type~1 dictionary entry to retrieve.
*
* @Values:
* @values:
* PS_DICT_FONT_TYPE ::
* PS_DICT_FONT_MATRIX ::
* PS_DICT_FONT_BBOX ::
@ -625,7 +625,7 @@ FT_BEGIN_HEADER
* PS_DICT_FS_TYPE ::
* PS_DICT_ITALIC_ANGLE ::
*
* @Since:
* @since:
* 2.4.8
*/
typedef enum PS_Dict_Keys_

2
include/freetype/ttnameid.h
Unescape View File

@ -28,7 +28,7 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* truetype_tables
*/

86
include/freetype/tttables.h
Unescape View File

@ -35,21 +35,21 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Section:
* @section:
* truetype_tables
*
* @Title:
* @title:
* TrueType Tables
*
* @Abstract:
* @abstract:
* TrueType specific table types and functions.
*
* @Description:
* @description:
* This section contains definitions of some basic tables specific to
* TrueType and OpenType as well as some routines used to access and
* process them.
*
* @Order:
* @order:
* TT_Header
* TT_HoriHeader
* TT_VertHeader
@ -73,10 +73,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_Header
*
* @Description:
* @description:
* A structure to model a TrueType font header table. All fields
* follow the OpenType specification.
*/
@ -111,15 +111,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_HoriHeader
*
* @Description:
* @description:
* A structure to model a TrueType horizontal header, the `hhea'
* table, as well as the corresponding horizontal metrics table,
* `hmtx'.
*
* @Fields:
* @fields:
* Version ::
* The table version.
*
@ -206,7 +206,7 @@ FT_BEGIN_HEADER
* short_metrics ::
* A pointer into the `hmtx' table.
*
* @Note:
* @note:
* For an OpenType variation font, the values of the following fields
* can change after a call to @FT_Set_Var_Design_Coordinates (and
* friends) if the font contains an `MVAR' table: `caret_Slope_Rise',
@ -245,15 +245,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_VertHeader
*
* @Description:
* @description:
* A structure used to model a TrueType vertical header, the `vhea'
* table, as well as the corresponding vertical metrics table,
* `vmtx'.
*
* @Fields:
* @fields:
* Version ::
* The table version.
*
@ -343,7 +343,7 @@ FT_BEGIN_HEADER
* short_metrics ::
* A pointer into the `vmtx' table.
*
* @Note:
* @note:
* For an OpenType variation font, the values of the following fields
* can change after a call to @FT_Set_Var_Design_Coordinates (and
* friends) if the font contains an `MVAR' table: `Ascender',
@ -383,10 +383,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_OS2
*
* @Description:
* @description:
* A structure to model a TrueType `OS/2' table. All fields comply
* to the OpenType specification.
*
@ -394,7 +394,7 @@ FT_BEGIN_HEADER
* `OS/2' table. In this case, the `version' field is always set to
* 0xFFFF.
*
* @Note:
* @note:
* For an OpenType variation font, the values of the following fields
* can change after a call to @FT_Set_Var_Design_Coordinates (and
* friends) if the font contains an `MVAR' table: `sCapHeight',
@ -469,16 +469,16 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_Postscript
*
* @Description:
* @description:
* A structure to model a TrueType `post' table. All fields comply
* to the OpenType specification. This structure does not reference
* a font's PostScript glyph names; use @FT_Get_Glyph_Name to
* retrieve them.
*
* @Note:
* @note:
* For an OpenType variation font, the values of the following fields
* can change after a call to @FT_Set_Var_Design_Coordinates (and
* friends) if the font contains an `MVAR' table: `underlinePosition'
@ -504,10 +504,10 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_PCLT
*
* @Description:
* @description:
* A structure to model a TrueType `PCLT' table. All fields comply
* to the OpenType specification.
*/
@ -534,15 +534,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Struct:
* @struct:
* TT_MaxProfile
*
* @Description:
* @description:
* The maximum profile (`maxp') table contains many max values, which
* can be used to pre-allocate arrays for speeding up glyph loading
* and hinting.
*
* @Fields:
* @fields:
* version ::
* The version number.
*
@ -608,7 +608,7 @@ FT_BEGIN_HEADER
* The maximum nesting depth of composite
* glyphs.
*
* @Note:
* @note:
* This structure is only used during font loading.
*/
typedef struct TT_MaxProfile_
@ -634,15 +634,15 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Enum:
* @enum:
* FT_Sfnt_Tag
*
* @Description:
* @description:
* An enumeration to specify indices of SFNT tables loaded and parsed
* by FreeType during initialization of an SFNT font. Used in the
* @FT_Get_Sfnt_Table API function.
*
* @Values:
* @values:
* FT_SFNT_HEAD ::
* To access the font's @TT_Header structure.
*
@ -691,20 +691,20 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_Sfnt_Table
*
* @Description:
* @description:
* Return a pointer to a given SFNT table stored within a face.
*
* @Input:
* @input:
* face ::
* A handle to the source.
*
* tag ::
* The index of the SFNT table.
*
* @Return:
* @return:
* A type-less pointer to the table. This will be NULL in case of
* error, or if the corresponding table was not found *OR* loaded
* from the file.
@ -712,7 +712,7 @@ FT_BEGIN_HEADER
* Use a typecast according to `tag' to access the structure
* elements.
*
* @Note:
* @note:
* The table is owned by the face object and disappears with it.
*
* This function is only useful to access SFNT tables that are loaded
@ -850,18 +850,18 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_CMap_Language_ID
*
* @Description:
* @description:
* Return cmap language ID as specified in the OpenType standard.
* Definitions of language ID values are in file @FT_TRUETYPE_IDS_H.
*
* @Input:
* @input:
* charmap ::
* The target charmap.
*
* @Return:
* @return:
* The language ID of `charmap'. If `charmap' doesn't belong to an
* SFNT face, just return~0 as the default value.
*
@ -874,17 +874,17 @@ FT_BEGIN_HEADER
/**************************************************************************
*
* @Function:
* @function:
* FT_Get_CMap_Format
*
* @Description:
* @description:
* Return the format of an SFNT `cmap' table.
*
* @Input:
* @input:
* charmap ::
* The target charmap.
*
* @Return:
* @return:
* The format of `charmap'. If `charmap' doesn't belong to an SFNT
* face, return -1.
*/

Write Preview
Loading…
Cancel
Save