docs/reference/ft2-raster.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2 "http://www.w3.org/TR/html4/loose.dtd">
   3 <html>
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6 <title>FreeType-2.6.5 API Reference</title>
   7 <style type="text/css">
   8   a:link { color: #0000EF; }
   9   a:visited { color: #51188E; }
  10   a:hover { color: #FF0000; }
  11
  12   body { font-family: Verdana, Geneva, Arial, Helvetica, serif;
  13          color: #000000;
  14          background: #FFFFFF;
  15          width: 87%;
  16          margin: auto; }
  17
  18   div.section { width: 75%;
  19                 margin: auto; }
  20   div.section hr { margin: 4ex 0 1ex 0; }
  21   div.section h4 { background-color: #EEEEFF;
  22                    font-size: medium;
  23                    font-style: oblique;
  24                    font-weight: bold;
  25                    margin: 3ex 0 1.5ex 9%;
  26                    padding: 0.3ex 0 0.3ex 1%; }
  27   div.section p { margin: 1.5ex 0 1.5ex 10%; }
  28   div.section pre { margin: 3ex 0 3ex 9%;
  29                     background-color: #D6E8FF;
  30                     padding: 2ex 0 2ex 1%; }
  31   div.section table.fields { width: 90%;
  32                              margin: 1.5ex 0 1.5ex 10%; }
  33   div.section table.toc { width: 95%;
  34                           margin: 1.5ex 0 1.5ex 5%; }
  35   div.timestamp { text-align: center;
  36                   font-size: 69%;
  37                   margin: 1.5ex 0 1.5ex 0; }
  38
  39   h1 { text-align: center; }
  40   h3 { font-size: medium;
  41        margin: 4ex 0 1.5ex 0; }
  42
  43   p { text-align: justify; }
  44
  45   pre.colored { color: blue; }
  46
  47   span.keyword { font-family: monospace;
  48                  text-align: left;
  49                  white-space: pre;
  50                  color: darkblue; }
  51
  52   table.fields td.val { font-weight: bold;
  53                         text-align: right;
  54                         width: 30%;
  55                         vertical-align: baseline;
  56                         padding: 1ex 1em 1ex 0; }
  57   table.fields td.desc { vertical-align: baseline;
  58                          padding: 1ex 0 1ex 1em; }
  59   table.fields td.desc p:first-child { margin: 0; }
  60   table.fields td.desc p { margin: 1.5ex 0 0 0; }
  61   table.index { margin: 6ex auto 6ex auto;
  62                 border: 0;
  63                 border-collapse: separate;
  64                 border-spacing: 1em 0.3ex; }
  65   table.index tr { padding: 0; }
  66   table.index td { padding: 0; }
  67   table.index-toc-link { width: 100%;
  68                          border: 0;
  69                          border-spacing: 0;
  70                          margin: 1ex 0 1ex 0; }
  71   table.index-toc-link td.left { padding: 0 0.5em 0 0.5em;
  72                                  font-size: 83%;
  73                                  text-align: left; }
  74   table.index-toc-link td.middle { padding: 0 0.5em 0 0.5em;
  75                                    font-size: 83%;
  76                                    text-align: center; }
  77   table.index-toc-link td.right { padding: 0 0.5em 0 0.5em;
  78                                   font-size: 83%;
  79                                   text-align: right; }
  80   table.synopsis { margin: 6ex auto 6ex auto;
  81                    border: 0;
  82                    border-collapse: separate;
  83                    border-spacing: 2em 0.6ex; }
  84   table.synopsis tr { padding: 0; }
  85   table.synopsis td { padding: 0; }
  86   table.toc td.link { width: 30%;
  87                       text-align: right;
  88                       vertical-align: baseline;
  89                       padding: 1ex 1em 1ex 0; }
  90   table.toc td.desc { vertical-align: baseline;
  91                       padding: 1ex 0 1ex 1em;
  92                       text-align: left; }
  93   table.toc td.desc p:first-child { margin: 0;
  94                                     text-align: left; }
  95   table.toc td.desc p { margin: 1.5ex 0 0 0;
  96                         text-align: left; }
  97
  98 </style>
  99 </head>
 100 <body>
 101
 102 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table>
 103 <h1>FreeType-2.6.5 API Reference</h1>
 104
 105 <h1 id="raster">Scanline Converter</h1>
 106 <h2>Synopsis</h2>
 107 <table class="synopsis">
 108 <tr><td><a href="#FT_Raster">FT_Raster</a></td><td>&nbsp;</td><td><a href="#FT_Raster_Funcs">FT_Raster_Funcs</a></td></tr>
 109 <tr><td><a href="#FT_Span">FT_Span</a></td><td><a href="#FT_Raster_NewFunc">FT_Raster_NewFunc</a></td><td>&nbsp;</td></tr>
 110 <tr><td><a href="#FT_SpanFunc">FT_SpanFunc</a></td><td><a href="#FT_Raster_DoneFunc">FT_Raster_DoneFunc</a></td><td><a href="#FT_Raster_BitTest_Func">FT_Raster_BitTest_Func</a></td></tr>
 111 <tr><td>&nbsp;</td><td><a href="#FT_Raster_ResetFunc">FT_Raster_ResetFunc</a></td><td><a href="#FT_Raster_BitSet_Func">FT_Raster_BitSet_Func</a></td></tr>
 112 <tr><td><a href="#FT_Raster_Params">FT_Raster_Params</a></td><td><a href="#FT_Raster_SetModeFunc">FT_Raster_SetModeFunc</a></td><td></td></tr>
 113 <tr><td><a href="#FT_RASTER_FLAG_XXX">FT_RASTER_FLAG_XXX</a></td><td><a href="#FT_Raster_RenderFunc">FT_Raster_RenderFunc</a></td><td></td></tr>
 114 </table>
 115
 116
 117 <p>This section contains technical definitions.</p>
 118
 119 <div class="section">
 120 <h3 id="FT_Raster">FT_Raster</h3>
 121 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 122 <pre>
 123   <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_RasterRec_*  <b>FT_Raster</b>;
 124 </pre>
 125
 126 <p>An opaque handle (pointer) to a raster object. Each object can be used independently to convert an outline into a bitmap or pixmap.</p>
 127
 128 <hr>
 129 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 130
 131 <div class="section">
 132 <h3 id="FT_Span">FT_Span</h3>
 133 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 134 <pre>
 135   <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Span_
 136   {
 137     <span class="keyword">short</span>           x;
 138     <span class="keyword">unsigned</span> <span class="keyword">short</span>  len;
 139     <span class="keyword">unsigned</span> <span class="keyword">char</span>   coverage;
 140
 141   } <b>FT_Span</b>;
 142 </pre>
 143
 144 <p>A structure used to model a single span of gray pixels when rendering an anti-aliased bitmap.</p>
 145
 146 <h4>fields</h4>
 147 <table class="fields">
 148 <tr><td class="val" id="x">x</td><td class="desc">
 149 <p>The span's horizontal start position.</p>
 150 </td></tr>
 151 <tr><td class="val" id="len">len</td><td class="desc">
 152 <p>The span's length in pixels.</p>
 153 </td></tr>
 154 <tr><td class="val" id="coverage">coverage</td><td class="desc">
 155 <p>The span color/coverage, ranging from 0 (background) to 255 (foreground).</p>
 156 </td></tr>
 157 </table>
 158
 159 <h4>note</h4>
 160 <p>This structure is used by the span drawing callback type named <a href="ft2-raster.html#FT_SpanFunc">FT_SpanFunc</a> that takes the y&nbsp;coordinate of the span as a parameter.</p>
 161 <p>The coverage value is always between 0 and 255. If you want less gray values, the callback function has to reduce them.</p>
 162
 163 <hr>
 164 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 165
 166 <div class="section">
 167 <h3 id="FT_SpanFunc">FT_SpanFunc</h3>
 168 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 169 <pre>
 170   <span class="keyword">typedef</span> <span class="keyword">void</span>
 171   (*<b>FT_SpanFunc</b>)( <span class="keyword">int</span>             y,
 172                   <span class="keyword">int</span>             count,
 173                   <span class="keyword">const</span> <a href="ft2-raster.html#FT_Span">FT_Span</a>*  spans,
 174                   <span class="keyword">void</span>*           user );
 175
 176 #define FT_Raster_Span_Func  <b>FT_SpanFunc</b>
 177 </pre>
 178
 179 <p>A function used as a call-back by the anti-aliased renderer in order to let client applications draw themselves the gray pixel spans on each scan line.</p>
 180
 181 <h4>input</h4>
 182 <table class="fields">
 183 <tr><td class="val" id="y">y</td><td class="desc">
 184 <p>The scanline's y&nbsp;coordinate.</p>
 185 </td></tr>
 186 <tr><td class="val" id="count">count</td><td class="desc">
 187 <p>The number of spans to draw on this scanline.</p>
 188 </td></tr>
 189 <tr><td class="val" id="spans">spans</td><td class="desc">
 190 <p>A table of &lsquo;count&rsquo; spans to draw on the scanline.</p>
 191 </td></tr>
 192 <tr><td class="val" id="user">user</td><td class="desc">
 193 <p>User-supplied data that is passed to the callback.</p>
 194 </td></tr>
 195 </table>
 196
 197 <h4>note</h4>
 198 <p>This callback allows client applications to directly render the gray spans of the anti-aliased bitmap to any kind of surfaces.</p>
 199 <p>This can be used to write anti-aliased outlines directly to a given background bitmap, and even perform translucency.</p>
 200 <p>Note that the &lsquo;count&rsquo; field cannot be greater than a fixed value defined by the &lsquo;FT_MAX_GRAY_SPANS&rsquo; configuration macro in &lsquo;ftoption.h&rsquo;. By default, this value is set to&nbsp;32, which means that if there are more than 32&nbsp;spans on a given scanline, the callback is called several times with the same &lsquo;y&rsquo; parameter in order to draw all callbacks.</p>
 201 <p>Otherwise, the callback is only called once per scan-line, and only for those scanlines that do have &lsquo;gray&rsquo; pixels on them.</p>
 202
 203 <hr>
 204 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 205
 206 <div class="section">
 207 <h3 id="FT_Raster_Params">FT_Raster_Params</h3>
 208 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 209 <pre>
 210   <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Raster_Params_
 211   {
 212     <span class="keyword">const</span> <a href="ft2-basic_types.html#FT_Bitmap">FT_Bitmap</a>*        target;
 213     <span class="keyword">const</span> <span class="keyword">void</span>*             source;
 214     <span class="keyword">int</span>                     flags;
 215     <a href="ft2-raster.html#FT_SpanFunc">FT_SpanFunc</a>             gray_spans;
 216     <a href="ft2-raster.html#FT_SpanFunc">FT_SpanFunc</a>             black_spans;  /* unused */
 217     <a href="ft2-raster.html#FT_Raster_BitTest_Func">FT_Raster_BitTest_Func</a>  bit_test;     /* unused */
 218     <a href="ft2-raster.html#FT_Raster_BitSet_Func">FT_Raster_BitSet_Func</a>   bit_set;      /* unused */
 219     <span class="keyword">void</span>*                   user;
 220     <a href="ft2-basic_types.html#FT_BBox">FT_BBox</a>                 clip_box;
 221
 222   } <b>FT_Raster_Params</b>;
 223 </pre>
 224
 225 <p>A structure to hold the arguments used by a raster's render function.</p>
 226
 227 <h4>fields</h4>
 228 <table class="fields">
 229 <tr><td class="val" id="target">target</td><td class="desc">
 230 <p>The target bitmap.</p>
 231 </td></tr>
 232 <tr><td class="val" id="source">source</td><td class="desc">
 233 <p>A pointer to the source glyph image (e.g., an <a href="ft2-outline_processing.html#FT_Outline">FT_Outline</a>).</p>
 234 </td></tr>
 235 <tr><td class="val" id="flags">flags</td><td class="desc">
 236 <p>The rendering flags.</p>
 237 </td></tr>
 238 <tr><td class="val" id="gray_spans">gray_spans</td><td class="desc">
 239 <p>The gray span drawing callback.</p>
 240 </td></tr>
 241 <tr><td class="val" id="black_spans">black_spans</td><td class="desc">
 242 <p>Unused.</p>
 243 </td></tr>
 244 <tr><td class="val" id="bit_test">bit_test</td><td class="desc">
 245 <p>Unused.</p>
 246 </td></tr>
 247 <tr><td class="val" id="bit_set">bit_set</td><td class="desc">
 248 <p>Unused.</p>
 249 </td></tr>
 250 <tr><td class="val" id="user">user</td><td class="desc">
 251 <p>User-supplied data that is passed to each drawing callback.</p>
 252 </td></tr>
 253 <tr><td class="val" id="clip_box">clip_box</td><td class="desc">
 254 <p>An optional clipping box. It is only used in direct rendering mode. Note that coordinates here should be expressed in <i>integer</i> pixels (and not in 26.6 fixed-point units).</p>
 255 </td></tr>
 256 </table>
 257
 258 <h4>note</h4>
 259 <p>An anti-aliased glyph bitmap is drawn if the <a href="ft2-raster.html#FT_RASTER_FLAG_XXX">FT_RASTER_FLAG_AA</a> bit flag is set in the &lsquo;flags&rsquo; field, otherwise a monochrome bitmap is generated.</p>
 260 <p>If the <a href="ft2-raster.html#FT_RASTER_FLAG_XXX">FT_RASTER_FLAG_DIRECT</a> bit flag is set in &lsquo;flags&rsquo;, the raster will call the &lsquo;gray_spans&rsquo; callback to draw gray pixel spans. This allows direct composition over a pre-existing bitmap through user-provided callbacks to perform the span drawing and composition. Not supported by the monochrome rasterizer.</p>
 261
 262 <hr>
 263 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 264
 265 <div class="section">
 266 <h3 id="FT_RASTER_FLAG_XXX">FT_RASTER_FLAG_XXX</h3>
 267 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 268 <pre>
 269 #define <a href="ft2-raster.html#FT_RASTER_FLAG_DEFAULT">FT_RASTER_FLAG_DEFAULT</a>  0x0
 270 #define <a href="ft2-raster.html#FT_RASTER_FLAG_AA">FT_RASTER_FLAG_AA</a>       0x1
 271 #define <a href="ft2-raster.html#FT_RASTER_FLAG_DIRECT">FT_RASTER_FLAG_DIRECT</a>   0x2
 272 #define <a href="ft2-raster.html#FT_RASTER_FLAG_CLIP">FT_RASTER_FLAG_CLIP</a>     0x4
 273
 274   /* these constants are deprecated; use the corresponding */
 275   /* `<b>FT_RASTER_FLAG_XXX</b>' values instead                   */
 276 #define ft_raster_flag_default  <a href="ft2-raster.html#FT_RASTER_FLAG_DEFAULT">FT_RASTER_FLAG_DEFAULT</a>
 277 #define ft_raster_flag_aa       <a href="ft2-raster.html#FT_RASTER_FLAG_AA">FT_RASTER_FLAG_AA</a>
 278 #define ft_raster_flag_direct   <a href="ft2-raster.html#FT_RASTER_FLAG_DIRECT">FT_RASTER_FLAG_DIRECT</a>
 279 #define ft_raster_flag_clip     <a href="ft2-raster.html#FT_RASTER_FLAG_CLIP">FT_RASTER_FLAG_CLIP</a>
 280 </pre>
 281
 282 <p>A list of bit flag constants as used in the &lsquo;flags&rsquo; field of a <a href="ft2-raster.html#FT_Raster_Params">FT_Raster_Params</a> structure.</p>
 283
 284 <h4>values</h4>
 285 <table class="fields">
 286 <tr><td class="val" id="FT_RASTER_FLAG_DEFAULT">FT_RASTER_FLAG_DEFAULT</td><td class="desc">
 287 <p>This value is 0.</p>
 288 </td></tr>
 289 <tr><td class="val" id="FT_RASTER_FLAG_AA">FT_RASTER_FLAG_AA</td><td class="desc">
 290 <p>This flag is set to indicate that an anti-aliased glyph image should be generated. Otherwise, it will be monochrome (1-bit).</p>
 291 </td></tr>
 292 <tr><td class="val" id="FT_RASTER_FLAG_DIRECT">FT_RASTER_FLAG_DIRECT</td><td class="desc">
 293 <p>This flag is set to indicate direct rendering. In this mode, client applications must provide their own span callback. This lets them directly draw or compose over an existing bitmap. If this bit is not set, the target pixmap's buffer <i>must</i> be zeroed before rendering.</p>
 294 <p>Direct rendering is only possible with anti-aliased glyphs.</p>
 295 </td></tr>
 296 <tr><td class="val" id="FT_RASTER_FLAG_CLIP">FT_RASTER_FLAG_CLIP</td><td class="desc">
 297 <p>This flag is only used in direct rendering mode. If set, the output will be clipped to a box specified in the &lsquo;clip_box&rsquo; field of the <a href="ft2-raster.html#FT_Raster_Params">FT_Raster_Params</a> structure.</p>
 298 <p>Note that by default, the glyph bitmap is clipped to the target pixmap, except in direct rendering mode where all spans are generated if no clipping box is set.</p>
 299 </td></tr>
 300 </table>
 301
 302 <hr>
 303 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 304
 305 <div class="section">
 306 <h3 id="FT_Raster_NewFunc">FT_Raster_NewFunc</h3>
 307 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 308 <pre>
 309   <span class="keyword">typedef</span> <span class="keyword">int</span>
 310   (*<b>FT_Raster_NewFunc</b>)( <span class="keyword">void</span>*       memory,
 311                         <a href="ft2-raster.html#FT_Raster">FT_Raster</a>*  raster );
 312
 313 #define FT_Raster_New_Func  <b>FT_Raster_NewFunc</b>
 314 </pre>
 315
 316 <p>A function used to create a new raster object.</p>
 317
 318 <h4>input</h4>
 319 <table class="fields">
 320 <tr><td class="val" id="memory">memory</td><td class="desc">
 321 <p>A handle to the memory allocator.</p>
 322 </td></tr>
 323 </table>
 324
 325 <h4>output</h4>
 326 <table class="fields">
 327 <tr><td class="val" id="raster">raster</td><td class="desc">
 328 <p>A handle to the new raster object.</p>
 329 </td></tr>
 330 </table>
 331
 332 <h4>return</h4>
 333 <p>Error code. 0&nbsp;means success.</p>
 334
 335 <h4>note</h4>
 336 <p>The &lsquo;memory&rsquo; parameter is a typeless pointer in order to avoid un-wanted dependencies on the rest of the FreeType code. In practice, it is an <a href="ft2-system_interface.html#FT_Memory">FT_Memory</a> object, i.e., a handle to the standard FreeType memory allocator. However, this field can be completely ignored by a given raster implementation.</p>
 337
 338 <hr>
 339 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 340
 341 <div class="section">
 342 <h3 id="FT_Raster_DoneFunc">FT_Raster_DoneFunc</h3>
 343 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 344 <pre>
 345   <span class="keyword">typedef</span> <span class="keyword">void</span>
 346   (*<b>FT_Raster_DoneFunc</b>)( <a href="ft2-raster.html#FT_Raster">FT_Raster</a>  raster );
 347
 348 #define FT_Raster_Done_Func  <b>FT_Raster_DoneFunc</b>
 349 </pre>
 350
 351 <p>A function used to destroy a given raster object.</p>
 352
 353 <h4>input</h4>
 354 <table class="fields">
 355 <tr><td class="val" id="raster">raster</td><td class="desc">
 356 <p>A handle to the raster object.</p>
 357 </td></tr>
 358 </table>
 359
 360 <hr>
 361 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 362
 363 <div class="section">
 364 <h3 id="FT_Raster_ResetFunc">FT_Raster_ResetFunc</h3>
 365 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 366 <pre>
 367   <span class="keyword">typedef</span> <span class="keyword">void</span>
 368   (*<b>FT_Raster_ResetFunc</b>)( <a href="ft2-raster.html#FT_Raster">FT_Raster</a>       raster,
 369                           <span class="keyword">unsigned</span> <span class="keyword">char</span>*  pool_base,
 370                           <span class="keyword">unsigned</span> <span class="keyword">long</span>   pool_size );
 371
 372 #define FT_Raster_Reset_Func  <b>FT_Raster_ResetFunc</b>
 373 </pre>
 374
 375 <p>FreeType used to provide an area of memory called the &lsquo;render pool&rsquo; available to all registered rasters. This was not thread safe however and now FreeType never allocates this pool. NULL is always passed in as pool_base.</p>
 376 <p>This function is called each time the render pool changes, or just after a new raster object is created.</p>
 377
 378 <h4>input</h4>
 379 <table class="fields">
 380 <tr><td class="val" id="raster">raster</td><td class="desc">
 381 <p>A handle to the new raster object.</p>
 382 </td></tr>
 383 <tr><td class="val" id="pool_base">pool_base</td><td class="desc">
 384 <p>The address in memory of the render pool.</p>
 385 </td></tr>
 386 <tr><td class="val" id="pool_size">pool_size</td><td class="desc">
 387 <p>The size in bytes of the render pool.</p>
 388 </td></tr>
 389 </table>
 390
 391 <h4>note</h4>
 392 <p>Rasters should ignore the render pool and rely on dynamic or stack allocation if they want to (a handle to the memory allocator is passed to the raster constructor).</p>
 393
 394 <hr>
 395 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 396
 397 <div class="section">
 398 <h3 id="FT_Raster_SetModeFunc">FT_Raster_SetModeFunc</h3>
 399 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 400 <pre>
 401   <span class="keyword">typedef</span> <span class="keyword">int</span>
 402   (*<b>FT_Raster_SetModeFunc</b>)( <a href="ft2-raster.html#FT_Raster">FT_Raster</a>      raster,
 403                             <span class="keyword">unsigned</span> <span class="keyword">long</span>  mode,
 404                             <span class="keyword">void</span>*          args );
 405
 406 #define FT_Raster_Set_Mode_Func  <b>FT_Raster_SetModeFunc</b>
 407 </pre>
 408
 409 <p>This function is a generic facility to change modes or attributes in a given raster. This can be used for debugging purposes, or simply to allow implementation-specific &lsquo;features&rsquo; in a given raster module.</p>
 410
 411 <h4>input</h4>
 412 <table class="fields">
 413 <tr><td class="val" id="raster">raster</td><td class="desc">
 414 <p>A handle to the new raster object.</p>
 415 </td></tr>
 416 <tr><td class="val" id="mode">mode</td><td class="desc">
 417 <p>A 4-byte tag used to name the mode or property.</p>
 418 </td></tr>
 419 <tr><td class="val" id="args">args</td><td class="desc">
 420 <p>A pointer to the new mode/property to use.</p>
 421 </td></tr>
 422 </table>
 423
 424 <hr>
 425 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 426
 427 <div class="section">
 428 <h3 id="FT_Raster_RenderFunc">FT_Raster_RenderFunc</h3>
 429 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 430 <pre>
 431   <span class="keyword">typedef</span> <span class="keyword">int</span>
 432   (*<b>FT_Raster_RenderFunc</b>)( <a href="ft2-raster.html#FT_Raster">FT_Raster</a>                raster,
 433                            <span class="keyword">const</span> <a href="ft2-raster.html#FT_Raster_Params">FT_Raster_Params</a>*  params );
 434
 435 #define FT_Raster_Render_Func  <b>FT_Raster_RenderFunc</b>
 436 </pre>
 437
 438 <p>Invoke a given raster to scan-convert a given glyph image into a target bitmap.</p>
 439
 440 <h4>input</h4>
 441 <table class="fields">
 442 <tr><td class="val" id="raster">raster</td><td class="desc">
 443 <p>A handle to the raster object.</p>
 444 </td></tr>
 445 <tr><td class="val" id="params">params</td><td class="desc">
 446 <p>A pointer to an <a href="ft2-raster.html#FT_Raster_Params">FT_Raster_Params</a> structure used to store the rendering parameters.</p>
 447 </td></tr>
 448 </table>
 449
 450 <h4>return</h4>
 451 <p>Error code. 0&nbsp;means success.</p>
 452
 453 <h4>note</h4>
 454 <p>The exact format of the source image depends on the raster's glyph format defined in its <a href="ft2-raster.html#FT_Raster_Funcs">FT_Raster_Funcs</a> structure. It can be an <a href="ft2-outline_processing.html#FT_Outline">FT_Outline</a> or anything else in order to support a large array of glyph formats.</p>
 455 <p>Note also that the render function can fail and return a &lsquo;FT_Err_Unimplemented_Feature&rsquo; error code if the raster used does not support direct composition.</p>
 456 <p>XXX: For now, the standard raster doesn't support direct composition but this should change for the final release (see the files &lsquo;demos/src/ftgrays.c&rsquo; and &lsquo;demos/src/ftgrays2.c&rsquo; for examples of distinct implementations that support direct composition).</p>
 457
 458 <hr>
 459 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 460
 461 <div class="section">
 462 <h3 id="FT_Raster_Funcs">FT_Raster_Funcs</h3>
 463 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 464 <pre>
 465   <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_Raster_Funcs_
 466   {
 467     <a href="ft2-basic_types.html#FT_Glyph_Format">FT_Glyph_Format</a>        glyph_format;
 468     <a href="ft2-raster.html#FT_Raster_NewFunc">FT_Raster_NewFunc</a>      raster_new;
 469     <a href="ft2-raster.html#FT_Raster_ResetFunc">FT_Raster_ResetFunc</a>    raster_reset;
 470     <a href="ft2-raster.html#FT_Raster_SetModeFunc">FT_Raster_SetModeFunc</a>  raster_set_mode;
 471     <a href="ft2-raster.html#FT_Raster_RenderFunc">FT_Raster_RenderFunc</a>   raster_render;
 472     <a href="ft2-raster.html#FT_Raster_DoneFunc">FT_Raster_DoneFunc</a>     raster_done;
 473
 474   } <b>FT_Raster_Funcs</b>;
 475 </pre>
 476
 477 <p>A structure used to describe a given raster class to the library.</p>
 478
 479 <h4>fields</h4>
 480 <table class="fields">
 481 <tr><td class="val" id="glyph_format">glyph_format</td><td class="desc">
 482 <p>The supported glyph format for this raster.</p>
 483 </td></tr>
 484 <tr><td class="val" id="raster_new">raster_new</td><td class="desc">
 485 <p>The raster constructor.</p>
 486 </td></tr>
 487 <tr><td class="val" id="raster_reset">raster_reset</td><td class="desc">
 488 <p>Used to reset the render pool within the raster.</p>
 489 </td></tr>
 490 <tr><td class="val" id="raster_render">raster_render</td><td class="desc">
 491 <p>A function to render a glyph into a given bitmap.</p>
 492 </td></tr>
 493 <tr><td class="val" id="raster_done">raster_done</td><td class="desc">
 494 <p>The raster destructor.</p>
 495 </td></tr>
 496 </table>
 497
 498 <hr>
 499 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 500
 501 <div class="section">
 502 <h3 id="FT_Raster_BitTest_Func">FT_Raster_BitTest_Func</h3>
 503 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 504 <pre>
 505   <span class="keyword">typedef</span> <span class="keyword">int</span>
 506   (*<b>FT_Raster_BitTest_Func</b>)( <span class="keyword">int</span>    y,
 507                              <span class="keyword">int</span>    x,
 508                              <span class="keyword">void</span>*  user );
 509 </pre>
 510
 511 <p>Deprecated, unimplemented.</p>
 512
 513 <hr>
 514 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 515
 516 <div class="section">
 517 <h3 id="FT_Raster_BitSet_Func">FT_Raster_BitSet_Func</h3>
 518 <p>Defined in FT_IMAGE_H (freetype/ftimage.h).</p>
 519 <pre>
 520   <span class="keyword">typedef</span> <span class="keyword">void</span>
 521   (*<b>FT_Raster_BitSet_Func</b>)( <span class="keyword">int</span>    y,
 522                             <span class="keyword">int</span>    x,
 523                             <span class="keyword">void</span>*  user );
 524 </pre>
 525
 526 <p>Deprecated, unimplemented.</p>
 527
 528 <hr>
 529 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 530
 531 </body>
 532 </html>