Clutter Engine 0.0.1
Loading...
Searching...
No Matches
ftmodapi.h
1/***************************************************************************/
2/* */
3/* ftmodapi.h */
4/* */
5/* FreeType modules public interface (specification). */
6/* */
7/* Copyright 1996-2016 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 FTMODAPI_H_
20#define FTMODAPI_H_
21
22
23#include <ft2build.h>
24#include FT_FREETYPE_H
25
26#ifdef FREETYPE_H
27#error "freetype.h of FreeType 1 has been loaded!"
28#error "Please fix the directory search order for header files"
29#error "so that freetype.h of FreeType 2 is found first."
30#endif
31
32
33FT_BEGIN_HEADER
34
35
36 /*************************************************************************/
37 /* */
38 /* <Section> */
39 /* module_management */
40 /* */
41 /* <Title> */
42 /* Module Management */
43 /* */
44 /* <Abstract> */
45 /* How to add, upgrade, remove, and control modules from FreeType. */
46 /* */
47 /* <Description> */
48 /* The definitions below are used to manage modules within FreeType. */
49 /* Modules can be added, upgraded, and removed at runtime. */
50 /* Additionally, some module properties can be controlled also. */
51 /* */
52 /* Here is a list of possible values of the `module_name' field in */
53 /* the @FT_Module_Class structure. */
54 /* */
55 /* { */
56 /* autofitter */
57 /* bdf */
58 /* cff */
59 /* gxvalid */
60 /* otvalid */
61 /* pcf */
62 /* pfr */
63 /* psaux */
64 /* pshinter */
65 /* psnames */
66 /* raster1 */
67 /* sfnt */
68 /* smooth, smooth-lcd, smooth-lcdv */
69 /* truetype */
70 /* type1 */
71 /* type42 */
72 /* t1cid */
73 /* winfonts */
74 /* } */
75 /* */
76 /* Note that the FreeType Cache sub-system is not a FreeType module. */
77 /* */
78 /* <Order> */
79 /* FT_Module */
80 /* FT_Module_Constructor */
81 /* FT_Module_Destructor */
82 /* FT_Module_Requester */
83 /* FT_Module_Class */
84 /* */
85 /* FT_Add_Module */
86 /* FT_Get_Module */
87 /* FT_Remove_Module */
88 /* FT_Add_Default_Modules */
89 /* */
90 /* FT_Property_Set */
91 /* FT_Property_Get */
92 /* */
93 /* FT_New_Library */
94 /* FT_Done_Library */
95 /* FT_Reference_Library */
96 /* */
97 /* FT_Renderer */
98 /* FT_Renderer_Class */
99 /* */
100 /* FT_Get_Renderer */
101 /* FT_Set_Renderer */
102 /* */
103 /* FT_Set_Debug_Hook */
104 /* */
105 /*************************************************************************/
106
107
108 /* module bit flags */
109#define FT_MODULE_FONT_DRIVER 1 /* this module is a font driver */
110#define FT_MODULE_RENDERER 2 /* this module is a renderer */
111#define FT_MODULE_HINTER 4 /* this module is a glyph hinter */
112#define FT_MODULE_STYLER 8 /* this module is a styler */
113
114#define FT_MODULE_DRIVER_SCALABLE 0x100 /* the driver supports */
115 /* scalable fonts */
116#define FT_MODULE_DRIVER_NO_OUTLINES 0x200 /* the driver does not */
117 /* support vector outlines */
118#define FT_MODULE_DRIVER_HAS_HINTER 0x400 /* the driver provides its */
119 /* own hinter */
120#define FT_MODULE_DRIVER_HINTS_LIGHTLY 0x800 /* the driver's hinter */
121 /* produces LIGHT hints */
122
123
124 /* deprecated values */
125#define ft_module_font_driver FT_MODULE_FONT_DRIVER
126#define ft_module_renderer FT_MODULE_RENDERER
127#define ft_module_hinter FT_MODULE_HINTER
128#define ft_module_styler FT_MODULE_STYLER
129
130#define ft_module_driver_scalable FT_MODULE_DRIVER_SCALABLE
131#define ft_module_driver_no_outlines FT_MODULE_DRIVER_NO_OUTLINES
132#define ft_module_driver_has_hinter FT_MODULE_DRIVER_HAS_HINTER
133#define ft_module_driver_hints_lightly FT_MODULE_DRIVER_HINTS_LIGHTLY
134
135
136 typedef FT_Pointer FT_Module_Interface;
137
138
139 /*************************************************************************/
140 /* */
141 /* <FuncType> */
142 /* FT_Module_Constructor */
143 /* */
144 /* <Description> */
145 /* A function used to initialize (not create) a new module object. */
146 /* */
147 /* <Input> */
148 /* module :: The module to initialize. */
149 /* */
150 typedef FT_Error
151 (*FT_Module_Constructor)( FT_Module module );
152
153
154 /*************************************************************************/
155 /* */
156 /* <FuncType> */
157 /* FT_Module_Destructor */
158 /* */
159 /* <Description> */
160 /* A function used to finalize (not destroy) a given module object. */
161 /* */
162 /* <Input> */
163 /* module :: The module to finalize. */
164 /* */
165 typedef void
166 (*FT_Module_Destructor)( FT_Module module );
167
168
169 /*************************************************************************/
170 /* */
171 /* <FuncType> */
172 /* FT_Module_Requester */
173 /* */
174 /* <Description> */
175 /* A function used to query a given module for a specific interface. */
176 /* */
177 /* <Input> */
178 /* module :: The module to be searched. */
179 /* */
180 /* name :: The name of the interface in the module. */
181 /* */
182 typedef FT_Module_Interface
183 (*FT_Module_Requester)( FT_Module module,
184 const char* name );
185
186
187 /*************************************************************************/
188 /* */
189 /* <Struct> */
190 /* FT_Module_Class */
191 /* */
192 /* <Description> */
193 /* The module class descriptor. */
194 /* */
195 /* <Fields> */
196 /* module_flags :: Bit flags describing the module. */
197 /* */
198 /* module_size :: The size of one module object/instance in */
199 /* bytes. */
200 /* */
201 /* module_name :: The name of the module. */
202 /* */
203 /* module_version :: The version, as a 16.16 fixed number */
204 /* (major.minor). */
205 /* */
206 /* module_requires :: The version of FreeType this module requires, */
207 /* as a 16.16 fixed number (major.minor). Starts */
208 /* at version 2.0, i.e., 0x20000. */
209 /* */
210 /* module_init :: The initializing function. */
211 /* */
212 /* module_done :: The finalizing function. */
213 /* */
214 /* get_interface :: The interface requesting function. */
215 /* */
216 typedef struct FT_Module_Class_
217 {
218 FT_ULong module_flags;
219 FT_Long module_size;
220 const FT_String* module_name;
221 FT_Fixed module_version;
222 FT_Fixed module_requires;
223
224 const void* module_interface;
225
226 FT_Module_Constructor module_init;
227 FT_Module_Destructor module_done;
228 FT_Module_Requester get_interface;
229
230 } FT_Module_Class;
231
232
233 /*************************************************************************/
234 /* */
235 /* <Function> */
236 /* FT_Add_Module */
237 /* */
238 /* <Description> */
239 /* Add a new module to a given library instance. */
240 /* */
241 /* <InOut> */
242 /* library :: A handle to the library object. */
243 /* */
244 /* <Input> */
245 /* clazz :: A pointer to class descriptor for the module. */
246 /* */
247 /* <Return> */
248 /* FreeType error code. 0~means success. */
249 /* */
250 /* <Note> */
251 /* An error will be returned if a module already exists by that name, */
252 /* or if the module requires a version of FreeType that is too great. */
253 /* */
254 FT_EXPORT( FT_Error )
255 FT_Add_Module( FT_Library library,
256 const FT_Module_Class* clazz );
257
258
259 /*************************************************************************/
260 /* */
261 /* <Function> */
262 /* FT_Get_Module */
263 /* */
264 /* <Description> */
265 /* Find a module by its name. */
266 /* */
267 /* <Input> */
268 /* library :: A handle to the library object. */
269 /* */
270 /* module_name :: The module's name (as an ASCII string). */
271 /* */
272 /* <Return> */
273 /* A module handle. 0~if none was found. */
274 /* */
275 /* <Note> */
276 /* FreeType's internal modules aren't documented very well, and you */
277 /* should look up the source code for details. */
278 /* */
279 FT_EXPORT( FT_Module )
280 FT_Get_Module( FT_Library library,
281 const char* module_name );
282
283
284 /*************************************************************************/
285 /* */
286 /* <Function> */
287 /* FT_Remove_Module */
288 /* */
289 /* <Description> */
290 /* Remove a given module from a library instance. */
291 /* */
292 /* <InOut> */
293 /* library :: A handle to a library object. */
294 /* */
295 /* <Input> */
296 /* module :: A handle to a module object. */
297 /* */
298 /* <Return> */
299 /* FreeType error code. 0~means success. */
300 /* */
301 /* <Note> */
302 /* The module object is destroyed by the function in case of success. */
303 /* */
304 FT_EXPORT( FT_Error )
305 FT_Remove_Module( FT_Library library,
306 FT_Module module );
307
308
309 /**********************************************************************
310 *
311 * @function:
312 * FT_Property_Set
313 *
314 * @description:
315 * Set a property for a given module.
316 *
317 * @input:
318 * library ::
319 * A handle to the library the module is part of.
320 *
321 * module_name ::
322 * The module name.
323 *
324 * property_name ::
325 * The property name. Properties are described in the `Synopsis'
326 * subsection of the module's documentation.
327 *
328 * Note that only a few modules have properties.
329 *
330 * value ::
331 * A generic pointer to a variable or structure that gives the new
332 * value of the property. The exact definition of `value' is
333 * dependent on the property; see the `Synopsis' subsection of the
334 * module's documentation.
335 *
336 * @return:
337 * FreeType error code. 0~means success.
338 *
339 * @note:
340 * If `module_name' isn't a valid module name, or `property_name'
341 * doesn't specify a valid property, or if `value' doesn't represent a
342 * valid value for the given property, an error is returned.
343 *
344 * The following example sets property `bar' (a simple integer) in
345 * module `foo' to value~1.
346 *
347 * {
348 * FT_UInt bar;
349 *
350 *
351 * bar = 1;
352 * FT_Property_Set( library, "foo", "bar", &bar );
353 * }
354 *
355 * Note that the FreeType Cache sub-system doesn't recognize module
356 * property changes. To avoid glyph lookup confusion within the cache
357 * you should call @FTC_Manager_Reset to completely flush the cache if
358 * a module property gets changed after @FTC_Manager_New has been
359 * called.
360 *
361 * It is not possible to set properties of the FreeType Cache
362 * sub-system itself with FT_Property_Set; use @FTC_Property_Set
363 * instead.
364 *
365 * @since:
366 * 2.4.11
367 *
368 */
369 FT_EXPORT( FT_Error )
370 FT_Property_Set( FT_Library library,
371 const FT_String* module_name,
372 const FT_String* property_name,
373 const void* value );
374
375
376 /**********************************************************************
377 *
378 * @function:
379 * FT_Property_Get
380 *
381 * @description:
382 * Get a module's property value.
383 *
384 * @input:
385 * library ::
386 * A handle to the library the module is part of.
387 *
388 * module_name ::
389 * The module name.
390 *
391 * property_name ::
392 * The property name. Properties are described in the `Synopsis'
393 * subsection of the module's documentation.
394 *
395 * @inout:
396 * value ::
397 * A generic pointer to a variable or structure that gives the
398 * value of the property. The exact definition of `value' is
399 * dependent on the property; see the `Synopsis' subsection of the
400 * module's documentation.
401 *
402 * @return:
403 * FreeType error code. 0~means success.
404 *
405 * @note:
406 * If `module_name' isn't a valid module name, or `property_name'
407 * doesn't specify a valid property, or if `value' doesn't represent a
408 * valid value for the given property, an error is returned.
409 *
410 * The following example gets property `baz' (a range) in module `foo'.
411 *
412 * {
413 * typedef range_
414 * {
415 * FT_Int32 min;
416 * FT_Int32 max;
417 *
418 * } range;
419 *
420 * range baz;
421 *
422 *
423 * FT_Property_Get( library, "foo", "baz", &baz );
424 * }
425 *
426 * It is not possible to retrieve properties of the FreeType Cache
427 * sub-system with FT_Property_Get; use @FTC_Property_Get instead.
428 *
429 * @since:
430 * 2.4.11
431 *
432 */
433 FT_EXPORT( FT_Error )
434 FT_Property_Get( FT_Library library,
435 const FT_String* module_name,
436 const FT_String* property_name,
437 void* value );
438
439
440 /*************************************************************************/
441 /* */
442 /* <Function> */
443 /* FT_Reference_Library */
444 /* */
445 /* <Description> */
446 /* A counter gets initialized to~1 at the time an @FT_Library */
447 /* structure is created. This function increments the counter. */
448 /* @FT_Done_Library then only destroys a library if the counter is~1, */
449 /* otherwise it simply decrements the counter. */
450 /* */
451 /* This function helps in managing life-cycles of structures that */
452 /* reference @FT_Library objects. */
453 /* */
454 /* <Input> */
455 /* library :: A handle to a target library object. */
456 /* */
457 /* <Return> */
458 /* FreeType error code. 0~means success. */
459 /* */
460 /* <Since> */
461 /* 2.4.2 */
462 /* */
463 FT_EXPORT( FT_Error )
464 FT_Reference_Library( FT_Library library );
465
466
467 /*************************************************************************/
468 /* */
469 /* <Function> */
470 /* FT_New_Library */
471 /* */
472 /* <Description> */
473 /* This function is used to create a new FreeType library instance */
474 /* from a given memory object. It is thus possible to use libraries */
475 /* with distinct memory allocators within the same program. Note, */
476 /* however, that the used @FT_Memory structure is expected to remain */
477 /* valid for the life of the @FT_Library object. */
478 /* */
479 /* Normally, you would call this function (followed by a call to */
480 /* @FT_Add_Default_Modules or a series of calls to @FT_Add_Module) */
481 /* instead of @FT_Init_FreeType to initialize the FreeType library. */
482 /* */
483 /* Don't use @FT_Done_FreeType but @FT_Done_Library to destroy a */
484 /* library instance. */
485 /* */
486 /* <Input> */
487 /* memory :: A handle to the original memory object. */
488 /* */
489 /* <Output> */
490 /* alibrary :: A pointer to handle of a new library object. */
491 /* */
492 /* <Return> */
493 /* FreeType error code. 0~means success. */
494 /* */
495 /* <Note> */
496 /* See the discussion of reference counters in the description of */
497 /* @FT_Reference_Library. */
498 /* */
499 FT_EXPORT( FT_Error )
500 FT_New_Library( FT_Memory memory,
501 FT_Library *alibrary );
502
503
504 /*************************************************************************/
505 /* */
506 /* <Function> */
507 /* FT_Done_Library */
508 /* */
509 /* <Description> */
510 /* Discard a given library object. This closes all drivers and */
511 /* discards all resource objects. */
512 /* */
513 /* <Input> */
514 /* library :: A handle to the target library. */
515 /* */
516 /* <Return> */
517 /* FreeType error code. 0~means success. */
518 /* */
519 /* <Note> */
520 /* See the discussion of reference counters in the description of */
521 /* @FT_Reference_Library. */
522 /* */
523 FT_EXPORT( FT_Error )
524 FT_Done_Library( FT_Library library );
525
526 /* */
527
528 typedef void
529 (*FT_DebugHook_Func)( void* arg );
530
531
532 /*************************************************************************/
533 /* */
534 /* <Function> */
535 /* FT_Set_Debug_Hook */
536 /* */
537 /* <Description> */
538 /* Set a debug hook function for debugging the interpreter of a font */
539 /* format. */
540 /* */
541 /* <InOut> */
542 /* library :: A handle to the library object. */
543 /* */
544 /* <Input> */
545 /* hook_index :: The index of the debug hook. You should use the */
546 /* values defined in `ftobjs.h', e.g., */
547 /* `FT_DEBUG_HOOK_TRUETYPE'. */
548 /* */
549 /* debug_hook :: The function used to debug the interpreter. */
550 /* */
551 /* <Note> */
552 /* Currently, four debug hook slots are available, but only two (for */
553 /* the TrueType and the Type~1 interpreter) are defined. */
554 /* */
555 /* Since the internal headers of FreeType are no longer installed, */
556 /* the symbol `FT_DEBUG_HOOK_TRUETYPE' isn't available publicly. */
557 /* This is a bug and will be fixed in a forthcoming release. */
558 /* */
559 FT_EXPORT( void )
560 FT_Set_Debug_Hook( FT_Library library,
561 FT_UInt hook_index,
562 FT_DebugHook_Func debug_hook );
563
564
565 /*************************************************************************/
566 /* */
567 /* <Function> */
568 /* FT_Add_Default_Modules */
569 /* */
570 /* <Description> */
571 /* Add the set of default drivers to a given library object. */
572 /* This is only useful when you create a library object with */
573 /* @FT_New_Library (usually to plug a custom memory manager). */
574 /* */
575 /* <InOut> */
576 /* library :: A handle to a new library object. */
577 /* */
578 FT_EXPORT( void )
579 FT_Add_Default_Modules( FT_Library library );
580
581
582
583 /**************************************************************************
584 *
585 * @section:
586 * truetype_engine
587 *
588 * @title:
589 * The TrueType Engine
590 *
591 * @abstract:
592 * TrueType bytecode support.
593 *
594 * @description:
595 * This section contains a function used to query the level of TrueType
596 * bytecode support compiled in this version of the library.
597 *
598 */
599
600
601 /**************************************************************************
602 *
603 * @enum:
604 * FT_TrueTypeEngineType
605 *
606 * @description:
607 * A list of values describing which kind of TrueType bytecode
608 * engine is implemented in a given FT_Library instance. It is used
609 * by the @FT_Get_TrueType_Engine_Type function.
610 *
611 * @values:
612 * FT_TRUETYPE_ENGINE_TYPE_NONE ::
613 * The library doesn't implement any kind of bytecode interpreter.
614 *
615 * FT_TRUETYPE_ENGINE_TYPE_UNPATENTED ::
616 * Deprecated and removed.
617 *
618 * FT_TRUETYPE_ENGINE_TYPE_PATENTED ::
619 * The library implements a bytecode interpreter that covers
620 * the full instruction set of the TrueType virtual machine (this
621 * was governed by patents until May 2010, hence the name).
622 *
623 * @since:
624 * 2.2
625 *
626 */
627 typedef enum FT_TrueTypeEngineType_
628 {
629 FT_TRUETYPE_ENGINE_TYPE_NONE = 0,
630 FT_TRUETYPE_ENGINE_TYPE_UNPATENTED,
631 FT_TRUETYPE_ENGINE_TYPE_PATENTED
632
633 } FT_TrueTypeEngineType;
634
635
636 /**************************************************************************
637 *
638 * @func:
639 * FT_Get_TrueType_Engine_Type
640 *
641 * @description:
642 * Return an @FT_TrueTypeEngineType value to indicate which level of
643 * the TrueType virtual machine a given library instance supports.
644 *
645 * @input:
646 * library ::
647 * A library instance.
648 *
649 * @return:
650 * A value indicating which level is supported.
651 *
652 * @since:
653 * 2.2
654 *
655 */
656 FT_EXPORT( FT_TrueTypeEngineType )
657 FT_Get_TrueType_Engine_Type( FT_Library library );
658
659 /* */
660
661
662FT_END_HEADER
663
664#endif /* FTMODAPI_H_ */
665
666
667/* END */
FT_Module_Class_
Definition ftmodapi.h:217
Generated by doxygen 1.12.0