sdk-world v2026.11.05
PS2 SDK - world tier (copyleft-allowed, non-essential packages)
Loading...
Searching...
No Matches
ftbzip2.h
Go to the documentation of this file.
1/****************************************************************************
2 *
3 * ftbzip2.h
4 *
5 * Bzip2-compressed stream support.
6 *
7 * Copyright (C) 2010-2025 by
8 * Joel Klinghed.
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
23#ifndef FTBZIP2_H_
24#define FTBZIP2_H_
25
26#include <freetype/freetype.h>
27
28#ifdef FREETYPE_H
29#error "freetype.h of FreeType 1 has been loaded!"
30#error "Please fix the directory search order for header files"
31#error "so that freetype.h of FreeType 2 is found first."
32#endif
33
34
35FT_BEGIN_HEADER
36
37 /**************************************************************************
38 *
39 * @section:
40 * bzip2
41 *
42 * @title:
43 * BZIP2 Streams
44 *
45 * @abstract:
46 * Using bzip2-compressed font files.
47 *
48 * @description:
49 * In certain builds of the library, bzip2 compression recognition is
50 * automatically handled when calling @FT_New_Face or @FT_Open_Face.
51 * This means that if no font driver is capable of handling the raw
52 * compressed file, the library will try to open a bzip2 compressed
53 * stream from it and re-open the face with it.
54 *
55 * The stream implementation is very basic and resets the decompression
56 * process each time seeking backwards is needed within the stream,
57 * which significantly undermines the performance.
58 *
59 * This section contains the declaration of Bzip2-specific functions.
60 *
61 */
62
63
64 /**************************************************************************
65 *
66 * @function:
67 * FT_Stream_OpenBzip2
68 *
69 * @description:
70 * Open a new stream to parse bzip2-compressed font files. This is
71 * mainly used to support the compressed `*.pcf.bz2` fonts that come with
72 * XFree86.
73 *
74 * @input:
75 * stream ::
76 * The target embedding stream.
77 *
78 * source ::
79 * The source stream.
80 *
81 * @return:
82 * FreeType error code. 0~means success.
83 *
84 * @note:
85 * The source stream must be opened _before_ calling this function.
86 *
87 * Calling the internal function `FT_Stream_Close` on the new stream will
88 * **not** call `FT_Stream_Close` on the source stream. None of the
89 * stream objects will be released to the heap.
90 *
91 * This function may return `FT_Err_Unimplemented_Feature` if your build
92 * of FreeType was not compiled with bzip2 support.
93 */
94 FT_EXPORT( FT_Error )
95 FT_Stream_OpenBzip2( FT_Stream stream,
96 FT_Stream source );
97
98 /* */
99
100
101FT_END_HEADER
102
103#endif /* FTBZIP2_H_ */
104
105
106/* END */