From 360fe27b55c93c9c6c86895dbbf5db3efc66cc43 Mon Sep 17 00:00:00 2001 From: Mike DePaulo Date: Sat, 28 Feb 2015 07:31:25 -0500 Subject: Updated to freetype 2.5.5 Conflicts: freetype/src/base/ftbdf.c freetype/src/base/fttype1.c freetype/src/pfr/pfrobjs.c --- freetype/docs/reference/ft2-gzip.html | 213 ++++++++++++++++++++-------------- 1 file changed, 129 insertions(+), 84 deletions(-) (limited to 'freetype/docs/reference/ft2-gzip.html') diff --git a/freetype/docs/reference/ft2-gzip.html b/freetype/docs/reference/ft2-gzip.html index 6a0c6d249..c7e5a84f3 100644 --- a/freetype/docs/reference/ft2-gzip.html +++ b/freetype/docs/reference/ft2-gzip.html @@ -3,152 +3,197 @@ -FreeType-2.5.3 API Reference +FreeType-2.5.5 API Reference - - -
[Index][TOC]
-

FreeType-2.5.3 API Reference

+ +

FreeType-2.5.5 API Reference

-

-GZIP Streams -

+

GZIP Streams

Synopsis

- - -
FT_Stream_OpenGzipFT_Gzip_Uncompress


+ + +
FT_Stream_OpenGzipFT_Gzip_Uncompress
+ -

This section contains the declaration of Gzip-specific functions.

-

-
-

FT_Stream_OpenGzip

-
-Defined in FT_GZIP_H (ftgzip.h). -

-
 
+
+

FT_Stream_OpenGzip

+

Defined in FT_GZIP_H (ftgzip.h).

+
   FT_EXPORT( FT_Error )
   FT_Stream_OpenGzip( FT_Stream  stream,
                       FT_Stream  source );
+
-

-

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 + +

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, 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.

-
-
-
- - -
[Index][TOC]
- -
-

FT_Gzip_Uncompress

-
-Defined in FT_GZIP_H (ftgzip.h). -

-
 
+
+ + +
+

FT_Gzip_Uncompress

+

Defined in FT_GZIP_H (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 + +

input

+ + - -
memory

A FreeType memory handle.

input +
input

The input buffer.

input_len +
input_len

The length of the input buffer.

-
-
output
-

- -
output + +

output

+ +
output

The output buffer.

-
-
inout
-

- -
output_len + +

inout

+ +
output_len

Before calling the function, this is the 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, ‘output_len’ is the size of the used data in ‘output’.

-
-
return
+ +

return

FreeType error code. 0 means success.

-
-
note
+ +

note

This function may return ‘FT_Err_Unimplemented_Feature’ if your build of FreeType was not compiled with zlib support.

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