| rev |
line source |
|
nuclear@0
|
1 /***************************************************************************/
|
|
nuclear@0
|
2 /* */
|
|
nuclear@0
|
3 /* ftlzw.h */
|
|
nuclear@0
|
4 /* */
|
|
nuclear@0
|
5 /* LZW-compressed stream support. */
|
|
nuclear@0
|
6 /* */
|
|
nuclear@0
|
7 /* Copyright 2004, 2006 by */
|
|
nuclear@0
|
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
|
|
nuclear@0
|
9 /* */
|
|
nuclear@0
|
10 /* This file is part of the FreeType project, and may only be used, */
|
|
nuclear@0
|
11 /* modified, and distributed under the terms of the FreeType project */
|
|
nuclear@0
|
12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
|
|
nuclear@0
|
13 /* this file you indicate that you have read the license and */
|
|
nuclear@0
|
14 /* understand and accept it fully. */
|
|
nuclear@0
|
15 /* */
|
|
nuclear@0
|
16 /***************************************************************************/
|
|
nuclear@0
|
17
|
|
nuclear@0
|
18
|
|
nuclear@0
|
19 #ifndef __FTLZW_H__
|
|
nuclear@0
|
20 #define __FTLZW_H__
|
|
nuclear@0
|
21
|
|
nuclear@0
|
22 #include <ft2build.h>
|
|
nuclear@0
|
23 #include FT_FREETYPE_H
|
|
nuclear@0
|
24
|
|
nuclear@0
|
25 #ifdef FREETYPE_H
|
|
nuclear@0
|
26 #error "freetype.h of FreeType 1 has been loaded!"
|
|
nuclear@0
|
27 #error "Please fix the directory search order for header files"
|
|
nuclear@0
|
28 #error "so that freetype.h of FreeType 2 is found first."
|
|
nuclear@0
|
29 #endif
|
|
nuclear@0
|
30
|
|
nuclear@0
|
31
|
|
nuclear@0
|
32 FT_BEGIN_HEADER
|
|
nuclear@0
|
33
|
|
nuclear@0
|
34 /*************************************************************************/
|
|
nuclear@0
|
35 /* */
|
|
nuclear@0
|
36 /* <Section> */
|
|
nuclear@0
|
37 /* lzw */
|
|
nuclear@0
|
38 /* */
|
|
nuclear@0
|
39 /* <Title> */
|
|
nuclear@0
|
40 /* LZW Streams */
|
|
nuclear@0
|
41 /* */
|
|
nuclear@0
|
42 /* <Abstract> */
|
|
nuclear@0
|
43 /* Using LZW-compressed font files. */
|
|
nuclear@0
|
44 /* */
|
|
nuclear@0
|
45 /* <Description> */
|
|
nuclear@0
|
46 /* This section contains the declaration of LZW-specific functions. */
|
|
nuclear@0
|
47 /* */
|
|
nuclear@0
|
48 /*************************************************************************/
|
|
nuclear@0
|
49
|
|
nuclear@0
|
50 /************************************************************************
|
|
nuclear@0
|
51 *
|
|
nuclear@0
|
52 * @function:
|
|
nuclear@0
|
53 * FT_Stream_OpenLZW
|
|
nuclear@0
|
54 *
|
|
nuclear@0
|
55 * @description:
|
|
nuclear@0
|
56 * Open a new stream to parse LZW-compressed font files. This is
|
|
nuclear@0
|
57 * mainly used to support the compressed `*.pcf.Z' fonts that come
|
|
nuclear@0
|
58 * with XFree86.
|
|
nuclear@0
|
59 *
|
|
nuclear@0
|
60 * @input:
|
|
nuclear@0
|
61 * stream :: The target embedding stream.
|
|
nuclear@0
|
62 *
|
|
nuclear@0
|
63 * source :: The source stream.
|
|
nuclear@0
|
64 *
|
|
nuclear@0
|
65 * @return:
|
|
nuclear@0
|
66 * FreeType error code. 0~means success.
|
|
nuclear@0
|
67 *
|
|
nuclear@0
|
68 * @note:
|
|
nuclear@0
|
69 * The source stream must be opened _before_ calling this function.
|
|
nuclear@0
|
70 *
|
|
nuclear@0
|
71 * Calling the internal function `FT_Stream_Close' on the new stream will
|
|
nuclear@0
|
72 * *not* call `FT_Stream_Close' on the source stream. None of the stream
|
|
nuclear@0
|
73 * objects will be released to the heap.
|
|
nuclear@0
|
74 *
|
|
nuclear@0
|
75 * The stream implementation is very basic and resets the decompression
|
|
nuclear@0
|
76 * process each time seeking backwards is needed within the stream
|
|
nuclear@0
|
77 *
|
|
nuclear@0
|
78 * In certain builds of the library, LZW compression recognition is
|
|
nuclear@0
|
79 * automatically handled when calling @FT_New_Face or @FT_Open_Face.
|
|
nuclear@0
|
80 * This means that if no font driver is capable of handling the raw
|
|
nuclear@0
|
81 * compressed file, the library will try to open a LZW stream from it
|
|
nuclear@0
|
82 * and re-open the face with it.
|
|
nuclear@0
|
83 *
|
|
nuclear@0
|
84 * This function may return `FT_Err_Unimplemented_Feature' if your build
|
|
nuclear@0
|
85 * of FreeType was not compiled with LZW support.
|
|
nuclear@0
|
86 */
|
|
nuclear@0
|
87 FT_EXPORT( FT_Error )
|
|
nuclear@0
|
88 FT_Stream_OpenLZW( FT_Stream stream,
|
|
nuclear@0
|
89 FT_Stream source );
|
|
nuclear@0
|
90
|
|
nuclear@0
|
91 /* */
|
|
nuclear@0
|
92
|
|
nuclear@0
|
93
|
|
nuclear@0
|
94 FT_END_HEADER
|
|
nuclear@0
|
95
|
|
nuclear@0
|
96 #endif /* __FTLZW_H__ */
|
|
nuclear@0
|
97
|
|
nuclear@0
|
98
|
|
nuclear@0
|
99 /* END */
|
