source: trunk/poppler/freetype2/include/freetype/ftimage.h @ 251

Last change on this file since 251 was 251, checked in by Eugene Romanenko, 13 years ago

PDF plugin: freetype library updated to version 2.3.5

File size: 77.6 KB
Line 
1/***************************************************************************/
2/*                                                                         */
3/*  ftimage.h                                                              */
4/*                                                                         */
5/*    FreeType glyph image formats and default raster interface            */
6/*    (specification).                                                     */
7/*                                                                         */
8/*  Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by       */
9/*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
10/*                                                                         */
11/*  This file is part of the FreeType project, and may only be used,       */
12/*  modified, and distributed under the terms of the FreeType project      */
13/*  license, LICENSE.TXT.  By continuing to use, modify, or distribute     */
14/*  this file you indicate that you have read the license and              */
15/*  understand and accept it fully.                                        */
16/*                                                                         */
17/***************************************************************************/
18
19  /*************************************************************************/
20  /*                                                                       */
21  /* Note: A `raster' is simply a scan-line converter, used to render      */
22  /*       FT_Outlines into FT_Bitmaps.                                    */
23  /*                                                                       */
24  /*************************************************************************/
25
26
27#ifndef __FTIMAGE_H__
28#define __FTIMAGE_H__
29
30
31  /* _STANDALONE_ is from ftgrays.c */
32#ifndef _STANDALONE_
33#include <ft2build.h>
34#endif
35
36
37FT_BEGIN_HEADER
38
39
40  /*************************************************************************/
41  /*                                                                       */
42  /* <Section>                                                             */
43  /*    basic_types                                                        */
44  /*                                                                       */
45  /*************************************************************************/
46
47
48  /*************************************************************************/
49  /*                                                                       */
50  /* <Type>                                                                */
51  /*    FT_Pos                                                             */
52  /*                                                                       */
53  /* <Description>                                                         */
54  /*    The type FT_Pos is a 32-bit integer used to store vectorial        */
55  /*    coordinates.  Depending on the context, these can represent        */
56  /*    distances in integer font units, or 16.16, or 26.6 fixed float     */
57  /*    pixel coordinates.                                                 */
58  /*                                                                       */
59  typedef signed long  FT_Pos;
60
61
62  /*************************************************************************/
63  /*                                                                       */
64  /* <Struct>                                                              */
65  /*    FT_Vector                                                          */
66  /*                                                                       */
67  /* <Description>                                                         */
68  /*    A simple structure used to store a 2D vector; coordinates are of   */
69  /*    the FT_Pos type.                                                   */
70  /*                                                                       */
71  /* <Fields>                                                              */
72  /*    x :: The horizontal coordinate.                                    */
73  /*    y :: The vertical coordinate.                                      */
74  /*                                                                       */
75  typedef struct  FT_Vector_
76  {
77    FT_Pos  x;
78    FT_Pos  y;
79
80  } FT_Vector;
81
82
83  /*************************************************************************/
84  /*                                                                       */
85  /* <Struct>                                                              */
86  /*    FT_BBox                                                            */
87  /*                                                                       */
88  /* <Description>                                                         */
89  /*    A structure used to hold an outline's bounding box, i.e., the      */
90  /*    coordinates of its extrema in the horizontal and vertical          */
91  /*    directions.                                                        */
92  /*                                                                       */
93  /* <Fields>                                                              */
94  /*    xMin :: The horizontal minimum (left-most).                        */
95  /*                                                                       */
96  /*    yMin :: The vertical minimum (bottom-most).                        */
97  /*                                                                       */
98  /*    xMax :: The horizontal maximum (right-most).                       */
99  /*                                                                       */
100  /*    yMax :: The vertical maximum (top-most).                           */
101  /*                                                                       */
102  typedef struct  FT_BBox_
103  {
104    FT_Pos  xMin, yMin;
105    FT_Pos  xMax, yMax;
106
107  } FT_BBox;
108
109
110  /*************************************************************************/
111  /*                                                                       */
112  /* <Enum>                                                                */
113  /*    FT_Pixel_Mode                                                      */
114  /*                                                                       */
115  /* <Description>                                                         */
116  /*    An enumeration type used to describe the format of pixels in a     */
117  /*    given bitmap.  Note that additional formats may be added in the    */
118  /*    future.                                                            */
119  /*                                                                       */
120  /* <Values>                                                              */
121  /*    FT_PIXEL_MODE_NONE ::                                              */
122  /*      Value~0 is reserved.                                             */
123  /*                                                                       */
124  /*    FT_PIXEL_MODE_MONO ::                                              */
125  /*      A monochrome bitmap, using 1~bit per pixel.  Note that pixels    */
126  /*      are stored in most-significant order (MSB), which means that     */
127  /*      the left-most pixel in a byte has value 128.                     */
128  /*                                                                       */
129  /*    FT_PIXEL_MODE_GRAY ::                                              */
130  /*      An 8-bit bitmap, generally used to represent anti-aliased glyph  */
131  /*      images.  Each pixel is stored in one byte.  Note that the number */
132  /*      of value `gray' levels is stored in the `num_grays' field of     */
133  /*      the @FT_Bitmap structure (it generally is 256).                  */
134  /*                                                                       */
135  /*    FT_PIXEL_MODE_GRAY2 ::                                             */
136  /*      A 2-bit/pixel bitmap, used to represent embedded anti-aliased    */
137  /*      bitmaps in font files according to the OpenType specification.   */
138  /*      We haven't found a single font using this format, however.       */
139  /*                                                                       */
140  /*    FT_PIXEL_MODE_GRAY4 ::                                             */
141  /*      A 4-bit/pixel bitmap, used to represent embedded anti-aliased    */
142  /*      bitmaps in font files according to the OpenType specification.   */
143  /*      We haven't found a single font using this format, however.       */
144  /*                                                                       */
145  /*    FT_PIXEL_MODE_LCD ::                                               */
146  /*      An 8-bit bitmap, used to represent RGB or BGR decimated glyph    */
147  /*      images used for display on LCD displays; the bitmap is three     */
148  /*      times wider than the original glyph image.  See also             */
149  /*      @FT_RENDER_MODE_LCD.                                             */
150  /*                                                                       */
151  /*    FT_PIXEL_MODE_LCD_V ::                                             */
152  /*      An 8-bit bitmap, used to represent RGB or BGR decimated glyph    */
153  /*      images used for display on rotated LCD displays; the bitmap      */
154  /*      is three times taller than the original glyph image.  See also   */
155  /*      @FT_RENDER_MODE_LCD_V.                                           */
156  /*                                                                       */
157  typedef enum  FT_Pixel_Mode_
158  {
159    FT_PIXEL_MODE_NONE = 0,
160    FT_PIXEL_MODE_MONO,
161    FT_PIXEL_MODE_GRAY,
162    FT_PIXEL_MODE_GRAY2,
163    FT_PIXEL_MODE_GRAY4,
164    FT_PIXEL_MODE_LCD,
165    FT_PIXEL_MODE_LCD_V,
166
167    FT_PIXEL_MODE_MAX      /* do not remove */
168
169  } FT_Pixel_Mode;
170
171
172  /*************************************************************************/
173  /*                                                                       */
174  /* <Enum>                                                                */
175  /*    ft_pixel_mode_xxx                                                  */
176  /*                                                                       */
177  /* <Description>                                                         */
178  /*    A list of deprecated constants.  Use the corresponding             */
179  /*    @FT_Pixel_Mode values instead.                                     */
180  /*                                                                       */
181  /* <Values>                                                              */
182  /*    ft_pixel_mode_none  :: See @FT_PIXEL_MODE_NONE.                    */
183  /*    ft_pixel_mode_mono  :: See @FT_PIXEL_MODE_MONO.                    */
184  /*    ft_pixel_mode_grays :: See @FT_PIXEL_MODE_GRAY.                    */
185  /*    ft_pixel_mode_pal2  :: See @FT_PIXEL_MODE_GRAY2.                   */
186  /*    ft_pixel_mode_pal4  :: See @FT_PIXEL_MODE_GRAY4.                   */
187  /*                                                                       */
188#define ft_pixel_mode_none   FT_PIXEL_MODE_NONE
189#define ft_pixel_mode_mono   FT_PIXEL_MODE_MONO
190#define ft_pixel_mode_grays  FT_PIXEL_MODE_GRAY
191#define ft_pixel_mode_pal2   FT_PIXEL_MODE_GRAY2
192#define ft_pixel_mode_pal4   FT_PIXEL_MODE_GRAY4
193
194 /* */
195
196#if 0
197
198  /*************************************************************************/
199  /*                                                                       */
200  /* <Enum>                                                                */
201  /*    FT_Palette_Mode                                                    */
202  /*                                                                       */
203  /* <Description>                                                         */
204  /*    THIS TYPE IS DEPRECATED.  DO NOT USE IT!                           */
205  /*                                                                       */
206  /*    An enumeration type to describe the format of a bitmap palette,    */
207  /*    used with ft_pixel_mode_pal4 and ft_pixel_mode_pal8.               */
208  /*                                                                       */
209  /* <Values>                                                              */
210  /*    ft_palette_mode_rgb  :: The palette is an array of 3-byte RGB      */
211  /*                            records.                                   */
212  /*                                                                       */
213  /*    ft_palette_mode_rgba :: The palette is an array of 4-byte RGBA     */
214  /*                            records.                                   */
215  /*                                                                       */
216  /* <Note>                                                                */
217  /*    As ft_pixel_mode_pal2, pal4 and pal8 are currently unused by       */
218  /*    FreeType, these types are not handled by the library itself.       */
219  /*                                                                       */
220  typedef enum  FT_Palette_Mode_
221  {
222    ft_palette_mode_rgb = 0,
223    ft_palette_mode_rgba,
224
225    ft_palette_mode_max   /* do not remove */
226
227  } FT_Palette_Mode;
228
229  /* */
230
231#endif
232
233
234  /*************************************************************************/
235  /*                                                                       */
236  /* <Struct>                                                              */
237  /*    FT_Bitmap                                                          */
238  /*                                                                       */
239  /* <Description>                                                         */
240  /*    A structure used to describe a bitmap or pixmap to the raster.     */
241  /*    Note that we now manage pixmaps of various depths through the      */
242  /*    `pixel_mode' field.                                                */
243  /*                                                                       */
244  /* <Fields>                                                              */
245  /*    rows         :: The number of bitmap rows.                         */
246  /*                                                                       */
247  /*    width        :: The number of pixels in bitmap row.                */
248  /*                                                                       */
249  /*    pitch        :: The pitch's absolute value is the number of bytes  */
250  /*                    taken by one bitmap row, including padding.        */
251  /*                    However, the pitch is positive when the bitmap has */
252  /*                    a `down' flow, and negative when it has an `up'    */
253  /*                    flow.  In all cases, the pitch is an offset to add */
254  /*                    to a bitmap pointer in order to go down one row.   */
255  /*                                                                       */
256  /*    buffer       :: A typeless pointer to the bitmap buffer.  This     */
257  /*                    value should be aligned on 32-bit boundaries in    */
258  /*                    most cases.                                        */
259  /*                                                                       */
260  /*    num_grays    :: This field is only used with                       */
261  /*                    @FT_PIXEL_MODE_GRAY; it gives the number of gray   */
262  /*                    levels used in the bitmap.                         */
263  /*                                                                       */
264  /*    pixel_mode   :: The pixel mode, i.e., how pixel bits are stored.   */
265  /*                    See @FT_Pixel_Mode for possible values.            */
266  /*                                                                       */
267  /*    palette_mode :: This field is intended for paletted pixel modes;   */
268  /*                    it indicates how the palette is stored.  Not       */
269  /*                    used currently.                                    */
270  /*                                                                       */
271  /*    palette      :: A typeless pointer to the bitmap palette; this     */
272  /*                    field is intended for paletted pixel modes.  Not   */
273  /*                    used currently.                                    */
274  /*                                                                       */
275  /* <Note>                                                                */
276  /*   For now, the only pixel modes supported by FreeType are mono and    */
277  /*   grays.  However, drivers might be added in the future to support    */
278  /*   more `colorful' options.                                            */
279  /*                                                                       */
280  typedef struct  FT_Bitmap_
281  {
282    int             rows;
283    int             width;
284    int             pitch;
285    unsigned char*  buffer;
286    short           num_grays;
287    char            pixel_mode;
288    char            palette_mode;
289    void*           palette;
290
291  } FT_Bitmap;
292
293
294  /*************************************************************************/
295  /*                                                                       */
296  /* <Section>                                                             */
297  /*    outline_processing                                                 */
298  /*                                                                       */
299  /*************************************************************************/
300
301
302  /*************************************************************************/
303  /*                                                                       */
304  /* <Struct>                                                              */
305  /*    FT_Outline                                                         */
306  /*                                                                       */
307  /* <Description>                                                         */
308  /*    This structure is used to describe an outline to the scan-line     */
309  /*    converter.                                                         */
310  /*                                                                       */
311  /* <Fields>                                                              */
312  /*    n_contours :: The number of contours in the outline.               */
313  /*                                                                       */
314  /*    n_points   :: The number of points in the outline.                 */
315  /*                                                                       */
316  /*    points     :: A pointer to an array of `n_points' @FT_Vector       */
317  /*                  elements, giving the outline's point coordinates.    */
318  /*                                                                       */
319  /*    tags       :: A pointer to an array of `n_points' chars, giving    */
320  /*                  each outline point's type.  If bit~0 is unset, the   */
321  /*                  point is `off' the curve, i.e., a Bézier control     */
322  /*                  point, while it is `on' when set.                    */
323  /*                                                                       */
324  /*                  Bit~1 is meaningful for `off' points only.  If set,  */
325  /*                  it indicates a third-order Bézier arc control point; */
326  /*                  and a second-order control point if unset.           */
327  /*                                                                       */
328  /*    contours   :: An array of `n_contours' shorts, giving the end      */
329  /*                  point of each contour within the outline.  For       */
330  /*                  example, the first contour is defined by the points  */
331  /*                  `0' to `contours[0]', the second one is defined by   */
332  /*                  the points `contours[0]+1' to `contours[1]', etc.    */
333  /*                                                                       */
334  /*    flags      :: A set of bit flags used to characterize the outline  */
335  /*                  and give hints to the scan-converter and hinter on   */
336  /*                  how to convert/grid-fit it.  See @FT_OUTLINE_FLAGS.  */
337  /*                                                                       */
338  typedef struct  FT_Outline_
339  {
340    short       n_contours;      /* number of contours in glyph        */
341    short       n_points;        /* number of points in the glyph      */
342
343    FT_Vector*  points;          /* the outline's points               */
344    char*       tags;            /* the points flags                   */
345    short*      contours;        /* the contour end points             */
346
347    int         flags;           /* outline masks                      */
348
349  } FT_Outline;
350
351
352  /*************************************************************************/
353  /*                                                                       */
354  /* <Enum>                                                                */
355  /*    FT_OUTLINE_FLAGS                                                   */
356  /*                                                                       */
357  /* <Description>                                                         */
358  /*    A list of bit-field constants use for the flags in an outline's    */
359  /*    `flags' field.                                                     */
360  /*                                                                       */
361  /* <Values>                                                              */
362  /*    FT_OUTLINE_NONE ::                                                 */
363  /*      Value~0 is reserved.                                             */
364  /*                                                                       */
365  /*    FT_OUTLINE_OWNER ::                                                */
366  /*      If set, this flag indicates that the outline's field arrays      */
367  /*      (i.e., `points', `flags', and `contours') are `owned' by the     */
368  /*      outline object, and should thus be freed when it is destroyed.   */
369  /*                                                                       */
370  /*    FT_OUTLINE_EVEN_ODD_FILL ::                                        */
371  /*      By default, outlines are filled using the non-zero winding rule. */
372  /*      If set to 1, the outline will be filled using the even-odd fill  */
373  /*      rule (only works with the smooth raster).                        */
374  /*                                                                       */
375  /*    FT_OUTLINE_REVERSE_FILL ::                                         */
376  /*      By default, outside contours of an outline are oriented in       */
377  /*      clock-wise direction, as defined in the TrueType specification.  */
378  /*      This flag is set if the outline uses the opposite direction      */
379  /*      (typically for Type~1 fonts).  This flag is ignored by the scan  */
380  /*      converter.                                                       */
381  /*                                                                       */
382  /*    FT_OUTLINE_IGNORE_DROPOUTS ::                                      */
383  /*      By default, the scan converter will try to detect drop-outs in   */
384  /*      an outline and correct the glyph bitmap to ensure consistent     */
385  /*      shape continuity.  If set, this flag hints the scan-line         */
386  /*      converter to ignore such cases.                                  */
387  /*                                                                       */
388  /*    FT_OUTLINE_SMART_DROPOUTS ::                                       */
389  /*      Select smart dropout control.  If unset, use simple dropout      */
390  /*      control.  Ignored if @FT_OUTLINE_IGNORE_DROPOUTS is set.         */
391  /*                                                                       */
392  /*    FT_OUTLINE_INCLUDE_STUBS ::                                        */
393  /*      If set, turn pixels on for `stubs', otherwise exclude them.      */
394  /*      Ignored if @FT_OUTLINE_IGNORE_DROPOUTS is set.                   */
395  /*                                                                       */
396  /*    FT_OUTLINE_HIGH_PRECISION ::                                       */
397  /*      This flag indicates that the scan-line converter should try to   */
398  /*      convert this outline to bitmaps with the highest possible        */
399  /*      quality.  It is typically set for small character sizes.  Note   */
400  /*      that this is only a hint that might be completely ignored by a   */
401  /*      given scan-converter.                                            */
402  /*                                                                       */
403  /*    FT_OUTLINE_SINGLE_PASS ::                                          */
404  /*      This flag is set to force a given scan-converter to only use a   */
405  /*      single pass over the outline to render a bitmap glyph image.     */
406  /*      Normally, it is set for very large character sizes.  It is only  */
407  /*      a hint that might be completely ignored by a given               */
408  /*      scan-converter.                                                  */
409  /*                                                                       */
410  /* <Note>                                                                */
411  /*    Please refer to the description of the `SCANTYPE' instruction in   */
412  /*    the OpenType specification (in file `ttinst1.doc') how simple      */
413  /*    drop-outs, smart drop-outs, and stubs are defined.                 */
414  /*                                                                       */
415#define FT_OUTLINE_NONE             0x0
416#define FT_OUTLINE_OWNER            0x1
417#define FT_OUTLINE_EVEN_ODD_FILL    0x2
418#define FT_OUTLINE_REVERSE_FILL     0x4
419#define FT_OUTLINE_IGNORE_DROPOUTS  0x8
420#define FT_OUTLINE_SMART_DROPOUTS   0x10
421#define FT_OUTLINE_INCLUDE_STUBS    0x20
422
423#define FT_OUTLINE_HIGH_PRECISION   0x100
424#define FT_OUTLINE_SINGLE_PASS      0x200
425
426
427 /*************************************************************************
428  *
429  * @enum:
430  *   ft_outline_flags
431  *
432  * @description:
433  *   These constants are deprecated.  Please use the corresponding
434  *   @FT_OUTLINE_FLAGS values.
435  *
436  * @values:
437  *   ft_outline_none            :: See @FT_OUTLINE_NONE.
438  *   ft_outline_owner           :: See @FT_OUTLINE_OWNER.
439  *   ft_outline_even_odd_fill   :: See @FT_OUTLINE_EVEN_ODD_FILL.
440  *   ft_outline_reverse_fill    :: See @FT_OUTLINE_REVERSE_FILL.
441  *   ft_outline_ignore_dropouts :: See @FT_OUTLINE_IGNORE_DROPOUTS.
442  *   ft_outline_high_precision  :: See @FT_OUTLINE_HIGH_PRECISION.
443  *   ft_outline_single_pass     :: See @FT_OUTLINE_SINGLE_PASS.
444  */
445#define ft_outline_none             FT_OUTLINE_NONE
446#define ft_outline_owner            FT_OUTLINE_OWNER
447#define ft_outline_even_odd_fill    FT_OUTLINE_EVEN_ODD_FILL
448#define ft_outline_reverse_fill     FT_OUTLINE_REVERSE_FILL
449#define ft_outline_ignore_dropouts  FT_OUTLINE_IGNORE_DROPOUTS
450#define ft_outline_high_precision   FT_OUTLINE_HIGH_PRECISION
451#define ft_outline_single_pass      FT_OUTLINE_SINGLE_PASS
452
453  /* */
454
455#define FT_CURVE_TAG( flag )  ( flag & 3 )
456
457#define FT_CURVE_TAG_ON           1
458#define FT_CURVE_TAG_CONIC        0
459#define FT_CURVE_TAG_CUBIC        2
460
461#define FT_CURVE_TAG_TOUCH_X      8  /* reserved for the TrueType hinter */
462#define FT_CURVE_TAG_TOUCH_Y     16  /* reserved for the TrueType hinter */
463
464#define FT_CURVE_TAG_TOUCH_BOTH  ( FT_CURVE_TAG_TOUCH_X | \
465                                   FT_CURVE_TAG_TOUCH_Y )
466
467#define FT_Curve_Tag_On       FT_CURVE_TAG_ON
468#define FT_Curve_Tag_Conic    FT_CURVE_TAG_CONIC
469#define FT_Curve_Tag_Cubic    FT_CURVE_TAG_CUBIC
470#define FT_Curve_Tag_Touch_X  FT_CURVE_TAG_TOUCH_X
471#define FT_Curve_Tag_Touch_Y  FT_CURVE_TAG_TOUCH_Y
472
473
474  /*************************************************************************/
475  /*                                                                       */
476  /* <FuncType>                                                            */
477  /*    FT_Outline_MoveToFunc                                              */
478  /*                                                                       */
479  /* <Description>                                                         */
480  /*    A function pointer type used to describe the signature of a `move  */
481  /*    to' function during outline walking/decomposition.                 */
482  /*                                                                       */
483  /*    A `move to' is emitted to start a new contour in an outline.       */
484  /*                                                                       */
485  /* <Input>                                                               */
486  /*    to   :: A pointer to the target point of the `move to'.            */
487  /*                                                                       */
488  /*    user :: A typeless pointer which is passed from the caller of the  */
489  /*            decomposition function.                                    */
490  /*                                                                       */
491  /* <Return>                                                              */
492  /*    Error code.  0~means success.                                      */
493  /*                                                                       */
494  typedef int
495  (*FT_Outline_MoveToFunc)( const FT_Vector*  to,
496                            void*             user );
497
498#define FT_Outline_MoveTo_Func  FT_Outline_MoveToFunc
499
500
501  /*************************************************************************/
502  /*                                                                       */
503  /* <FuncType>                                                            */
504  /*    FT_Outline_LineToFunc                                              */
505  /*                                                                       */
506  /* <Description>                                                         */
507  /*    A function pointer type used to describe the signature of a `line  */
508  /*    to' function during outline walking/decomposition.                 */
509  /*                                                                       */
510  /*    A `line to' is emitted to indicate a segment in the outline.       */
511  /*                                                                       */
512  /* <Input>                                                               */
513  /*    to   :: A pointer to the target point of the `line to'.            */
514  /*                                                                       */
515  /*    user :: A typeless pointer which is passed from the caller of the  */
516  /*            decomposition function.                                    */
517  /*                                                                       */
518  /* <Return>                                                              */
519  /*    Error code.  0~means success.                                      */
520  /*                                                                       */
521  typedef int
522  (*FT_Outline_LineToFunc)( const FT_Vector*  to,
523                            void*             user );
524
525#define FT_Outline_LineTo_Func  FT_Outline_LineToFunc
526
527
528  /*************************************************************************/
529  /*                                                                       */
530  /* <FuncType>                                                            */
531  /*    FT_Outline_ConicToFunc                                             */
532  /*                                                                       */
533  /* <Description>                                                         */
534  /*    A function pointer type use to describe the signature of a `conic  */
535  /*    to' function during outline walking/decomposition.                 */
536  /*                                                                       */
537  /*    A `conic to' is emitted to indicate a second-order Bézier arc in   */
538  /*    the outline.                                                       */
539  /*                                                                       */
540  /* <Input>                                                               */
541  /*    control :: An intermediate control point between the last position */
542  /*               and the new target in `to'.                             */
543  /*                                                                       */
544  /*    to      :: A pointer to the target end point of the conic arc.     */
545  /*                                                                       */
546  /*    user    :: A typeless pointer which is passed from the caller of   */
547  /*               the decomposition function.                             */
548  /*                                                                       */
549  /* <Return>                                                              */
550  /*    Error code.  0~means success.                                      */
551  /*                                                                       */
552  typedef int
553  (*FT_Outline_ConicToFunc)( const FT_Vector*  control,
554                             const FT_Vector*  to,
555                             void*             user );
556
557#define FT_Outline_ConicTo_Func  FT_Outline_ConicToFunc
558
559
560  /*************************************************************************/
561  /*                                                                       */
562  /* <FuncType>                                                            */
563  /*    FT_Outline_CubicToFunc                                             */
564  /*                                                                       */
565  /* <Description>                                                         */
566  /*    A function pointer type used to describe the signature of a `cubic */
567  /*    to' function during outline walking/decomposition.                 */
568  /*                                                                       */
569  /*    A `cubic to' is emitted to indicate a third-order Bézier arc.      */
570  /*                                                                       */
571  /* <Input>                                                               */
572  /*    control1 :: A pointer to the first Bézier control point.           */
573  /*                                                                       */
574  /*    control2 :: A pointer to the second Bézier control point.          */
575  /*                                                                       */
576  /*    to       :: A pointer to the target end point.                     */
577  /*                                                                       */
578  /*    user     :: A typeless pointer which is passed from the caller of  */
579  /*                the decomposition function.                            */
580  /*                                                                       */
581  /* <Return>                                                              */
582  /*    Error code.  0~means success.                                      */
583  /*                                                                       */
584  typedef int
585  (*FT_Outline_CubicToFunc)( const FT_Vector*  control1,
586                             const FT_Vector*  control2,
587                             const FT_Vector*  to,
588                             void*             user );
589
590#define FT_Outline_CubicTo_Func  FT_Outline_CubicToFunc
591
592
593  /*************************************************************************/
594  /*                                                                       */
595  /* <Struct>                                                              */
596  /*    FT_Outline_Funcs                                                   */
597  /*                                                                       */
598  /* <Description>                                                         */
599  /*    A structure to hold various function pointers used during outline  */
600  /*    decomposition in order to emit segments, conic, and cubic Béziers, */
601  /*    as well as `move to' and `close to' operations.                    */
602  /*                                                                       */
603  /* <Fields>                                                              */
604  /*    move_to  :: The `move to' emitter.                                 */
605  /*                                                                       */
606  /*    line_to  :: The segment emitter.                                   */
607  /*                                                                       */
608  /*    conic_to :: The second-order Bézier arc emitter.                   */
609  /*                                                                       */
610  /*    cubic_to :: The third-order Bézier arc emitter.                    */
611  /*                                                                       */
612  /*    shift    :: The shift that is applied to coordinates before they   */
613  /*                are sent to the emitter.                               */
614  /*                                                                       */
615  /*    delta    :: The delta that is applied to coordinates before they   */
616  /*                are sent to the emitter, but after the shift.          */
617  /*                                                                       */
618  /* <Note>                                                                */
619  /*    The point coordinates sent to the emitters are the transformed     */
620  /*    version of the original coordinates (this is important for high    */
621  /*    accuracy during scan-conversion).  The transformation is simple:   */
622  /*                                                                       */
623  /*    {                                                                  */
624  /*      x' = (x << shift) - delta                                        */
625  /*      y' = (x << shift) - delta                                        */
626  /*    }                                                                  */
627  /*                                                                       */
628  /*    Set the value of `shift' and `delta' to~0 to get the original      */
629  /*    point coordinates.                                                 */
630  /*                                                                       */
631  typedef struct  FT_Outline_Funcs_
632  {
633    FT_Outline_MoveToFunc   move_to;
634    FT_Outline_LineToFunc   line_to;
635    FT_Outline_ConicToFunc  conic_to;
636    FT_Outline_CubicToFunc  cubic_to;
637
638    int                     shift;
639    FT_Pos                  delta;
640
641  } FT_Outline_Funcs;
642
643
644  /*************************************************************************/
645  /*                                                                       */
646  /* <Section>                                                             */
647  /*    basic_types                                                        */
648  /*                                                                       */
649  /*************************************************************************/
650
651
652  /*************************************************************************/
653  /*                                                                       */
654  /* <Macro>                                                               */
655  /*    FT_IMAGE_TAG                                                       */
656  /*                                                                       */
657  /* <Description>                                                         */
658  /*    This macro converts four-letter tags to an unsigned long type.     */
659  /*                                                                       */
660  /* <Note>                                                                */
661  /*    Since many 16-bit compilers don't like 32-bit enumerations, you    */
662  /*    should redefine this macro in case of problems to something like   */
663  /*    this:                                                              */
664  /*                                                                       */
665  /*    {                                                                  */
666  /*      #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 )  value         */
667  /*    }                                                                  */
668  /*                                                                       */
669  /*    to get a simple enumeration without assigning special numbers.     */
670  /*                                                                       */
671#ifndef FT_IMAGE_TAG
672#define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 )  \
673          value = ( ( (unsigned long)_x1 << 24 ) | \
674                    ( (unsigned long)_x2 << 16 ) | \
675                    ( (unsigned long)_x3 << 8  ) | \
676                      (unsigned long)_x4         )
677#endif /* FT_IMAGE_TAG */
678
679
680  /*************************************************************************/
681  /*                                                                       */
682  /* <Enum>                                                                */
683  /*    FT_Glyph_Format                                                    */
684  /*                                                                       */
685  /* <Description>                                                         */
686  /*    An enumeration type used to describe the format of a given glyph   */
687  /*    image.  Note that this version of FreeType only supports two image */
688  /*    formats, even though future font drivers will be able to register  */
689  /*    their own format.                                                  */
690  /*                                                                       */
691  /* <Values>                                                              */
692  /*    FT_GLYPH_FORMAT_NONE ::                                            */
693  /*      The value~0 is reserved.                                         */
694  /*                                                                       */
695  /*    FT_GLYPH_FORMAT_COMPOSITE ::                                       */
696  /*      The glyph image is a composite of several other images.  This    */
697  /*      format is _only_ used with @FT_LOAD_NO_RECURSE, and is used to   */
698  /*      report compound glyphs (like accented characters).               */
699  /*                                                                       */
700  /*    FT_GLYPH_FORMAT_BITMAP ::                                          */
701  /*      The glyph image is a bitmap, and can be described as an          */
702  /*      @FT_Bitmap.  You generally need to access the `bitmap' field of  */
703  /*      the @FT_GlyphSlotRec structure to read it.                       */
704  /*                                                                       */
705  /*    FT_GLYPH_FORMAT_OUTLINE ::                                         */
706  /*      The glyph image is a vectorial outline made of line segments     */
707  /*      and Bézier arcs; it can be described as an @FT_Outline; you      */
708  /*      generally want to access the `outline' field of the              */
709  /*      @FT_GlyphSlotRec structure to read it.                           */
710  /*                                                                       */
711  /*    FT_GLYPH_FORMAT_PLOTTER ::                                         */
712  /*      The glyph image is a vectorial path with no inside and outside   */
713  /*      contours.  Some Type~1 fonts, like those in the Hershey family,  */
714  /*      contain glyphs in this format.  These are described as           */
715  /*      @FT_Outline, but FreeType isn't currently capable of rendering   */
716  /*      them correctly.                                                  */
717  /*                                                                       */
718  typedef enum  FT_Glyph_Format_
719  {
720    FT_IMAGE_TAG( FT_GLYPH_FORMAT_NONE, 0, 0, 0, 0 ),
721
722    FT_IMAGE_TAG( FT_GLYPH_FORMAT_COMPOSITE, 'c', 'o', 'm', 'p' ),
723    FT_IMAGE_TAG( FT_GLYPH_FORMAT_BITMAP,    'b', 'i', 't', 's' ),
724    FT_IMAGE_TAG( FT_GLYPH_FORMAT_OUTLINE,   'o', 'u', 't', 'l' ),
725    FT_IMAGE_TAG( FT_GLYPH_FORMAT_PLOTTER,   'p', 'l', 'o', 't' )
726
727  } FT_Glyph_Format;
728
729
730  /*************************************************************************/
731  /*                                                                       */
732  /* <Enum>                                                                */
733  /*    ft_glyph_format_xxx                                                */
734  /*                                                                       */
735  /* <Description>                                                         */
736  /*    A list of deprecated constants.  Use the corresponding             */
737  /*    @FT_Glyph_Format values instead.                                   */
738  /*                                                                       */
739  /* <Values>                                                              */
740  /*    ft_glyph_format_none      :: See @FT_GLYPH_FORMAT_NONE.            */
741  /*    ft_glyph_format_composite :: See @FT_GLYPH_FORMAT_COMPOSITE.       */
742  /*    ft_glyph_format_bitmap    :: See @FT_GLYPH_FORMAT_BITMAP.          */
743  /*    ft_glyph_format_outline   :: See @FT_GLYPH_FORMAT_OUTLINE.         */
744  /*    ft_glyph_format_plotter   :: See @FT_GLYPH_FORMAT_PLOTTER.         */
745  /*                                                                       */
746#define ft_glyph_format_none       FT_GLYPH_FORMAT_NONE
747#define ft_glyph_format_composite  FT_GLYPH_FORMAT_COMPOSITE
748#define ft_glyph_format_bitmap     FT_GLYPH_FORMAT_BITMAP
749#define ft_glyph_format_outline    FT_GLYPH_FORMAT_OUTLINE
750#define ft_glyph_format_plotter    FT_GLYPH_FORMAT_PLOTTER
751
752
753  /*************************************************************************/
754  /*************************************************************************/
755  /*************************************************************************/
756  /*****                                                               *****/
757  /*****            R A S T E R   D E F I N I T I O N S                *****/
758  /*****                                                               *****/
759  /*************************************************************************/
760  /*************************************************************************/
761  /*************************************************************************/
762
763
764  /*************************************************************************/
765  /*                                                                       */
766  /* A raster is a scan converter, in charge of rendering an outline into  */
767  /* a a bitmap.  This section contains the public API for rasters.        */
768  /*                                                                       */
769  /* Note that in FreeType 2, all rasters are now encapsulated within      */
770  /* specific modules called `renderers'.  See `freetype/ftrender.h' for   */
771  /* more details on renderers.                                            */
772  /*                                                                       */
773  /*************************************************************************/
774
775
776  /*************************************************************************/
777  /*                                                                       */
778  /* <Section>                                                             */
779  /*    raster                                                             */
780  /*                                                                       */
781  /* <Title>                                                               */
782  /*    Scanline Converter                                                 */
783  /*                                                                       */
784  /* <Abstract>                                                            */
785  /*    How vectorial outlines are converted into bitmaps and pixmaps.     */
786  /*                                                                       */
787  /* <Description>                                                         */
788  /*    This section contains technical definitions.                       */
789  /*                                                                       */
790  /*************************************************************************/
791
792
793  /*************************************************************************/
794  /*                                                                       */
795  /* <Type>                                                                */
796  /*    FT_Raster                                                          */
797  /*                                                                       */
798  /* <Description>                                                         */
799  /*    A handle (pointer) to a raster object.  Each object can be used    */
800  /*    independently to convert an outline into a bitmap or pixmap.       */
801  /*                                                                       */
802  typedef struct FT_RasterRec_*  FT_Raster;
803
804
805  /*************************************************************************/
806  /*                                                                       */
807  /* <Struct>                                                              */
808  /*    FT_Span                                                            */
809  /*                                                                       */
810  /* <Description>                                                         */
811  /*    A structure used to model a single span of gray (or black) pixels  */
812  /*    when rendering a monochrome or anti-aliased bitmap.                */
813  /*                                                                       */
814  /* <Fields>                                                              */
815  /*    x        :: The span's horizontal start position.                  */
816  /*                                                                       */
817  /*    len      :: The span's length in pixels.                           */
818  /*                                                                       */
819  /*    coverage :: The span color/coverage, ranging from 0 (background)   */
820  /*                to 255 (foreground).  Only used for anti-aliased       */
821  /*                rendering.                                             */
822  /*                                                                       */
823  /* <Note>                                                                */
824  /*    This structure is used by the span drawing callback type named     */
825  /*    @FT_SpanFunc which takes the y~coordinate of the span as a         */
826  /*    a parameter.                                                       */
827  /*                                                                       */
828  /*    The coverage value is always between 0 and 255.  If you want less  */
829  /*    gray values, the callback function has to reduce them.             */
830  /*                                                                       */
831  typedef struct  FT_Span_
832  {
833    short           x;
834    unsigned short  len;
835    unsigned char   coverage;
836
837  } FT_Span;
838
839
840  /*************************************************************************/
841  /*                                                                       */
842  /* <FuncType>                                                            */
843  /*    FT_SpanFunc                                                        */
844  /*                                                                       */
845  /* <Description>                                                         */
846  /*    A function used as a call-back by the anti-aliased renderer in     */
847  /*    order to let client applications draw themselves the gray pixel    */
848  /*    spans on each scan line.                                           */
849  /*                                                                       */
850  /* <Input>                                                               */
851  /*    y     :: The scanline's y~coordinate.                              */
852  /*                                                                       */
853  /*    count :: The number of spans to draw on this scanline.             */
854  /*                                                                       */
855  /*    spans :: A table of `count' spans to draw on the scanline.         */
856  /*                                                                       */
857  /*    user  :: User-supplied data that is passed to the callback.        */
858  /*                                                                       */
859  /* <Note>                                                                */
860  /*    This callback allows client applications to directly render the    */
861  /*    gray spans of the anti-aliased bitmap to any kind of surfaces.     */
862  /*                                                                       */
863  /*    This can be used to write anti-aliased outlines directly to a      */
864  /*    given background bitmap, and even perform translucency.            */
865  /*                                                                       */
866  /*    Note that the `count' field cannot be greater than a fixed value   */
867  /*    defined by the `FT_MAX_GRAY_SPANS' configuration macro in          */
868  /*    `ftoption.h'.  By default, this value is set to~32, which means    */
869  /*    that if there are more than 32~spans on a given scanline, the      */
870  /*    callback is called several times with the same `y' parameter in    */
871  /*    order to draw all callbacks.                                       */
872  /*                                                                       */
873  /*    Otherwise, the callback is only called once per scan-line, and     */
874  /*    only for those scanlines that do have `gray' pixels on them.       */
875  /*                                                                       */
876  typedef void
877  (*FT_SpanFunc)( int             y,
878                  int             count,
879                  const FT_Span*  spans,
880                  void*           user );
881
882#define FT_Raster_Span_Func  FT_SpanFunc
883
884
885  /*************************************************************************/
886  /*                                                                       */
887  /* <FuncType>                                                            */
888  /*    FT_Raster_BitTest_Func                                             */
889  /*                                                                       */
890  /* <Description>                                                         */
891  /*    THIS TYPE IS DEPRECATED.  DO NOT USE IT.                           */
892  /*                                                                       */
893  /*    A function used as a call-back by the monochrome scan-converter    */
894  /*    to test whether a given target pixel is already set to the drawing */
895  /*    `color'.  These tests are crucial to implement drop-out control    */
896  /*    per-se the TrueType spec.                                          */
897  /*                                                                       */
898  /* <Input>                                                               */
899  /*    y     :: The pixel's y~coordinate.                                 */
900  /*                                                                       */
901  /*    x     :: The pixel's x~coordinate.                                 */
902  /*                                                                       */
903  /*    user  :: User-supplied data that is passed to the callback.        */
904  /*                                                                       */
905  /* <Return>                                                              */
906  /*   1~if the pixel is `set', 0~otherwise.                               */
907  /*                                                                       */
908  typedef int
909  (*FT_Raster_BitTest_Func)( int    y,
910                             int    x,
911                             void*  user );
912
913
914  /*************************************************************************/
915  /*                                                                       */
916  /* <FuncType>                                                            */
917  /*    FT_Raster_BitSet_Func                                              */
918  /*                                                                       */
919  /* <Description>                                                         */
920  /*    THIS TYPE IS DEPRECATED.  DO NOT USE IT.                           */
921  /*                                                                       */
922  /*    A function used as a call-back by the monochrome scan-converter    */
923  /*    to set an individual target pixel.  This is crucial to implement   */
924  /*    drop-out control according to the TrueType specification.          */
925  /*                                                                       */
926  /* <Input>                                                               */
927  /*    y     :: The pixel's y~coordinate.                                 */
928  /*                                                                       */
929  /*    x     :: The pixel's x~coordinate.                                 */
930  /*                                                                       */
931  /*    user  :: User-supplied data that is passed to the callback.        */
932  /*                                                                       */
933  /* <Return>                                                              */
934  /*    1~if the pixel is `set', 0~otherwise.                              */
935  /*                                                                       */
936  typedef void
937  (*FT_Raster_BitSet_Func)( int    y,
938                            int    x,
939                            void*  user );
940
941
942  /*************************************************************************/
943  /*                                                                       */
944  /* <Enum>                                                                */
945  /*    FT_RASTER_FLAG_XXX                                                 */
946  /*                                                                       */
947  /* <Description>                                                         */
948  /*    A list of bit flag constants as used in the `flags' field of a     */
949  /*    @FT_Raster_Params structure.                                       */
950  /*                                                                       */
951  /* <Values>                                                              */
952  /*    FT_RASTER_FLAG_DEFAULT :: This value is 0.                         */
953  /*                                                                       */
954  /*    FT_RASTER_FLAG_AA      :: This flag is set to indicate that an     */
955  /*                              anti-aliased glyph image should be       */
956  /*                              generated.  Otherwise, it will be        */
957  /*                              monochrome (1-bit).                      */
958  /*                                                                       */
959  /*    FT_RASTER_FLAG_DIRECT  :: This flag is set to indicate direct      */
960  /*                              rendering.  In this mode, client         */
961  /*                              applications must provide their own span */
962  /*                              callback.  This lets them directly       */
963  /*                              draw or compose over an existing bitmap. */
964  /*                              If this bit is not set, the target       */
965  /*                              pixmap's buffer _must_ be zeroed before  */
966  /*                              rendering.                               */
967  /*                                                                       */
968  /*                              Note that for now, direct rendering is   */
969  /*                              only possible with anti-aliased glyphs.  */
970  /*                                                                       */
971  /*    FT_RASTER_FLAG_CLIP    :: This flag is only used in direct         */
972  /*                              rendering mode.  If set, the output will */
973  /*                              be clipped to a box specified in the     */
974  /*                              `clip_box' field of the                  */
975  /*                              @FT_Raster_Params structure.             */
976  /*                                                                       */
977  /*                              Note that by default, the glyph bitmap   */
978  /*                              is clipped to the target pixmap, except  */
979  /*                              in direct rendering mode where all spans */
980  /*                              are generated if no clipping box is set. */
981  /*                                                                       */
982#define FT_RASTER_FLAG_DEFAULT  0x0
983#define FT_RASTER_FLAG_AA       0x1
984#define FT_RASTER_FLAG_DIRECT   0x2
985#define FT_RASTER_FLAG_CLIP     0x4
986
987  /* deprecated */
988#define ft_raster_flag_default  FT_RASTER_FLAG_DEFAULT
989#define ft_raster_flag_aa       FT_RASTER_FLAG_AA
990#define ft_raster_flag_direct   FT_RASTER_FLAG_DIRECT
991#define ft_raster_flag_clip     FT_RASTER_FLAG_CLIP
992
993
994  /*************************************************************************/
995  /*                                                                       */
996  /* <Struct>                                                              */
997  /*    FT_Raster_Params                                                   */
998  /*                                                                       */
999  /* <Description>                                                         */
1000  /*    A structure to hold the arguments used by a raster's render        */
1001  /*    function.                                                          */
1002  /*                                                                       */
1003  /* <Fields>                                                              */
1004  /*    target      :: The target bitmap.                                  */
1005  /*                                                                       */
1006  /*    source      :: A pointer to the source glyph image (e.g., an       */
1007  /*                   @FT_Outline).                                       */
1008  /*                                                                       */
1009  /*    flags       :: The rendering flags.                                */
1010  /*                                                                       */
1011  /*    gray_spans  :: The gray span drawing callback.                     */
1012  /*                                                                       */
1013  /*    black_spans :: The black span drawing callback.                    */
1014  /*                                                                       */
1015  /*    bit_test    :: The bit test callback.  UNIMPLEMENTED!              */
1016  /*                                                                       */
1017  /*    bit_set     :: The bit set callback.  UNIMPLEMENTED!               */
1018  /*                                                                       */
1019  /*    user        :: User-supplied data that is passed to each drawing   */
1020  /*                   callback.                                           */
1021  /*                                                                       */
1022  /*    clip_box    :: An optional clipping box.  It is only used in       */
1023  /*                   direct rendering mode.  Note that coordinates here  */
1024  /*                   should be expressed in _integer_ pixels (and not in */
1025  /*                   26.6 fixed-point units).                            */
1026  /*                                                                       */
1027  /* <Note>                                                                */
1028  /*    An anti-aliased glyph bitmap is drawn if the @FT_RASTER_FLAG_AA    */
1029  /*    bit flag is set in the `flags' field, otherwise a monochrome       */
1030  /*    bitmap is generated.                                               */
1031  /*                                                                       */
1032  /*    If the @FT_RASTER_FLAG_DIRECT bit flag is set in `flags', the      */
1033  /*    raster will call the `gray_spans' callback to draw gray pixel      */
1034  /*    spans, in the case of an aa glyph bitmap, it will call             */
1035  /*    `black_spans', and `bit_test' and `bit_set' in the case of a       */
1036  /*    monochrome bitmap.  This allows direct composition over a          */
1037  /*    pre-existing bitmap through user-provided callbacks to perform the */
1038  /*    span drawing/composition.                                          */
1039  /*                                                                       */
1040  /*    Note that the `bit_test' and `bit_set' callbacks are required when */
1041  /*    rendering a monochrome bitmap, as they are crucial to implement    */
1042  /*    correct drop-out control as defined in the TrueType specification. */
1043  /*                                                                       */
1044  typedef struct  FT_Raster_Params_
1045  {
1046    const FT_Bitmap*        target;
1047    const void*             source;
1048    int                     flags;
1049    FT_SpanFunc             gray_spans;
1050    FT_SpanFunc             black_spans;
1051    FT_Raster_BitTest_Func  bit_test;     /* doesn't work! */
1052    FT_Raster_BitSet_Func   bit_set;      /* doesn't work! */
1053    void*                   user;
1054    FT_BBox                 clip_box;
1055
1056  } FT_Raster_Params;
1057
1058
1059  /*************************************************************************/
1060  /*                                                                       */
1061  /* <FuncType>                                                            */
1062  /*    FT_Raster_NewFunc                                                  */
1063  /*                                                                       */
1064  /* <Description>                                                         */
1065  /*    A function used to create a new raster object.                     */
1066  /*                                                                       */
1067  /* <Input>                                                               */
1068  /*    memory :: A handle to the memory allocator.                        */
1069  /*                                                                       */
1070  /* <Output>                                                              */
1071  /*    raster :: A handle to the new raster object.                       */
1072  /*                                                                       */
1073  /* <Return>                                                              */
1074  /*    Error code.  0~means success.                                      */
1075  /*                                                                       */
1076  /* <Note>                                                                */
1077  /*    The `memory' parameter is a typeless pointer in order to avoid     */
1078  /*    un-wanted dependencies on the rest of the FreeType code.  In       */
1079  /*    practice, it is an @FT_Memory object, i.e., a handle to the        */
1080  /*    standard FreeType memory allocator.  However, this field can be    */
1081  /*    completely ignored by a given raster implementation.               */
1082  /*                                                                       */
1083  typedef int
1084  (*FT_Raster_NewFunc)( void*       memory,
1085                        FT_Raster*  raster );
1086
1087#define FT_Raster_New_Func  FT_Raster_NewFunc
1088
1089
1090  /*************************************************************************/
1091  /*                                                                       */
1092  /* <FuncType>                                                            */
1093  /*    FT_Raster_DoneFunc                                                 */
1094  /*                                                                       */
1095  /* <Description>                                                         */
1096  /*    A function used to destroy a given raster object.                  */
1097  /*                                                                       */
1098  /* <Input>                                                               */
1099  /*    raster :: A handle to the raster object.                           */
1100  /*                                                                       */
1101  typedef void
1102  (*FT_Raster_DoneFunc)( FT_Raster  raster );
1103
1104#define FT_Raster_Done_Func  FT_Raster_DoneFunc
1105
1106
1107  /*************************************************************************/
1108  /*                                                                       */
1109  /* <FuncType>                                                            */
1110  /*    FT_Raster_ResetFunc                                                */
1111  /*                                                                       */
1112  /* <Description>                                                         */
1113  /*    FreeType provides an area of memory called the `render pool',      */
1114  /*    available to all registered rasters.  This pool can be freely used */
1115  /*    during a given scan-conversion but is shared by all rasters.  Its  */
1116  /*    content is thus transient.                                         */
1117  /*                                                                       */
1118  /*    This function is called each time the render pool changes, or just */
1119  /*    after a new raster object is created.                              */
1120  /*                                                                       */
1121  /* <Input>                                                               */
1122  /*    raster    :: A handle to the new raster object.                    */
1123  /*                                                                       */
1124  /*    pool_base :: The address in memory of the render pool.             */
1125  /*                                                                       */
1126  /*    pool_size :: The size in bytes of the render pool.                 */
1127  /*                                                                       */
1128  /* <Note>                                                                */
1129  /*    Rasters can ignore the render pool and rely on dynamic memory      */
1130  /*    allocation if they want to (a handle to the memory allocator is    */
1131  /*    passed to the raster constructor).  However, this is not           */
1132  /*    recommended for efficiency purposes.                               */
1133  /*                                                                       */
1134  typedef void
1135  (*FT_Raster_ResetFunc)( FT_Raster       raster,
1136                          unsigned char*  pool_base,
1137                          unsigned long   pool_size );
1138
1139#define FT_Raster_Reset_Func  FT_Raster_ResetFunc
1140
1141
1142  /*************************************************************************/
1143  /*                                                                       */
1144  /* <FuncType>                                                            */
1145  /*    FT_Raster_SetModeFunc                                              */
1146  /*                                                                       */
1147  /* <Description>                                                         */
1148  /*    This function is a generic facility to change modes or attributes  */
1149  /*    in a given raster.  This can be used for debugging purposes, or    */
1150  /*    simply to allow implementation-specific `features' in a given      */
1151  /*    raster module.                                                     */
1152  /*                                                                       */
1153  /* <Input>                                                               */
1154  /*    raster :: A handle to the new raster object.                       */
1155  /*                                                                       */
1156  /*    mode   :: A 4-byte tag used to name the mode or property.          */
1157  /*                                                                       */
1158  /*    args   :: A pointer to the new mode/property to use.               */
1159  /*                                                                       */
1160  typedef int
1161  (*FT_Raster_SetModeFunc)( FT_Raster      raster,
1162                            unsigned long  mode,
1163                            void*          args );
1164
1165#define FT_Raster_Set_Mode_Func  FT_Raster_SetModeFunc
1166
1167
1168  /*************************************************************************/
1169  /*                                                                       */
1170  /* <FuncType>                                                            */
1171  /*    FT_Raster_RenderFunc                                               */
1172  /*                                                                       */
1173  /* <Description>                                                         */
1174  /*    Invoke a given raster to scan-convert a given glyph image into a   */
1175  /*    target bitmap.                                                     */
1176  /*                                                                       */
1177  /* <Input>                                                               */
1178  /*    raster :: A handle to the raster object.                           */
1179  /*                                                                       */
1180  /*    params :: A pointer to an @FT_Raster_Params structure used to      */
1181  /*              store the rendering parameters.                          */
1182  /*                                                                       */
1183  /* <Return>                                                              */
1184  /*    Error code.  0~means success.                                      */
1185  /*                                                                       */
1186  /* <Note>                                                                */
1187  /*    The exact format of the source image depends on the raster's glyph */
1188  /*    format defined in its @FT_Raster_Funcs structure.  It can be an    */
1189  /*    @FT_Outline or anything else in order to support a large array of  */
1190  /*    glyph formats.                                                     */
1191  /*                                                                       */
1192  /*    Note also that the render function can fail and return a           */
1193  /*    `FT_Err_Unimplemented_Feature' error code if the raster used does  */
1194  /*    not support direct composition.                                    */
1195  /*                                                                       */
1196  /*    XXX: For now, the standard raster doesn't support direct           */
1197  /*         composition but this should change for the final release (see */
1198  /*         the files `demos/src/ftgrays.c' and `demos/src/ftgrays2.c'    */
1199  /*         for examples of distinct implementations which support direct */
1200  /*         composition).                                                 */
1201  /*                                                                       */
1202  typedef int
1203  (*FT_Raster_RenderFunc)( FT_Raster                raster,
1204                           const FT_Raster_Params*  params );
1205
1206#define FT_Raster_Render_Func  FT_Raster_RenderFunc
1207
1208
1209  /*************************************************************************/
1210  /*                                                                       */
1211  /* <Struct>                                                              */
1212  /*    FT_Raster_Funcs                                                    */
1213  /*                                                                       */
1214  /* <Description>                                                         */
1215  /*   A structure used to describe a given raster class to the library.   */
1216  /*                                                                       */
1217  /* <Fields>                                                              */
1218  /*    glyph_format  :: The supported glyph format for this raster.       */
1219  /*                                                                       */
1220  /*    raster_new    :: The raster constructor.                           */
1221  /*                                                                       */
1222  /*    raster_reset  :: Used to reset the render pool within the raster.  */
1223  /*                                                                       */
1224  /*    raster_render :: A function to render a glyph into a given bitmap. */
1225  /*                                                                       */
1226  /*    raster_done   :: The raster destructor.                            */
1227  /*                                                                       */
1228  typedef struct  FT_Raster_Funcs_
1229  {
1230    FT_Glyph_Format        glyph_format;
1231    FT_Raster_NewFunc      raster_new;
1232    FT_Raster_ResetFunc    raster_reset;
1233    FT_Raster_SetModeFunc  raster_set_mode;
1234    FT_Raster_RenderFunc   raster_render;
1235    FT_Raster_DoneFunc     raster_done;
1236
1237  } FT_Raster_Funcs;
1238
1239
1240  /* */
1241
1242
1243FT_END_HEADER
1244
1245#endif /* __FTIMAGE_H__ */
1246
1247
1248/* END */
1249
1250
1251/* Local Variables: */
1252/* coding: utf-8    */
1253/* End:             */
Note: See TracBrowser for help on using the repository browser.