annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/gtk-doc/html/cairo/cairo-cairo-font-options-t.html @ 68:5028fdace37b

planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
rev   line source
jpayne@68 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
jpayne@68 2 <html>
jpayne@68 3 <head>
jpayne@68 4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
jpayne@68 5 <title>cairo_font_options_t: Cairo: A Vector Graphics Library</title>
jpayne@68 6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
jpayne@68 7 <link rel="home" href="index.html" title="Cairo: A Vector Graphics Library">
jpayne@68 8 <link rel="up" href="cairo-fonts.html" title="Fonts">
jpayne@68 9 <link rel="prev" href="cairo-cairo-scaled-font-t.html" title="cairo_scaled_font_t">
jpayne@68 10 <link rel="next" href="cairo-FreeType-Fonts.html" title="FreeType Fonts">
jpayne@68 11 <meta name="generator" content="GTK-Doc V1.27 (XML mode)">
jpayne@68 12 <link rel="stylesheet" href="style.css" type="text/css">
jpayne@68 13 </head>
jpayne@68 14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
jpayne@68 15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
jpayne@68 16 <td width="100%" align="left" class="shortcuts">
jpayne@68 17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
jpayne@68 18 <a href="#cairo-cairo-font-options-t.description" class="shortcut">Description</a></span>
jpayne@68 19 </td>
jpayne@68 20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
jpayne@68 21 <td><a accesskey="u" href="cairo-fonts.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
jpayne@68 22 <td><a accesskey="p" href="cairo-cairo-scaled-font-t.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
jpayne@68 23 <td><a accesskey="n" href="cairo-FreeType-Fonts.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
jpayne@68 24 </tr></table>
jpayne@68 25 <div class="refentry">
jpayne@68 26 <a name="cairo-cairo-font-options-t"></a><div class="titlepage"></div>
jpayne@68 27 <div class="refnamediv"><table width="100%"><tr>
jpayne@68 28 <td valign="top">
jpayne@68 29 <h2><span class="refentrytitle"><a name="cairo-cairo-font-options-t.top_of_page"></a>cairo_font_options_t</span></h2>
jpayne@68 30 <p>cairo_font_options_t — How a font should be rendered</p>
jpayne@68 31 </td>
jpayne@68 32 <td class="gallery_image" valign="top" align="right"></td>
jpayne@68 33 </tr></table></div>
jpayne@68 34 <div class="refsect1">
jpayne@68 35 <a name="cairo-cairo-font-options-t.functions"></a><h2>Functions</h2>
jpayne@68 36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 37 <colgroup>
jpayne@68 38 <col width="150px" class="functions_return">
jpayne@68 39 <col class="functions_name">
jpayne@68 40 </colgroup>
jpayne@68 41 <tbody>
jpayne@68 42 <tr>
jpayne@68 43 <td class="function_type">
jpayne@68 44 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="returnvalue">cairo_font_options_t</span></a> *
jpayne@68 45 </td>
jpayne@68 46 <td class="function_name">
jpayne@68 47 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-create" title="cairo_font_options_create ()">cairo_font_options_create</a> <span class="c_punctuation">()</span>
jpayne@68 48 </td>
jpayne@68 49 </tr>
jpayne@68 50 <tr>
jpayne@68 51 <td class="function_type">
jpayne@68 52 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="returnvalue">cairo_font_options_t</span></a> *
jpayne@68 53 </td>
jpayne@68 54 <td class="function_name">
jpayne@68 55 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-copy" title="cairo_font_options_copy ()">cairo_font_options_copy</a> <span class="c_punctuation">()</span>
jpayne@68 56 </td>
jpayne@68 57 </tr>
jpayne@68 58 <tr>
jpayne@68 59 <td class="function_type">
jpayne@68 60 <span class="returnvalue">void</span>
jpayne@68 61 </td>
jpayne@68 62 <td class="function_name">
jpayne@68 63 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-destroy" title="cairo_font_options_destroy ()">cairo_font_options_destroy</a> <span class="c_punctuation">()</span>
jpayne@68 64 </td>
jpayne@68 65 </tr>
jpayne@68 66 <tr>
jpayne@68 67 <td class="function_type">
jpayne@68 68 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 69 </td>
jpayne@68 70 <td class="function_name">
jpayne@68 71 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-status" title="cairo_font_options_status ()">cairo_font_options_status</a> <span class="c_punctuation">()</span>
jpayne@68 72 </td>
jpayne@68 73 </tr>
jpayne@68 74 <tr>
jpayne@68 75 <td class="function_type">
jpayne@68 76 <span class="returnvalue">void</span>
jpayne@68 77 </td>
jpayne@68 78 <td class="function_name">
jpayne@68 79 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-merge" title="cairo_font_options_merge ()">cairo_font_options_merge</a> <span class="c_punctuation">()</span>
jpayne@68 80 </td>
jpayne@68 81 </tr>
jpayne@68 82 <tr>
jpayne@68 83 <td class="function_type">unsigned <span class="returnvalue">long</span>
jpayne@68 84 </td>
jpayne@68 85 <td class="function_name">
jpayne@68 86 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-hash" title="cairo_font_options_hash ()">cairo_font_options_hash</a> <span class="c_punctuation">()</span>
jpayne@68 87 </td>
jpayne@68 88 </tr>
jpayne@68 89 <tr>
jpayne@68 90 <td class="function_type">
jpayne@68 91 <a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
jpayne@68 92 </td>
jpayne@68 93 <td class="function_name">
jpayne@68 94 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-equal" title="cairo_font_options_equal ()">cairo_font_options_equal</a> <span class="c_punctuation">()</span>
jpayne@68 95 </td>
jpayne@68 96 </tr>
jpayne@68 97 <tr>
jpayne@68 98 <td class="function_type">
jpayne@68 99 <span class="returnvalue">void</span>
jpayne@68 100 </td>
jpayne@68 101 <td class="function_name">
jpayne@68 102 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-set-antialias" title="cairo_font_options_set_antialias ()">cairo_font_options_set_antialias</a> <span class="c_punctuation">()</span>
jpayne@68 103 </td>
jpayne@68 104 </tr>
jpayne@68 105 <tr>
jpayne@68 106 <td class="function_type">
jpayne@68 107 <a class="link" href="cairo-cairo-t.html#cairo-antialias-t" title="enum cairo_antialias_t"><span class="returnvalue">cairo_antialias_t</span></a>
jpayne@68 108 </td>
jpayne@68 109 <td class="function_name">
jpayne@68 110 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-get-antialias" title="cairo_font_options_get_antialias ()">cairo_font_options_get_antialias</a> <span class="c_punctuation">()</span>
jpayne@68 111 </td>
jpayne@68 112 </tr>
jpayne@68 113 <tr>
jpayne@68 114 <td class="function_type">
jpayne@68 115 <span class="returnvalue">void</span>
jpayne@68 116 </td>
jpayne@68 117 <td class="function_name">
jpayne@68 118 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-set-subpixel-order" title="cairo_font_options_set_subpixel_order ()">cairo_font_options_set_subpixel_order</a> <span class="c_punctuation">()</span>
jpayne@68 119 </td>
jpayne@68 120 </tr>
jpayne@68 121 <tr>
jpayne@68 122 <td class="function_type">
jpayne@68 123 <a class="link" href="cairo-cairo-font-options-t.html#cairo-subpixel-order-t" title="enum cairo_subpixel_order_t"><span class="returnvalue">cairo_subpixel_order_t</span></a>
jpayne@68 124 </td>
jpayne@68 125 <td class="function_name">
jpayne@68 126 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-get-subpixel-order" title="cairo_font_options_get_subpixel_order ()">cairo_font_options_get_subpixel_order</a> <span class="c_punctuation">()</span>
jpayne@68 127 </td>
jpayne@68 128 </tr>
jpayne@68 129 <tr>
jpayne@68 130 <td class="function_type">
jpayne@68 131 <span class="returnvalue">void</span>
jpayne@68 132 </td>
jpayne@68 133 <td class="function_name">
jpayne@68 134 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-set-hint-style" title="cairo_font_options_set_hint_style ()">cairo_font_options_set_hint_style</a> <span class="c_punctuation">()</span>
jpayne@68 135 </td>
jpayne@68 136 </tr>
jpayne@68 137 <tr>
jpayne@68 138 <td class="function_type">
jpayne@68 139 <a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-style-t" title="enum cairo_hint_style_t"><span class="returnvalue">cairo_hint_style_t</span></a>
jpayne@68 140 </td>
jpayne@68 141 <td class="function_name">
jpayne@68 142 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-get-hint-style" title="cairo_font_options_get_hint_style ()">cairo_font_options_get_hint_style</a> <span class="c_punctuation">()</span>
jpayne@68 143 </td>
jpayne@68 144 </tr>
jpayne@68 145 <tr>
jpayne@68 146 <td class="function_type">
jpayne@68 147 <span class="returnvalue">void</span>
jpayne@68 148 </td>
jpayne@68 149 <td class="function_name">
jpayne@68 150 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-set-hint-metrics" title="cairo_font_options_set_hint_metrics ()">cairo_font_options_set_hint_metrics</a> <span class="c_punctuation">()</span>
jpayne@68 151 </td>
jpayne@68 152 </tr>
jpayne@68 153 <tr>
jpayne@68 154 <td class="function_type">
jpayne@68 155 <a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-metrics-t" title="enum cairo_hint_metrics_t"><span class="returnvalue">cairo_hint_metrics_t</span></a>
jpayne@68 156 </td>
jpayne@68 157 <td class="function_name">
jpayne@68 158 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-get-hint-metrics" title="cairo_font_options_get_hint_metrics ()">cairo_font_options_get_hint_metrics</a> <span class="c_punctuation">()</span>
jpayne@68 159 </td>
jpayne@68 160 </tr>
jpayne@68 161 <tr>
jpayne@68 162 <td class="function_type">const <span class="returnvalue">char</span> *
jpayne@68 163 </td>
jpayne@68 164 <td class="function_name">
jpayne@68 165 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-get-variations" title="cairo_font_options_get_variations ()">cairo_font_options_get_variations</a> <span class="c_punctuation">()</span>
jpayne@68 166 </td>
jpayne@68 167 </tr>
jpayne@68 168 <tr>
jpayne@68 169 <td class="function_type">
jpayne@68 170 <span class="returnvalue">void</span>
jpayne@68 171 </td>
jpayne@68 172 <td class="function_name">
jpayne@68 173 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-set-variations" title="cairo_font_options_set_variations ()">cairo_font_options_set_variations</a> <span class="c_punctuation">()</span>
jpayne@68 174 </td>
jpayne@68 175 </tr>
jpayne@68 176 </tbody>
jpayne@68 177 </table></div>
jpayne@68 178 </div>
jpayne@68 179 <div class="refsect1">
jpayne@68 180 <a name="cairo-cairo-font-options-t.other"></a><h2>Types and Values</h2>
jpayne@68 181 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 182 <colgroup>
jpayne@68 183 <col width="150px" class="name">
jpayne@68 184 <col class="description">
jpayne@68 185 </colgroup>
jpayne@68 186 <tbody>
jpayne@68 187 <tr>
jpayne@68 188 <td class="typedef_keyword">typedef</td>
jpayne@68 189 <td class="function_name"><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t">cairo_font_options_t</a></td>
jpayne@68 190 </tr>
jpayne@68 191 <tr>
jpayne@68 192 <td class="datatype_keyword">enum</td>
jpayne@68 193 <td class="function_name"><a class="link" href="cairo-cairo-font-options-t.html#cairo-subpixel-order-t" title="enum cairo_subpixel_order_t">cairo_subpixel_order_t</a></td>
jpayne@68 194 </tr>
jpayne@68 195 <tr>
jpayne@68 196 <td class="datatype_keyword">enum</td>
jpayne@68 197 <td class="function_name"><a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-style-t" title="enum cairo_hint_style_t">cairo_hint_style_t</a></td>
jpayne@68 198 </tr>
jpayne@68 199 <tr>
jpayne@68 200 <td class="datatype_keyword">enum</td>
jpayne@68 201 <td class="function_name"><a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-metrics-t" title="enum cairo_hint_metrics_t">cairo_hint_metrics_t</a></td>
jpayne@68 202 </tr>
jpayne@68 203 </tbody>
jpayne@68 204 </table></div>
jpayne@68 205 </div>
jpayne@68 206 <div class="refsect1">
jpayne@68 207 <a name="cairo-cairo-font-options-t.description"></a><h2>Description</h2>
jpayne@68 208 <p>The font options specify how fonts should be rendered. Most of the
jpayne@68 209 time the font options implied by a surface are just right and do not
jpayne@68 210 need any changes, but for pixel-based targets tweaking font options
jpayne@68 211 may result in superior output on a particular display.</p>
jpayne@68 212 </div>
jpayne@68 213 <div class="refsect1">
jpayne@68 214 <a name="cairo-cairo-font-options-t.functions_details"></a><h2>Functions</h2>
jpayne@68 215 <div class="refsect2">
jpayne@68 216 <a name="cairo-font-options-create"></a><h3>cairo_font_options_create ()</h3>
jpayne@68 217 <pre class="programlisting"><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="returnvalue">cairo_font_options_t</span></a> *
jpayne@68 218 cairo_font_options_create (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
jpayne@68 219 <p>Allocates a new font options object with all options initialized
jpayne@68 220 to default values.</p>
jpayne@68 221 <div class="refsect3">
jpayne@68 222 <a name="cairo-font-options-create.returns"></a><h4>Returns</h4>
jpayne@68 223 <p> a newly allocated <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a>. Free with
jpayne@68 224 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-destroy" title="cairo_font_options_destroy ()"><code class="function">cairo_font_options_destroy()</code></a>. This function always returns a
jpayne@68 225 valid pointer; if memory cannot be allocated, then a special
jpayne@68 226 error object is returned where all operations on the object do nothing.
jpayne@68 227 You can check for this with <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-status" title="cairo_font_options_status ()"><code class="function">cairo_font_options_status()</code></a>.</p>
jpayne@68 228 </div>
jpayne@68 229 <p class="since">Since: 1.0</p>
jpayne@68 230 </div>
jpayne@68 231 <hr>
jpayne@68 232 <div class="refsect2">
jpayne@68 233 <a name="cairo-font-options-copy"></a><h3>cairo_font_options_copy ()</h3>
jpayne@68 234 <pre class="programlisting"><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="returnvalue">cairo_font_options_t</span></a> *
jpayne@68 235 cairo_font_options_copy (<em class="parameter"><code>const <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *original</code></em>);</pre>
jpayne@68 236 <p>Allocates a new font options object copying the option values from
jpayne@68 237 <em class="parameter"><code>original</code></em>
jpayne@68 238 .</p>
jpayne@68 239 <div class="refsect3">
jpayne@68 240 <a name="cairo-font-options-copy.parameters"></a><h4>Parameters</h4>
jpayne@68 241 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 242 <colgroup>
jpayne@68 243 <col width="150px" class="parameters_name">
jpayne@68 244 <col class="parameters_description">
jpayne@68 245 <col width="200px" class="parameters_annotations">
jpayne@68 246 </colgroup>
jpayne@68 247 <tbody><tr>
jpayne@68 248 <td class="parameter_name"><p>original</p></td>
jpayne@68 249 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 250 <td class="parameter_annotations"> </td>
jpayne@68 251 </tr></tbody>
jpayne@68 252 </table></div>
jpayne@68 253 </div>
jpayne@68 254 <div class="refsect3">
jpayne@68 255 <a name="cairo-font-options-copy.returns"></a><h4>Returns</h4>
jpayne@68 256 <p> a newly allocated <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a>. Free with
jpayne@68 257 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-destroy" title="cairo_font_options_destroy ()"><code class="function">cairo_font_options_destroy()</code></a>. This function always returns a
jpayne@68 258 valid pointer; if memory cannot be allocated, then a special
jpayne@68 259 error object is returned where all operations on the object do nothing.
jpayne@68 260 You can check for this with <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-status" title="cairo_font_options_status ()"><code class="function">cairo_font_options_status()</code></a>.</p>
jpayne@68 261 </div>
jpayne@68 262 <p class="since">Since: 1.0</p>
jpayne@68 263 </div>
jpayne@68 264 <hr>
jpayne@68 265 <div class="refsect2">
jpayne@68 266 <a name="cairo-font-options-destroy"></a><h3>cairo_font_options_destroy ()</h3>
jpayne@68 267 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 268 cairo_font_options_destroy (<em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);</pre>
jpayne@68 269 <p>Destroys a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> object created with
jpayne@68 270 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-create" title="cairo_font_options_create ()"><code class="function">cairo_font_options_create()</code></a> or <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-copy" title="cairo_font_options_copy ()"><code class="function">cairo_font_options_copy()</code></a>.</p>
jpayne@68 271 <div class="refsect3">
jpayne@68 272 <a name="cairo-font-options-destroy.parameters"></a><h4>Parameters</h4>
jpayne@68 273 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 274 <colgroup>
jpayne@68 275 <col width="150px" class="parameters_name">
jpayne@68 276 <col class="parameters_description">
jpayne@68 277 <col width="200px" class="parameters_annotations">
jpayne@68 278 </colgroup>
jpayne@68 279 <tbody><tr>
jpayne@68 280 <td class="parameter_name"><p>options</p></td>
jpayne@68 281 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 282 <td class="parameter_annotations"> </td>
jpayne@68 283 </tr></tbody>
jpayne@68 284 </table></div>
jpayne@68 285 </div>
jpayne@68 286 <p class="since">Since: 1.0</p>
jpayne@68 287 </div>
jpayne@68 288 <hr>
jpayne@68 289 <div class="refsect2">
jpayne@68 290 <a name="cairo-font-options-status"></a><h3>cairo_font_options_status ()</h3>
jpayne@68 291 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 292 cairo_font_options_status (<em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);</pre>
jpayne@68 293 <p>Checks whether an error has previously occurred for this
jpayne@68 294 font options object</p>
jpayne@68 295 <div class="refsect3">
jpayne@68 296 <a name="cairo-font-options-status.parameters"></a><h4>Parameters</h4>
jpayne@68 297 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 298 <colgroup>
jpayne@68 299 <col width="150px" class="parameters_name">
jpayne@68 300 <col class="parameters_description">
jpayne@68 301 <col width="200px" class="parameters_annotations">
jpayne@68 302 </colgroup>
jpayne@68 303 <tbody><tr>
jpayne@68 304 <td class="parameter_name"><p>options</p></td>
jpayne@68 305 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 306 <td class="parameter_annotations"> </td>
jpayne@68 307 </tr></tbody>
jpayne@68 308 </table></div>
jpayne@68 309 </div>
jpayne@68 310 <div class="refsect3">
jpayne@68 311 <a name="cairo-font-options-status.returns"></a><h4>Returns</h4>
jpayne@68 312 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a></p>
jpayne@68 313 </div>
jpayne@68 314 <p class="since">Since: 1.0</p>
jpayne@68 315 </div>
jpayne@68 316 <hr>
jpayne@68 317 <div class="refsect2">
jpayne@68 318 <a name="cairo-font-options-merge"></a><h3>cairo_font_options_merge ()</h3>
jpayne@68 319 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 320 cairo_font_options_merge (<em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>,
jpayne@68 321 <em class="parameter"><code>const <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *other</code></em>);</pre>
jpayne@68 322 <p>Merges non-default options from <em class="parameter"><code>other</code></em>
jpayne@68 323 into <em class="parameter"><code>options</code></em>
jpayne@68 324 , replacing
jpayne@68 325 existing values. This operation can be thought of as somewhat
jpayne@68 326 similar to compositing <em class="parameter"><code>other</code></em>
jpayne@68 327 onto <em class="parameter"><code>options</code></em>
jpayne@68 328 with the operation
jpayne@68 329 of <a class="link" href="cairo-cairo-t.html#CAIRO-OPERATOR-OVER:CAPS"><code class="literal">CAIRO_OPERATOR_OVER</code></a>.</p>
jpayne@68 330 <div class="refsect3">
jpayne@68 331 <a name="cairo-font-options-merge.parameters"></a><h4>Parameters</h4>
jpayne@68 332 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 333 <colgroup>
jpayne@68 334 <col width="150px" class="parameters_name">
jpayne@68 335 <col class="parameters_description">
jpayne@68 336 <col width="200px" class="parameters_annotations">
jpayne@68 337 </colgroup>
jpayne@68 338 <tbody>
jpayne@68 339 <tr>
jpayne@68 340 <td class="parameter_name"><p>options</p></td>
jpayne@68 341 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 342 <td class="parameter_annotations"> </td>
jpayne@68 343 </tr>
jpayne@68 344 <tr>
jpayne@68 345 <td class="parameter_name"><p>other</p></td>
jpayne@68 346 <td class="parameter_description"><p>another <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 347 <td class="parameter_annotations"> </td>
jpayne@68 348 </tr>
jpayne@68 349 </tbody>
jpayne@68 350 </table></div>
jpayne@68 351 </div>
jpayne@68 352 <p class="since">Since: 1.0</p>
jpayne@68 353 </div>
jpayne@68 354 <hr>
jpayne@68 355 <div class="refsect2">
jpayne@68 356 <a name="cairo-font-options-hash"></a><h3>cairo_font_options_hash ()</h3>
jpayne@68 357 <pre class="programlisting">unsigned <span class="returnvalue">long</span>
jpayne@68 358 cairo_font_options_hash (<em class="parameter"><code>const <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);</pre>
jpayne@68 359 <p>Compute a hash for the font options object; this value will
jpayne@68 360 be useful when storing an object containing a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a>
jpayne@68 361 in a hash table.</p>
jpayne@68 362 <div class="refsect3">
jpayne@68 363 <a name="cairo-font-options-hash.parameters"></a><h4>Parameters</h4>
jpayne@68 364 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 365 <colgroup>
jpayne@68 366 <col width="150px" class="parameters_name">
jpayne@68 367 <col class="parameters_description">
jpayne@68 368 <col width="200px" class="parameters_annotations">
jpayne@68 369 </colgroup>
jpayne@68 370 <tbody><tr>
jpayne@68 371 <td class="parameter_name"><p>options</p></td>
jpayne@68 372 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 373 <td class="parameter_annotations"> </td>
jpayne@68 374 </tr></tbody>
jpayne@68 375 </table></div>
jpayne@68 376 </div>
jpayne@68 377 <div class="refsect3">
jpayne@68 378 <a name="cairo-font-options-hash.returns"></a><h4>Returns</h4>
jpayne@68 379 <p> the hash value for the font options object.
jpayne@68 380 The return value can be cast to a 32-bit type if a
jpayne@68 381 32-bit hash value is needed.</p>
jpayne@68 382 </div>
jpayne@68 383 <p class="since">Since: 1.0</p>
jpayne@68 384 </div>
jpayne@68 385 <hr>
jpayne@68 386 <div class="refsect2">
jpayne@68 387 <a name="cairo-font-options-equal"></a><h3>cairo_font_options_equal ()</h3>
jpayne@68 388 <pre class="programlisting"><a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
jpayne@68 389 cairo_font_options_equal (<em class="parameter"><code>const <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>,
jpayne@68 390 <em class="parameter"><code>const <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *other</code></em>);</pre>
jpayne@68 391 <p>Compares two font options objects for equality.</p>
jpayne@68 392 <div class="refsect3">
jpayne@68 393 <a name="cairo-font-options-equal.parameters"></a><h4>Parameters</h4>
jpayne@68 394 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 395 <colgroup>
jpayne@68 396 <col width="150px" class="parameters_name">
jpayne@68 397 <col class="parameters_description">
jpayne@68 398 <col width="200px" class="parameters_annotations">
jpayne@68 399 </colgroup>
jpayne@68 400 <tbody>
jpayne@68 401 <tr>
jpayne@68 402 <td class="parameter_name"><p>options</p></td>
jpayne@68 403 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 404 <td class="parameter_annotations"> </td>
jpayne@68 405 </tr>
jpayne@68 406 <tr>
jpayne@68 407 <td class="parameter_name"><p>other</p></td>
jpayne@68 408 <td class="parameter_description"><p>another <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 409 <td class="parameter_annotations"> </td>
jpayne@68 410 </tr>
jpayne@68 411 </tbody>
jpayne@68 412 </table></div>
jpayne@68 413 </div>
jpayne@68 414 <div class="refsect3">
jpayne@68 415 <a name="cairo-font-options-equal.returns"></a><h4>Returns</h4>
jpayne@68 416 <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if all fields of the two font options objects match.
jpayne@68 417 Note that this function will return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if either object is in
jpayne@68 418 error.</p>
jpayne@68 419 </div>
jpayne@68 420 <p class="since">Since: 1.0</p>
jpayne@68 421 </div>
jpayne@68 422 <hr>
jpayne@68 423 <div class="refsect2">
jpayne@68 424 <a name="cairo-font-options-set-antialias"></a><h3>cairo_font_options_set_antialias ()</h3>
jpayne@68 425 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 426 cairo_font_options_set_antialias (<em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>,
jpayne@68 427 <em class="parameter"><code><a class="link" href="cairo-cairo-t.html#cairo-antialias-t" title="enum cairo_antialias_t"><span class="type">cairo_antialias_t</span></a> antialias</code></em>);</pre>
jpayne@68 428 <p>Sets the antialiasing mode for the font options object. This
jpayne@68 429 specifies the type of antialiasing to do when rendering text.</p>
jpayne@68 430 <div class="refsect3">
jpayne@68 431 <a name="cairo-font-options-set-antialias.parameters"></a><h4>Parameters</h4>
jpayne@68 432 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 433 <colgroup>
jpayne@68 434 <col width="150px" class="parameters_name">
jpayne@68 435 <col class="parameters_description">
jpayne@68 436 <col width="200px" class="parameters_annotations">
jpayne@68 437 </colgroup>
jpayne@68 438 <tbody>
jpayne@68 439 <tr>
jpayne@68 440 <td class="parameter_name"><p>options</p></td>
jpayne@68 441 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 442 <td class="parameter_annotations"> </td>
jpayne@68 443 </tr>
jpayne@68 444 <tr>
jpayne@68 445 <td class="parameter_name"><p>antialias</p></td>
jpayne@68 446 <td class="parameter_description"><p>the new antialiasing mode</p></td>
jpayne@68 447 <td class="parameter_annotations"> </td>
jpayne@68 448 </tr>
jpayne@68 449 </tbody>
jpayne@68 450 </table></div>
jpayne@68 451 </div>
jpayne@68 452 <p class="since">Since: 1.0</p>
jpayne@68 453 </div>
jpayne@68 454 <hr>
jpayne@68 455 <div class="refsect2">
jpayne@68 456 <a name="cairo-font-options-get-antialias"></a><h3>cairo_font_options_get_antialias ()</h3>
jpayne@68 457 <pre class="programlisting"><a class="link" href="cairo-cairo-t.html#cairo-antialias-t" title="enum cairo_antialias_t"><span class="returnvalue">cairo_antialias_t</span></a>
jpayne@68 458 cairo_font_options_get_antialias (<em class="parameter"><code>const <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);</pre>
jpayne@68 459 <p>Gets the antialiasing mode for the font options object.</p>
jpayne@68 460 <div class="refsect3">
jpayne@68 461 <a name="cairo-font-options-get-antialias.parameters"></a><h4>Parameters</h4>
jpayne@68 462 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 463 <colgroup>
jpayne@68 464 <col width="150px" class="parameters_name">
jpayne@68 465 <col class="parameters_description">
jpayne@68 466 <col width="200px" class="parameters_annotations">
jpayne@68 467 </colgroup>
jpayne@68 468 <tbody><tr>
jpayne@68 469 <td class="parameter_name"><p>options</p></td>
jpayne@68 470 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 471 <td class="parameter_annotations"> </td>
jpayne@68 472 </tr></tbody>
jpayne@68 473 </table></div>
jpayne@68 474 </div>
jpayne@68 475 <div class="refsect3">
jpayne@68 476 <a name="cairo-font-options-get-antialias.returns"></a><h4>Returns</h4>
jpayne@68 477 <p> the antialiasing mode</p>
jpayne@68 478 </div>
jpayne@68 479 <p class="since">Since: 1.0</p>
jpayne@68 480 </div>
jpayne@68 481 <hr>
jpayne@68 482 <div class="refsect2">
jpayne@68 483 <a name="cairo-font-options-set-subpixel-order"></a><h3>cairo_font_options_set_subpixel_order ()</h3>
jpayne@68 484 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 485 cairo_font_options_set_subpixel_order (<em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>,
jpayne@68 486 <em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-subpixel-order-t" title="enum cairo_subpixel_order_t"><span class="type">cairo_subpixel_order_t</span></a> subpixel_order</code></em>);</pre>
jpayne@68 487 <p>Sets the subpixel order for the font options object. The subpixel
jpayne@68 488 order specifies the order of color elements within each pixel on
jpayne@68 489 the display device when rendering with an antialiasing mode of
jpayne@68 490 <a class="link" href="cairo-cairo-t.html#CAIRO-ANTIALIAS-SUBPIXEL:CAPS"><code class="literal">CAIRO_ANTIALIAS_SUBPIXEL</code></a>. See the documentation for
jpayne@68 491 <a class="link" href="cairo-cairo-font-options-t.html#cairo-subpixel-order-t" title="enum cairo_subpixel_order_t"><span class="type">cairo_subpixel_order_t</span></a> for full details.</p>
jpayne@68 492 <div class="refsect3">
jpayne@68 493 <a name="cairo-font-options-set-subpixel-order.parameters"></a><h4>Parameters</h4>
jpayne@68 494 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 495 <colgroup>
jpayne@68 496 <col width="150px" class="parameters_name">
jpayne@68 497 <col class="parameters_description">
jpayne@68 498 <col width="200px" class="parameters_annotations">
jpayne@68 499 </colgroup>
jpayne@68 500 <tbody>
jpayne@68 501 <tr>
jpayne@68 502 <td class="parameter_name"><p>options</p></td>
jpayne@68 503 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 504 <td class="parameter_annotations"> </td>
jpayne@68 505 </tr>
jpayne@68 506 <tr>
jpayne@68 507 <td class="parameter_name"><p>subpixel_order</p></td>
jpayne@68 508 <td class="parameter_description"><p>the new subpixel order</p></td>
jpayne@68 509 <td class="parameter_annotations"> </td>
jpayne@68 510 </tr>
jpayne@68 511 </tbody>
jpayne@68 512 </table></div>
jpayne@68 513 </div>
jpayne@68 514 <p class="since">Since: 1.0</p>
jpayne@68 515 </div>
jpayne@68 516 <hr>
jpayne@68 517 <div class="refsect2">
jpayne@68 518 <a name="cairo-font-options-get-subpixel-order"></a><h3>cairo_font_options_get_subpixel_order ()</h3>
jpayne@68 519 <pre class="programlisting"><a class="link" href="cairo-cairo-font-options-t.html#cairo-subpixel-order-t" title="enum cairo_subpixel_order_t"><span class="returnvalue">cairo_subpixel_order_t</span></a>
jpayne@68 520 cairo_font_options_get_subpixel_order (<em class="parameter"><code>const <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);</pre>
jpayne@68 521 <p>Gets the subpixel order for the font options object.
jpayne@68 522 See the documentation for <a class="link" href="cairo-cairo-font-options-t.html#cairo-subpixel-order-t" title="enum cairo_subpixel_order_t"><span class="type">cairo_subpixel_order_t</span></a> for full details.</p>
jpayne@68 523 <div class="refsect3">
jpayne@68 524 <a name="cairo-font-options-get-subpixel-order.parameters"></a><h4>Parameters</h4>
jpayne@68 525 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 526 <colgroup>
jpayne@68 527 <col width="150px" class="parameters_name">
jpayne@68 528 <col class="parameters_description">
jpayne@68 529 <col width="200px" class="parameters_annotations">
jpayne@68 530 </colgroup>
jpayne@68 531 <tbody><tr>
jpayne@68 532 <td class="parameter_name"><p>options</p></td>
jpayne@68 533 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 534 <td class="parameter_annotations"> </td>
jpayne@68 535 </tr></tbody>
jpayne@68 536 </table></div>
jpayne@68 537 </div>
jpayne@68 538 <div class="refsect3">
jpayne@68 539 <a name="cairo-font-options-get-subpixel-order.returns"></a><h4>Returns</h4>
jpayne@68 540 <p> the subpixel order for the font options object</p>
jpayne@68 541 </div>
jpayne@68 542 <p class="since">Since: 1.0</p>
jpayne@68 543 </div>
jpayne@68 544 <hr>
jpayne@68 545 <div class="refsect2">
jpayne@68 546 <a name="cairo-font-options-set-hint-style"></a><h3>cairo_font_options_set_hint_style ()</h3>
jpayne@68 547 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 548 cairo_font_options_set_hint_style (<em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>,
jpayne@68 549 <em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-style-t" title="enum cairo_hint_style_t"><span class="type">cairo_hint_style_t</span></a> hint_style</code></em>);</pre>
jpayne@68 550 <p>Sets the hint style for font outlines for the font options object.
jpayne@68 551 This controls whether to fit font outlines to the pixel grid,
jpayne@68 552 and if so, whether to optimize for fidelity or contrast.
jpayne@68 553 See the documentation for <a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-style-t" title="enum cairo_hint_style_t"><span class="type">cairo_hint_style_t</span></a> for full details.</p>
jpayne@68 554 <div class="refsect3">
jpayne@68 555 <a name="cairo-font-options-set-hint-style.parameters"></a><h4>Parameters</h4>
jpayne@68 556 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 557 <colgroup>
jpayne@68 558 <col width="150px" class="parameters_name">
jpayne@68 559 <col class="parameters_description">
jpayne@68 560 <col width="200px" class="parameters_annotations">
jpayne@68 561 </colgroup>
jpayne@68 562 <tbody>
jpayne@68 563 <tr>
jpayne@68 564 <td class="parameter_name"><p>options</p></td>
jpayne@68 565 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 566 <td class="parameter_annotations"> </td>
jpayne@68 567 </tr>
jpayne@68 568 <tr>
jpayne@68 569 <td class="parameter_name"><p>hint_style</p></td>
jpayne@68 570 <td class="parameter_description"><p>the new hint style</p></td>
jpayne@68 571 <td class="parameter_annotations"> </td>
jpayne@68 572 </tr>
jpayne@68 573 </tbody>
jpayne@68 574 </table></div>
jpayne@68 575 </div>
jpayne@68 576 <p class="since">Since: 1.0</p>
jpayne@68 577 </div>
jpayne@68 578 <hr>
jpayne@68 579 <div class="refsect2">
jpayne@68 580 <a name="cairo-font-options-get-hint-style"></a><h3>cairo_font_options_get_hint_style ()</h3>
jpayne@68 581 <pre class="programlisting"><a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-style-t" title="enum cairo_hint_style_t"><span class="returnvalue">cairo_hint_style_t</span></a>
jpayne@68 582 cairo_font_options_get_hint_style (<em class="parameter"><code>const <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);</pre>
jpayne@68 583 <p>Gets the hint style for font outlines for the font options object.
jpayne@68 584 See the documentation for <a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-style-t" title="enum cairo_hint_style_t"><span class="type">cairo_hint_style_t</span></a> for full details.</p>
jpayne@68 585 <div class="refsect3">
jpayne@68 586 <a name="cairo-font-options-get-hint-style.parameters"></a><h4>Parameters</h4>
jpayne@68 587 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 588 <colgroup>
jpayne@68 589 <col width="150px" class="parameters_name">
jpayne@68 590 <col class="parameters_description">
jpayne@68 591 <col width="200px" class="parameters_annotations">
jpayne@68 592 </colgroup>
jpayne@68 593 <tbody><tr>
jpayne@68 594 <td class="parameter_name"><p>options</p></td>
jpayne@68 595 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 596 <td class="parameter_annotations"> </td>
jpayne@68 597 </tr></tbody>
jpayne@68 598 </table></div>
jpayne@68 599 </div>
jpayne@68 600 <div class="refsect3">
jpayne@68 601 <a name="cairo-font-options-get-hint-style.returns"></a><h4>Returns</h4>
jpayne@68 602 <p> the hint style for the font options object</p>
jpayne@68 603 </div>
jpayne@68 604 <p class="since">Since: 1.0</p>
jpayne@68 605 </div>
jpayne@68 606 <hr>
jpayne@68 607 <div class="refsect2">
jpayne@68 608 <a name="cairo-font-options-set-hint-metrics"></a><h3>cairo_font_options_set_hint_metrics ()</h3>
jpayne@68 609 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 610 cairo_font_options_set_hint_metrics (<em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>,
jpayne@68 611 <em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-metrics-t" title="enum cairo_hint_metrics_t"><span class="type">cairo_hint_metrics_t</span></a> hint_metrics</code></em>);</pre>
jpayne@68 612 <p>Sets the metrics hinting mode for the font options object. This
jpayne@68 613 controls whether metrics are quantized to integer values in
jpayne@68 614 device units.
jpayne@68 615 See the documentation for <a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-metrics-t" title="enum cairo_hint_metrics_t"><span class="type">cairo_hint_metrics_t</span></a> for full details.</p>
jpayne@68 616 <div class="refsect3">
jpayne@68 617 <a name="cairo-font-options-set-hint-metrics.parameters"></a><h4>Parameters</h4>
jpayne@68 618 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 619 <colgroup>
jpayne@68 620 <col width="150px" class="parameters_name">
jpayne@68 621 <col class="parameters_description">
jpayne@68 622 <col width="200px" class="parameters_annotations">
jpayne@68 623 </colgroup>
jpayne@68 624 <tbody>
jpayne@68 625 <tr>
jpayne@68 626 <td class="parameter_name"><p>options</p></td>
jpayne@68 627 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 628 <td class="parameter_annotations"> </td>
jpayne@68 629 </tr>
jpayne@68 630 <tr>
jpayne@68 631 <td class="parameter_name"><p>hint_metrics</p></td>
jpayne@68 632 <td class="parameter_description"><p>the new metrics hinting mode</p></td>
jpayne@68 633 <td class="parameter_annotations"> </td>
jpayne@68 634 </tr>
jpayne@68 635 </tbody>
jpayne@68 636 </table></div>
jpayne@68 637 </div>
jpayne@68 638 <p class="since">Since: 1.0</p>
jpayne@68 639 </div>
jpayne@68 640 <hr>
jpayne@68 641 <div class="refsect2">
jpayne@68 642 <a name="cairo-font-options-get-hint-metrics"></a><h3>cairo_font_options_get_hint_metrics ()</h3>
jpayne@68 643 <pre class="programlisting"><a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-metrics-t" title="enum cairo_hint_metrics_t"><span class="returnvalue">cairo_hint_metrics_t</span></a>
jpayne@68 644 cairo_font_options_get_hint_metrics (<em class="parameter"><code>const <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);</pre>
jpayne@68 645 <p>Gets the metrics hinting mode for the font options object.
jpayne@68 646 See the documentation for <a class="link" href="cairo-cairo-font-options-t.html#cairo-hint-metrics-t" title="enum cairo_hint_metrics_t"><span class="type">cairo_hint_metrics_t</span></a> for full details.</p>
jpayne@68 647 <div class="refsect3">
jpayne@68 648 <a name="cairo-font-options-get-hint-metrics.parameters"></a><h4>Parameters</h4>
jpayne@68 649 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 650 <colgroup>
jpayne@68 651 <col width="150px" class="parameters_name">
jpayne@68 652 <col class="parameters_description">
jpayne@68 653 <col width="200px" class="parameters_annotations">
jpayne@68 654 </colgroup>
jpayne@68 655 <tbody><tr>
jpayne@68 656 <td class="parameter_name"><p>options</p></td>
jpayne@68 657 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 658 <td class="parameter_annotations"> </td>
jpayne@68 659 </tr></tbody>
jpayne@68 660 </table></div>
jpayne@68 661 </div>
jpayne@68 662 <div class="refsect3">
jpayne@68 663 <a name="cairo-font-options-get-hint-metrics.returns"></a><h4>Returns</h4>
jpayne@68 664 <p> the metrics hinting mode for the font options object</p>
jpayne@68 665 </div>
jpayne@68 666 <p class="since">Since: 1.0</p>
jpayne@68 667 </div>
jpayne@68 668 <hr>
jpayne@68 669 <div class="refsect2">
jpayne@68 670 <a name="cairo-font-options-get-variations"></a><h3>cairo_font_options_get_variations ()</h3>
jpayne@68 671 <pre class="programlisting">const <span class="returnvalue">char</span> *
jpayne@68 672 cairo_font_options_get_variations (<em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);</pre>
jpayne@68 673 <p>Gets the OpenType font variations for the font options object.
jpayne@68 674 See <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-set-variations" title="cairo_font_options_set_variations ()"><code class="function">cairo_font_options_set_variations()</code></a> for details about the
jpayne@68 675 string format.</p>
jpayne@68 676 <div class="refsect3">
jpayne@68 677 <a name="cairo-font-options-get-variations.parameters"></a><h4>Parameters</h4>
jpayne@68 678 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 679 <colgroup>
jpayne@68 680 <col width="150px" class="parameters_name">
jpayne@68 681 <col class="parameters_description">
jpayne@68 682 <col width="200px" class="parameters_annotations">
jpayne@68 683 </colgroup>
jpayne@68 684 <tbody><tr>
jpayne@68 685 <td class="parameter_name"><p>options</p></td>
jpayne@68 686 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 687 <td class="parameter_annotations"> </td>
jpayne@68 688 </tr></tbody>
jpayne@68 689 </table></div>
jpayne@68 690 </div>
jpayne@68 691 <div class="refsect3">
jpayne@68 692 <a name="cairo-font-options-get-variations.returns"></a><h4>Returns</h4>
jpayne@68 693 <p> the font variations for the font options object. The
jpayne@68 694 returned string belongs to the <em class="parameter"><code>options</code></em>
jpayne@68 695 and must not be modified.
jpayne@68 696 It is valid until either the font options object is destroyed or
jpayne@68 697 the font variations in this object is modified with
jpayne@68 698 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-set-variations" title="cairo_font_options_set_variations ()"><code class="function">cairo_font_options_set_variations()</code></a>.</p>
jpayne@68 699 </div>
jpayne@68 700 <p class="since">Since: 1.16</p>
jpayne@68 701 </div>
jpayne@68 702 <hr>
jpayne@68 703 <div class="refsect2">
jpayne@68 704 <a name="cairo-font-options-set-variations"></a><h3>cairo_font_options_set_variations ()</h3>
jpayne@68 705 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 706 cairo_font_options_set_variations (<em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>,
jpayne@68 707 <em class="parameter"><code>const <span class="type">char</span> *variations</code></em>);</pre>
jpayne@68 708 <p>Sets the OpenType font variations for the font options object.
jpayne@68 709 Font variations are specified as a string with a format that
jpayne@68 710 is similar to the CSS font-variation-settings. The string contains
jpayne@68 711 a comma-separated list of axis assignments, which each assignment
jpayne@68 712 consists of a 4-character axis name and a value, separated by
jpayne@68 713 whitespace and optional equals sign.</p>
jpayne@68 714 <p>Examples:</p>
jpayne@68 715 <p>wght=200,wdth=140.5</p>
jpayne@68 716 <p>wght 200 , wdth 140.5</p>
jpayne@68 717 <div class="refsect3">
jpayne@68 718 <a name="cairo-font-options-set-variations.parameters"></a><h4>Parameters</h4>
jpayne@68 719 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 720 <colgroup>
jpayne@68 721 <col width="150px" class="parameters_name">
jpayne@68 722 <col class="parameters_description">
jpayne@68 723 <col width="200px" class="parameters_annotations">
jpayne@68 724 </colgroup>
jpayne@68 725 <tbody>
jpayne@68 726 <tr>
jpayne@68 727 <td class="parameter_name"><p>options</p></td>
jpayne@68 728 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a></p></td>
jpayne@68 729 <td class="parameter_annotations"> </td>
jpayne@68 730 </tr>
jpayne@68 731 <tr>
jpayne@68 732 <td class="parameter_name"><p>variations</p></td>
jpayne@68 733 <td class="parameter_description"><p>the new font variations, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
jpayne@68 734 <td class="parameter_annotations"> </td>
jpayne@68 735 </tr>
jpayne@68 736 </tbody>
jpayne@68 737 </table></div>
jpayne@68 738 </div>
jpayne@68 739 <p class="since">Since: 1.16</p>
jpayne@68 740 </div>
jpayne@68 741 </div>
jpayne@68 742 <div class="refsect1">
jpayne@68 743 <a name="cairo-cairo-font-options-t.other_details"></a><h2>Types and Values</h2>
jpayne@68 744 <div class="refsect2">
jpayne@68 745 <a name="cairo-font-options-t"></a><h3>cairo_font_options_t</h3>
jpayne@68 746 <pre class="programlisting">typedef struct _cairo_font_options cairo_font_options_t;
jpayne@68 747 </pre>
jpayne@68 748 <p>An opaque structure holding all options that are used when
jpayne@68 749 rendering fonts.</p>
jpayne@68 750 <p>Individual features of a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> can be set or
jpayne@68 751 accessed using functions named
jpayne@68 752 <code class="function">cairo_font_options_set_<span class="emphasis"><em>feature_name</em></span>()</code> and
jpayne@68 753 <code class="function">cairo_font_options_get_<span class="emphasis"><em>feature_name</em></span>()</code>, like
jpayne@68 754 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-set-antialias" title="cairo_font_options_set_antialias ()"><code class="function">cairo_font_options_set_antialias()</code></a> and
jpayne@68 755 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-get-antialias" title="cairo_font_options_get_antialias ()"><code class="function">cairo_font_options_get_antialias()</code></a>.</p>
jpayne@68 756 <p>New features may be added to a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> in the
jpayne@68 757 future. For this reason, <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-copy" title="cairo_font_options_copy ()"><code class="function">cairo_font_options_copy()</code></a>,
jpayne@68 758 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-equal" title="cairo_font_options_equal ()"><code class="function">cairo_font_options_equal()</code></a>, <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-merge" title="cairo_font_options_merge ()"><code class="function">cairo_font_options_merge()</code></a>, and
jpayne@68 759 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-hash" title="cairo_font_options_hash ()"><code class="function">cairo_font_options_hash()</code></a> should be used to copy, check
jpayne@68 760 for equality, merge, or compute a hash value of
jpayne@68 761 <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> objects.</p>
jpayne@68 762 <p class="since">Since: 1.0</p>
jpayne@68 763 </div>
jpayne@68 764 <hr>
jpayne@68 765 <div class="refsect2">
jpayne@68 766 <a name="cairo-subpixel-order-t"></a><h3>enum cairo_subpixel_order_t</h3>
jpayne@68 767 <p>The subpixel order specifies the order of color elements within
jpayne@68 768 each pixel on the display device when rendering with an
jpayne@68 769 antialiasing mode of <a class="link" href="cairo-cairo-t.html#CAIRO-ANTIALIAS-SUBPIXEL:CAPS"><code class="literal">CAIRO_ANTIALIAS_SUBPIXEL</code></a>.</p>
jpayne@68 770 <div class="refsect3">
jpayne@68 771 <a name="cairo-subpixel-order-t.members"></a><h4>Members</h4>
jpayne@68 772 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 773 <colgroup>
jpayne@68 774 <col width="300px" class="enum_members_name">
jpayne@68 775 <col class="enum_members_description">
jpayne@68 776 <col width="200px" class="enum_members_annotations">
jpayne@68 777 </colgroup>
jpayne@68 778 <tbody>
jpayne@68 779 <tr>
jpayne@68 780 <td class="enum_member_name"><p><a name="CAIRO-SUBPIXEL-ORDER-DEFAULT:CAPS"></a>CAIRO_SUBPIXEL_ORDER_DEFAULT</p></td>
jpayne@68 781 <td class="enum_member_description">
jpayne@68 782 <p>Use the default subpixel order for
jpayne@68 783 for the target device, since 1.0</p>
jpayne@68 784 </td>
jpayne@68 785 <td class="enum_member_annotations"> </td>
jpayne@68 786 </tr>
jpayne@68 787 <tr>
jpayne@68 788 <td class="enum_member_name"><p><a name="CAIRO-SUBPIXEL-ORDER-RGB:CAPS"></a>CAIRO_SUBPIXEL_ORDER_RGB</p></td>
jpayne@68 789 <td class="enum_member_description">
jpayne@68 790 <p>Subpixel elements are arranged horizontally
jpayne@68 791 with red at the left, since 1.0</p>
jpayne@68 792 </td>
jpayne@68 793 <td class="enum_member_annotations"> </td>
jpayne@68 794 </tr>
jpayne@68 795 <tr>
jpayne@68 796 <td class="enum_member_name"><p><a name="CAIRO-SUBPIXEL-ORDER-BGR:CAPS"></a>CAIRO_SUBPIXEL_ORDER_BGR</p></td>
jpayne@68 797 <td class="enum_member_description">
jpayne@68 798 <p>Subpixel elements are arranged horizontally
jpayne@68 799 with blue at the left, since 1.0</p>
jpayne@68 800 </td>
jpayne@68 801 <td class="enum_member_annotations"> </td>
jpayne@68 802 </tr>
jpayne@68 803 <tr>
jpayne@68 804 <td class="enum_member_name"><p><a name="CAIRO-SUBPIXEL-ORDER-VRGB:CAPS"></a>CAIRO_SUBPIXEL_ORDER_VRGB</p></td>
jpayne@68 805 <td class="enum_member_description">
jpayne@68 806 <p>Subpixel elements are arranged vertically
jpayne@68 807 with red at the top, since 1.0</p>
jpayne@68 808 </td>
jpayne@68 809 <td class="enum_member_annotations"> </td>
jpayne@68 810 </tr>
jpayne@68 811 <tr>
jpayne@68 812 <td class="enum_member_name"><p><a name="CAIRO-SUBPIXEL-ORDER-VBGR:CAPS"></a>CAIRO_SUBPIXEL_ORDER_VBGR</p></td>
jpayne@68 813 <td class="enum_member_description">
jpayne@68 814 <p>Subpixel elements are arranged vertically
jpayne@68 815 with blue at the top, since 1.0</p>
jpayne@68 816 </td>
jpayne@68 817 <td class="enum_member_annotations"> </td>
jpayne@68 818 </tr>
jpayne@68 819 </tbody>
jpayne@68 820 </table></div>
jpayne@68 821 </div>
jpayne@68 822 <p class="since">Since: 1.0</p>
jpayne@68 823 </div>
jpayne@68 824 <hr>
jpayne@68 825 <div class="refsect2">
jpayne@68 826 <a name="cairo-hint-style-t"></a><h3>enum cairo_hint_style_t</h3>
jpayne@68 827 <p>Specifies the type of hinting to do on font outlines. Hinting
jpayne@68 828 is the process of fitting outlines to the pixel grid in order
jpayne@68 829 to improve the appearance of the result. Since hinting outlines
jpayne@68 830 involves distorting them, it also reduces the faithfulness
jpayne@68 831 to the original outline shapes. Not all of the outline hinting
jpayne@68 832 styles are supported by all font backends.</p>
jpayne@68 833 <p>New entries may be added in future versions.</p>
jpayne@68 834 <div class="refsect3">
jpayne@68 835 <a name="cairo-hint-style-t.members"></a><h4>Members</h4>
jpayne@68 836 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 837 <colgroup>
jpayne@68 838 <col width="300px" class="enum_members_name">
jpayne@68 839 <col class="enum_members_description">
jpayne@68 840 <col width="200px" class="enum_members_annotations">
jpayne@68 841 </colgroup>
jpayne@68 842 <tbody>
jpayne@68 843 <tr>
jpayne@68 844 <td class="enum_member_name"><p><a name="CAIRO-HINT-STYLE-DEFAULT:CAPS"></a>CAIRO_HINT_STYLE_DEFAULT</p></td>
jpayne@68 845 <td class="enum_member_description">
jpayne@68 846 <p>Use the default hint style for
jpayne@68 847 font backend and target device, since 1.0</p>
jpayne@68 848 </td>
jpayne@68 849 <td class="enum_member_annotations"> </td>
jpayne@68 850 </tr>
jpayne@68 851 <tr>
jpayne@68 852 <td class="enum_member_name"><p><a name="CAIRO-HINT-STYLE-NONE:CAPS"></a>CAIRO_HINT_STYLE_NONE</p></td>
jpayne@68 853 <td class="enum_member_description">
jpayne@68 854 <p>Do not hint outlines, since 1.0</p>
jpayne@68 855 </td>
jpayne@68 856 <td class="enum_member_annotations"> </td>
jpayne@68 857 </tr>
jpayne@68 858 <tr>
jpayne@68 859 <td class="enum_member_name"><p><a name="CAIRO-HINT-STYLE-SLIGHT:CAPS"></a>CAIRO_HINT_STYLE_SLIGHT</p></td>
jpayne@68 860 <td class="enum_member_description">
jpayne@68 861 <p>Hint outlines slightly to improve
jpayne@68 862 contrast while retaining good fidelity to the original
jpayne@68 863 shapes, since 1.0</p>
jpayne@68 864 </td>
jpayne@68 865 <td class="enum_member_annotations"> </td>
jpayne@68 866 </tr>
jpayne@68 867 <tr>
jpayne@68 868 <td class="enum_member_name"><p><a name="CAIRO-HINT-STYLE-MEDIUM:CAPS"></a>CAIRO_HINT_STYLE_MEDIUM</p></td>
jpayne@68 869 <td class="enum_member_description">
jpayne@68 870 <p>Hint outlines with medium strength
jpayne@68 871 giving a compromise between fidelity to the original shapes
jpayne@68 872 and contrast, since 1.0</p>
jpayne@68 873 </td>
jpayne@68 874 <td class="enum_member_annotations"> </td>
jpayne@68 875 </tr>
jpayne@68 876 <tr>
jpayne@68 877 <td class="enum_member_name"><p><a name="CAIRO-HINT-STYLE-FULL:CAPS"></a>CAIRO_HINT_STYLE_FULL</p></td>
jpayne@68 878 <td class="enum_member_description">
jpayne@68 879 <p>Hint outlines to maximize contrast, since 1.0</p>
jpayne@68 880 </td>
jpayne@68 881 <td class="enum_member_annotations"> </td>
jpayne@68 882 </tr>
jpayne@68 883 </tbody>
jpayne@68 884 </table></div>
jpayne@68 885 </div>
jpayne@68 886 <p class="since">Since: 1.0</p>
jpayne@68 887 </div>
jpayne@68 888 <hr>
jpayne@68 889 <div class="refsect2">
jpayne@68 890 <a name="cairo-hint-metrics-t"></a><h3>enum cairo_hint_metrics_t</h3>
jpayne@68 891 <p>Specifies whether to hint font metrics; hinting font metrics
jpayne@68 892 means quantizing them so that they are integer values in
jpayne@68 893 device space. Doing this improves the consistency of
jpayne@68 894 letter and line spacing, however it also means that text
jpayne@68 895 will be laid out differently at different zoom factors.</p>
jpayne@68 896 <div class="refsect3">
jpayne@68 897 <a name="cairo-hint-metrics-t.members"></a><h4>Members</h4>
jpayne@68 898 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 899 <colgroup>
jpayne@68 900 <col width="300px" class="enum_members_name">
jpayne@68 901 <col class="enum_members_description">
jpayne@68 902 <col width="200px" class="enum_members_annotations">
jpayne@68 903 </colgroup>
jpayne@68 904 <tbody>
jpayne@68 905 <tr>
jpayne@68 906 <td class="enum_member_name"><p><a name="CAIRO-HINT-METRICS-DEFAULT:CAPS"></a>CAIRO_HINT_METRICS_DEFAULT</p></td>
jpayne@68 907 <td class="enum_member_description">
jpayne@68 908 <p>Hint metrics in the default
jpayne@68 909 manner for the font backend and target device, since 1.0</p>
jpayne@68 910 </td>
jpayne@68 911 <td class="enum_member_annotations"> </td>
jpayne@68 912 </tr>
jpayne@68 913 <tr>
jpayne@68 914 <td class="enum_member_name"><p><a name="CAIRO-HINT-METRICS-OFF:CAPS"></a>CAIRO_HINT_METRICS_OFF</p></td>
jpayne@68 915 <td class="enum_member_description">
jpayne@68 916 <p>Do not hint font metrics, since 1.0</p>
jpayne@68 917 </td>
jpayne@68 918 <td class="enum_member_annotations"> </td>
jpayne@68 919 </tr>
jpayne@68 920 <tr>
jpayne@68 921 <td class="enum_member_name"><p><a name="CAIRO-HINT-METRICS-ON:CAPS"></a>CAIRO_HINT_METRICS_ON</p></td>
jpayne@68 922 <td class="enum_member_description">
jpayne@68 923 <p>Hint font metrics, since 1.0</p>
jpayne@68 924 </td>
jpayne@68 925 <td class="enum_member_annotations"> </td>
jpayne@68 926 </tr>
jpayne@68 927 </tbody>
jpayne@68 928 </table></div>
jpayne@68 929 </div>
jpayne@68 930 <p class="since">Since: 1.0</p>
jpayne@68 931 </div>
jpayne@68 932 </div>
jpayne@68 933 <div class="refsect1">
jpayne@68 934 <a name="cairo-cairo-font-options-t.see-also"></a><h2>See Also</h2>
jpayne@68 935 <p><a class="link" href="cairo-cairo-scaled-font-t.html#cairo-scaled-font-t" title="cairo_scaled_font_t"><span class="type">cairo_scaled_font_t</span></a></p>
jpayne@68 936 </div>
jpayne@68 937 </div>
jpayne@68 938 <div class="footer">
jpayne@68 939 <hr>Generated by GTK-Doc V1.27</div>
jpayne@68 940 </body>
jpayne@68 941 </html>