ReactOS  0.4.14-dev-390-g34947ad
ftrender.h
Go to the documentation of this file.
1 /***************************************************************************/
2 /* */
3 /* ftrender.h */
4 /* */
5 /* FreeType renderer modules public interface (specification). */
6 /* */
7 /* Copyright 1996-2018 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
9 /* */
10 /* This file is part of the FreeType project, and may only be used, */
11 /* modified, and distributed under the terms of the FreeType project */
12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
13 /* this file you indicate that you have read the license and */
14 /* understand and accept it fully. */
15 /* */
16 /***************************************************************************/
17 
18 
19 #ifndef FTRENDER_H_
20 #define FTRENDER_H_
21 
22 
23 #include <ft2build.h>
24 #include FT_MODULE_H
25 #include FT_GLYPH_H
26 
27 
29 
30 
31  /*************************************************************************/
32  /* */
33  /* <Section> */
34  /* module_management */
35  /* */
36  /*************************************************************************/
37 
38 
39  /* create a new glyph object */
40  typedef FT_Error
43 
44  /* destroys a given glyph object */
45  typedef void
47 
48  typedef void
50  const FT_Matrix* matrix,
51  const FT_Vector* delta );
52 
53  typedef void
55  FT_BBox* abbox );
56 
57  typedef FT_Error
59  FT_Glyph target );
60 
61  typedef FT_Error
64 
65 /* deprecated */
66 #define FT_Glyph_Init_Func FT_Glyph_InitFunc
67 #define FT_Glyph_Done_Func FT_Glyph_DoneFunc
68 #define FT_Glyph_Transform_Func FT_Glyph_TransformFunc
69 #define FT_Glyph_BBox_Func FT_Glyph_GetBBoxFunc
70 #define FT_Glyph_Copy_Func FT_Glyph_CopyFunc
71 #define FT_Glyph_Prepare_Func FT_Glyph_PrepareFunc
72 
73 
75  {
78 
85  };
86 
87 
88  typedef FT_Error
92  const FT_Vector* origin );
93 
94  typedef FT_Error
97  const FT_Matrix* matrix,
98  const FT_Vector* delta );
99 
100 
101  typedef void
104  FT_BBox* cbox );
105 
106 
107  typedef FT_Error
109  FT_ULong mode_tag,
110  FT_Pointer mode_ptr );
111 
112 /* deprecated identifiers */
113 #define FTRenderer_render FT_Renderer_RenderFunc
114 #define FTRenderer_transform FT_Renderer_TransformFunc
115 #define FTRenderer_getCBox FT_Renderer_GetCBoxFunc
116 #define FTRenderer_setMode FT_Renderer_SetModeFunc
117 
118 
119  /*************************************************************************/
120  /* */
121  /* <Struct> */
122  /* FT_Renderer_Class */
123  /* */
124  /* <Description> */
125  /* The renderer module class descriptor. */
126  /* */
127  /* <Fields> */
128  /* root :: The root @FT_Module_Class fields. */
129  /* */
130  /* glyph_format :: The glyph image format this renderer handles. */
131  /* */
132  /* render_glyph :: A method used to render the image that is in a */
133  /* given glyph slot into a bitmap. */
134  /* */
135  /* transform_glyph :: A method used to transform the image that is in */
136  /* a given glyph slot. */
137  /* */
138  /* get_glyph_cbox :: A method used to access the glyph's cbox. */
139  /* */
140  /* set_mode :: A method used to pass additional parameters. */
141  /* */
142  /* raster_class :: For @FT_GLYPH_FORMAT_OUTLINE renderers only. */
143  /* This is a pointer to its raster's class. */
144  /* */
145  typedef struct FT_Renderer_Class_
146  {
148 
150 
155 
157 
159 
160 
161  /*************************************************************************/
162  /* */
163  /* <Function> */
164  /* FT_Get_Renderer */
165  /* */
166  /* <Description> */
167  /* Retrieve the current renderer for a given glyph format. */
168  /* */
169  /* <Input> */
170  /* library :: A handle to the library object. */
171  /* */
172  /* format :: The glyph format. */
173  /* */
174  /* <Return> */
175  /* A renderer handle. 0~if none found. */
176  /* */
177  /* <Note> */
178  /* An error will be returned if a module already exists by that name, */
179  /* or if the module requires a version of FreeType that is too great. */
180  /* */
181  /* To add a new renderer, simply use @FT_Add_Module. To retrieve a */
182  /* renderer by its name, use @FT_Get_Module. */
183  /* */
187 
188 
189  /*************************************************************************/
190  /* */
191  /* <Function> */
192  /* FT_Set_Renderer */
193  /* */
194  /* <Description> */
195  /* Set the current renderer to use, and set additional mode. */
196  /* */
197  /* <InOut> */
198  /* library :: A handle to the library object. */
199  /* */
200  /* <Input> */
201  /* renderer :: A handle to the renderer object. */
202  /* */
203  /* num_params :: The number of additional parameters. */
204  /* */
205  /* parameters :: Additional parameters. */
206  /* */
207  /* <Return> */
208  /* FreeType error code. 0~means success. */
209  /* */
210  /* <Note> */
211  /* In case of success, the renderer will be used to convert glyph */
212  /* images in the renderer's known format into bitmaps. */
213  /* */
214  /* This doesn't change the current renderer for other formats. */
215  /* */
216  /* Currently, no FreeType renderer module uses `parameters'; you */
217  /* should thus always pass NULL as the value. */
218  /* */
221  FT_Renderer renderer,
222  FT_UInt num_params,
223  FT_Parameter* parameters );
224 
225  /* */
226 
227 
229 
230 #endif /* FTRENDER_H_ */
231 
232 
233 /* END */
int FT_Error
Definition: fttypes.h:300
void(* FT_Glyph_DoneFunc)(FT_Glyph glyph)
Definition: ftrender.h:46
signed long FT_Long
Definition: fttypes.h:242
unsigned long FT_ULong
Definition: fttypes.h:253
struct png_info_def **typedef void(__cdecl typeof(png_destroy_read_struct))(struct png_struct_def **
Definition: typeof.h:49
FT_Glyph_DoneFunc glyph_done
Definition: ftrender.h:80
FT_Glyph_TransformFunc glyph_transform
Definition: ftrender.h:82
FT_Error(* FT_Glyph_PrepareFunc)(FT_Glyph glyph, FT_GlyphSlot slot)
Definition: ftrender.h:62
#define FT_END_HEADER
Definition: ftheader.h:54
struct _slot slot
Definition: vfat.h:196
GLuint GLenum matrix
Definition: glext.h:9407
enum FT_Render_Mode_ FT_Render_Mode
FT_Renderer_GetCBoxFunc get_glyph_cbox
Definition: ftrender.h:153
voidpf uLong int origin
Definition: ioapi.h:142
FT_BBox * abbox
Definition: ftbbox.c:443
FT_Library library
Definition: cffdrivr.c:654
GLint GLint GLsizei GLsizei GLsizei GLint GLenum format
Definition: gl.h:1546
void(* FT_Renderer_GetCBoxFunc)(FT_Renderer renderer, FT_GlyphSlot slot, FT_BBox *cbox)
Definition: ftrender.h:102
FT_Glyph_Format glyph_format
Definition: ftrender.h:149
#define FT_BEGIN_HEADER
Definition: ftheader.h:36
FT_Raster_Funcs * raster_class
Definition: ftrender.h:156
FT_BEGIN_HEADER typedef FT_Error(* FT_Glyph_InitFunc)(FT_Glyph glyph, FT_GlyphSlot slot)
Definition: ftrender.h:41
void(* FT_Glyph_TransformFunc)(FT_Glyph glyph, const FT_Matrix *matrix, const FT_Vector *delta)
Definition: ftrender.h:49
FT_Error(* FT_Glyph_CopyFunc)(FT_Glyph source, FT_Glyph target)
Definition: ftrender.h:58
FT_Renderer_SetModeFunc set_mode
Definition: ftrender.h:154
FT_Glyph_InitFunc glyph_init
Definition: ftrender.h:79
FT_Glyph_Format glyph_format
Definition: ftrender.h:77
void(* FT_Glyph_GetBBoxFunc)(FT_Glyph glyph, FT_BBox *abbox)
Definition: ftrender.h:54
FT_Glyph_GetBBoxFunc glyph_bbox
Definition: ftrender.h:83
FT_Renderer_RenderFunc render_glyph
Definition: ftrender.h:151
FT_Module_Class root
Definition: ftrender.h:147
FT_Glyph_CopyFunc glyph_copy
Definition: ftrender.h:81
struct FT_Renderer_Class_ FT_Renderer_Class
GLenum mode
Definition: glext.h:6217
FT_Error(* FT_Renderer_SetModeFunc)(FT_Renderer renderer, FT_ULong mode_tag, FT_Pointer mode_ptr)
Definition: ftrender.h:108
unsigned int FT_UInt
Definition: fttypes.h:231
GLsizei GLsizei GLchar * source
Definition: glext.h:6048
#define FT_EXPORT(x)
Definition: ftconfig.h:461
enum FT_Glyph_Format_ FT_Glyph_Format
FT_Glyph_PrepareFunc glyph_prepare
Definition: ftrender.h:84
FT_Renderer_TransformFunc transform_glyph
Definition: ftrender.h:152
FT_Error(* FT_Renderer_TransformFunc)(FT_Renderer renderer, FT_GlyphSlot slot, const FT_Matrix *matrix, const FT_Vector *delta)
Definition: ftrender.h:95
GLenum target
Definition: glext.h:7315
FT_Error(* FT_Renderer_RenderFunc)(FT_Renderer renderer, FT_GlyphSlot slot, FT_Render_Mode mode, const FT_Vector *origin)
Definition: ftrender.h:89
FT_Long glyph_size
Definition: ftrender.h:76
FT_Get_Renderer(FT_Library library, FT_Glyph_Format format)
Definition: ftobjs.c:4416
FT_Set_Renderer(FT_Library library, FT_Renderer renderer, FT_UInt num_params, FT_Parameter *parameters)
Definition: ftobjs.c:4428