FreeType » Docs » Support API » GZIP Streams
GZIP Streams¶
Synopsis¶
This section contains the declaration of Gzip-specific functions.
FT_Stream_OpenGzip¶
Defined in FT_GZIP_H (freetype/ftgzip.h).
Open a new stream to parse gzip-compressed font files. This is mainly used to support the compressed *.pcf.gz
fonts that come with XFree86.
input
stream |
The target embedding stream. |
source |
The source stream. |
return
FreeType error code. 0 means success.
note
The source stream must be opened before calling this function.
Calling the internal function FT_Stream_Close
on the new stream will not call FT_Stream_Close
on the source stream. None of the stream objects will be released to the heap.
The stream implementation is very basic and resets the decompression process each time seeking backwards is needed within the stream.
In certain builds of the library, gzip compression recognition is automatically handled when calling FT_New_Face
or FT_Open_Face
. This means that if no font driver is capable of handling the raw compressed file, the library will try to open a gzipped stream from it and re-open the face with it.
This function may return FT_Err_Unimplemented_Feature
if your build of FreeType was not compiled with zlib support.
FT_Gzip_Uncompress¶
Defined in FT_GZIP_H (freetype/ftgzip.h).
FT_EXPORT( FT_Error )
FT_Gzip_Uncompress( FT_Memory memory,
FT_Byte* output,
FT_ULong* output_len,
const FT_Byte* input,
FT_ULong input_len );
Decompress a zipped input buffer into an output buffer. This function is modeled after zlib's uncompress
function.
input
memory |
A FreeType memory handle. |
input |
The input buffer. |
input_len |
The length of the input buffer. |
output
output |
The output buffer. |
inout
output_len |
Before calling the function, this is the total size of the output buffer, which must be large enough to hold the entire uncompressed data (so the size of the uncompressed data must be known in advance). After calling the function, |
return
FreeType error code. 0 means success.
note
This function may return FT_Err_Unimplemented_Feature
if your build of FreeType was not compiled with zlib support.
since
2.5.1