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-system_interface.html | 474 +++++++++++----------- 1 file changed, 232 insertions(+), 242 deletions(-) (limited to 'freetype/docs/reference/ft2-system_interface.html') diff --git a/freetype/docs/reference/ft2-system_interface.html b/freetype/docs/reference/ft2-system_interface.html index 05ce8320c..139cbc7f0 100644 --- a/freetype/docs/reference/ft2-system_interface.html +++ b/freetype/docs/reference/ft2-system_interface.html @@ -3,193 +3,222 @@ -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

-

-System Interface -

+

System Interface

Synopsis

- - - - - -
FT_MemoryFT_MemoryRecFT_Stream_CloseFunc
FT_Alloc_FuncFT_StreamFT_StreamRec
FT_Free_FuncFT_StreamDesc
FT_Realloc_FuncFT_Stream_IoFunc


- -
+ + + + + +
FT_MemoryFT_MemoryRecFT_Stream_CloseFunc
FT_Alloc_FuncFT_StreamFT_StreamRec
FT_Free_FuncFT_StreamDesc
FT_Realloc_FuncFT_Stream_IoFunc
+ +

This section contains various definitions related to memory management and i/o access. You need to understand this information if you want to use a custom memory manager or you own i/o streams.

-

-
-

FT_Memory

-
-Defined in FT_SYSTEM_H (ftsystem.h). -

-
 
+

+
FT_Memory

+
Defined in FT_SYSTEM_H (ftsystem.h).

+
   typedef struct FT_MemoryRec_*  FT_Memory;
+

 
-

-

A handle to a given memory manager object, defined with an FT_MemoryRec structure.

-

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

FT_Alloc_Func

-
-Defined in FT_SYSTEM_H (ftsystem.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_Alloc_Func

+
Defined in FT_SYSTEM_H (ftsystem.h).

+
   typedef void*
   (*FT_Alloc_Func)( FT_Memory  memory,
                     long       size );
+

 
-

-

A function used to allocate ‘size’ bytes from ‘memory’.

-

-
input
-

- -
memory + +

input

+ + -
memory

A handle to the source memory manager.

size +
size

The size in bytes to allocate.

-
-
return
+ +

return

Address of new memory block. 0 in case of failure.

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

FT_Free_Func

-
-Defined in FT_SYSTEM_H (ftsystem.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_Free_Func

+
Defined in FT_SYSTEM_H (ftsystem.h).

+
   typedef void
   (*FT_Free_Func)( FT_Memory  memory,
                    void*      block );
+

 
-

-

A function used to release a given block of memory.

-

-
input
-

- -
memory + +

input

+ + -
memory

A handle to the source memory manager.

block +
block

The address of the target memory block.

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

FT_Realloc_Func

-
-Defined in FT_SYSTEM_H (ftsystem.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_Realloc_Func

+
Defined in FT_SYSTEM_H (ftsystem.h).

+
   typedef void*
   (*FT_Realloc_Func)( FT_Memory  memory,
                       long       cur_size,
                       long       new_size,
                       void*      block );
+

 
-

-

A function used to re-allocate a given block of memory.

-

-
input
-

- -
memory + +

input

+ + - - -
memory

A handle to the source memory manager.

cur_size +
cur_size

The block's current size in bytes.

new_size +
new_size

The block's requested new size.

block +
block

The block's current address.

-
-
return
+ +

return

New block address. 0 in case of memory shortage.

-
-
note
+ +

note

In case of error, the old block must still be available.

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

FT_MemoryRec

-
-Defined in FT_SYSTEM_H (ftsystem.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_MemoryRec

+
Defined in FT_SYSTEM_H (ftsystem.h).

+
   struct  FT_MemoryRec_
   {
     void*            user;
@@ -197,158 +226,123 @@ Defined in FT_SYSTEM_H (ftsystem.h).
     FT_Free_Func     free;
     FT_Realloc_Func  realloc;
   };
+

 
-

-

A structure used to describe a given memory manager to FreeType 2.

-

-
fields
-

- -
user + +

fields

+ + - - -
user

A generic typeless pointer for user data.

alloc +
alloc

A pointer type to an allocation function.

free +
free

A pointer type to an memory freeing function.

realloc +
realloc

A pointer type to a reallocation function.

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

FT_Stream

-
-Defined in FT_SYSTEM_H (ftsystem.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_Stream

+
Defined in FT_SYSTEM_H (ftsystem.h).

+
   typedef struct FT_StreamRec_*  FT_Stream;
+

 
-

-

A handle to an input stream.

-

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

FT_StreamDesc

-
-Defined in FT_SYSTEM_H (ftsystem.h). -

-
 
+
also

+
See FT_StreamRec for the publicly accessible fields of a given stream object.

+
+

+
[Index][Top][TOC]

+
+

+
FT_StreamDesc

+
Defined in FT_SYSTEM_H (ftsystem.h).

+
   typedef union  FT_StreamDesc_
   {
     long   value;
     void*  pointer;
 
   } FT_StreamDesc;
+

 
-

-

A union type used to store either a long or a pointer. This is used to store a file descriptor or a ‘FILE*’ in an input stream.

-

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

FT_Stream_IoFunc

-
-Defined in FT_SYSTEM_H (ftsystem.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_Stream_IoFunc

+
Defined in FT_SYSTEM_H (ftsystem.h).

+
   typedef unsigned long
   (*FT_Stream_IoFunc)( FT_Stream       stream,
                        unsigned long   offset,
                        unsigned char*  buffer,
                        unsigned long   count );
+

 
-

-

A function used to seek and read data from a given input stream.

-

-
input
-

- -
stream + +

input

+ + - - -
stream

A handle to the source stream.

offset +
offset

The offset of read in stream (always from start).

buffer +
buffer

The address of the read buffer.

count +
count

The number of bytes to read from the stream.

-
-
return
+ +

return

The number of bytes effectively read by the stream.

-
-
note
+ +

note

This function might be called to perform a seek or skip operation with a ‘count’ of 0. A non-zero return value then indicates an error.

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

FT_Stream_CloseFunc

-
-Defined in FT_SYSTEM_H (ftsystem.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_Stream_CloseFunc

+
Defined in FT_SYSTEM_H (ftsystem.h).

+
   typedef void
   (*FT_Stream_CloseFunc)( FT_Stream  stream );
+

 
-

-

A function used to close a given input stream.

-

-
input
-

- -
stream + +

input

+ +
stream

A handle to the target stream.

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

FT_StreamRec

-
-Defined in FT_SYSTEM_H (ftsystem.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_StreamRec

+
Defined in FT_SYSTEM_H (ftsystem.h).

+
   typedef struct  FT_StreamRec_
   {
     unsigned char*       base;
@@ -365,51 +359,47 @@ Defined in FT_SYSTEM_H (ftsystem.h).
     unsigned char*       limit;
 
   } FT_StreamRec;
+

 
-

-

A structure used to describe an input stream.

-

-
input
-

- -
base + +

input

+ + - - - - - - - - -
base

For memory-based streams, this is the address of the first stream byte in memory. This field should always be set to NULL for disk-based streams.

size +
size

The stream size in bytes.

+

In case of compressed streams where the size is unknown before actually doing the decompression, the value is set to 0x7FFFFFFF. (Note that this size value can occur for normal streams also; it is thus just a hint.)

pos +
pos

The current position within the stream.

descriptor +
descriptor

This field is a union that can hold an integer or a pointer. It is used by stream implementations to store file descriptors or ‘FILE*’ pointers.

pathname +
pathname

This field is completely ignored by FreeType. However, it is often useful during debugging to use it to store the stream's filename (where available).

read +
read

The stream's input function.

close +
close

The stream's close function.

memory +
memory

The memory manager to use to preload frames. This is set internally by FreeType and shouldn't be touched by stream implementations.

cursor +
cursor

This field is set and used internally by FreeType when parsing frames.

limit +
limit

This field is set and used internally by FreeType when parsing frames.

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