paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-22 10:59:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LazFreeType/various. Standardizes tagging for file names in unit overview topics.

Browse Source
This commit is contained in:
dsiders 2023-05-10 08:54:36 +01:00
parent b4f9ac5380
commit d6c2ae28f5
6 changed files with 1123 additions and 1065 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,107 +1,109 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="freetypelaz">
<!--
====================================================================
TTError
====================================================================
-->
<module name="TTError">
<short>Simple error management for the FreeType library.</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.
</p>
<p>
The Pascal version of the library doesn't support multiple threads. We use a global error
variable, called simply "error" to report all defects. The various functions return an error
condition, which can be either Success (false) or Failure (true).
</p>
<p>
Note that the use of macros in the C version to automate error reporting makes the two source
trees very similar, even if they differ from some design points like this one.
</p>
</descr>
<package name="freetypelaz">
<!--
====================================================================
TTError
====================================================================
-->
<module name="TTError">
<short>Simple error management for the FreeType library.</short>
<descr>
<p>
Copyright 1996, 1997 by David Turner, Robert Wilhelm, and Werner Lemberg.
</p>
<p>
<file>tterror.pas</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>
<p>
The Pascal version of the library doesn't support multiple threads. We use a
global error variable, called simply "error" to report all defects. The
various functions return an error condition, which can be either Success
(<b>False</b>) or Failure (<b>True</b>).
</p>
<p>
Note that the use of macros in the C version to automate error reporting makes
the two source trees very similar, even if they differ from some design points
like this one.
</p>
</descr>
<!-- unresolved external references -->
<element name="TTTypes"/>
<!-- unresolved external references -->
<element name="TTTypes"/>
<element name="Check_Error">
<short/>
<descr/>
<seealso/>
</element>
<element name="Check_Error.error">
<short/>
</element>
<element name="Check_Error">
<short/>
<descr/>
<seealso/>
</element>
<element name="Check_Error.error">
<short/>
</element>
<element name="Panic1">
<short/>
<descr/>
<seealso/>
</element>
<element name="Panic1.message">
<short/>
</element>
<element name="Panic1">
<short/>
<descr/>
<seealso/>
</element>
<element name="Panic1.message">
<short/>
</element>
<element name="Trace1">
<short/>
<descr/>
<seealso/>
</element>
<element name="Trace1.message">
<short/>
</element>
<element name="Trace1">
<short/>
<descr/>
<seealso/>
</element>
<element name="Trace1.message">
<short/>
</element>
<element name="Err_Ras_None">
<short/>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_None">
<short/>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_NotIni">
<short>Rasterizer not Initialized.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_NotIni">
<short>Rasterizer not Initialized.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Overflow">
<short>Profile Table Overflow.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Overflow">
<short>Profile Table Overflow.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Neg_H">
<short>Negative Height encountered.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Neg_H">
<short>Negative Height encountered.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Invalid">
<short>Invalid value encountered.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Invalid">
<short>Invalid value encountered.</short>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Invalid_Contours">
<short/>
<descr/>
<seealso/>
</element>
<element name="Err_Ras_Invalid_Contours">
<short/>
<descr/>
<seealso/>
</element>
<element name="error">
<short>Global error variable used for the FreeType library.</short>
<descr/>
<seealso/>
</element>
<element name="error">
<short>Global error variable used for the FreeType library.</short>
<descr/>
<seealso/>
</element>
</module>
<!-- TTError -->
</package>
</module>
<!-- TTError -->
</package>
</fpdoc-descriptions>

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

@ -1,487 +1,516 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="freetypelaz">
<!--
====================================================================
TTFile
====================================================================
-->
<module name="TTFile">
<short>File I/O specification.</short>
<descr>
<p>
Copyright 1996 David Turner, Robert Wilhelm and Werner Lemberg.
</p>
<package name="freetypelaz">
<!--
====================================================================
TTFile
====================================================================
-->
<module name="TTFile">
<short>File I/O specification.</short>
<descr>
<p>
Copyright 1996 David Turner, Robert Wilhelm and Werner Lemberg.
</p>
<p>
<file>ttfile.pas</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>
<p>
<b>Notes:</b>
</p>
<p>
Changes from 1.2 to 1.3:
</p>
<ul>
<li>Moved stream into TFreeTypeStream object</li>
</ul>
<p>
Changes from 1.1 to 1.2:
</p>
<ul>
<li>Changes the stream operations semantics. See changes.txt</li>
<li>Stream records are now allocated on demand in the heap</li>
<li>
Introduced the 'frame cache' to avoid Allocating/Freeing each frame, even tiny
ones.
</li>
<li>Support for thread-safety and re-entrancy (for information only)</li>
</ul>
<p>
Changes from 1.0 to 1.1:
</p>
<ul>
<li>Defined the type TT_Stream for file handles</li>
<li>Renamed (and cleaned) the API</li>
<li>
Caching and memory-mapped files use the same API as TT_Access_Frame to notify
</li>
<li>
Only the interface was really rewritten. This component still only supports
one opened file at a time.
</li>
</ul>
</descr>
<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.
</p>
<p>
<b>Notes:</b>
</p>
<p>
Changes from 1.2 to 1.3:
</p>
<ul>
<li>Moved stream into TFreeTypeStream object</li>
</ul>
<p>
Changes from 1.1 to 1.2:
</p>
<ul>
<li>Changes the stream operations semantics. See changes.txt</li>
<li>Stream records are now allocated on demand in the heap</li>
<li>Introduced the 'frame cache' to avoid Allocating/Freeing each frame, even tiny ones.</li>
<li>Support for thread-safety and re-entrancy (for information only)</li>
</ul>
<p>
Changes from 1.0 to 1.1:
</p>
<ul>
<li>Defined the type TT_Stream for file handles</li>
<li>Renamed (and cleaned) the API</li>
<li>Caching and memory-mapped files use the same API as TT_Access_Frame to notify</li>
<li>Only the interface was really rewritten. This component still only supports one opened file at a time.</li>
</ul>
</descr>
<!-- unresolved external references -->
<element name="TTTypes"/>
<element name="TTError"/>
<element name="Classes"/>
<!-- unresolved external references -->
<element name="TTTypes"/>
<element name="TTError"/>
<element name="Classes"/>
<element name="TFreeTypeStream">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.GetSize">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.GetSize.Result">
<short/>
</element>
<element name="TFreeTypeStream.GetSize">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.GetSize.Result">
<short/>
</element>
<element name="TFreeTypeStream.FCurrentFrame"/>
<element name="TFreeTypeStream.FFrameCursor"/>
<element name="TFreeTypeStream.FCurrentFrame"/>
<element name="TFreeTypeStream.FFrameCursor"/>
<element name="TFreeTypeStream.FFrameSize"/>
<element name="TFreeTypeStream.FFrameCache"/>
<element name="TFreeTypeStream.FName"/>
<element name="TFreeTypeStream.FStream"/>
<element name="TFreeTypeStream.FBase"/>
<element name="TFreeTypeStream.FStoredSize"/>
<element name="TFreeTypeStream.FPosit"/>
<element name="TFreeTypeStream.FOwnedStream"/>
<element name="TFreeTypeStream.FOpen"/>
<element name="TFreeTypeStream.FUsed"/>
<element name="TFreeTypeStream.FFrameSize"/>
<element name="TFreeTypeStream.FFrameCache"/>
<element name="TFreeTypeStream.FName"/>
<element name="TFreeTypeStream.FStream"/>
<element name="TFreeTypeStream.FBase"/>
<element name="TFreeTypeStream.FStoredSize"/>
<element name="TFreeTypeStream.FPosit"/>
<element name="TFreeTypeStream.FOwnedStream"/>
<element name="TFreeTypeStream.FOpen"/>
<element name="TFreeTypeStream.FUsed"/>
<element name="TFreeTypeStream.GetFilePos">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.GetFilePos.Result">
<short/>
</element>
<element name="TFreeTypeStream.GetFilePos">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.GetFilePos.Result">
<short/>
</element>
<element name="TFreeTypeStream.GetFileSize">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.GetFileSize.Result">
<short/>
</element>
<element name="TFreeTypeStream.GetFileSize">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.GetFileSize.Result">
<short/>
</element>
<element name="TFreeTypeStream.GetPosition">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.GetPosition.Result">
<short/>
</element>
<element name="TFreeTypeStream.GetPosition">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.GetPosition.Result">
<short/>
</element>
<element name="TFreeTypeStream.Size">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Size">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Init">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Init">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Create">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Create.APathName">
<short/>
</element>
<element name="TFreeTypeStream.Create.AStream">
<short/>
</element>
<element name="TFreeTypeStream.Create.AStreamOwner">
<short/>
</element>
<element name="TFreeTypeStream.Create">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Create.APathName">
<short/>
</element>
<element name="TFreeTypeStream.Create.AStream">
<short/>
</element>
<element name="TFreeTypeStream.Create.AStreamOwner">
<short/>
</element>
<element name="TFreeTypeStream.Destroy">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Destroy">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Activate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Activate.Result">
<short/>
</element>
<element name="TFreeTypeStream.Activate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Activate.Result">
<short/>
</element>
<element name="TFreeTypeStream.Deactivate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Deactivate.Result">
<short/>
</element>
<element name="TFreeTypeStream.Deactivate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Deactivate.Result">
<short/>
</element>
<element name="TFreeTypeStream.SeekFile">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.SeekFile.Return">
<short/>
</element>
<element name="TFreeTypeStream.SeekFile.APos">
<short/>
</element>
<element name="TFreeTypeStream.SeekFile">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.SeekFile.Return">
<short/>
</element>
<element name="TFreeTypeStream.SeekFile.APos">
<short/>
</element>
<element name="TFreeTypeStream.SkipFile">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.SkipFile.Result">
<short/>
</element>
<element name="TFreeTypeStream.SkipFile.ADist">
<short/>
</element>
<element name="TFreeTypeStream.SkipFile">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.SkipFile.Result">
<short/>
</element>
<element name="TFreeTypeStream.SkipFile.ADist">
<short/>
</element>
<element name="TFreeTypeStream.ReadFile">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.ReadFile.Result">
<short/>
</element>
<element name="TFreeTypeStream.ReadFile.ABuff">
<short/>
</element>
<element name="TFreeTypeStream.ReadFile.ACount">
<short/>
</element>
<element name="TFreeTypeStream.ReadFile">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.ReadFile.Result">
<short/>
</element>
<element name="TFreeTypeStream.ReadFile.ABuff">
<short/>
</element>
<element name="TFreeTypeStream.ReadFile.ACount">
<short/>
</element>
<element name="TFreeTypeStream.ReadAtFile">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.ReadAtFile.Result">
<short/>
</element>
<element name="TFreeTypeStream.ReadAtFile.APos">
<short/>
</element>
<element name="TFreeTypeStream.ReadAtFile.ABuff">
<short/>
</element>
<element name="TFreeTypeStream.ReadAtFile.ACount">
<short/>
</element>
<element name="TFreeTypeStream.ReadAtFile">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.ReadAtFile.Result">
<short/>
</element>
<element name="TFreeTypeStream.ReadAtFile.APos">
<short/>
</element>
<element name="TFreeTypeStream.ReadAtFile.ABuff">
<short/>
</element>
<element name="TFreeTypeStream.ReadAtFile.ACount">
<short/>
</element>
<element name="TFreeTypeStream.AccessFrame">
<short>
Access the next aSize bytes.
</short>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.AccessFrame.Result">
<short/>
</element>
<element name="TFreeTypeStream.AccessFrame.ASize">
<short/>
</element>
<element name="TFreeTypeStream.AccessFrame">
<short>
Access the next aSize bytes.
</short>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.AccessFrame.Result">
<short/>
</element>
<element name="TFreeTypeStream.AccessFrame.ASize">
<short/>
</element>
<element name="TFreeTypeStream.CheckAndAccessFrame">
<short>
Access the next min(aSize ,file_size - file_pos) bytes.
</short>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.CheckAndAccessFrame.Result">
<short/>
</element>
<element name="TFreeTypeStream.CheckAndAccessFrame.ASize">
<short/>
</element>
<element name="TFreeTypeStream.CheckAndAccessFrame">
<short>
Access the next min(aSize ,file_size - file_pos) bytes.
</short>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.CheckAndAccessFrame.Result">
<short/>
</element>
<element name="TFreeTypeStream.CheckAndAccessFrame.ASize">
<short/>
</element>
<element name="TFreeTypeStream.ForgetFrame">
<short>
Discards the previously cached frame.
</short>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.ForgetFrame.Result">
<short/>
</element>
<element name="TFreeTypeStream.ForgetFrame">
<short>
Discards the previously cached frame.
</short>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.ForgetFrame.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_Byte">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a
ForgetFrame. They do not provide error handling, intentionnaly, and are much
faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_Byte.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_Byte">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a ForgetFrame. They do not provide error handling, intentionnaly, and are much faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_Byte.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_Char">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a
ForgetFrame. They do not provide error handling, intentionnaly, and are much
faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_Char.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_Char">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a ForgetFrame. They do not provide error handling, intentionnaly, and are much faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_Char.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_Short">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a
ForgetFrame. They do not provide error handling, intentionnaly, and are much
faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_Short.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_Short">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a ForgetFrame. They do not provide error handling, intentionnaly, and are much faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_Short.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_UShort">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a
ForgetFrame. They do not provide error handling, intentionnaly, and are much
faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_UShort.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_UShort">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a ForgetFrame. They do not provide error handling, intentionnaly, and are much faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_UShort.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_Long">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a
ForgetFrame. They do not provide error handling, intentionnaly, and are much
faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_Long.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_Long">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a ForgetFrame. They do not provide error handling, intentionnaly, and are much faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_Long.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_ULong">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a ForgetFrame. They do not provide error handling, intentionnaly, and are much faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_ULong.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_ULong">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a ForgetFrame. They do not provide error handling, intentionnaly, and are much faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_ULong.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_Tag4">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a
ForgetFrame. They do not provide error handling, intentionnaly, and are much
faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_Tag4.Result">
<short/>
</element>
<element name="TFreeTypeStream.GET_Tag4">
<short/>
<descr>
<p>
The following functions should only be used after a AccessFrame and before a ForgetFrame. They do not provide error handling, intentionnaly, and are much faster moreover, they could be converted to MACROS in the C version.
</p>
</descr>
<seealso/>
</element>
<element name="TFreeTypeStream.GET_Tag4.Result">
<short/>
</element>
<element name="TFreeTypeStream.Open">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Open">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Name">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Name">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Base">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Base">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Position">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Position">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Used">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFreeTypeStream.Used">
<short/>
<descr/>
<seealso/>
</element>
<element name="TTFile_Init">
<short/>
<descr/>
<seealso/>
</element>
<element name="TTFile_Init.Result">
<short/>
</element>
<element name="TTFile_Init">
<short/>
<descr/>
<seealso/>
</element>
<element name="TTFile_Init.Result">
<short/>
</element>
<element name="TTFile_Done">
<short/>
<descr/>
<seealso/>
</element>
<element name="TTFile_Done">
<short/>
<descr/>
<seealso/>
</element>
<element name="TT_Open_Stream">
<short/>
<descr>
<p>
Open a file and return a stream handle for it. Should only be used for the
main stream in a new typeface object.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Open_Stream.Result">
<short/>
</element>
<element name="TT_Open_Stream.name">
<short/>
</element>
<element name="TT_Open_Stream.stream">
<short/>
</element>
<element name="TT_Open_Stream">
<short/>
<descr>
<p>
Open a file and return a stream handle for it. Should only be used for the main stream in a new typeface object.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Open_Stream.Result">
<short/>
</element>
<element name="TT_Open_Stream.name">
<short/>
</element>
<element name="TT_Open_Stream.stream">
<short/>
</element>
<element name="TT_Close_Stream">
<short/>
<descr>
<p>
Closes and discards a stream when it is no longer needed. Should only be used
for the main stream in a typeface object.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Close_Stream.stream">
<short/>
</element>
<element name="TT_Close_Stream">
<short/>
<descr>
<p>
Closes and discards a stream when it is no longer needed. Should only be used for the main stream in a typeface object.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Close_Stream.stream">
<short/>
</element>
<element name="TT_Use_Stream">
<short/>
<descr>
<p>
Notifies the component that we're going to use the file opened in
'org_stream', and report errors to the 'error' variable. The 'stream' variable
is untouched, except in re-entrant builds.
</p>
<p>
In re-entrant builds, the original file handle is duplicated to a new stream
which reference is passed to the 'stream' variable. Thus, each thread can have
its own file cursor to access the same file concurrently.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Use_Stream.Result">
<short/>
</element>
<element name="TT_Use_Stream.org_stream">
<short/>
</element>
<element name="TT_Use_Stream.stream">
<short/>
</element>
<element name="TT_Use_Stream">
<short/>
<descr>
<p>
Notifies he component that we're going to use the file opened in 'org_stream', and report errors to the 'error' variable. The 'stream' variable is untouched, except in re-entrant builds.
</p>
<p>
In re-entrant builds, the original file handle is duplicated to a new stream which reference is passed to the 'stream' variable. Thus, each thread can have its own file cursor to access the same file concurrently.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Use_Stream.Result">
<short/>
</element>
<element name="TT_Use_Stream.org_stream">
<short/>
</element>
<element name="TT_Use_Stream.stream">
<short/>
</element>
<element name="TT_Flush_Stream">
<short/>
<descr>
<p>
Closes a stream's font handle. This is useful to save system resources.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Flush_Stream.stream">
<short/>
</element>
<element name="TT_Flush_Stream">
<short/>
<descr>
<p>
Closes a stream's font handle. This is useful to save system resources.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Flush_Stream.stream">
<short/>
</element>
<element name="TT_Done_Stream">
<short/>
<descr>
<p>
Notifies the file component that we don't need to perform file ops on the
stream anymore. In re-entrant builds, should also discard the stream.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Done_Stream.stream">
<short/>
</element>
<element name="TT_Done_Stream">
<short/>
<descr>
<p>
Notifies the file component that we don't need to perform file ops on the stream anymore. In re-entrant builds, should also discard the stream.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Done_Stream.stream">
<short/>
</element>
<element name="TT_Stream_Size">
<short/>
<descr/>
<seealso/>
</element>
<element name="TT_Stream_Size.Result">
<short/>
</element>
<element name="TT_Stream_Size.stream">
<short/>
</element>
<element name="TT_Stream_Size">
<short/>
<descr/>
<seealso/>
</element>
<element name="TT_Stream_Size.Result">
<short/>
</element>
<element name="TT_Stream_Size.stream">
<short/>
</element>
</module>
<!-- TTFile -->
</package>
</module>
<!-- TTFile -->
</package>
</fpdoc-descriptions>

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

@ -1,100 +1,108 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="freetypelaz">
<!--
====================================================================
TTGLoad
====================================================================
-->
<module name="TTGLoad">
<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.
</p>
</descr>
<package name="freetypelaz">
<!--
====================================================================
TTGLoad
====================================================================
-->
<module name="TTGLoad">
<short>TrueType glyph loader.</short>
<descr>
<p>
Copyright 1996, 1997 by David Turner, Robert Wilhelm, and Werner Lemberg.
</p>
<p>
<file>ttgload.pas</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>
<!-- unresolved external references -->
<element name="LazFreeType"/>
<element name="TTError"/>
<element name="TTTypes"/>
<element name="TTObjs"/>
<!-- unresolved external references -->
<element name="LazFreeType"/>
<element name="TTError"/>
<element name="TTTypes"/>
<element name="TTObjs"/>
<element name="Load_TrueType_Glyph">
<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).
</p>
<p>
By default (i.e. with load_flags = 0), this function only returns the unscaled glyph metrics and points in EM units.
</p>
<p>
Use the flags to query scaling and hinting ops.
</p>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_Glyph.Result">
<short/>
</element>
<element name="Load_TrueType_Glyph.instance">
<short/>
</element>
<element name="Load_TrueType_Glyph.glyph">
<short/>
</element>
<element name="Load_TrueType_Glyph.glyph_index">
<short/>
</element>
<element name="Load_TrueType_Glyph.load_flags">
<short/>
</element>
<element name="Load_TrueType_Glyph">
<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).
</p>
<p>
By default (i.e. with load_flags = 0), this function only returns the unscaled
glyph metrics and points in EM units.
</p>
<p>
Use the flags to query scaling and hinting ops.
</p>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_Glyph.Result">
<short/>
</element>
<element name="Load_TrueType_Glyph.instance">
<short/>
</element>
<element name="Load_TrueType_Glyph.glyph">
<short/>
</element>
<element name="Load_TrueType_Glyph.glyph_index">
<short/>
</element>
<element name="Load_TrueType_Glyph.load_flags">
<short/>
</element>
<element name="TT_Get_Metrics">
<short/>
<descr>
<p>
Returns horizontal or vertical metrics in font units for a given glyph. The metrics are the left side bearing [resp. top side bearing] and advance width [resp. advance height].
</p>
<p>
This function may move later to another component.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Get_Metrics.header">
<short/>
</element>
<element name="TT_Get_Metrics.index">
<short/>
</element>
<element name="TT_Get_Metrics.bearing">
<short/>
</element>
<element name="TT_Get_Metrics.advance">
<short/>
</element>
<element name="TT_Get_Metrics">
<short/>
<descr>
<p>
Returns horizontal or vertical metrics in font units for a given glyph. The
metrics are the left side bearing [resp. top side bearing] and advance width [
resp. advance height].
</p>
<p>
This function may move later to another component.
</p>
</descr>
<seealso/>
</element>
<element name="TT_Get_Metrics.header">
<short/>
</element>
<element name="TT_Get_Metrics.index">
<short/>
</element>
<element name="TT_Get_Metrics.bearing">
<short/>
</element>
<element name="TT_Get_Metrics.advance">
<short/>
</element>
<element name="Get_Advance_Widths">
<short/>
<descr/>
<seealso/>
</element>
<element name="Get_Advance_Widths.Result">
<short/>
</element>
<element name="Get_Advance_Widths.face">
<short/>
</element>
<element name="Get_Advance_Widths.ppem">
<short/>
</element>
<element name="Get_Advance_Widths">
<short/>
<descr/>
<seealso/>
</element>
<element name="Get_Advance_Widths.Result">
<short/>
</element>
<element name="Get_Advance_Widths.face">
<short/>
</element>
<element name="Get_Advance_Widths.ppem">
<short/>
</element>
</module>
<!-- TTGLoad -->
</package>
</module>
<!-- TTGLoad -->
</package>
</fpdoc-descriptions>

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

@ -1,70 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="freetypelaz">
<!--
====================================================================
TTInterp
====================================================================
-->
<module name="TTInterp">
<short>TrueType bytecode interpreter.</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.
</p>
<p>
An error log is written to the <file>ttinterp.log</file> file when enabled.
</p>
<p>
Copyright 1996 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.
</p>
<p>
Changes between 2.1 and 2.0:
</p>
<ul>
<li>Moved into TInterpreter class</li>
<li>Multithreading should be possible</li>
<li>Error log</li>
<li>Dynamic stack size</li>
</ul>
<p>
Changes between 2.0 and 1.2:
</p>
<ul>
<li>Lots and lots of changes: This version is not re-entrant, but much faster.</li>
</ul>
</descr>
<package name="freetypelaz">
<!--
====================================================================
TTInterp
====================================================================
-->
<module name="TTInterp">
<short>TrueType bytecode interpreter.</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.
</p>
<p>
An error log is written to the <file>ttinterp.log</file> file when enabled.
</p>
<p>
Copyright 1996 David Turner, Robert Wilhelm and Werner Lemberg.
</p>
<p>
<file>ttinterp.pas</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>
<p>
Changes between 2.1 and 2.0:
</p>
<ul>
<li>Moved into TInterpreter class</li>
<li>Multithreading should be possible</li>
<li>Error log</li>
<li>Dynamic stack size</li>
</ul>
<p>
Changes between 2.0 and 1.2:
</p>
<ul>
<li>Lots and lots of changes: This version is not re-entrant, but much faster.</li>
</ul>
</descr>
<!-- unresolved external references -->
<element name="TTTypes"/>
<element name="TTObjs"/>
<!-- unresolved external references -->
<element name="TTTypes"/>
<element name="TTObjs"/>
<element name="Run_Ins">
<short>
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.
</descr>
<seealso/>
</element>
<element name="Run_Ins.Result">
<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>
</element>
<element name="Run_Ins.AErrorLog">
<short>True enables error logging in the routine.</short>
</element>
<element name="Run_Ins">
<short>
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.
</descr>
<seealso/>
</element>
<element name="Run_Ins.Result">
<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>
</element>
<element name="Run_Ins.AErrorLog">
<short><b>True</b> enables error logging in the routine.</short>
</element>
</module>
<!-- TTInterp -->
</package>
</module>
<!-- TTInterp -->
</package>
</fpdoc-descriptions>

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

@ -1,272 +1,277 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="freetypelaz">
<!--
====================================================================
TTLoad
====================================================================
-->
<module name="TTLoad">
<short>TrueType Table loaders used in the FreeType library.</short>
<descr>
<p>
Copyright 1996 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.
</p>
<p>
Difference between 1.0 and 1.1: HUGE!!!
</p>
<ul>
<li>Changed the load model to get in touch with TTFile 1.1</li>
<li>Now loads one whole resident table in one call</li>
<li>Defined resident and instance records/data</li>
</ul>
</descr>
<package name="freetypelaz">
<!--
====================================================================
TTLoad
====================================================================
-->
<module name="TTLoad">
<short>TrueType Table loaders used in the FreeType library.</short>
<descr>
<p>
Copyright 1996 David Turner, Robert Wilhelm and Werner Lemberg.
</p>
<p>
<file>ttload.pas</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>
<p>
Difference between 1.0 and 1.1: HUGE!!!
</p>
<ul>
<li>Changed the load model to get in touch with TTFile 1.1</li>
<li>Now loads one whole resident table in one call</li>
<li>Defined resident and instance records/data</li>
</ul>
</descr>
<!-- unresolved external references -->
<element name="TTTypes"/>
<element name="TTTables"/>
<element name="TTCMap"/>
<element name="TTObjs"/>
<element name="TTFile"/>
<!-- unresolved external references -->
<element name="TTTypes"/>
<element name="TTTables"/>
<element name="TTCMap"/>
<element name="TTObjs"/>
<element name="TTFile"/>
<element name="LookUp_TrueType_Table">
<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>
</element>
<element name="LookUp_TrueType_Table.face">
<short>Resident table to look for.</short>
</element>
<element name="LookUp_TrueType_Table.aTag">
<short>Searched tag.</short>
</element>
<element name="LookUp_TrueType_Table">
<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>
</element>
<element name="LookUp_TrueType_Table.face">
<short>Resident table to look for.</short>
</element>
<element name="LookUp_TrueType_Table.aTag">
<short>Searched tag.</short>
</element>
<element name="Load_TrueType_Directory">
<short/>
<descr>
<remark>
Please notes: A table directory doesn't own subttables. There is no constructor or destructor for it.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_Directory.Result">
<short>True on success, or False on failure.</short>
</element>
<element name="Load_TrueType_Directory.face">
<short/>
</element>
<element name="Load_TrueType_Directory.faceIndex">
<short/>
</element>
<element name="Load_TrueType_Directory">
<short/>
<descr>
<remark>
A table directory does not own subttables. There is no constructor or
destructor for it.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_Directory.Result">
<short><b>True</b> on success, or <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_Directory.face">
<short/>
</element>
<element name="Load_TrueType_Directory.faceIndex">
<short/>
</element>
<element name="Load_TrueType_MaxProfile">
<short/>
<descr>
<remark>
Please notes : A maximum profile is a static table that owns no subttable. It has then no constructor nor destructor.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_MaxProfile.Result">
<short>True on success, or False on failure.</short>
</element>
<element name="Load_TrueType_MaxProfile.face">
<short/>
</element>
<element name="Load_TrueType_MaxProfile">
<short/>
<descr>
<remark>
A maximum profile is a static table that owns no subttable. It has then no
constructor nor destructor.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_MaxProfile.Result">
<short><b>True</b> on success, or <b>False</b> 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>
<descr>
<remark>
A font header is a static table that owns no subttable. It has neither a constructor nor a destructor.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_Header.Result">
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Header.face">
<short>Current leading segment.</short>
</element>
<element name="Load_TrueType_Header">
<short>Load the TrueType header table in the resident table.</short>
<descr>
<remark>
A font header is a static table that owns no subttable. It has neither a
constructor nor a destructor.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_Header.Result">
<short><b>True</b> on success, <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_Header.face">
<short>Current leading segment.</short>
</element>
<element name="Load_TrueType_Locations">
<short>Loads the location table in resident table.</short>
<descr>
<remark>
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.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_Locations.Result">
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Locations.face">
<short>Current Resident Leading Segment.</short>
</element>
<element name="Load_TrueType_Locations">
<short>Loads the location table in resident table.</short>
<descr>
<remark>
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.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_Locations.Result">
<short><b>True</b> on success, <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_Locations.face">
<short>Current Resident Leading Segment.</short>
</element>
<element name="Load_TrueType_CVT">
<short/>
<descr>
<remark>
Please note : This attribute table is destroyed by the resident destructor.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_CVT.Result">
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_CVT.face">
<short/>
</element>
<element name="Load_TrueType_CVT">
<short/>
<descr>
<remark>
This attribute table is destroyed by the resident destructor.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_CVT.Result">
<short><b>True</b> on success, <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_CVT.face">
<short/>
</element>
<element name="Load_TrueType_CMap">
<short/>
<descr>
<remark>
The Cmap table directory is destroyed by the resident destructor. The Cmap subtables must be destroyed by Free_CMap_Table.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_CMap.Result">
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_CMap.face">
<short/>
</element>
<element name="Load_TrueType_CMap">
<short/>
<descr>
<remark>
The Cmap table directory is destroyed by the resident destructor. The Cmap
subtables must be destroyed by Free_CMap_Table.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_CMap.Result">
<short><b>True</b> on success, <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_CMap.face">
<short/>
</element>
<element name="Load_TrueType_Gasp">
<short/>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Gasp.Result">
<short/>
</element>
<element name="Load_TrueType_Gasp.face">
<short/>
</element>
<element name="Load_TrueType_Gasp">
<short/>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Gasp.Result">
<short/>
</element>
<element name="Load_TrueType_Gasp.face">
<short/>
</element>
<element name="Load_TrueType_Names">
<short>Loads the name table into the face table.</short>
<descr>
<remark>
This attribute table is destroyed by the resident destructor.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_Names.Result">
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Names.face">
<short/>
</element>
<element name="Load_TrueType_Names">
<short>Loads the name table into the face table.</short>
<descr>
<remark>
This attribute table is destroyed by the resident destructor.
</remark>
</descr>
<seealso/>
</element>
<element name="Load_TrueType_Names.Result">
<short><b>True</b> on success, <b>False</b> 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>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Programs.Result">
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Programs.face">
<short/>
</element>
<element name="Load_TrueType_Programs">
<short>Load the Font and CVT programs in the resident table.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Programs.Result">
<short><b>True</b> on success, <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_Programs.face">
<short/>
</element>
<element name="Load_TrueType_Postscript">
<short>Loads the Postscript table.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Postscript.Result">
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_Postscript.face">
<short/>
</element>
<element name="Load_TrueType_Postscript">
<short>Loads the Postscript table.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Postscript.Result">
<short><b>True</b> on success, <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_Postscript.face">
<short/>
</element>
<element name="Load_TrueType_OS2">
<short>Load the OS/2 Table.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_OS2.Result">
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_OS2.face">
<short/>
</element>
<element name="Load_TrueType_OS2">
<short>Load the OS/2 Table.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_OS2.Result">
<short><b>True</b> on success, <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_OS2.face">
<short/>
</element>
<element name="Load_TrueType_HDMX">
<short>Load the 'hdmx' tables.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_HDMX.Result">
<short>True on success, False on failure.</short>
</element>
<element name="Load_TrueType_HDMX.face">
<short/>
</element>
<element name="Load_TrueType_HDMX">
<short>Load the 'hdmx' tables.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_HDMX.Result">
<short><b>True</b> on success, <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_HDMX.face">
<short/>
</element>
<element name="Load_TrueType_Metrics_Header">
<short/>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Metrics_Header.Result">
<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.
</short>
</element>
<element name="Load_TrueType_Metrics_Header.vertical">
<short/>
</element>
<element name="Load_TrueType_Metrics_Header">
<short/>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Metrics_Header.Result">
<short><b>True</b> on success, <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_Metrics_Header.face">
<short>
When True, try to load the vertical header.
</short>
</element>
<element name="Load_TrueType_Metrics_Header.vertical">
<short/>
</element>
<element name="Load_TrueType_Any">
<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>
</element>
<element name="Load_TrueType_Any.face">
<short>The face object for the font file.</short>
</element>
<element name="Load_TrueType_Any.tag">
<short>The table.</short>
</element>
<element name="Load_TrueType_Any.offset">
<short/>
</element>
<element name="Load_TrueType_Any.buffer">
<short/>
</element>
<element name="Load_TrueType_Any.length">
<short/>
</element>
<element name="Load_TrueType_Any">
<short>Load any TrueType table in user memory.</short>
<descr/>
<seealso/>
</element>
<element name="Load_TrueType_Any.Result">
<short><b>True</b> on success, <b>False</b> on failure.</short>
</element>
<element name="Load_TrueType_Any.face">
<short>The face object for the font file.</short>
</element>
<element name="Load_TrueType_Any.tag">
<short>The table.</short>
</element>
<element name="Load_TrueType_Any.offset">
<short/>
</element>
<element name="Load_TrueType_Any.buffer">
<short/>
</element>
<element name="Load_TrueType_Any.length">
<short/>
</element>
</module>
<!-- TTLoad -->
</package>
</module>
<!-- TTLoad -->
</package>
</fpdoc-descriptions>

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

@ -1,138 +1,150 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="freetypelaz">
<!--
====================================================================
TTMemory
====================================================================
-->
<module name="TTMemory">
<short>Memory management specification.</short>
<descr>
<p>
Copyright 1996 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.
</p>
<p>
Differences between 2.1 and 2.0:
</p>
<ul>
<li>Added a memory mutex to make the component thread-safe.</li>
</ul>
<p>
Differences between 2.0 and 1.1:
</p>
<ul>
<li>The growing heap was completely removed in version 2.0,</li>
<li>
The support for small mini-heaps may be re-introduced later to allow the storage of several consecutive arrays in one single block.
</li>
</ul>
<remark>
<p>IMPORTANT NOTICE :</p>
<p>
The Alloc and Free functions mimic their C equivalent, however, some points must be noticed:
</p>
<ul>
<li>
Both functions return a boolean. As usual, True indicates success, while False indicates failure.
</li>
<li>
The Alloc function puts a small header on front of each allocated block. The header contains a magic cookie and the size of the allocated block. This allows calls to Free without passing a block size as an argument, and thus reduces the risks of memory leaks.
</li>
<li>
It is possible to call Free with a nil pointer, in which case nothing happens, and the result is set to True (success).
</li>
</ul>
<p>
The pointer is set to nil after a call to Free in all cases.
This is done to clear the destructors code, allowing:
</p>
<code>
<package name="freetypelaz">
<!--
====================================================================
TTMemory
====================================================================
-->
<module name="TTMemory">
<short>Memory management specification.</short>
<descr>
<p>
Copyright 1996 David Turner, Robert Wilhelm and Werner Lemberg.
</p>
<p>
<file>ttmemory.pas</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>
<p>
Differences between 2.1 and 2.0:
</p>
<ul>
<li>Added a memory mutex to make the component thread-safe.</li>
</ul>
<p>
Differences between 2.0 and 1.1:
</p>
<ul>
<li>The growing heap was completely removed in version 2.0,</li>
<li>
The support for small mini-heaps may be re-introduced later to allow the
storage of several consecutive arrays in one single block.
</li>
</ul>
<remark>
<p>IMPORTANT NOTICE :</p>
<p>
The Alloc and Free functions mimic their C equivalent, however, some points
must be noticed:
</p>
<ul>
<li>
Both functions return a boolean. As usual, <b>True</b> indicates success,
while <b>False</b> indicates failure.
</li>
<li>
The Alloc function puts a small header on front of each allocated block. The
header contains a magic cookie and the size of the allocated block. This
allows calls to Free without passing a block size as an argument, and thus
reduces the risks of memory leaks.
</li>
<li>
It is possible to call Free with a nil pointer, in which case nothing happens,
and the result is set to <b>True</b> (success).
</li>
</ul>
<p>
The pointer is set to nil after a call to Free in all cases.
This is done to clear the destructors code, allowing:
</p>
<code>
if (pointer) then
begin
Free(pointer);
pointer := nil;
Free(pointer);
pointer := nil;
end;
</code>
<p>To be replaced by a single line:</p>
<code>
</code>
<p>To be replaced by a single line:</p>
<code>
Free(pointer);
</code>
</remark>
</descr>
</code>
</remark>
</descr>
<!-- unresolved external references -->
<element name="TTTypes"/>
<!-- unresolved external references -->
<element name="TTTypes"/>
<element name="TMarkRecord">
<short/>
<descr/>
<seealso/>
</element>
<element name="TMarkRecord.Magic">
<short/>
</element>
<element name="TMarkRecord.Top">
<short/>
</element>
<element name="TMarkRecord">
<short/>
<descr/>
<seealso/>
</element>
<element name="TMarkRecord.Magic">
<short/>
</element>
<element name="TMarkRecord.Top">
<short/>
</element>
<element name="Font_Pool_Allocated">
<short/>
<descr/>
<seealso/>
</element>
<element name="Font_Pool_Allocated">
<short/>
<descr/>
<seealso/>
</element>
<element name="Alloc">
<short/>
<descr>
<p>
Allocates a new memory block in the current heap of <var>size</var> bytes. Returns failure if no memory is left in the heap.
</p>
</descr>
<seealso/>
</element>
<element name="Alloc.Result">
<short/>
</element>
<element name="Alloc.P">
<short/>
</element>
<element name="Alloc.size">
<short/>
</element>
<element name="Alloc">
<short/>
<descr>
<p>
Allocates a new memory block in the current heap of <var>size</var> bytes.
Returns failure if no memory is left in the heap.
</p>
</descr>
<seealso/>
</element>
<element name="Alloc.Result">
<short/>
</element>
<element name="Alloc.P">
<short/>
</element>
<element name="Alloc.size">
<short/>
</element>
<element name="Free">
<short/>
<descr>
<p>
Releases a block previously allocated through <var>Alloc</var>. Returns True (success) if P is Nil before the call. Sets P to nil before exit.
</p>
</descr>
<seealso/>
</element>
<element name="Free.P">
<short/>
</element>
<element name="Free">
<short/>
<descr>
<p>
Releases a block previously allocated through <var>Alloc</var>. Returns
<b>True</b> (success) if P is Nil before the call. Sets P to nil before exit.
</p>
</descr>
<seealso/>
</element>
<element name="Free.P">
<short/>
</element>
<element name="TTMemory_Init">
<short/>
<descr/>
<seealso/>
</element>
<element name="TTMemory_Init.Result">
<short/>
</element>
<element name="TTMemory_Init">
<short/>
<descr/>
<seealso/>
</element>
<element name="TTMemory_Init.Result">
<short/>
</element>
<element name="TTMemory_Done">
<short/>
<descr/>
<seealso/>
</element>
<element name="TTMemory_Done">
<short/>
<descr/>
<seealso/>
</element>
</module>
<!-- TTMemory -->
</package>
</module>
<!-- TTMemory -->
</package>
</fpdoc-descriptions>