diff options
Diffstat (limited to 'src/3rdparty/freetype/docs/reference/ft2-basic_types.html')
| -rw-r--r-- | src/3rdparty/freetype/docs/reference/ft2-basic_types.html | 229 |
1 files changed, 226 insertions, 3 deletions
diff --git a/src/3rdparty/freetype/docs/reference/ft2-basic_types.html b/src/3rdparty/freetype/docs/reference/ft2-basic_types.html index 9e77145b6a..8df510ffb8 100644 --- a/src/3rdparty/freetype/docs/reference/ft2-basic_types.html +++ b/src/3rdparty/freetype/docs/reference/ft2-basic_types.html @@ -3,7 +3,7 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>FreeType-2.3.9 API Reference</title> +<title>FreeType-2.3.12 API Reference</title> <style type="text/css"> body { font-family: Verdana, Geneva, Arial, Helvetica, serif; color: #000000; @@ -35,7 +35,7 @@ <table align=center><tr><td><font size=-1>[<a href="ft2-index.html">Index</a>]</font></td> <td width="100%"></td> <td><font size=-1>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table> -<center><h1>FreeType-2.3.9 API Reference</h1></center> +<center><h1>FreeType-2.3.12 API Reference</h1></center> <center><h1> Basic Data Types @@ -64,6 +64,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Byte">FT_Byte</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <b>FT_Byte</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A simple typedef for the <i>unsigned</i> char type.</p> </td></tr></table><br> </td></tr></table> @@ -75,6 +83,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Bytes">FT_Bytes</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">const</span> <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>* <b>FT_Bytes</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for constant memory areas.</p> </td></tr></table><br> </td></tr></table> @@ -86,6 +102,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Char">FT_Char</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">char</span> <b>FT_Char</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A simple typedef for the <i>signed</i> char type.</p> </td></tr></table><br> </td></tr></table> @@ -97,6 +121,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Int">FT_Int</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">int</span> <b>FT_Int</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for the int type.</p> </td></tr></table><br> </td></tr></table> @@ -108,6 +140,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_UInt">FT_UInt</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <b>FT_UInt</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for the unsigned int type.</p> </td></tr></table><br> </td></tr></table> @@ -119,6 +159,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Int16">FT_Int16</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span> <b>FT_Int16</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for a 16bit signed integer type.</p> </td></tr></table><br> </td></tr></table> @@ -130,6 +178,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_UInt16">FT_UInt16</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">short</span> <b>FT_UInt16</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for a 16bit unsigned integer type.</p> </td></tr></table><br> </td></tr></table> @@ -141,6 +197,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Int32">FT_Int32</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> XXX <b>FT_Int32</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for a 32bit signed integer type. The size depends on the configuration.</p> </td></tr></table><br> </td></tr></table> @@ -151,6 +215,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_UInt32">FT_UInt32</a></h4> +<table align=center width="87%"><tr><td> +Defined in FT_CONFIG_CONFIG_H (freetype/config/ftconfig.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> XXX <b>FT_UInt32</b>; + +</pre></table><br> </td></tr></table> <hr width="75%"> <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td> @@ -160,6 +232,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Short">FT_Short</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span> <b>FT_Short</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for signed short.</p> </td></tr></table><br> </td></tr></table> @@ -171,6 +251,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_UShort">FT_UShort</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">short</span> <b>FT_UShort</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for unsigned short.</p> </td></tr></table><br> </td></tr></table> @@ -182,6 +270,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Long">FT_Long</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span> <b>FT_Long</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for signed long.</p> </td></tr></table><br> </td></tr></table> @@ -193,6 +289,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_ULong">FT_ULong</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">long</span> <b>FT_ULong</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for unsigned long.</p> </td></tr></table><br> </td></tr></table> @@ -204,6 +308,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Bool">FT_Bool</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <b>FT_Bool</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef of unsigned char, used for simple booleans. As usual, values 1 and 0 represent true and false, respectively.</p> </td></tr></table><br> </td></tr></table> @@ -215,6 +327,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Offset">FT_Offset</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> size_t <b>FT_Offset</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>This is equivalent to the ANSI C ‘size_t’ type, i.e., the largest <i>unsigned</i> integer type used to express a file size or position, or a memory block size.</p> </td></tr></table><br> </td></tr></table> @@ -226,6 +346,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_PtrDist">FT_PtrDist</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> ft_ptrdiff_t <b>FT_PtrDist</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>This is equivalent to the ANSI C ‘ptrdiff_t’ type, i.e., the largest <i>signed</i> integer type used to express the distance between two pointers.</p> </td></tr></table><br> </td></tr></table> @@ -237,6 +365,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_String">FT_String</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">char</span> <b>FT_String</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A simple typedef for the char type, usually used for strings.</p> </td></tr></table><br> </td></tr></table> @@ -248,6 +384,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Tag">FT_Tag</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <a href="ft2-basic_types.html#FT_UInt32">FT_UInt32</a> <b>FT_Tag</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A typedef for 32-bit tags (as used in the SFNT format).</p> </td></tr></table><br> </td></tr></table> @@ -259,6 +403,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Error">FT_Error</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">int</span> <b>FT_Error</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>The FreeType error code type. A value of 0 is always interpreted as a successful operation.</p> </td></tr></table><br> </td></tr></table> @@ -270,6 +422,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Fixed">FT_Fixed</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span> <b>FT_Fixed</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>This type is used to store 16.16 fixed float values, like scaling values or matrix coefficients.</p> </td></tr></table><br> </td></tr></table> @@ -281,6 +441,14 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Pointer">FT_Pointer</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">void</span>* <b>FT_Pointer</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A simple typedef for a typeless pointer.</p> </td></tr></table><br> </td></tr></table> @@ -292,7 +460,15 @@ Basic Data Types <table align=center width="75%"><tr><td> <h4><a name="FT_Pos">FT_Pos</a></h4> <table align=center width="87%"><tr><td> -<p>The type FT_Pos is a 32-bit integer used to store vectorial coordinates. Depending on the context, these can represent distances in integer font units, or 16.16, or 26.6 fixed float pixel coordinates.</p> +Defined in FT_IMAGE_H (freetype/ftimage.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span> <b>FT_Pos</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> +<p>The type FT_Pos is used to store vectorial coordinates. Depending on the context, these can represent distances in integer font units, or 16.16, or 26.6 fixed float pixel coordinates.</p> </td></tr></table><br> </td></tr></table> <hr width="75%"> @@ -370,6 +546,11 @@ Defined in FT_IMAGE_H (freetype/ftimage.h). </td></tr> </table> </td></tr></table> +<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td> +<p>The bounding box is specified with the coordinates of the lower left and the upper right corner. In PostScript, those values are often called (llx,lly) and (urx,ury), respectively.</p> +<p>If ‘yMin’ is negative, this value gives the glyph's descender. Otherwise, the glyph doesn't descend below the baseline. Similarly, if ‘ymax’ is positive, this value gives the glyph's ascender.</p> +<p>‘xMin’ gives the horizontal distance from the glyph's origin to the left edge of the glyph's bounding box. If ‘xMin’ is negative, the glyph extends to the left of the origin.</p> +</td></tr></table> </td></tr></table> <hr width="75%"> <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td> @@ -424,6 +605,14 @@ Defined in FT_TYPES_H (freetype/fttypes.h). <table align=center width="75%"><tr><td> <h4><a name="FT_FWord">FT_FWord</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span> <b>FT_FWord</b>; /* distance in FUnits */ + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A signed 16-bit integer used to store a distance in original font units.</p> </td></tr></table><br> </td></tr></table> @@ -435,6 +624,14 @@ Defined in FT_TYPES_H (freetype/fttypes.h). <table align=center width="75%"><tr><td> <h4><a name="FT_UFWord">FT_UFWord</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">short</span> <b>FT_UFWord</b>; /* <span class="keyword">unsigned</span> distance */ + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>An unsigned 16-bit integer used to store a distance in original font units.</p> </td></tr></table><br> </td></tr></table> @@ -446,6 +643,14 @@ Defined in FT_TYPES_H (freetype/fttypes.h). <table align=center width="75%"><tr><td> <h4><a name="FT_F2Dot14">FT_F2Dot14</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">short</span> <b>FT_F2Dot14</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A signed 2.14 fixed float type used for unit vectors.</p> </td></tr></table><br> </td></tr></table> @@ -492,6 +697,14 @@ Defined in FT_TYPES_H (freetype/fttypes.h). <table align=center width="75%"><tr><td> <h4><a name="FT_F26Dot6">FT_F26Dot6</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">signed</span> <span class="keyword">long</span> <b>FT_F26Dot6</b>; + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>A signed 26.6 fixed float type used for vectorial pixel coordinates.</p> </td></tr></table><br> </td></tr></table> @@ -676,6 +889,7 @@ Defined in FT_IMAGE_H (freetype/ftimage.h). </td></tr> <tr valign=top><td><b>pitch</b></td><td> <p>The pitch's absolute value is the number of bytes taken by one bitmap row, including padding. However, the pitch is positive when the bitmap has a ‘down’ flow, and negative when it has an ‘up’ flow. In all cases, the pitch is an offset to add to a bitmap pointer in order to go down one row.</p> +<p>For the B/W rasterizer, ‘pitch’ is always an even number.</p> </td></tr> <tr valign=top><td><b>buffer</b></td><td> <p>A typeless pointer to the bitmap buffer. This value should be aligned on 32-bit boundaries in most cases.</p> @@ -870,6 +1084,14 @@ Defined in FT_TYPES_H (freetype/fttypes.h). <table align=center width="75%"><tr><td> <h4><a name="FT_Generic_Finalizer">FT_Generic_Finalizer</a></h4> <table align=center width="87%"><tr><td> +Defined in FT_TYPES_H (freetype/fttypes.h). +</td></tr></table><br> +<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> + + <span class="keyword">typedef</span> <span class="keyword">void</span> (*<b>FT_Generic_Finalizer</b>)(<span class="keyword">void</span>* object); + +</pre></table><br> +<table align=center width="87%"><tr><td> <p>Describe a function used to destroy the ‘client’ data of any FreeType object. See the description of the <a href="ft2-basic_types.html#FT_Generic">FT_Generic</a> type for details of usage.</p> </td></tr></table><br> <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td> @@ -926,6 +1148,7 @@ Defined in FT_TYPES_H (freetype/fttypes.h). <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> #define <b>FT_MAKE_TAG</b>( _x1, _x2, _x3, _x4 ) \ + (<a href="ft2-basic_types.html#FT_Tag">FT_Tag</a>) \ ( ( (<a href="ft2-basic_types.html#FT_ULong">FT_ULong</a>)_x1 << 24 ) | \ ( (<a href="ft2-basic_types.html#FT_ULong">FT_ULong</a>)_x2 << 16 ) | \ ( (<a href="ft2-basic_types.html#FT_ULong">FT_ULong</a>)_x3 << 8 ) | \ |