| 4680 |
right-hear |
1 |
/***************************************************************************/ |
|
|
2 |
/* */ |
|
|
3 |
/* ftpfr.h */ |
|
|
4 |
/* */ |
|
|
5 |
/* FreeType API for accessing PFR-specific data (specification only). */ |
|
|
6 |
/* */ |
|
|
7 |
/* Copyright 2002, 2003, 2004, 2006, 2008, 2009 by */ |
|
|
8 |
/* David Turner, Robert Wilhelm, and Werner Lemberg. */ |
|
|
9 |
/* */ |
|
|
10 |
/* This file is part of the FreeType project, and may only be used, */ |
|
|
11 |
/* modified, and distributed under the terms of the FreeType project */ |
|
|
12 |
/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ |
|
|
13 |
/* this file you indicate that you have read the license and */ |
|
|
14 |
/* understand and accept it fully. */ |
|
|
15 |
/* */ |
|
|
16 |
/***************************************************************************/ |
|
|
17 |
|
|
|
18 |
|
|
|
19 |
#ifndef __FTPFR_H__ |
|
|
20 |
#define __FTPFR_H__ |
|
|
21 |
|
|
|
22 |
#include |
|
|
23 |
#include FT_FREETYPE_H |
|
|
24 |
|
|
|
25 |
#ifdef FREETYPE_H |
|
|
26 |
#error "freetype.h of FreeType 1 has been loaded!" |
|
|
27 |
#error "Please fix the directory search order for header files" |
|
|
28 |
#error "so that freetype.h of FreeType 2 is found first." |
|
|
29 |
#endif |
|
|
30 |
|
|
|
31 |
|
|
|
32 |
FT_BEGIN_HEADER |
|
|
33 |
|
|
|
34 |
|
|
|
35 |
/*************************************************************************/ |
|
|
36 |
/* */ |
|
|
37 |
/* |
|
|
38 |
/* pfr_fonts */ |
|
|
39 |
/* */ |
|
|
40 |
/* */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l41">41</a></td>
<td class="code"><pre> /* PFR Fonts */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l42">42</a></td>
<td class="code"><pre> /* */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l43">43</a></td>
<td class="code"><pre> /* <Abstract> */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l44">44</a></td>
<td class="code"><pre> /* PFR/TrueDoc specific API. */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l45">45</a></td>
<td class="code"><pre> /* */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l46">46</a></td>
<td class="code"><pre> /* <Description> */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l47">47</a></td>
<td class="code"><pre> /* This section contains the declaration of PFR-specific functions. */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l48">48</a></td>
<td class="code"><pre> /* */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l49">49</a></td>
<td class="code"><pre> /*************************************************************************/</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l50">50</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l51">51</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l52">52</a></td>
<td class="code"><pre> /**********************************************************************</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l53">53</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l54">54</a></td>
<td class="code"><pre> * @function:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l55">55</a></td>
<td class="code"><pre> * FT_Get_PFR_Metrics</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l56">56</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l57">57</a></td>
<td class="code"><pre> * @description:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l58">58</a></td>
<td class="code"><pre> * Return the outline and metrics resolutions of a given PFR face.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l59">59</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l60">60</a></td>
<td class="code"><pre> * @input:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l61">61</a></td>
<td class="code"><pre> * face :: Handle to the input face. It can be a non-PFR face.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l62">62</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l63">63</a></td>
<td class="code"><pre> * @output:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l64">64</a></td>
<td class="code"><pre> * aoutline_resolution ::</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l65">65</a></td>
<td class="code"><pre> * Outline resolution. This is equivalent to `face->units_per_EM'</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l66">66</a></td>
<td class="code"><pre> * for non-PFR fonts. Optional (parameter can be NULL).</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l67">67</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l68">68</a></td>
<td class="code"><pre> * ametrics_resolution ::</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l69">69</a></td>
<td class="code"><pre> * Metrics resolution. This is equivalent to `outline_resolution'</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l70">70</a></td>
<td class="code"><pre> * for non-PFR fonts. Optional (parameter can be NULL).</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l71">71</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l72">72</a></td>
<td class="code"><pre> * ametrics_x_scale ::</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l73">73</a></td>
<td class="code"><pre> * A 16.16 fixed-point number used to scale distance expressed</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l74">74</a></td>
<td class="code"><pre> * in metrics units to device sub-pixels. This is equivalent to</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l75">75</a></td>
<td class="code"><pre> * `face->size->x_scale', but for metrics only. Optional (parameter</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l76">76</a></td>
<td class="code"><pre> * can be NULL).</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l77">77</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l78">78</a></td>
<td class="code"><pre> * ametrics_y_scale ::</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l79">79</a></td>
<td class="code"><pre> * Same as `ametrics_x_scale' but for the vertical direction.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l80">80</a></td>
<td class="code"><pre> * optional (parameter can be NULL).</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l81">81</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l82">82</a></td>
<td class="code"><pre> * @return:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l83">83</a></td>
<td class="code"><pre> * FreeType error code. 0~means success.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l84">84</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l85">85</a></td>
<td class="code"><pre> * @note:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l86">86</a></td>
<td class="code"><pre> * If the input face is not a PFR, this function will return an error.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l87">87</a></td>
<td class="code"><pre> * However, in all cases, it will return valid values.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l88">88</a></td>
<td class="code"><pre> */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l89">89</a></td>
<td class="code"><pre> FT_EXPORT( FT_Error )</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l90">90</a></td>
<td class="code"><pre> FT_Get_PFR_Metrics( FT_Face face,</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l91">91</a></td>
<td class="code"><pre> FT_UInt *aoutline_resolution,</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l92">92</a></td>
<td class="code"><pre> FT_UInt *ametrics_resolution,</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l93">93</a></td>
<td class="code"><pre> FT_Fixed *ametrics_x_scale,</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l94">94</a></td>
<td class="code"><pre> FT_Fixed *ametrics_y_scale );</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l95">95</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l96">96</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l97">97</a></td>
<td class="code"><pre> /**********************************************************************</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l98">98</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l99">99</a></td>
<td class="code"><pre> * @function:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l100">100</a></td>
<td class="code"><pre> * FT_Get_PFR_Kerning</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l101">101</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l102">102</a></td>
<td class="code"><pre> * @description:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l103">103</a></td>
<td class="code"><pre> * Return the kerning pair corresponding to two glyphs in a PFR face.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l104">104</a></td>
<td class="code"><pre> * The distance is expressed in metrics units, unlike the result of</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l105">105</a></td>
<td class="code"><pre> * @FT_Get_Kerning.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l106">106</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l107">107</a></td>
<td class="code"><pre> * @input:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l108">108</a></td>
<td class="code"><pre> * face :: A handle to the input face.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l109">109</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l110">110</a></td>
<td class="code"><pre> * left :: Index of the left glyph.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l111">111</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l112">112</a></td>
<td class="code"><pre> * right :: Index of the right glyph.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l113">113</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l114">114</a></td>
<td class="code"><pre> * @output:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l115">115</a></td>
<td class="code"><pre> * avector :: A kerning vector.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l116">116</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l117">117</a></td>
<td class="code"><pre> * @return:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l118">118</a></td>
<td class="code"><pre> * FreeType error code. 0~means success.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l119">119</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l120">120</a></td>
<td class="code"><pre> * @note:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l121">121</a></td>
<td class="code"><pre> * This function always return distances in original PFR metrics</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l122">122</a></td>
<td class="code"><pre> * units. This is unlike @FT_Get_Kerning with the @FT_KERNING_UNSCALED</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l123">123</a></td>
<td class="code"><pre> * mode, which always returns distances converted to outline units.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l124">124</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l125">125</a></td>
<td class="code"><pre> * You can use the value of the `x_scale' and `y_scale' parameters</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l126">126</a></td>
<td class="code"><pre> * returned by @FT_Get_PFR_Metrics to scale these to device sub-pixels.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l127">127</a></td>
<td class="code"><pre> */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l128">128</a></td>
<td class="code"><pre> FT_EXPORT( FT_Error )</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l129">129</a></td>
<td class="code"><pre> FT_Get_PFR_Kerning( FT_Face face,</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l130">130</a></td>
<td class="code"><pre> FT_UInt left,</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l131">131</a></td>
<td class="code"><pre> FT_UInt right,</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l132">132</a></td>
<td class="code"><pre> FT_Vector *avector );</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l133">133</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l134">134</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l135">135</a></td>
<td class="code"><pre> /**********************************************************************</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l136">136</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l137">137</a></td>
<td class="code"><pre> * @function:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l138">138</a></td>
<td class="code"><pre> * FT_Get_PFR_Advance</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l139">139</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l140">140</a></td>
<td class="code"><pre> * @description:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l141">141</a></td>
<td class="code"><pre> * Return a given glyph advance, expressed in original metrics units,</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l142">142</a></td>
<td class="code"><pre> * from a PFR font.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l143">143</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l144">144</a></td>
<td class="code"><pre> * @input:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l145">145</a></td>
<td class="code"><pre> * face :: A handle to the input face.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l146">146</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l147">147</a></td>
<td class="code"><pre> * gindex :: The glyph index.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l148">148</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l149">149</a></td>
<td class="code"><pre> * @output:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l150">150</a></td>
<td class="code"><pre> * aadvance :: The glyph advance in metrics units.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l151">151</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l152">152</a></td>
<td class="code"><pre> * @return:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l153">153</a></td>
<td class="code"><pre> * FreeType error code. 0~means success.</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l154">154</a></td>
<td class="code"><pre> *</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l155">155</a></td>
<td class="code"><pre> * @note:</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l156">156</a></td>
<td class="code"><pre> * You can use the `x_scale' or `y_scale' results of @FT_Get_PFR_Metrics</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l157">157</a></td>
<td class="code"><pre> * to convert the advance to device sub-pixels (i.e., 1/64th of pixels).</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l158">158</a></td>
<td class="code"><pre> */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l159">159</a></td>
<td class="code"><pre> FT_EXPORT( FT_Error )</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l160">160</a></td>
<td class="code"><pre> FT_Get_PFR_Advance( FT_Face face,</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l161">161</a></td>
<td class="code"><pre> FT_UInt gindex,</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l162">162</a></td>
<td class="code"><pre> FT_Pos *aadvance );</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l163">163</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l164">164</a></td>
<td class="code"><pre> /* */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l165">165</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l166">166</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l167">167</a></td>
<td class="code"><pre>FT_END_HEADER</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l168">168</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l169">169</a></td>
<td class="code"><pre>#endif /* __FTPFR_H__ */</pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l170">170</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l171">171</a></td>
<td class="code"><pre> </pre></td>
</tr>
<tr valign="middle">
<td></td>
<td></td>
<td><a name="l172">172</a></td>
<td class="code"><pre>/* END */</Description></Abstract> |