paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-06 14:58:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: FreeType. Fixes missing punctuation in short descriptions.

Browse Source 
git-svn-id: trunk@65271 -
This commit is contained in:
dsiders 2021-06-18 05:59:28 +00:00
parent 119d138004
commit 9e98d206ad
17 changed files with 368 additions and 369 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/xml/freetype/easylazfreetype.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="EasyLazFreeType">
<short>Implements a simple interface to the FreeType library</short>
<short>Implements a simple interface to the FreeType library.</short>
<descr>
<p>
Provides classes and types needed for FreeType fonts and glyphs, and the drawing class used to render text or glyphs using a specified FreeType font.

46
docs/xml/freetype/lazfreetype.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="LazFreeType">
<short>Implements a high-level interface to the FreeType library</short>
<short>Implements a high-level interface to the FreeType library.</short>
<descr>
<p>
<file>lazfreetype.pas</file> implements the high-level interface to the FreeType library. It is based in code provided by the FreeType project (freetype.pas), Copyright 1996 by David Turner, Robert Wilhelm and Werner Lemberg.
@ -31,7 +31,7 @@
<element name="Classes"/>
<element name="TT_Init_FreeType">
<short>Initializes the FreeType engine</short>
<short>Initializes the FreeType engine.</short>
<descr/>
<seealso/>
</element>
@ -40,13 +40,13 @@
</element>
<element name="TT_Done_FreeType">
<short>Finalizes the FreeType engine, and discards all objects</short>
<short>Finalizes the FreeType engine, and discards all objects.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Set_Raster_Palette">
<short>Set the gray-level palette used for font-smoothing</short>
<short>Set the gray-level palette used for font-smoothing.</short>
<descr>
<p>
palette is an array of Byte values which define the gray-level palette used in the default
@ -90,14 +90,14 @@
</seealso>
</element>
<element name="TT_Set_Raster_Palette.Result">
<short>Success or error status value returned from the routine</short>
<short>Success or error status value returned from the routine.</short>
</element>
<element name="TT_Set_Raster_Palette.palette">
<short>Values for the gray-level palette</short>
<short>Values for the gray-level palette.</short>
</element>
<element name="TT_Open_Face">
<short>Opens a new font and returns a handle for it in the _face argument</short>
<short>Opens a new font and returns a handle for it in the _face argument.</short>
<descr>
<p>
<var>TT_Open_Face</var>
@ -135,20 +135,20 @@
</seealso>
</element>
<element name="TT_Open_Face.Result">
<short>Success or error status for the operation</short>
<short>Success or error status for the operation.</short>
</element>
<element name="TT_Open_Face.fontname">
<short>TrueType font file or collection opened in the routine</short>
<short>TrueType font file or collection opened in the routine.</short>
</element>
<element name="TT_Open_Face._face">
<short>Handle for the font face opened in the routine</short>
<short>Handle for the font face opened in the routine.</short>
</element>
<element name="TT_Open_Face.AStream">
<short>Stream with the font data examined in the routine</short>
<short>Stream with the font data examined in the routine.</short>
</element>
<element name="TT_Open_Collection">
<short>Opens a font file embedded in a collection</short>
<short>Opens a font file embedded in a collection.</short>
<descr>
<p>
<var>TT_Open_Collection</var>
@ -184,20 +184,20 @@
</seealso>
</element>
<element name="TT_Open_Collection.Result">
<short>Success or fail status for the routine</short>
<short>Success or fail status for the routine.</short>
</element>
<element name="TT_Open_Collection.fontname">
<short>Font collection examined in the routine</short>
<short>Font collection examined in the routine.</short>
</element>
<element name="TT_Open_Collection.faceIndex">
<short>Position of the desired font embedded in the collection</short>
<short>Position of the desired font embedded in the collection.</short>
</element>
<element name="TT_Open_Collection._face">
<short>Handle for the font face opened in the routine</short>
<short>Handle for the font face opened in the routine.</short>
</element>
<element name="TT_Get_Face_Properties">
<short>Gets properties for the specified font face</short>
<short>Gets properties for the specified font face.</short>
<descr>
<p>
<var>TT_Get_Face_Properties</var>
@ -249,25 +249,25 @@
<short>Success or failure status for the routine. 0 indicates success.</short>
</element>
<element name="TT_Get_Face_Properties._face">
<short>Font face examined in the routine</short>
<short>Font face examined in the routine.</short>
</element>
<element name="TT_Get_Face_Properties.prop">
<short>Properties for the specified font face</short>
<short>Properties for the specified font face.</short>
</element>
<element name="TT_Set_Face_Pointer">
<short>Sets the pointer to the data for the font face</short>
<short>Sets the pointer to the data for the font face.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Set_Face_Pointer.Result">
<short>Success or failure status for the routine</short>
<short>Success or failure status for the routine.</short>
</element>
<element name="TT_Set_Face_Pointer._face">
<short>Font face updated in the routine</short>
<short>Font face updated in the routine.</short>
</element>
<element name="TT_Set_Face_Pointer.data">
<short>Pointer to the data assigned to the specified font face</short>
<short>Pointer to the data assigned to the specified font face.</short>
</element>
<element name="TT_Get_Face_Pointer">

100
docs/xml/freetype/lazfreetypefontcollection.xml
View File

@ -8,7 +8,7 @@
-->
<module name="LazFreeTypeFontCollection">
<short>
Contains a font collection and font collection items used in the FreeType library
Contains a font collection and font collection items used in the FreeType library.
</short>
<descr>
<p>
@ -25,7 +25,7 @@
<element name="TTTypes"/>
<element name="TFontCollectionItem">
<short>Implements a collection item for a font used in the FreeType library</short>
<short>Implements a collection item for a font used in the FreeType library.</short>
<descr>
<p>
Used in the implementation of the TFamilyCollectionItem and TFreeTypeFontCollection classes.
@ -55,46 +55,46 @@
</element>
<element name="TFontCollectionItem.SetInformation">
<short>Sets the value for the indexed Information property</short>
<short>Sets the value for the indexed Information property.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.SetInformation.AIndex">
<short>Ordinal position where the new value is stored</short>
<short>Ordinal position where the new value is stored.</short>
</element>
<element name="TFontCollectionItem.SetInformation.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TFontCollectionItem.SetUsePostscriptStyle">
<short>Sets the value for the UsePostscriptStyle property</short>
<short>Sets the value for the UsePostscriptStyle property.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.SetUsePostscriptStyle.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TFontCollectionItem.GetFilename">
<short>Gets the value for the Filename property</short>
<short>Gets the value for the Filename property.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.GetFilename.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TFontCollectionItem.GetBold">
<short>Indicates whether the Bold style is included in the list of styles for the font face</short>
<short>Indicates whether the Bold style is included in the list of styles for the font face.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.GetBold.Result">
<short>True when Bold is included in the list of styles for the font</short>
<short>True when Bold is included in the list of styles for the font.</short>
</element>
<element name="TFontCollectionItem.GetInformation">
<short>Gets the value for the indexed Information property</short>
<short>Gets the value for the indexed Information property.</short>
<descr/>
<seealso>
<link id="TFontCollectionItem.Information"/>
@ -102,15 +102,15 @@
</seealso>
</element>
<element name="TFontCollectionItem.GetInformation.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TFontCollectionItem.GetInformation.AIndex">
<short>Identifies the datum retrieved for the property value</short>
<short>Identifies the datum retrieved for the property value.</short>
</element>
<element name="TFontCollectionItem.GetItalic">
<short>
Indicates whether the Italic style is included in the list of styles for the font face
Indicates whether the Italic style is included in the list of styles for the font face.
</short>
<descr/>
<seealso/>
@ -120,138 +120,140 @@
</element>
<element name="TFontCollectionItem.GetStyleCount">
<short>Gets the value for the StyleCount property</short>
<short>Gets the value for the StyleCount property.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.GetStyleCount.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TFontCollectionItem.GetStyles">
<short>Gets the value for the Styles property</short>
<short>Gets the value for the Styles property.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.GetStyles.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TFontCollectionItem.GetStyle">
<short>Gets the value for the indexed Style property</short>
<short>Gets the value for the indexed Style property.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.GetStyle.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TFontCollectionItem.GetStyle.AIndex">
<short>Ordinal position for the style used in the property value</short>
<short>Ordinal position for the style used in the property value.</short>
</element>
<element name="TFontCollectionItem.GetVersionNumber">
<short>Gets the value for the VersionNumber property</short>
<short>Gets the value for the VersionNumber property.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.GetVersionNumber.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TFontCollectionItem.NotifyDestroy">
<short>Executes the notification procedure in listeners when the collection item is freed</short>
<short>Executes the notification procedure in listeners when the collection item is freed.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.Init">
<short>Sets the default values for members in the collection item</short>
<short>Sets the default values for members in the collection item.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.Create.AFilename">
<short>File name for the font in the collection item</short>
<short>File name for the font in the collection item.</short>
</element>
<element name="TFontCollectionItem.Create.AStream">
<short>Stream instance with the font for the collection item</short>
<short>Stream instance with the font for the collection item.</short>
</element>
<element name="TFontCollectionItem.Create.AOwner">
<short>Owner of the stream instance</short>
<short>Owner of the stream instance.</short>
</element>
<element name="TFontCollectionItem.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.HasStyle">
<short>Indicates if the specified style name is available for he font</short>
<short>Indicates if the specified style name is available for he font.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.HasStyle.Result">
<short>True when the style name is present in the list of styles for the font</short>
<short>True when the style name is present in the list of styles for the font.</short>
</element>
<element name="TFontCollectionItem.HasStyle.AStyle">
<short>Style name to locate in the styles for the font</short>
<short>Style name to locate in the styles for the font.</short>
</element>
<element name="TFontCollectionItem.Information">
<short>Provides access to embedded data for the font</short>
<short>Provides access to embedded data for the font.</short>
<descr/>
<seealso>
<link id="TFreeTypeInformation"/>
</seealso>
</element>
<element name="TFontCollectionItem.Information.AIndex">
<short>Data item accessed in the font</short>
<short>Data item accessed in the font.</short>
</element>
<element name="TFontCollectionItem.VersionNumber">
<short>Gets the value for the VersionNumber property</short>
<short>Gets the value for the VersionNumber property.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.CreateFont">
<short>Creates a TFreeTypeFont instance for the stream or file name</short>
<short>Creates a TFreeTypeFont instance for the stream or file name.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.CreateFont.Result">
<short>TFreeTypeFont instance created in the method</short>
<short>TFreeTypeFont instance created in the method.</short>
</element>
<element name="TFontCollectionItem.QueryFace">
<short>Opens the font face for the specified listener using the FreeType library</short>
<short>Opens the font face for the specified listener using the FreeType library.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.QueryFace.Result">
<short>Handle for the font face when available</short>
<short>Handle for the font face when available.</short>
</element>
<element name="TFontCollectionItem.QueryFace.AListener">
<short>Listener notifed when the font face is destroyed</short>
<short>Listener notifed when the font face is destroyed.</short>
</element>
<element name="TFontCollectionItem.ReleaseFace">
<short>Frees the handle for the font face and updates the list of listeners</short>
<short>Frees the handle for the font face and updates the list of listeners.</short>
<descr/>
<seealso/>
</element>
<element name="TFontCollectionItem.ReleaseFace.AListener">
<short>Listener removed form thelist of listeners</short>
<short>Listener removed form thelist of listeners.</short>
</element>
<element name="TFontCollectionItem.UsePostscriptStyle">
<short>Indicates if Postscript style names are used in the style list for the font</short>
<short>
Indicates if Postscript style names are used in the style list for the font
</short>
<descr/>
<seealso>
<link id="TFontCollectionItem.Information"/>
@ -260,7 +262,7 @@
</element>
<element name="TFamilyCollectionItem">
<short>Implements a font collection item with styles mapped to font family names</short>
<short>Implements a font collection item with styles mapped to font family names.</short>
<descr/>
<seealso>
<link id="#freetypelaz.easylazfreetype.TCustomFamilyCollectionItem">TCustomFamilyCollectionItem</link>
@ -473,7 +475,7 @@
</element>
<element name="TFreeTypeFontCollection">
<short>Implements a font collection used in the FreeType library</short>
<short>Implements a font collection used in the FreeType library.</short>
<descr>
<p>
Provides methods to add or remove a TrueType font file by name. Methods are provided to load and remove all TrueType fonts found in a directory. Provides enumerators to access fonts by file name or family name.
@ -722,12 +724,12 @@
</element>
<element name="SetDefaultFreeTypeFontCollection">
<short>Sets the default font collection used in EasyLazFreeType to the specified value</short>
<short>Sets the default font collection used in EasyLazFreeType to the specified value.</short>
<descr/>
<seealso/>
</element>
<element name="SetDefaultFreeTypeFontCollection.ACollection">
<short>Font collection used in EasyLazFreeType</short>
<short>Font collection used in EasyLazFreeType.</short>
</element>
</module>

2
docs/xml/freetype/ttcache.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTCache">
<short>Defines and implements object caches used in the FreeType library</short>
<short>Defines and implements object caches used in the FreeType library.</short>
<descr>
<p>
An object class is a structure layout that encapsulate one given type of data used by the FreeType engine. Each object class is completely described by:

2
docs/xml/freetype/ttcalc.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTCalc">
<short>Type and routines needed for arithmetic computations in the FreeType library</short>
<short>Type and routines needed for arithmetic computations in the FreeType library.</short>
<descr/>
<element name="Int16">

36
docs/xml/freetype/ttdebug.xml
View File

@ -7,29 +7,29 @@
====================================================================
-->
<module name="TTDebug">
<short>Used by the debugger</short>
<short>Used by the debugger.</short>
<descr/>
<element name="ByteHexStr">
<short>hex representation of a byte</short>
<short>hex representation of a byte.</short>
<descr/>
<seealso/>
</element>
<element name="ShortHexStr">
<short>hex representation of a short</short>
<short>hex representation of a short.</short>
<descr/>
<seealso/>
</element>
<element name="LongHexStr">
<short>hex representation of a long</short>
<short>hex representation of a long.</short>
<descr/>
<seealso/>
</element>
<element name="DebugStr">
<short>Disassembled line oputput</short>
<short>Disassembled line oputput.</short>
<descr/>
<seealso/>
</element>
@ -77,7 +77,7 @@
<element name="TRangeRec">
<short>
A record to store line number information and a list of breakpoints
A record to store line number information and a list of breakpoints.
</short>
<descr/>
<seealso/>
@ -120,7 +120,7 @@
</element>
<element name="Generate_Range">
<short>Generate Line Number information specific to a given range</short>
<short>Generate Line Number information specific to a given range.</short>
<descr/>
<seealso/>
</element>
@ -135,7 +135,7 @@
</element>
<element name="Throw_Range">
<short>Discard Line Number Information</short>
<short>Discard Line Number Information.</short>
<descr/>
<seealso/>
</element>
@ -144,7 +144,7 @@
</element>
<element name="Toggle_Break">
<short>Toggle a breakpoint</short>
<short>Toggle a breakpoint.</short>
<descr/>
<seealso/>
</element>
@ -159,7 +159,7 @@
</element>
<element name="Set_Break">
<short>Set a breakpoint on a given address</short>
<short>Set a breakpoint on a given address.</short>
<descr/>
<seealso/>
</element>
@ -174,7 +174,7 @@
</element>
<element name="Clear_Break">
<short>Clear one specific breakpoint</short>
<short>Clear one specific breakpoint.</short>
<descr/>
<seealso/>
</element>
@ -186,7 +186,7 @@
</element>
<element name="Clear_All_Breaks">
<short>Clear the breakpoint list</short>
<short>Clear the breakpoint list.</short>
<descr/>
<seealso/>
</element>
@ -195,7 +195,7 @@
</element>
<element name="Find_BreakPoint">
<short>Find one breakpoint at a given address</short>
<short>Find one breakpoint at a given address.</short>
<descr/>
<seealso/>
</element>
@ -213,7 +213,7 @@
</element>
<element name="Cur_U_Line">
<short>Returns the current disassembled line at Code(IP)</short>
<short>Returns the current disassembled line at Code(IP).</short>
<descr/>
<seealso/>
</element>
@ -228,7 +228,7 @@
</element>
<element name="Get_Length">
<short>Returns the length of the current opcode at Code(IP)</short>
<short>Returns the length of the current opcode at Code(IP).</short>
<descr/>
<seealso/>
</element>
@ -258,7 +258,7 @@
</element>
<element name="Hex8">
<short>Returns a 8-bit hexadecimal string</short>
<short>Returns a 8-bit hexadecimal string.</short>
<descr/>
<seealso/>
</element>
@ -270,7 +270,7 @@
</element>
<element name="Hex16">
<short>Returns a 16-bit hexadecimal string</short>
<short>Returns a 16-bit hexadecimal string.</short>
<descr/>
<seealso/>
</element>
@ -282,7 +282,7 @@
</element>
<element name="Hex32">
<short>Returns a 32-bit hexadecimal string</short>
<short>Returns a 32-bit hexadecimal string.</short>
<descr/>
<seealso/>
</element>

12
docs/xml/freetype/tterror.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTError">
<short>Simple error management for the FreeType library</short>
<short>Simple error management for the FreeType library.</short>
<descr>
<p>
Copyright 1996, 1997 by David Turner, Robert Wilhelm, and Werner Lemberg.
@ -66,25 +66,25 @@
</element>
<element name="Err_Ras_NotIni">
<short>Rasterizer not Initialized</short>
<short>Rasterizer not Initialized.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Overflow">
<short>Profile Table Overflow</short>
<short>Profile Table Overflow.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Neg_H">
<short>Negative Height encountered</short>
<short>Negative Height encountered.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Invalid">
<short>Invalid value encountered</short>
<short>Invalid value encountered.</short>
<descr/>
<seealso/>
</element>
@ -96,7 +96,7 @@
</element>
<element name="error">
<short>Global error variable used for the FreeType library</short>
<short>Global error variable used for the FreeType library.</short>
<descr/>
<seealso/>
</element>

8
docs/xml/freetype/ttfile.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTFile">
<short>File I/O specification</short>
<short>File I/O specification.</short>
<descr>
<p>
Copyright 1996 David Turner, Robert Wilhelm and Werner Lemberg.
@ -216,7 +216,7 @@
<element name="TFreeTypeStream.AccessFrame">
<short>
Access the next aSize bytes
Access the next aSize bytes.
</short>
<descr/>
<seealso/>
@ -230,7 +230,7 @@
<element name="TFreeTypeStream.CheckAndAccessFrame">
<short>
Access the next min(aSize ,file_size - file_pos) bytes
Access the next min(aSize ,file_size - file_pos) bytes.
</short>
<descr/>
<seealso/>
@ -244,7 +244,7 @@
<element name="TFreeTypeStream.ForgetFrame">
<short>
Discards the previously cached frame
Discards the previously cached frame.
</short>
<descr/>
<seealso/>

9
docs/xml/freetype/ttgload.xml
View File

@ -7,16 +7,13 @@
====================================================================
-->
<module name="TTGLoad">
<short>TrueType glyph loader</short>
<short>TrueType glyph loader.</short>
<descr>
<p>
Copyright 1996, 1997 by David Turner, Robert Wilhelm, and Werner Lemberg.
</p>
<p>
This file is part of the FreeType project, and may only be used modified and distributed under
the terms of the FreeType project license, LICENSE.TXT. By continuing to use, modify or
distribute this file you indicate that you have read the license and understand and accept it
fully.
This file is part of the FreeType project, and may only be used modified and distributed under the terms of the FreeType project license, LICENSE.TXT. By continuing to use, modify or distribute this file you indicate that you have read the license and understand and accept it fully.
</p>
</descr>
@ -27,7 +24,7 @@
<element name="TTObjs"/>
<element name="Load_TrueType_Glyph">
<short>Loads a font glyph into a given glyph info</short>
<short>Loads a font glyph into a given glyph info.</short>
<descr>
<p>
The instance and glyph objects faces <b>must</b> match. The load_flags indicate what kind of values should be written to the glyph object (metrics, outline in EM coordinates, grid-fitted outline).

12
docs/xml/freetype/ttinterp.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTInterp">
<short>TrueType bytecode intepreter</short>
<short>TrueType bytecode intepreter.</short>
<descr>
<p>
Most of the functionality is found in types and classes defined in the implementation section, and accessed by calling the Run_Ins function. Multithreading should be possible.
@ -47,7 +47,7 @@
<element name="Run_Ins">
<short>
Runs the TrueType bytecode interpreter with the code range and IP in the execution context
Runs the TrueType bytecode interpreter with the code range and IP in the execution context.
</short>
<descr>
Used in the implementation of routines in the <file>TTObjs.pas</file> unit.
@ -55,14 +55,14 @@
<seealso/>
</element>
<element name="Run_Ins.Result">
<short>TError return value from the TInterpreter class instance in the routine</short>
<short>TError return value from the TInterpreter class instance in the routine.</short>
</element>
<element name="Run_Ins.exec">
<short>Execution context for the routine</short>
<short>Execution context for the routine.</short>
</element>
<element name="Run_Ins.AErrorLog">
<short>True enables error logging in the routine</short>
</element>
<short>True enables error logging in the routine.</short>
</element>
</module>
<!-- TTInterp -->

2
docs/xml/freetype/ttkern.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTKern">
<short>Implements kerning tables used in the <file>LazFreeType.pas</file> unit</short>
<short>Implements kerning tables used in the <file>LazFreeType.pas</file> unit.</short>
<descr/>
<element name="Classes"/>

62
docs/xml/freetype/ttload.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTLoad">
<short>TrueType Table loaders used in the FreeType library</short>
<short>TrueType Table loaders used in the FreeType library.</short>
<descr>
<p>
Copyright 1996 David Turner, Robert Wilhelm and Werner Lemberg.
@ -36,18 +36,18 @@
<element name="TTFile"/>
<element name="LookUp_TrueType_Table">
<short>Looks for a TrueType table by name</short>
<short>Looks for a TrueType table by name.</short>
<descr/>
<seealso/>
</element>
<element name="LookUp_TrueType_Table.Result">
<short>Index of the table if found, -1 otherwise</short>
<short>Index of the table if found, -1 otherwise.</short>
</element>
<element name="LookUp_TrueType_Table.face">
<short>Resident table to look for</short>
<short>Resident table to look for.</short>
</element>
<element name="LookUp_TrueType_Table.aTag">
<short>Searched tag</short>
<short>Searched tag.</short>
</element>
<element name="Load_TrueType_Directory">
@ -60,7 +60,7 @@
<seealso/>
</element>
<element name="Load_TrueType_Directory.Result">
<short>True on success, or False on failure</short>
<short>True on success, or False on failure.</short>
</element>
<element name="Load_TrueType_Directory.face">
<short/>
@ -79,14 +79,14 @@
<seealso/>
</element>
<element name="Load_TrueType_MaxProfile.Result">
<short>True on success, or False on failure</short>
<short>True on success, or False on failure.</short>
</element>
<element name="Load_TrueType_MaxProfile.face">
<short/>
</element>
<element name="Load_TrueType_Header">
<short>Load the TrueType header table in the resident table</short>
<short>Load the TrueType header table in the resident table.</short>
<descr>
<remark>
Please note: A font header is a static table that owns no subttable. It has neither a constructor nor a destructor.
@ -95,14 +95,14 @@
<seealso/>
</element>
<element name="Load_TrueType_Header.Result">
<short>True on success, False on failure</short>
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Header.face">
<short>Current leading segment</short>
<short>Current leading segment.</short>
</element>
<element name="Load_TrueType_Locations">
<short>Loads the location table in resident table</short>
<short>Loads the location table in resident table.</short>
<descr>
<remark>
Please note: The Font Header <b>must</b> be loaded in the leading segment before calling this function. This table is destroyed directly by the resident destructor.
@ -111,10 +111,10 @@
<seealso/>
</element>
<element name="Load_TrueType_Locations.Result">
<short>True on success, False on failure</short>
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Locations.face">
<short>Current Resident Leading Segment</short>
<short>Current Resident Leading Segment.</short>
</element>
<element name="Load_TrueType_CVT">
@ -127,7 +127,7 @@
<seealso/>
</element>
<element name="Load_TrueType_CVT.Result">
<short>True on success, False on failur</short>
<short>True on success, False on failur.</short>
</element>
<element name="Load_TrueType_CVT.face">
<short/>
@ -143,7 +143,7 @@
<seealso/>
</element>
<element name="Load_TrueType_CMap.Result">
<short>True on success, False on failure</short>
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_CMap.face">
<short/>
@ -162,7 +162,7 @@
</element>
<element name="Load_TrueType_Names">
<short>Loads the name table into the face table</short>
<short>Loads the name table into the face table.</short>
<descr>
<remark>
Please note: This attribute table is destroyed by the resident destructor.
@ -171,55 +171,55 @@
<seealso/>
</element>
<element name="Load_TrueType_Names.Result">
<short>True on success, False on failure</short>
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Names.face">
<short/>
</element>
<element name="Load_TrueType_Programs">
<short>Load the Font and CVT programs in the resident table</short>
<short>Load the Font and CVT programs in the resident table.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Programs.Result">
<short>True on success, False on failure</short>
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Programs.face">
<short/>
</element>
<element name="Load_TrueType_Postscript">
<short>Loads the Postscript table</short>
<short>Loads the Postscript table.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Postscript.Result">
<short>True on success, False on failure</short>
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Postscript.face">
<short/>
</element>
<element name="Load_TrueType_OS2">
<short>Load the OS/2 Table</short>
<short>Load the OS/2 Table.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_OS2.Result">
<short>True on success, False on failure</short>
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_OS2.face">
<short/>
</element>
<element name="Load_TrueType_HDMX">
<short>Load the 'hdmx' tables</short>
<short>Load the 'hdmx' tables.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_HDMX.Result">
<short>True on success, False on failure</short>
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_HDMX.face">
<short/>
@ -231,11 +231,11 @@
<seealso/>
</element>
<element name="Load_TrueType_Metrics_Header.Result">
<short>True on success, False on failure</short>
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Metrics_Header.face">
<short>
When True, try to load the vertical header
When True, try to load the vertical header.
</short>
</element>
<element name="Load_TrueType_Metrics_Header.vertical">
@ -243,18 +243,18 @@
</element>
<element name="Load_TrueType_Any">
<short>Load any TrueType table in user memory</short>
<short>Load any TrueType table in user memory.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Any.Result">
<short>True on success, False on failure</short>
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Any.face">
<short>The face object for the font file</short>
<short>The face object for the font file.</short>
</element>
<element name="Load_TrueType_Any.tag">
<short>The table</short>
<short>The table.</short>
</element>
<element name="Load_TrueType_Any.offset">
<short/>

2
docs/xml/freetype/ttmemory.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTMemory">
<short>Memory management specification</short>
<short>Memory management specification.</short>
<descr>
<p>
Copyright 1996 David Turner, Robert Wilhelm and Werner Lemberg.

250
docs/xml/freetype/ttobjs.xml
View File

@ -3,7 +3,7 @@
<package name="freetypelaz">
<!-- TTObjs -->
<module name="TTObjs">
<short>Contains objects definitions used in the FreeType (TrueType) library</short>
<short>Contains objects definitions used in the FreeType (TrueType) library.</short>
<descr>
<p>
The four important objects managed by the library are:
@ -74,13 +74,13 @@
<element name="TTCMap"/>
<element name="PGraphicsState">
<short>Pointer to a TGraphicsState record type</short>
<short>Pointer to a TGraphicsState record type.</short>
<descr/>
<seealso/>
</element>
<element name="TGraphicsState">
<short>Graphics State</short>
<short>Graphics State.</short>
<descr>
<p>
The Graphics State (GS) is managed by the instruction field, but does not come from the font file. Thus, we can use <var>int</var> data types where needed.
@ -201,7 +201,7 @@
</element>
<element name="MaxCodeRanges">
<short>Maximum number of code ranges</short>
<short>Maximum number of code ranges.</short>
<descr>
<p>
There can only be 3 active code ranges at once:
@ -254,8 +254,8 @@
<element name="TCodeRange">
<short>
Defines a code range
</short>
Defines a code range.
</short>
<descr>
<p>
Code ranges can be resident to a glyph (i.e. the Font Program), while some others are volatile (Glyph instructions). Tracking the state and presence of code ranges allows function and instruction definitions within a code range to be forgotten when the range is discarded.
@ -277,7 +277,7 @@
</element>
<element name="TCodeRangeTable">
<short>Defines a code range</short>
<short>Defines a code range.</short>
<descr>
<p>
Code ranges can be resident in a glyph (i.e. the Font Program), while some others are volatile (Glyph instructions). Tracking the state and presence of code ranges allows function and instruction definitions within a code range to be forgotten when the range is discarded.
@ -294,8 +294,8 @@
<element name="TDefRecord">
<short>
Defines a function / instruction definition record
</short>
Defines a function / instruction definition record.
</short>
<descr/>
<seealso/>
</element>
@ -341,7 +341,7 @@
</element>
<element name="TCallRecord">
<short>Defines a call record used to manage function calls</short>
<short>Defines a call record used to manage function calls.</short>
<descr/>
<seealso/>
</element>
@ -367,7 +367,7 @@
</element>
<element name="TCallStack">
<short>Defines a simple call stack</short>
<short>Defines a simple call stack.</short>
<descr/>
<seealso/>
</element>
@ -401,12 +401,12 @@
</element>
<element name="TGlyph_Zone.org">
<short>Original (scaled) coordinates</short>
<short>Original (scaled) coordinates.</short>
<descr/>
<seealso/>
</element>
<element name="TGlyph_Zone.cur">
<short>Current coordinates</short>
<short>Current coordinates.</short>
<descr/>
<seealso/>
</element>
@ -422,7 +422,7 @@
</element>
<element name="TRound_Function">
<short>Rounding function, as used by the interpreter</short>
<short>Rounding function, as used by the interpreter.</short>
<descr/>
<seealso/>
</element>
@ -438,8 +438,8 @@
<element name="TMove_Function">
<short>
Point displacement along the freedom vector routine, as used by the interpreter
</short>
Point displacement along the freedom vector routine, as used by the interpreter.
</short>
<descr/>
<seealso/>
</element>
@ -455,8 +455,8 @@
<element name="TProject_Function">
<short>
Distance projection along one of the proj. vectors, as used by the interpreter
</short>
Distance projection along one of the proj. vectors, as used by the interpreter.
</short>
<descr/>
<seealso/>
</element>
@ -472,8 +472,8 @@
<element name="TFunc_Get_CVT">
<short>
Reads a CVT value
</short>
Reads a CVT value.
</short>
<descr>
Take care of non-square pixels when needed.
</descr>
@ -488,8 +488,8 @@
<element name="TFunc_Set_CVT">
<short>
Setting or Moving a CVT value
</short>
Setting or Moving a CVT value.
</short>
<descr>
Take care of non-square pixels when needed.
</descr>
@ -759,21 +759,21 @@ y_ppem = 10
</element>
<element name="TFace">
<short>The FreeType Face object</short>
<short>The FreeType Face object.</short>
<descr/>
<seealso/>
</element>
<element name="TFace.stream">
<short>Input / output stream</short>
<short>Input / output stream.</short>
<descr/>
<seealso/>
</element>
<element name="TFace.ttcHeader">
<short>
TrueType collection header
</short>
TrueType collection header.
</short>
<descr>
TrueType collection header, if any was found.
</descr>
@ -781,7 +781,7 @@ y_ppem = 10
</element>
<element name="TFace.maxProfile">
<short>Maximum profile table</short>
<short>Maximum profile table.</short>
<descr>
<p>
Maximum profile table, as defined by the TrueType Specification.
@ -799,7 +799,7 @@ y_ppem = 10
<seealso/>
</element>
<element name="TFace.fontHeader">
<short>The font header</short>
<short>The font header.</short>
<descr>
<p>
The font header as defined by the TrueType Specification.
@ -808,7 +808,7 @@ y_ppem = 10
<seealso/>
</element>
<element name="TFace.horizontalHeader">
<short>The horizontal header</short>
<short>The horizontal header.</short>
<descr>
<p>
The horizontal header, as defined in the TrueType specification.
@ -817,32 +817,32 @@ y_ppem = 10
<seealso/>
</element>
<element name="TFace.verticalInfo">
<short>Set to true when vertical data is in the font</short>
<short>Set to true when vertical data is in the font.</short>
<descr/>
<seealso/>
</element>
<element name="TFace.verticalHeader">
<short>Vertical header table</short>
<short>Vertical header table.</short>
<descr/>
<seealso/>
</element>
<element name="TFace.os2">
<short>OS/2 table</short>
<short>OS/2 table.</short>
<descr/>
<seealso/>
</element>
<element name="TFace.postscript">
<short>Postscript table</short>
<short>Postscript table.</short>
<descr/>
<seealso/>
</element>
<element name="TFace.hdmx">
<short>Horizontal device metrics table</short>
<short>Horizontal device metrics table.</short>
<descr/>
<seealso/>
</element>
<element name="TFace.nameTable">
<short>Name table</short>
<short>Name table.</short>
<descr/>
<seealso/>
</element>
@ -938,8 +938,8 @@ y_ppem = 10
<element name="TFace.numGlyphs">
<short>
Total number of glyphs in the typeface
</short>
Total number of glyphs in the typeface.
</short>
<descr>
<p>
The value must be set by the maximum profile loader.
@ -949,8 +949,8 @@ y_ppem = 10
</element>
<element name="TFace.maxPoints">
<short>
Maximum number of glyph points, simple and composite
</short>
Maximum number of glyph points, simple and composite.
</short>
<descr>
<p>
The value must be set by the maximum profile loader.
@ -960,8 +960,8 @@ y_ppem = 10
</element>
<element name="TFace.maxContours">
<short>
Maximum number of glyph contours, simple and composite
</short>
Maximum number of glyph contours, simple and composite.
</short>
<descr>
<p>
The value must be set by the maximum profile loader.
@ -971,8 +971,8 @@ y_ppem = 10
</element>
<element name="TFace.maxComponents">
<short>
Maximum number of components in a composite glyph
</short>
Maximum number of components in a composite glyph.
</short>
<descr>
<p>
The value must be set by the maximum profile loader.
@ -1031,7 +1031,7 @@ y_ppem = 10
</element>
<element name="TInstance">
<short>FreeType Instance Object</short>
<short>FreeType Instance Object.</short>
<descr/>
<seealso/>
</element>
@ -1052,8 +1052,8 @@ y_ppem = 10
</element>
<element name="TInstance.numFDefs">
<short>
Number of function definitions
</short>
Number of function definitions.
</short>
<descr/>
<seealso/>
</element>
@ -1064,15 +1064,15 @@ y_ppem = 10
</element>
<element name="TInstance.FDefs">
<short>
Table of FDefs entries
</short>
Table of FDefs entries.
</short>
<descr/>
<seealso/>
</element>
<element name="TInstance.numIDefs">
<short>
Number of instruction definitions
</short>
Number of instruction definitions.
</short>
<descr/>
<seealso/>
</element>
@ -1083,22 +1083,22 @@ y_ppem = 10
</element>
<element name="TInstance.IDefs">
<short>
Table of IDefs entries
</short>
Table of IDefs entries.
</short>
<descr/>
<seealso/>
</element>
<element name="TInstance.maxFunc">
<short>
Maximum function number
</short>
Maximum function number.
</short>
<descr/>
<seealso/>
</element>
<element name="TInstance.maxIns">
<short>
Maximum instruction number
</short>
Maximum instruction number.
</short>
<descr/>
<seealso/>
</element>
@ -1120,8 +1120,8 @@ y_ppem = 10
</element>
<element name="TInstance.storage">
<short>
The storage area
</short>
The storage area.
</short>
<descr/>
<seealso/>
</element>
@ -1132,23 +1132,23 @@ y_ppem = 10
</element>
<element name="TInstance.cvt">
<short>
The scaled Control Value Table
</short>
The scaled Control Value Table.
</short>
<descr/>
<seealso/>
</element>
<element name="TInstance.twilight">
<short>
The instance's twilight zone
</short>
The instance's twilight zone.
</short>
<descr/>
<seealso/>
</element>
<element name="TInstance.debug">
<short>
Debugging variable
</short>
Debugging variable.
</short>
<descr/>
<seealso/>
</element>
@ -1163,8 +1163,8 @@ y_ppem = 10
</element>
<element name="TInstance.genericP">
<short>
Generic pointer
</short>
Generic pointer.
</short>
<descr>
<p>
See TT_Set/Get_Instance_Pointer.
@ -1174,7 +1174,7 @@ y_ppem = 10
</element>
<element name="TExec_Context">
<short>FreeType Execution Context Object</short>
<short>FreeType Execution Context Object.</short>
<descr/>
<seealso/>
</element>
@ -1201,15 +1201,15 @@ y_ppem = 10
</element>
<element name="TExec_Context.stackSize">
<short>
Size of instance stack
</short>
Size of instance stack.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.stack">
<short>
Current instance stack
</short>
Current instance stack.
</short>
<descr/>
<seealso/>
</element>
@ -1245,36 +1245,36 @@ y_ppem = 10
</element>
<element name="TExec_Context.curRange">
<short>
Ccurrent code range number
</short>
Ccurrent code range number.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.code">
<short>
Current code range
</short>
Current code range.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.IP">
<short>
Current instruction pointer
</short>
Current instruction pointer.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.codeSize">
<short>
Size of current range
</short>
Size of current range.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.step_ins">
<short>
Used by the interpreter
</short>
Used by the interpreter.
</short>
<descr>
If true, go to the next instruction.
</descr>
@ -1287,22 +1287,22 @@ y_ppem = 10
</element>
<element name="TExec_Context.loadStack">
<short>
The load stack used to load composite glyphs
</short>
The load stack used to load composite glyphs.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.glyphIns">
<short>
Glyph instructions
</short>
Glyph instructions.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.glyphSize">
<short>
Glyph instruction size
</short>
Glyph instruction size.
</short>
<descr/>
<seealso/>
</element>
@ -1313,22 +1313,22 @@ y_ppem = 10
</element>
<element name="TExec_Context.callStack">
<short>
Interpreter call stack
</short>
Interpreter call stack.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.period">
<short>
Value used for SuperRounding
</short>
Value used for SuperRounding.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.phase">
<short>
Value used for SuperRounding
</short>
Value used for SuperRounding.
</short>
<descr/>
<seealso/>
</element>
@ -1349,8 +1349,8 @@ y_ppem = 10
</element>
<element name="TExec_Context.numFDefs">
<short>
Number of function definitions
</short>
Number of function definitions.
</short>
<descr/>
<seealso/>
</element>
@ -1361,15 +1361,15 @@ y_ppem = 10
</element>
<element name="TExec_Context.FDefs">
<short>
Table of FDefs entries
</short>
Table of FDefs entries.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.numIDefs">
<short>
Number of instruction definitions
</short>
Number of instruction definitions.
</short>
<descr/>
<seealso/>
</element>
@ -1380,22 +1380,22 @@ y_ppem = 10
</element>
<element name="TExec_Context.IDefs">
<short>
Table of IDefs entries
</short>
Table of IDefs entries.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.maxFunc">
<short>
Maximum function number
</short>
Maximum function number.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.maxIns">
<short>
Maximum instruction number
</short>
Maximum instruction number.
</short>
<descr/>
<seealso/>
</element>
@ -1406,15 +1406,15 @@ y_ppem = 10
</element>
<element name="TExec_Context.storeSize">
<short>
Size of the current storage
</short>
Size of the current storage.
</short>
<descr/>
<seealso/>
</element>
<element name="TExec_Context.storage">
<short>
Sorage area
</short>
Sorage area.
</short>
<descr/>
<seealso/>
</element>
@ -1529,8 +1529,8 @@ y_ppem = 10
<element name="TGlyph">
<short>
FreeType Glyph Object
</short>
FreeType Glyph Object.
</short>
<descr/>
<seealso/>
</element>
@ -1595,16 +1595,16 @@ y_ppem = 10
</element>
<element name="TFont_Input.fontIndex">
<short>
Index of the font in the collection
</short>
Index of the font in the collection.
</short>
<descr/>
<seealso/>
</element>
<element name="Goto_CodeRange">
<short>
Go to a specified code range
</short>
Go to a specified code range.
</short>
<descr/>
<seealso/>
</element>
@ -1623,8 +1623,8 @@ y_ppem = 10
<element name="Get_CodeRange">
<short>
Returns a pointer to a given code range record
</short>
Returns a pointer to a given code range record.
</short>
<descr>
<p>
Used only by the debugger.
@ -1644,8 +1644,8 @@ y_ppem = 10
<element name="Set_CodeRange">
<short>
Sets properties for the given code range
</short>
Sets properties for the given code range.
</short>
<descr/>
<seealso/>
</element>
@ -1667,8 +1667,8 @@ y_ppem = 10
<element name="Clear_CodeRange">
<short>
Clear a given code range
</short>
Clear a given code range.
</short>
<descr/>
<seealso/>
</element>
@ -1823,8 +1823,8 @@ y_ppem = 10
<element name="TTObjs_Init">
<short>
Initialize the object manager
</short>
Initialize the object manager.
</short>
<descr/>
<seealso/>
</element>
@ -1834,8 +1834,8 @@ y_ppem = 10
<element name="TTObjs_Done">
<short>
Finalize the object manager
</short>
Finalize the object manager.
</short>
<descr/>
<seealso/>
</element>

62
docs/xml/freetype/ttraster.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTRaster">
<short>Implements the glyph rasterizer for the FreeType library</short>
<short>Implements the glyph rasterizer for the FreeType library.</short>
<descr>
<p>
Copyright 1996 David Turner, Robert Wilhelm and Werner Lemberg.
@ -111,7 +111,7 @@
</element>
<element name="TFreeTypeRasterizer.Precision_Bits">
<short>Fractional bits of Raster coordinates</short>
<short>Fractional bits of Raster coordinates.</short>
</element>
<element name="TFreeTypeRasterizer.Precision">
@ -123,15 +123,15 @@
</element>
<element name="TFreeTypeRasterizer.Precision_Step">
<short>Bezier subdivision minimal step</short>
<short>Bezier subdivision minimal step.</short>
</element>
<element name="TFreeTypeRasterizer.Precision_Shift">
<short>Shift used to convert coordinates</short>
<short>Shift used to convert coordinates.</short>
</element>
<element name="TFreeTypeRasterizer.Precision_Mask">
<short>Integer truncation mask</short>
<short>Integer truncation mask.</short>
</element>
<element name="TFreeTypeRasterizer.Precision_Jitter">
@ -139,11 +139,11 @@
</element>
<element name="TFreeTypeRasterizer.Pool">
<short>Profiles buffer a.k.a. Render Pool</short>
<short>Profiles buffer a.k.a. Render Pool.</short>
</element>
<element name="TFreeTypeRasterizer.Cible">
<short>Description of target map</short>
<short>Description of target map.</short>
</element>
<element name="TFreeTypeRasterizer.BWidth">
@ -151,55 +151,55 @@
</element>
<element name="TFreeTypeRasterizer.BCible">
<short>Target bitmap buffer</short>
<short>Target bitmap buffer.</short>
</element>
<element name="TFreeTypeRasterizer.GCible">
<short>Target pixmap buffer</short>
<short>Target pixmap buffer.</short>
</element>
<element name="TFreeTypeRasterizer.TraceBOfs">
<short>Current offset in target bitmap</short>
<short>Current offset in target bitmap.</short>
</element>
<element name="TFreeTypeRasterizer.TraceBIncr">
<short>Increment to the next line in the target bitmap</short>
<short>Increment to the next line in the target bitmap.</short>
</element>
<element name="TFreeTypeRasterizer.TraceGOfs">
<short>Current offset in targer pixmap</short>
<short>Current offset in targer pixmap.</short>
</element>
<element name="TFreeTypeRasterizer.TraceGIncr">
<short>Increment to the next line in the target pixmap</short>
<short>Increment to the next line in the target pixmap.</short>
</element>
<element name="TFreeTypeRasterizer.gray_min_x">
<short>Current min x during gray rendering</short>
<short>Current min x during gray rendering.</short>
</element>
<element name="TFreeTypeRasterizer.gray_max_x">
<short>Current max x during gray rendering</short>
<short>Current max x during gray rendering.</short>
</element>
<element name="TFreeTypeRasterizer.Proc_Sweep_Init">
<short>Sweep initialization</short>
<short>Sweep initialization.</short>
</element>
<element name="TFreeTypeRasterizer.Proc_Sweep_Span">
<short>Span drawing</short>
<short>Span drawing.</short>
</element>
<element name="TFreeTypeRasterizer.Proc_Sweep_Drop">
<short>Drop out control</short>
<short>Drop out control.</short>
</element>
<element name="TFreeTypeRasterizer.Proc_Sweep_Step">
<short>Sweep line step</short>
<short>Sweep line step.</short>
</element>
<element name="TFreeTypeRasterizer.Proc_Sweep_Direct">
<short>Direct rendering</short>
<short>Direct rendering.</short>
</element>
<element name="TFreeTypeRasterizer.Direct_X">
@ -219,42 +219,42 @@
</element>
<element name="TFreeTypeRasterizer.Flags">
<short>Current flags array</short>
<short>Current flags array.</short>
</element>
<element name="TFreeTypeRasterizer.Outs">
<short>Current endpoints array</short>
<short>Current endpoints array.</short>
</element>
<element name="TFreeTypeRasterizer.nContours">
<short>Current number of contours</short>
<short>Current number of contours.</short>
</element>
<element name="TFreeTypeRasterizer.DropOutControl">
<short>Current drop-out control mode</short>
<short>Current drop-out control mode.</short>
</element>
<element name="TFreeTypeRasterizer.Grays">
<short>Gray palette used during gray-levels rendering</short>
<short>Gray palette used during gray-levels rendering.</short>
<descr>
0: background .. 4: foreground
</descr>
</element>
<element name="TFreeTypeRasterizer.BGray_Data">
<short>Temporary bitmap for grayscale</short>
<short>Temporary bitmap for grayscale.</short>
</element>
<element name="TFreeTypeRasterizer.BGray_Incr">
<short>Increment for the temporary bitmap</short>
<short>Increment for the temporary bitmap.</short>
</element>
<element name="TFreeTypeRasterizer.BGray_End">
<short>Ending offset of the temporary bitmap</short>
<short>Ending offset of the temporary bitmap.</short>
</element>
<element name="TFreeTypeRasterizer.BGray_Capacity">
<short>Current capacity of the temporary bitmap</short>
<short>Current capacity of the temporary bitmap.</short>
</element>
<element name="TFreeTypeRasterizer.Second_Pass">
@ -548,7 +548,7 @@
</element>
<element name="TFreeTypeRasterizer.Render_Glyph">
<short>Render one glyph in the target bitmap (1-bit per pixel)</short>
<short>Render one glyph in the target bitmap (1-bit per pixel).</short>
</element>
<element name="TFreeTypeRasterizer.Render_Glyph.Result">
<short/>
@ -561,7 +561,7 @@
</element>
<element name="TFreeTypeRasterizer.Render_Gray_Glyph">
<short>Render one gray-level glyph in the target pixmap</short>
<short>Render one gray-level glyph in the target pixmap.</short>
<descr>
<p>
Palette points to an array of 5 colors used for the rendering. Use Nil to reuse the last palette. The default is VGA graylevels.

16
docs/xml/freetype/tttables.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTTables">
<short>TrueType table declarations used in the FreeType library</short>
<short>TrueType table declarations used in the FreeType library.</short>
<descr>
<p>
TTTables now contains only the declarations for the TrueType tables.
@ -27,7 +27,7 @@
</element>
<element name="TTTCHeader">
<short>TrueType collection header</short>
<short>TrueType collection header.</short>
<descr/>
<seealso/>
</element>
@ -63,7 +63,7 @@
</element>
<element name="TTableDir">
<short>TrueType Table Directory type</short>
<short>TrueType Table Directory type.</short>
<descr/>
<seealso/>
</element>
@ -77,7 +77,7 @@
</element>
<element name="TTableDir.numTables">
<short>Number of tables in the directory</short>
<short>Number of tables in the directory.</short>
<descr/>
<seealso/>
</element>
@ -115,25 +115,25 @@
</element>
<element name="TTableDirEntry.Tag">
<short>Table type</short>
<short>Table type.</short>
<descr/>
<seealso/>
</element>
<element name="TTableDirEntry.CheckSum">
<short>Table Checksum</short>
<short>Table Checksum.</short>
<descr/>
<seealso/>
</element>
<element name="TTableDirEntry.Offset">
<short>Table file offset</short>
<short>Table file offset.</short>
<descr/>
<seealso/>
</element>
<element name="TTableDirEntry.Length">
<short>Table length</short>
<short>Table length.</short>
<descr/>
<seealso/>
</element>

114
docs/xml/freetype/tttypes.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TTTypes">
<short>Global type definitions</short>
<short>Global type definitions.</short>
<descr>
<p>
Global type definitions used in the FreeType library.
@ -68,19 +68,19 @@
</element>
<element name="TT_FWord">
<short>Distance in FUnits</short>
<short>Distance in FUnits.</short>
<descr/>
<seealso/>
</element>
<element name="TT_UFWord">
<short>Unsigned Distance</short>
<short>Unsigned Distance.</short>
<descr/>
<seealso/>
</element>
<element name="TT_F2Dot14">
<short>Alias for the Integer type</short>
<short>Alias for the Integer type.</short>
<descr>
<p>
Signed fixed float 2.14 used for unary vectors, with layout:
@ -115,7 +115,7 @@
</element>
<element name="TT_F26Dot6">
<short>Alias for the LongInt type</short>
<short>Alias for the LongInt type.</short>
<descr>
<p>
26.6 fixed float, used for pixel coordinates.
@ -125,7 +125,7 @@
</element>
<element name="TT_Pos">
<short>Alias for the LongInt type</short>
<short>Alias for the LongInt type.</short>
<descr>
<p>
FUnits or 26.6 fixed float value, depending on context.
@ -257,7 +257,7 @@
</element>
<element name="TT_KerningInfo">
<short>Kerning information between two glyphs</short>
<short>Kerning information between two glyphs.</short>
<descr/>
<seealso/>
</element>
@ -351,7 +351,7 @@
</element>
<element name="TT_Outline">
<short>Glyph outline description</short>
<short>Glyph outline description.</short>
<descr/>
<seealso/>
</element>
@ -369,25 +369,25 @@
</element>
<element name="TT_Outline.points">
<short>Array of point coordinates</short>
<short>Array of point coordinates.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Outline.flags">
<short>Array of point flags</short>
<short>Array of point flags.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Outline.conEnds">
<short>Array of contours ends</short>
<short>Array of contours ends.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Outline.owner">
<short>Flag set when the outline owns the arrays it uses</short>
<short>Flag set when the outline owns the arrays it uses.</short>
<descr/>
<seealso/>
</element>
@ -411,7 +411,7 @@
</element>
<element name="TT_Glyph_Metrics">
<short>Glyph metrics structure</short>
<short>Glyph metrics structure.</short>
<descr>
<p>
Glyph metrics structure.
@ -445,7 +445,7 @@
</element>
<element name="TT_Big_Glyph_Metrics">
<short>Big glyph metrics structure</short>
<short>Big glyph metrics structure.</short>
<descr>
<p>
Big glyph metrics structure.
@ -519,7 +519,7 @@
</element>
<element name="TT_Instance_Metrics">
<short>Instance metrics structure</short>
<short>Instance metrics structure.</short>
<descr>
<p>
Instance metrics used to return information to a client with the state for the instance.
@ -583,7 +583,7 @@
</element>
<element name="TT_Raster_Map">
<short>Describes a bitmap or pixmap to the rasterizer</short>
<short>Describes a bitmap or pixmap to the rasterizer.</short>
<descr>
<p>
A record used to describe a bitmap or pixmap to the rasterizer.
@ -593,43 +593,43 @@
</element>
<element name="TT_Raster_Map.Rows">
<short>Number of rows for the bitmap</short>
<short>Number of rows for the bitmap.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Raster_Map.Cols">
<short>Numer of columns (bytes) per Row</short>
<short>Numer of columns (bytes) per Row.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Raster_Map.Width">
<short>Number of pixels per Row</short>
<short>Number of pixels per Row.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Raster_Map.Flow">
<short>Flow direction for the bitmap / pixmap</short>
<short>Flow direction for the bitmap / pixmap.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Raster_Map.Buffer">
<short>Data for the bitmap / pixmap</short>
<short>Data for the bitmap / pixmap.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Raster_Map.Size">
<short>Size in bytes for the Data in the bitmap / pixmap</short>
<short>Size in bytes for the Data in the bitmap / pixmap.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Header">
<short>TrueType font header table structure</short>
<short>TrueType font header table structure.</short>
<descr>
<p>
The TrueType font header table structure.
@ -741,7 +741,7 @@
</element>
<element name="TT_Horizontal_Header">
<short>TrueType horizontal header table structure</short>
<short>TrueType horizontal header table structure.</short>
<descr>
<p>
The TrueType horizontal header table structure.
@ -829,19 +829,19 @@
</element>
<element name="TT_Horizontal_Header.short_metrics">
<short>Not part of the header in the file</short>
<short>Not part of the header in the file.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Horizontal_Header.long_metrics">
<short>Not part of the header in the file</short>
<short>Not part of the header in the file.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Vertical_Header">
<short>TrueType vertical header table structure</short>
<short>TrueType vertical header table structure.</short>
<descr>
<p>
The TrueType vertical header table structure.
@ -929,19 +929,19 @@
</element>
<element name="TT_Vertical_Header.short_metrics">
<short>Not part of the header in the file</short>
<short>Not part of the header in the file.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Vertical_Header.long_metrics">
<short>Not part of the header in the file</short>
<short>Not part of the header in the file.</short>
<descr/>
<seealso/>
</element>
<element name="TT_OS2">
<short>TrueType OS/2 table structure</short>
<short>TrueType OS/2 table structure.</short>
<descr>
<p>
The TrueType OS/2 table structure.
@ -1053,25 +1053,25 @@
</element>
<element name="TT_OS2.ulUnicodeRange1">
<short>Bits 0 - 31</short>
<short>Bits 0 - 31.</short>
<descr/>
<seealso/>
</element>
<element name="TT_OS2.ulUnicodeRange2">
<short>Bits 32 - 63</short>
<short>Bits 32 - 63.</short>
<descr/>
<seealso/>
</element>
<element name="TT_OS2.ulUnicodeRange3">
<short>Bits 64 - 95</short>
<short>Bits 64 - 95.</short>
<descr/>
<seealso/>
</element>
<element name="TT_OS2.ulUnicodeRange4">
<short>Bits 96 - 127</short>
<short>Bits 96 - 127.</short>
<descr/>
<seealso/>
</element>
@ -1131,49 +1131,49 @@
</element>
<element name="TT_OS2.ulCodePageRange1">
<short>In Version 1 tables only</short>
<short>In Version 1 tables only.</short>
<descr/>
<seealso/>
</element>
<element name="TT_OS2.ulCodePageRange2">
<short>In Version 1 tables only</short>
<short>In Version 1 tables only.</short>
<descr/>
<seealso/>
</element>
<element name="TT_OS2.sxHeight">
<short>In Version 2 tables only</short>
<short>In Version 2 tables only.</short>
<descr/>
<seealso/>
</element>
<element name="TT_OS2.sCapHeight">
<short>In Version 2 tables only</short>
<short>In Version 2 tables only.</short>
<descr/>
<seealso/>
</element>
<element name="TT_OS2.usDefaultChar">
<short>In Version 2 tables only</short>
<short>In Version 2 tables only.</short>
<descr/>
<seealso/>
</element>
<element name="TT_OS2.usBreakChar">
<short>In Version 2 tables only</short>
<short>In Version 2 tables only.</short>
<descr/>
<seealso/>
</element>
<element name="TT_OS2.usMaxContext">
<short>In Version 2 tables only</short>
<short>In Version 2 tables only.</short>
<descr/>
<seealso/>
</element>
<element name="TT_Postscript">
<short>TrueType Postscript table structure</short>
<short>TrueType Postscript table structure.</short>
<descr>
<p>
The TrueType Postscript table structure.
@ -1241,7 +1241,7 @@
</element>
<element name="TT_Face_Properties">
<short>TrueType font face properties</short>
<short>TrueType font face properties.</short>
<descr>
<p>
Used to report important properties for a font face to clients.
@ -1305,7 +1305,7 @@
</element>
<element name="TT_Stream">
<short>Object handle type for a Stream</short>
<short>Object handle type for a Stream.</short>
<descr/>
<seealso/>
</element>
@ -1317,7 +1317,7 @@
</element>
<element name="TT_Face">
<short>Object handle type for a Face</short>
<short>Object handle type for a Face.</short>
<descr/>
<seealso/>
</element>
@ -1341,7 +1341,7 @@
</element>
<element name="TT_Glyph">
<short>Object handle type for a Glyph</short>
<short>Object handle type for a Glyph.</short>
<descr/>
<seealso/>
</element>
@ -1353,7 +1353,7 @@
</element>
<element name="TT_CharMap">
<short>Object handle type for a Character Map</short>
<short>Object handle type for a Character Map.</short>
<descr/>
<seealso/>
</element>
@ -1377,7 +1377,7 @@
</element>
<element name="TT_Err_Ok">
<short>Success is always 0</short>
<short>Success is always 0.</short>
<descr/>
<seealso/>
</element>
@ -2023,7 +2023,7 @@
</element>
<element name="TCoordinates">
<short>Internal type for coordinates in the FreeType library</short>
<short>Internal type for coordinates in the FreeType library.</short>
<descr/>
<seealso/>
</element>
@ -2050,32 +2050,32 @@
<seealso></seealso>
</element>
<element name="TVecRecord.n">
<short>Number of points</short>
<short>Number of points.</short>
</element>
<element name="TVecRecord.org_x">
<short>Original coordinate arrays</short>
<short>Original coordinate arrays.</short>
</element>
<element name="TVecRecord.org_y">
<short>Original coordinate arrays</short>
<short>Original coordinate arrays.</short>
</element>
<element name="TVecRecord.cur_x">
<short>Current coordinate arrays</short>
<short>Current coordinate arrays.</short>
</element>
<element name="TVecRecord.cur_y">
<short>Current coordinate arrays</short>
<short>Current coordinate arrays.</short>
</element>
<element name="TVecRecord.touch">
<short>Touch flags array</short>
<short>Touch flags array.</short>
</element>
<element name="Success">
<short>Success value is always False (no error)</short>
<short>Success value is always False (no error).</short>
<descr/>
<seealso/>
</element>
<element name="Failure">
<short>Failure value is always True (error has occurred)</short>
<short>Failure value is always True (error has occurred).</short>
<descr/>
<seealso/>
</element>