From 462f18c7b25fe3e467f837647d07ab0a78aa8d2b Mon Sep 17 00:00:00 2001 From: marha Date: Sun, 22 Feb 2015 21:39:56 +0100 Subject: Merged origin/release (checked in because wanted to merge new stuff) --- freetype/docs/reference/ft2-bzip2.html | 151 ++++++++++++++++++++++----------- 1 file changed, 103 insertions(+), 48 deletions(-) (limited to 'freetype/docs/reference/ft2-bzip2.html') diff --git a/freetype/docs/reference/ft2-bzip2.html b/freetype/docs/reference/ft2-bzip2.html index 59e15464e..dc33973b1 100644 --- a/freetype/docs/reference/ft2-bzip2.html +++ b/freetype/docs/reference/ft2-bzip2.html @@ -3,92 +3,147 @@ -FreeType-2.5.3 API Reference +FreeType-2.5.5 API Reference - - -
[Index][TOC]
-

FreeType-2.5.3 API Reference

+
[Index][TOC]
+

FreeType-2.5.5 API Reference

-

-BZIP2 Streams -

+

BZIP2 Streams

Synopsis

- - -
FT_Stream_OpenBzip2


+ + +
FT_Stream_OpenBzip2
+ -

This section contains the declaration of Bzip2-specific functions.

-

-
-

FT_Stream_OpenBzip2

-
-Defined in FT_BZIP2_H (ftbzip2.h). -

-
 
+

+
FT_Stream_OpenBzip2

+
Defined in FT_BZIP2_H (ftbzip2.h).

+
   FT_EXPORT( FT_Error )
   FT_Stream_OpenBzip2( FT_Stream  stream,
                        FT_Stream  source );
+

 
-

-

Open a new stream to parse bzip2-compressed font files. This is mainly used to support the compressed ‘*.pcf.bz2’ fonts that come with XFree86.

-

-
input
-

- -
stream + +

input

+ + -
stream

The target embedding stream.

source +
source

The source stream.

-
-
return
+ +

return

FreeType error code. 0 means success.

-
-
note
+ +

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, bzip2 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 bzip2 compressed 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 bzip2 support.

-
-
-
- - -
[Index][TOC]
+ +
+
[Index][Top][TOC]
-- cgit v1.2.3