cheshirekow  v0.1.0
freetype Namespace Reference

root namespace for freetype More...

Namespaces

 curve_tag
 A list of constants used to describe curve tags.
 
 encoding
 An enumeration used to specify character sets supported by charmaps. Used in the FT_Select_Charmap API function.
 
 faceflag
 A list of bit flags used in the ‘face_flags’ field of the FT_FaceRec structure. They inform client applications of properties of the corresponding face.
 
 fstype
 A list of bit flags used in the ‘fsType’ field of the OS/2 table in a TrueType or OpenType font and the ‘FSType’ entry in a PostScript font.
 
 glyphformat
 namespace wrapper for GlyphFormat enumeration
 
 kerning_mode
 An enumeration used to specify which kerning values to return in FT_Get_Kerning.
 
 load
 A list of bit-field constants used with FT_Load_Glyph to indicate what kind of operations to perform during glyph loading.
 
 load_target
 A list of values that are used to select a specific hinting algorithm to use by the hinter. You should OR one of these values to your ‘load_flags’ when calling FT_Load_Glyph.
 
 pixelmode
 namespace wrapper for PixelMode enumeration
 
 render_mode
 An enumeration type that lists the render modes supported by FreeType 2.
 
 size_request_type
 namespace wrapper for SizeRequestType
 
 styleflag
 A list of bit-flags used to indicate the style of a given face. These are used in the ‘style_flags’ field of FT_FaceRec.
 
 subglyph_flag
 A list of constants used to describe subglyphs. Please refer to the TrueType specification for the meaning of the various flags.
 

Classes

class  ConstCPtr
 acts like a const c-pointer by overloading the ->() operator, but is not copyable and doesn't allow the underlying c-pointer to be copied More...
 
struct  ContourIterator
 
struct  ContourReference
 
class  CPtr
 acts like a c-pointer by overloading the ->() operator, but is not copyable and doesn't allow the underlying c-pointer to be copied More...
 
struct  EncTag
 template used to replace the FT_ENC_TAG macro: converts four-letter tags into an unsigned long type More...
 
struct  Face
 traits class for a Face, a Freetype face instance. A face object models a given typeface, in a given style. More...
 
class  FaceDelegate
 c++ interface on top of c-object pointer More...
 
struct  GlyphSlot
 traits class for a GlyphSlot, a face's storage location for storing a glyph image More...
 
class  GlyphSlotDelegate
 
struct  ImageTag
 template used to replace the FT_IMAGE_TAG macro: converts four-letter tags into an unsigned long type More...
 
struct  Library
 traits class for Library, a FreeType library instance More...
 
class  LibraryDelegate
 c++ interface on top of c-object pointer More...
 
struct  LValuePair
 allows an error to be returned with a result in a single expression More...
 
class  Memory
 A handle to a given memory manager object, defined with an FT_MemoryRec structure. More...
 
class  Module
 
class  ModuleClass
 
class  OpenArgs
 A structure used to indicate how to open a new font file or stream. A pointer to such a structure can be used as a parameter for the functions Open_Face_t& and Attach_Stream_t&. More...
 
struct  Outline
 
class  OutlineDelegate
 
struct  PointIterator
 
struct  PointReference
 
class  RefPtr
 pointer to a reference counted object, auto destruct when reference count is zero More...
 
struct  RValuePair
 allows an error to be returned with a result in a single expression More...
 
class  Untag
 

Typedefs

typedef sigc::slot< void *, long > AllocFunc_t
 a function used to allocate bytes from memory More...
 
typedef FT_Bool Bool
 used for simple booleans, 1=true, 0=false More...
 
typedef FT_Bool Bool_t
 used for simple booleans, 1=true, 0=false More...
 
typedef FT_Byte Byte
 simple typedef unsigned char More...
 
typedef FT_Byte Byte_t
 simple typedef unsigned char More...
 
typedef FT_Bytes Bytes
 a typedef for constant memory area More...
 
typedef FT_Bytes Bytes_t
 a typedef for constant memory area More...
 
typedef FT_Char Char
 simple typedef for signed char More...
 
typedef FT_Char Char_t
 simple typedef for signed char More...
 
typedef encoding::Encoding Encoding
 
typedef FT_Error Error
 FreeType error code, a value of 0 is always interpreted as a successful operation. More...
 
typedef FT_Error Error_t
 FreeType error code, a value of 0 is always interpreted as a successful operation. More...
 
typedef FT_F26Dot6 F26Dot6
 signed 26.6 fixed float type used for vectoral pixel coordinates More...
 
typedef FT_F26Dot6 F26Dot6_t
 signed 26.6 fixed float type used for vectoral pixel coordinates More...
 
typedef FT_F2Dot14 F2Dot14
 signed 2.14 fixed float type used for unit vectors More...
 
typedef FT_F2Dot14 F2Dot14_t
 signed 2.14 fixed float type used for unit vectors More...
 
typedef FT_Fixed Fixed
 Used to store 16.16 fixed float values, like scaling values or matrix coefficients. More...
 
typedef FT_Fixed Fixed_t
 Used to store 16.16 fixed float values, like scaling values or matrix coefficients. More...
 
typedef sigc::slot< void, void * > FreeFunc_t
 a function used to release a given block of memory More...
 
typedef FT_FWord FWord
 signed 16bit integer used to store distance in original font units More...
 
typedef FT_FWord FWord_t
 signed 16bit integer used to store distance in original font units More...
 
typedef sigc::slot< void, void * > GenericFinalizer_t
 Describe a function used to destroy the ‘client’ data of any FreeType object. See the description of the FT_Generic type for details of usage. More...
 
typedef glyphformat::GlyphFormat GlyphFormat
 
typedef FT_Int Int
 typedef for int More...
 
typedef FT_Int16 Int16
 typedef for 16bit integer More...
 
typedef FT_Int16 Int16_t
 typedef for 16bit integer More...
 
typedef FT_Int32 Int32
 typedef for 32bit signed int More...
 
typedef FT_Int32 Int32_t
 typedef for 32bit signed int More...
 
typedef FT_Int Int_t
 typedef for int More...
 
typedef FT_Long Long
 simple typedef for signed long More...
 
typedef FT_Long Long_t
 simple typedef for signed long More...
 
typedef FT_Offset Offset
 the largest unsigned integer type used to express a file size or position or a memory block size More...
 
typedef FT_Offset Offset_t
 the largest unsigned integer type used to express a file size or position or a memory block size More...
 
typedef FT_Pointer Pointer
 simple typedef for typeless ptr More...
 
typedef FT_Pointer Pointer_t
 simple typedef for typeless ptr More...
 
typedef FT_Pos Pos
 used to store vectoral coordinates. depending on the context these represent distances in integer font units, or 16.16, or 26.6 fixed float pixel coords More...
 
typedef FT_Pos Pos_t
 used to store vectoral coordinates. depending on the context these represent distances in integer font units, or 16.16, or 26.6 fixed float pixel coords More...
 
typedef FT_PtrDist PtrDist
 the largest signed integer type used to express a distance between two pointers More...
 
typedef FT_PtrDist PtrDist_t
 the largest signed integer type used to express a distance between two pointers More...
 
typedef sigc::slot< void
*, long, long, void * > 
ReallocFunc_t
 a function used to re-allocate a given block of memory More...
 
typedef FT_Short Short
 simlpe typedef for signed short More...
 
typedef FT_Short Short_t
 simlpe typedef for signed short More...
 
typedef
size_request_type::SizeRequestType 
SizeRequestType
 
typedef FT_String String
 simple typedef for char More...
 
typedef FT_String String_t
 simple typedef for char More...
 
typedef FT_Tag Tag
 typedef for 32bit tags (as used in the SFNT format) More...
 
typedef FT_Tag Tag_t
 typedef for 32bit tags (as used in the SFNT format) More...
 
typedef FT_UFWord UFWord
 unsigned 16bit integer used to store distance in original font units More...
 
typedef FT_UFWord UFWord_t
 unsigned 16bit integer used to store distance in original font units More...
 
typedef FT_UInt UInt
 typedef for unsigned int More...
 
typedef FT_UInt16 UInt16
 typedef for 16bit unsigned int More...
 
typedef FT_UInt16 UInt16_t
 typedef for 16bit unsigned int More...
 
typedef FT_UInt32 UInt32
 typedef for 32bit unsigned int More...
 
typedef FT_UInt32 UInt32_t
 typedef for 32bit unsigned int More...
 
typedef FT_UInt UInt_t
 typedef for unsigned int More...
 
typedef FT_ULong ULong
 simple typedef for unsigned long More...
 
typedef FT_ULong ULong_t
 simple typedef for unsigned long More...
 
typedef FT_UShort UShort
 simple typedef for unsigned short More...
 
typedef FT_UShort UShort_t
 simple typedef for unsigned short More...
 

Functions

Error_t done (RefPtr< Library > &library)
 Destroy a given FreeType library object and all of its children, including resources, drivers, faces, sizes, etc. More...
 
RefPtr< Libraryinit ()
 Initialize a new FreeType library object. The set of modules that are registered by this function is determined at build time. More...
 
RValuePair< RefPtr< Library >
, Error
init_e ()
 Initialize a new FreeType library object. The set of modules that are registered by this function is determined at build time. More...
 

Variables

const unsigned int MAJOR
 
const unsigned int MINOR
 
const unsigned int PATCH
 

Detailed Description

root namespace for freetype

Typedef Documentation

typedef sigc::slot<void*,long> freetype::AllocFunc_t

a function used to allocate bytes from memory

Input parameter will be number of bytes requested and the function should return a pointer to a memory block or 0 in case of failure

Definition at line 266 of file types.h.

typedef FT_Bool freetype::Bool

used for simple booleans, 1=true, 0=false

Definition at line 106 of file types.h.

typedef FT_Bool freetype::Bool_t

used for simple booleans, 1=true, 0=false

Definition at line 59 of file types.h.

typedef FT_Byte freetype::Byte

simple typedef unsigned char

Definition at line 93 of file types.h.

typedef FT_Byte freetype::Byte_t

simple typedef unsigned char

Definition at line 46 of file types.h.

typedef FT_Bytes freetype::Bytes

a typedef for constant memory area

Definition at line 94 of file types.h.

typedef FT_Bytes freetype::Bytes_t

a typedef for constant memory area

Definition at line 47 of file types.h.

typedef FT_Char freetype::Char

simple typedef for signed char

Definition at line 95 of file types.h.

typedef FT_Char freetype::Char_t

simple typedef for signed char

Definition at line 48 of file types.h.

Definition at line 874 of file types.h.

typedef FT_Error freetype::Error

FreeType error code, a value of 0 is always interpreted as a successful operation.

Definition at line 117 of file types.h.

typedef FT_Error freetype::Error_t

FreeType error code, a value of 0 is always interpreted as a successful operation.

Definition at line 70 of file types.h.

typedef FT_F26Dot6 freetype::F26Dot6

signed 26.6 fixed float type used for vectoral pixel coordinates

Definition at line 137 of file types.h.

typedef FT_F26Dot6 freetype::F26Dot6_t

signed 26.6 fixed float type used for vectoral pixel coordinates

Definition at line 90 of file types.h.

typedef FT_F2Dot14 freetype::F2Dot14

signed 2.14 fixed float type used for unit vectors

Definition at line 135 of file types.h.

typedef FT_F2Dot14 freetype::F2Dot14_t

signed 2.14 fixed float type used for unit vectors

Definition at line 88 of file types.h.

typedef FT_Fixed freetype::Fixed

Used to store 16.16 fixed float values, like scaling values or matrix coefficients.

Definition at line 120 of file types.h.

typedef FT_Fixed freetype::Fixed_t

Used to store 16.16 fixed float values, like scaling values or matrix coefficients.

Definition at line 73 of file types.h.

typedef sigc::slot<void,void*> freetype::FreeFunc_t

a function used to release a given block of memory

Input parameter is a pointer to a block of memory returned from the associated allocator

Definition at line 273 of file types.h.

typedef FT_FWord freetype::FWord

signed 16bit integer used to store distance in original font units

Definition at line 129 of file types.h.

typedef FT_FWord freetype::FWord_t

signed 16bit integer used to store distance in original font units

Definition at line 82 of file types.h.

typedef sigc::slot<void,void*> freetype::GenericFinalizer_t

Describe a function used to destroy the ‘client’ data of any FreeType object. See the description of the FT_Generic type for details of usage.

input: The address of the FreeType object which is under finalization. Its client data is accessed through its ‘generic’ field.

Definition at line 258 of file types.h.

Definition at line 250 of file types.h.

typedef FT_Int freetype::Int

typedef for int

Definition at line 96 of file types.h.

typedef FT_Int16 freetype::Int16

typedef for 16bit integer

Definition at line 98 of file types.h.

typedef FT_Int16 freetype::Int16_t

typedef for 16bit integer

Definition at line 51 of file types.h.

typedef FT_Int32 freetype::Int32

typedef for 32bit signed int

Definition at line 100 of file types.h.

typedef FT_Int32 freetype::Int32_t

typedef for 32bit signed int

Definition at line 53 of file types.h.

typedef FT_Int freetype::Int_t

typedef for int

Definition at line 49 of file types.h.

typedef FT_Long freetype::Long

simple typedef for signed long

Definition at line 104 of file types.h.

typedef FT_Long freetype::Long_t

simple typedef for signed long

Definition at line 57 of file types.h.

typedef FT_Offset freetype::Offset

the largest unsigned integer type used to express a file size or position or a memory block size

Definition at line 108 of file types.h.

typedef FT_Offset freetype::Offset_t

the largest unsigned integer type used to express a file size or position or a memory block size

Definition at line 61 of file types.h.

typedef FT_Pointer freetype::Pointer

simple typedef for typeless ptr

Definition at line 123 of file types.h.

typedef FT_Pointer freetype::Pointer_t

simple typedef for typeless ptr

Definition at line 76 of file types.h.

typedef FT_Pos freetype::Pos

used to store vectoral coordinates. depending on the context these represent distances in integer font units, or 16.16, or 26.6 fixed float pixel coords

Definition at line 124 of file types.h.

typedef FT_Pos freetype::Pos_t

used to store vectoral coordinates. depending on the context these represent distances in integer font units, or 16.16, or 26.6 fixed float pixel coords

Definition at line 77 of file types.h.

typedef FT_PtrDist freetype::PtrDist

the largest signed integer type used to express a distance between two pointers

Definition at line 111 of file types.h.

typedef FT_PtrDist freetype::PtrDist_t

the largest signed integer type used to express a distance between two pointers

Definition at line 64 of file types.h.

typedef sigc::slot<void*,long,long,void*> freetype::ReallocFunc_t

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

Parameters are:

cur_size the block's current size in bytes

new_size the block's requested size

block the block's current address

Return value is the new block address, or 0 in the case of memory shortage

Note
In case of error the old block must still be available

Definition at line 287 of file types.h.

typedef FT_Short freetype::Short

simlpe typedef for signed short

Definition at line 102 of file types.h.

typedef FT_Short freetype::Short_t

simlpe typedef for signed short

Definition at line 55 of file types.h.

typedef FT_String freetype::String

simple typedef for char

Definition at line 114 of file types.h.

typedef FT_String freetype::String_t

simple typedef for char

Definition at line 67 of file types.h.

typedef FT_Tag freetype::Tag

typedef for 32bit tags (as used in the SFNT format)

Definition at line 115 of file types.h.

typedef FT_Tag freetype::Tag_t

typedef for 32bit tags (as used in the SFNT format)

Definition at line 68 of file types.h.

typedef FT_UFWord freetype::UFWord

unsigned 16bit integer used to store distance in original font units

Definition at line 132 of file types.h.

typedef FT_UFWord freetype::UFWord_t

unsigned 16bit integer used to store distance in original font units

Definition at line 85 of file types.h.

typedef FT_UInt freetype::UInt

typedef for unsigned int

Definition at line 97 of file types.h.

typedef FT_UInt16 freetype::UInt16

typedef for 16bit unsigned int

Definition at line 99 of file types.h.

typedef FT_UInt16 freetype::UInt16_t

typedef for 16bit unsigned int

Definition at line 52 of file types.h.

typedef FT_UInt32 freetype::UInt32

typedef for 32bit unsigned int

Definition at line 101 of file types.h.

typedef FT_UInt32 freetype::UInt32_t

typedef for 32bit unsigned int

Definition at line 54 of file types.h.

typedef FT_UInt freetype::UInt_t

typedef for unsigned int

Definition at line 50 of file types.h.

typedef FT_ULong freetype::ULong

simple typedef for unsigned long

Definition at line 105 of file types.h.

typedef FT_ULong freetype::ULong_t

simple typedef for unsigned long

Definition at line 58 of file types.h.

typedef FT_UShort freetype::UShort

simple typedef for unsigned short

Definition at line 103 of file types.h.

typedef FT_UShort freetype::UShort_t

simple typedef for unsigned short

Definition at line 56 of file types.h.

Function Documentation

Error_t freetype::done ( RefPtr< Library > &  library)

Destroy a given FreeType library object and all of its children, including resources, drivers, faces, sizes, etc.

Parameters
[in]libraryhandle to the library object to destroy, must have been created with freetype::init
Returns
FeeType error code. 0 means success
Note
Since this function decements the reference count of the library, it will alter the library object changing it's underlying pointer to null, so that the handle becomes invalid
RefPtr<Library> freetype::init ( )

Initialize a new FreeType library object. The set of modules that are registered by this function is determined at build time.

Returns
A handle to a new library object
Note
In case you want to provide your own memory allocating routines, use Library::new instead, followed by a call to Library::add_default_modules (or a series of calls to Library::add_module).
For multi-threading applications each thread should have its own Library object.
when using this function, it is expected that the library is destroyed with freetype::done. This is becasue freetype::init creates a memory manager and gives it a reference count, and when we call ~Library it only decrements the library count, not the reference count. Therefore, make sure you call freetype::done on the main library instance prior to it going out of scope
this version silently ignores any error result, see init_e for a function which returns an error code as well
RValuePair< RefPtr<Library>, Error > freetype::init_e ( )

Initialize a new FreeType library object. The set of modules that are registered by this function is determined at build time.

Returns
A handle to a new library object, and the result of the underlyinig call
Note
In case you want to provide your own memory allocating routines, use Library::new instead, followed by a call to Library::add_default_modules (or a series of calls to Library::add_module).
For multi-threading applications each thread should have its own Library object.
when using this function, it is expected that the library is destroyed with freetype::done. This is becasue freetype::init creates a memory manager and gives it a reference count, and when we call ~Library it only decrements the library count, not the reference count. Therefore, make sure you call freetype::done on the main library instance prior to it going out of scope

Variable Documentation

const unsigned int freetype::MAJOR

Definition at line 48 of file common.h.

const unsigned int freetype::MINOR

Definition at line 49 of file common.h.

const unsigned int freetype::PATCH