summaryrefslogtreecommitdiff
path: root/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-layer_management.html
diff options
context:
space:
mode:
Diffstat (limited to 'Build/source/libs/freetype2/freetype-src/docs/reference/ft2-layer_management.html')
-rw-r--r--Build/source/libs/freetype2/freetype-src/docs/reference/ft2-layer_management.html196
1 files changed, 148 insertions, 48 deletions
diff --git a/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-layer_management.html b/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-layer_management.html
index 8c7c1fb9ab4..7fb91a8f224 100644
--- a/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-layer_management.html
+++ b/Build/source/libs/freetype2/freetype-src/docs/reference/ft2-layer_management.html
@@ -6,7 +6,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
- <meta name="description" content="API Reference Documentation for FreeType-2.11.0">
+ <meta name="description" content="API Reference Documentation for FreeType-2.11.1">
@@ -18,7 +18,7 @@
- <title>Glyph Layer Management - FreeType-2.11.0 API Reference</title>
+ <title>Glyph Layer Management - FreeType-2.11.1 API Reference</title>
@@ -82,7 +82,7 @@
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="index.html" title="FreeType-2.11.0 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.11.0 API Reference" data-md-component="logo">
+ <a href="index.html" title="FreeType-2.11.1 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.11.1 API Reference" data-md-component="logo">
<img src="images/favico.ico" alt="logo">
@@ -94,7 +94,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
- FreeType-2.11.0 API Reference
+ FreeType-2.11.1 API Reference
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
@@ -161,12 +161,12 @@
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="index.html" title="FreeType-2.11.0 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.11.0 API Reference" data-md-component="logo">
+ <a href="index.html" title="FreeType-2.11.1 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.11.1 API Reference" data-md-component="logo">
<img src="images/favico.ico" alt="logo">
</a>
- FreeType-2.11.0 API Reference
+ FreeType-2.11.1 API Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -580,6 +580,13 @@
</li>
<li class="md-nav__item">
+ <a href="#ft_clipbox" class="md-nav__link">
+ FT_ClipBox
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
<a href="#ft_get_color_glyph_paint" class="md-nav__link">
FT_Get_Color_Glyph_Paint
</a>
@@ -587,6 +594,13 @@
</li>
<li class="md-nav__item">
+ <a href="#ft_get_color_glyph_clipbox" class="md-nav__link">
+ FT_Get_Color_Glyph_ClipBox
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
<a href="#ft_get_paint_layers" class="md-nav__link">
FT_Get_Paint_Layers
</a>
@@ -1520,6 +1534,13 @@
</li>
<li class="md-nav__item">
+ <a href="#ft_clipbox" class="md-nav__link">
+ FT_ClipBox
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
<a href="#ft_get_color_glyph_paint" class="md-nav__link">
FT_Get_Color_Glyph_Paint
</a>
@@ -1527,6 +1548,13 @@
</li>
<li class="md-nav__item">
+ <a href="#ft_get_color_glyph_clipbox" class="md-nav__link">
+ FT_Get_Color_Glyph_ClipBox
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
<a href="#ft_get_paint_layers" class="md-nav__link">
FT_Get_Paint_Layers
</a>
@@ -1899,22 +1927,23 @@
FT_COLR_COMPOSITE_SRC_ATOP = 9,
FT_COLR_COMPOSITE_DEST_ATOP = 10,
FT_COLR_COMPOSITE_XOR = 11,
- FT_COLR_COMPOSITE_SCREEN = 12,
- FT_COLR_COMPOSITE_OVERLAY = 13,
- FT_COLR_COMPOSITE_DARKEN = 14,
- FT_COLR_COMPOSITE_LIGHTEN = 15,
- FT_COLR_COMPOSITE_COLOR_DODGE = 16,
- FT_COLR_COMPOSITE_COLOR_BURN = 17,
- FT_COLR_COMPOSITE_HARD_LIGHT = 18,
- FT_COLR_COMPOSITE_SOFT_LIGHT = 19,
- FT_COLR_COMPOSITE_DIFFERENCE = 20,
- FT_COLR_COMPOSITE_EXCLUSION = 21,
- FT_COLR_COMPOSITE_MULTIPLY = 22,
- FT_COLR_COMPOSITE_HSL_HUE = 23,
- FT_COLR_COMPOSITE_HSL_SATURATION = 24,
- FT_COLR_COMPOSITE_HSL_COLOR = 25,
- FT_COLR_COMPOSITE_HSL_LUMINOSITY = 26,
- FT_COLR_COMPOSITE_MAX = 27
+ FT_COLR_COMPOSITE_PLUS = 12,
+ FT_COLR_COMPOSITE_SCREEN = 13,
+ FT_COLR_COMPOSITE_OVERLAY = 14,
+ FT_COLR_COMPOSITE_DARKEN = 15,
+ FT_COLR_COMPOSITE_LIGHTEN = 16,
+ FT_COLR_COMPOSITE_COLOR_DODGE = 17,
+ FT_COLR_COMPOSITE_COLOR_BURN = 18,
+ FT_COLR_COMPOSITE_HARD_LIGHT = 19,
+ FT_COLR_COMPOSITE_SOFT_LIGHT = 20,
+ FT_COLR_COMPOSITE_DIFFERENCE = 21,
+ FT_COLR_COMPOSITE_EXCLUSION = 22,
+ FT_COLR_COMPOSITE_MULTIPLY = 23,
+ FT_COLR_COMPOSITE_HSL_HUE = 24,
+ FT_COLR_COMPOSITE_HSL_SATURATION = 25,
+ FT_COLR_COMPOSITE_HSL_COLOR = 26,
+ FT_COLR_COMPOSITE_HSL_LUMINOSITY = 27,
+ FT_COLR_COMPOSITE_MAX = 28
} <b>FT_Composite_Mode</b>;
</code></pre></div>
@@ -2015,13 +2044,13 @@
<p>The <code><a href="ft2-layer_management.html#ft_colorline">FT_ColorLine</a></code> information for this paint, i.e., the list of color stops along the gradient.</p>
</td></tr>
<tr><td class="val" id="p0">p0</td><td class="desc">
-<p>The starting point of the gradient definition (in font units).</p>
+<p>The starting point of the gradient definition in font units represented as a 16.16 fixed-point <code>FT_Vector</code>.</p>
</td></tr>
<tr><td class="val" id="p1">p1</td><td class="desc">
-<p>The end point of the gradient definition (in font units).</p>
+<p>The end point of the gradient definition in font units represented as a 16.16 fixed-point <code>FT_Vector</code>.</p>
</td></tr>
<tr><td class="val" id="p2">p2</td><td class="desc">
-<p>Optional point&nbsp;p2 to rotate the gradient (in font units). Otherwise equal to&nbsp;p0.</p>
+<p>Optional point&nbsp;p2 to rotate the gradient in font units represented as a 16.16 fixed-point <code>FT_Vector</code>. Otherwise equal to&nbsp;p0.</p>
</td></tr>
</table>
@@ -2037,9 +2066,9 @@
<a href="ft2-layer_management.html#ft_colorline">FT_ColorLine</a> colorline;
<a href="ft2-basic_types.html#ft_vector">FT_Vector</a> c0;
- <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a> r0;
+ <a href="ft2-basic_types.html#ft_pos">FT_Pos</a> r0;
<a href="ft2-basic_types.html#ft_vector">FT_Vector</a> c1;
- <a href="ft2-basic_types.html#ft_ushort">FT_UShort</a> r1;
+ <a href="ft2-basic_types.html#ft_pos">FT_Pos</a> r1;
} <b>FT_PaintRadialGradient</b>;
</code></pre></div>
@@ -2051,16 +2080,16 @@
<p>The <code><a href="ft2-layer_management.html#ft_colorline">FT_ColorLine</a></code> information for this paint, i.e., the list of color stops along the gradient.</p>
</td></tr>
<tr><td class="val" id="c0">c0</td><td class="desc">
-<p>The center of the starting point of the radial gradient (in font units).</p>
+<p>The center of the starting point of the radial gradient in font units represented as a 16.16 fixed-point <code>FT_Vector</code>.</p>
</td></tr>
<tr><td class="val" id="r0">r0</td><td class="desc">
-<p>The radius of the starting circle of the radial gradient (in font units).</p>
+<p>The radius of the starting circle of the radial gradient in font units represented as a 16.16 fixed-point value.</p>
</td></tr>
<tr><td class="val" id="c1">c1</td><td class="desc">
-<p>The center of the end point of the radial gradient (in font units).</p>
+<p>The center of the end point of the radial gradient in font units represented as a 16.16 fixed-point <code>FT_Vector</code>.</p>
</td></tr>
<tr><td class="val" id="r1">r1</td><td class="desc">
-<p>The radius of the end circle of the radial gradient (in font units).</p>
+<p>The radius of the end circle of the radial gradient in font units represented as a 16.16 fixed-point value.</p>
</td></tr>
</table>
@@ -2089,13 +2118,13 @@
<p>The <code><a href="ft2-layer_management.html#ft_colorline">FT_ColorLine</a></code> information for this paint, i.e., the list of color stops along the gradient.</p>
</td></tr>
<tr><td class="val" id="center">center</td><td class="desc">
-<p>The center of the sweep gradient (in font units).</p>
+<p>The center of the sweep gradient in font units represented as a vector of 16.16 fixed-point values.</p>
</td></tr>
<tr><td class="val" id="start_angle">start_angle</td><td class="desc">
-<p>The start angle of the sweep gradient, in 16.16 fixed point format specifying degrees. Values are given counter-clockwise, starting from the (positive) y&nbsp;axis.</p>
+<p>The start angle of the sweep gradient in 16.16 fixed-point format specifying degrees divided by 180.0 (as in the spec). Multiply by 180.0f to receive degrees value. Values are given counter-clockwise, starting from the (positive) y&nbsp;axis.</p>
</td></tr>
<tr><td class="val" id="end_angle">end_angle</td><td class="desc">
-<p>The end angle of the sweep gradient, in 16.16 fixed point format specifying degrees. Values are given counter-clockwise, starting from the (positive) y&nbsp;axis.</p>
+<p>The end angle of the sweep gradient in 16.16 fixed-point format specifying degrees divided by 180.0 (as in the spec). Multiply by 180.0f to receive degrees value. Values are given counter-clockwise, starting from the (positive) y&nbsp;axis.</p>
</td></tr>
</table>
@@ -2169,7 +2198,7 @@
<p>An opaque paint that is subject to being transformed.</p>
</td></tr>
<tr><td class="val" id="affine">affine</td><td class="desc">
-<p>A 2x3 transformation matrix in <code><a href="ft2-layer_management.html#ft_affine23">FT_Affine23</a></code> format.</p>
+<p>A 2x3 transformation matrix in <code><a href="ft2-layer_management.html#ft_affine23">FT_Affine23</a></code> format containing 16.16 fixed-point values.</p>
</td></tr>
</table>
@@ -2197,10 +2226,10 @@
<p>An <code><a href="ft2-layer_management.html#ft_opaquepaint">FT_OpaquePaint</a></code> object referencing the paint that is to be rotated.</p>
</td></tr>
<tr><td class="val" id="dx">dx</td><td class="desc">
-<p>Translation in x&nbsp;direction (in font units).</p>
+<p>Translation in x&nbsp;direction in font units represented as a 16.16 fixed-point value.</p>
</td></tr>
<tr><td class="val" id="dy">dy</td><td class="desc">
-<p>Translation in y&nbsp;direction (in font units).</p>
+<p>Translation in y&nbsp;direction in font units represented as a 16.16 fixed-point value.</p>
</td></tr>
</table>
@@ -2231,16 +2260,16 @@
<p>An <code><a href="ft2-layer_management.html#ft_opaquepaint">FT_OpaquePaint</a></code> object referencing the paint that is to be scaled.</p>
</td></tr>
<tr><td class="val" id="scale_x">scale_x</td><td class="desc">
-<p>Scale factor in x&nbsp;direction.</p>
+<p>Scale factor in x&nbsp;direction represented as a 16.16 fixed-point value.</p>
</td></tr>
<tr><td class="val" id="scale_y">scale_y</td><td class="desc">
-<p>Scale factor in y&nbsp;direction.</p>
+<p>Scale factor in y&nbsp;direction represented as a 16.16 fixed-point value.</p>
</td></tr>
<tr><td class="val" id="center_x">center_x</td><td class="desc">
-<p>x&nbsp;coordinate of center point to scale from.</p>
+<p>x&nbsp;coordinate of center point to scale from represented as a 16.16 fixed-point value.</p>
</td></tr>
<tr><td class="val" id="center_y">center_y</td><td class="desc">
-<p>y&nbsp;coordinate of center point to scale from.</p>
+<p>y&nbsp;coordinate of center point to scale from represented as a 16.16 fixed-point value.</p>
</td></tr>
</table>
@@ -2270,13 +2299,13 @@
<p>An <code><a href="ft2-layer_management.html#ft_opaquepaint">FT_OpaquePaint</a></code> object referencing the paint that is to be rotated.</p>
</td></tr>
<tr><td class="val" id="angle">angle</td><td class="desc">
-<p>The rotation angle that is to be applied.</p>
+<p>The rotation angle that is to be applied in degrees divided by 180.0 (as in the spec) represented as a 16.16 fixed-point value. Multiply by 180.0f to receive degrees value.</p>
</td></tr>
<tr><td class="val" id="center_x">center_x</td><td class="desc">
-<p>The x&nbsp;coordinate of the pivot point of the rotation (in font units).</p>
+<p>The x&nbsp;coordinate of the pivot point of the rotation in font units) represented as a 16.16 fixed-point value.</p>
</td></tr>
<tr><td class="val" id="center_y">center_y</td><td class="desc">
-<p>The y&nbsp;coordinate of the pivot point of the rotation (in font units).</p>
+<p>The y&nbsp;coordinate of the pivot point of the rotation in font units represented as a 16.16 fixed-point value.</p>
</td></tr>
</table>
@@ -2307,16 +2336,16 @@
<p>An <code><a href="ft2-layer_management.html#ft_opaquepaint">FT_OpaquePaint</a></code> object referencing the paint that is to be skewed.</p>
</td></tr>
<tr><td class="val" id="x_skew_angle">x_skew_angle</td><td class="desc">
-<p>The skewing angle in x&nbsp;direction.</p>
+<p>The skewing angle in x&nbsp;direction in degrees divided by 180.0 (as in the spec) represented as a 16.16 fixed-point value. Multiply by 180.0f to receive degrees.</p>
</td></tr>
<tr><td class="val" id="y_skew_angle">y_skew_angle</td><td class="desc">
-<p>The skewing angle in y&nbsp;direction.</p>
+<p>The skewing angle in y&nbsp;direction in degrees divided by 180.0 (as in the spec) represented as a 16.16 fixed-point value. Multiply by 180.0f to receive degrees.</p>
</td></tr>
<tr><td class="val" id="center_x">center_x</td><td class="desc">
-<p>The x&nbsp;coordinate of the pivot point of the skew (in font units).</p>
+<p>The x&nbsp;coordinate of the pivot point of the skew in font units represented as a 16.16 fixed-point value.</p>
</td></tr>
<tr><td class="val" id="center_y">center_y</td><td class="desc">
-<p>The y&nbsp;coordinate of the pivot point of the skew (in font units).</p>
+<p>The y&nbsp;coordinate of the pivot point of the skew in font units represented as a 16.16 fixed-point value.</p>
</td></tr>
</table>
@@ -2429,6 +2458,40 @@
<p>2.11 &ndash; <strong>currently experimental only!</strong> There might be changes without retaining backward compatibility of both the API and ABI.</p>
<hr>
+<h2 id="ft_clipbox">FT_ClipBox<a class="headerlink" href="#ft_clipbox" title="Permanent link">&para;</a></h2>
+<p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p>
+<div class = "codehilite"><pre><code> <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_ClipBox_
+ {
+ <a href="ft2-basic_types.html#ft_vector">FT_Vector</a> bottom_left;
+ <a href="ft2-basic_types.html#ft_vector">FT_Vector</a> top_left;
+ <a href="ft2-basic_types.html#ft_vector">FT_Vector</a> top_right;
+ <a href="ft2-basic_types.html#ft_vector">FT_Vector</a> bottom_right;
+
+ } <b>FT_ClipBox</b>;
+</code></pre></div>
+
+<p>A structure representing a &lsquo;COLR&rsquo; v1 &lsquo;ClipBox&rsquo; table. &lsquo;COLR&rsquo; v1 glyphs may optionally define a clip box for aiding allocation or defining a maximum drawable region. Use <code><a href="ft2-layer_management.html#ft_get_color_glyph_clipbox">FT_Get_Color_Glyph_ClipBox</a></code> to retrieve it.</p>
+<h4>fields</h4>
+<table class="fields">
+<tr><td class="val" id="bottom_left">bottom_left</td><td class="desc">
+<p>The bottom left corner of the clip box as an <code><a href="ft2-basic_types.html#ft_vector">FT_Vector</a></code> with fixed-point coordinates in 26.6 format.</p>
+</td></tr>
+<tr><td class="val" id="top_left">top_left</td><td class="desc">
+<p>The top left corner of the clip box as an <code><a href="ft2-basic_types.html#ft_vector">FT_Vector</a></code> with fixed-point coordinates in 26.6 format.</p>
+</td></tr>
+<tr><td class="val" id="top_right">top_right</td><td class="desc">
+<p>The top right corner of the clip box as an <code><a href="ft2-basic_types.html#ft_vector">FT_Vector</a></code> with fixed-point coordinates in 26.6 format.</p>
+</td></tr>
+<tr><td class="val" id="bottom_right">bottom_right</td><td class="desc">
+<p>The bottom right corner of the clip box as an <code><a href="ft2-basic_types.html#ft_vector">FT_Vector</a></code> with fixed-point coordinates in 26.6 format.</p>
+</td></tr>
+</table>
+
+<h4>since</h4>
+
+<p>2.12 &ndash; <strong>currently experimental only!</strong> There might be changes without retaining backward compatibility of both the API and ABI.</p>
+<hr>
+
<h2 id="ft_get_color_glyph_paint">FT_Get_Color_Glyph_Paint<a class="headerlink" href="#ft_get_color_glyph_paint" title="Permanent link">&para;</a></h2>
<p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p>
<div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_bool">FT_Bool</a> )
@@ -2473,6 +2536,43 @@
<p>2.11 &ndash; <strong>currently experimental only!</strong> There might be changes without retaining backward compatibility of both the API and ABI.</p>
<hr>
+<h2 id="ft_get_color_glyph_clipbox">FT_Get_Color_Glyph_ClipBox<a class="headerlink" href="#ft_get_color_glyph_clipbox" title="Permanent link">&para;</a></h2>
+<p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p>
+<div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_bool">FT_Bool</a> )
+ <b>FT_Get_Color_Glyph_ClipBox</b>( <a href="ft2-base_interface.html#ft_face">FT_Face</a> face,
+ <a href="ft2-basic_types.html#ft_uint">FT_UInt</a> base_glyph,
+ <a href="ft2-layer_management.html#ft_clipbox">FT_ClipBox</a>* clip_box );
+</code></pre></div>
+
+<p>Search for a &lsquo;COLR&rsquo; v1 clip box for the specified <code>base_glyph</code> and fill the <code>clip_box</code> parameter with the &lsquo;COLR&rsquo; v1 &lsquo;ClipBox&rsquo; information if one is found.</p>
+<h4>input</h4>
+<table class="fields">
+<tr><td class="val" id="face">face</td><td class="desc">
+<p>A handle to the parent face object.</p>
+</td></tr>
+<tr><td class="val" id="base_glyph">base_glyph</td><td class="desc">
+<p>The glyph index for which to retrieve the clip box.</p>
+</td></tr>
+</table>
+
+<h4>output</h4>
+<table class="fields">
+<tr><td class="val" id="clip_box">clip_box</td><td class="desc">
+<p>The clip box for the requested <code>base_glyph</code> if one is found. The clip box is computed taking scale and transformations configured on the <code><a href="ft2-base_interface.html#ft_face">FT_Face</a></code> into account. <code><a href="ft2-layer_management.html#ft_clipbox">FT_ClipBox</a></code> contains <code><a href="ft2-basic_types.html#ft_vector">FT_Vector</a></code> values in 26.6 format.</p>
+</td></tr>
+</table>
+
+<h4>return</h4>
+
+<p>Value&nbsp;1 if a clip box is found. If no clip box is found or an error occured, value&nbsp;0 is returned.</p>
+<h4>note</h4>
+
+<p>To retrieve the clip box in font units, reset scale to units-per-em and remove transforms configured using <code><a href="ft2-base_interface.html#ft_set_transform">FT_Set_Transform</a></code>.</p>
+<h4>since</h4>
+
+<p>2.12 &ndash; <strong>currently experimental only!</strong> There might be changes without retaining backward compatibility of both the API and ABI.</p>
+<hr>
+
<h2 id="ft_get_paint_layers">FT_Get_Paint_Layers<a class="headerlink" href="#ft_get_paint_layers" title="Permanent link">&para;</a></h2>
<p>Defined in FT_COLOR_H (freetype/ftcolor.h).</p>
<div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_bool">FT_Bool</a> )