This documentation describes the Prokee module interface.
Library Functions (Pointer Macros):
FreeType Core API
FreeType Version:
FT_Library_Version
void FT_Library_Version(FT_Library library,FT_Int *amajor,FT_Int *aminor,FT_Int *apatch)
Base Interface:
FT_New_Face
FT_Error FT_New_Face(FT_Library library,const char *filepathname,FT_Long face_index,FT_Face *aface)
FT_New_Memory_Face
FT_Error FT_New_Memory_Face(FT_Library library,const FT_Byte *file_base,FT_Long file_size,FT_Long face_index,FT_Face *aface)
FT_Face_Properties
FT_Error FT_Face_Properties(FT_Face face,FT_UInt num_properties,FT_Parameter *properties)
FT_Open_Face
FT_Error FT_Open_Face(FT_Library library,const FT_Open_Args *args,FT_Long face_index,FT_Face *aface)
FT_Attach_File
FT_Error FT_Attach_File(FT_Face face,const char *filepathname)
FT_Attach_Stream
FT_Error FT_Attach_Stream(FT_Face face,FT_Open_Args *parameters)
FT_Set_Char_Size
FT_Error FT_Set_Char_Size(FT_Face face,FT_F26Dot6 char_width,FT_F26Dot6 char_height,FT_UInt horz_resolution,FT_UInt vert_resolution)
FT_Set_Pixel_Sizes
FT_Error FT_Set_Pixel_Sizes(FT_Face face,FT_UInt pixel_width,FT_UInt pixel_height)
FT_Select_Size
FT_Error FT_Select_Size(FT_Face face,FT_Int strike_index)
FT_Set_Transform
void FT_Set_Transform(FT_Face face,FT_Matrix *matrix,FT_Vector *delta)
FT_Load_Glyph
FT_Error FT_Load_Glyph(FT_Face face,FT_UInt glyph_index,FT_Int32 load_flags)
FT_Get_Next_Char
FT_ULong FT_Get_Next_Char(FT_Face face,FT_ULong charcode,FT_UInt *agindex)
FT_Get_Name_Index
FT_UInt FT_Get_Name_Index(FT_Face face,const FT_String *glyph_name)
FT_Load_Char
FT_Error FT_Load_Char(FT_Face face,FT_ULong char_code,FT_Int32 load_flags)
FT_Render_Glyph
FT_Error FT_Render_Glyph(FT_GlyphSlot slot,FT_Render_Mode render_mode)
FT_Get_Kerning
FT_Error FT_Get_Kerning(FT_Face face,FT_UInt left_glyph,FT_UInt right_glyph,FT_UInt kern_mode,FT_Vector *akerning)
FT_Get_Track_Kerning
FT_Error FT_Get_Track_Kerning(FT_Face face,FT_Fixed point_size,FT_Int degree,FT_Fixed *akerning)
FT_Get_Glyph_Name
FT_Error FT_Get_Glyph_Name(FT_Face face,FT_UInt glyph_index,FT_Pointer buffer,FT_UInt buffer_max)
FT_Set_Charmap
FT_Error FT_Set_Charmap(FT_Face face,FT_CharMap charmap)
FT_Get_SubGlyph_Info
FT_Error FT_Get_SubGlyph_Info(FT_GlyphSlot glyph,FT_UInt sub_index,FT_Int *p_index,FT_UInt *p_flags,FT_Int *p_arg1,FT_Int *p_arg2,FT_Matrix *p_transform)
Unicode Variation Sequences:
Glyph Color Management:
FT_Palette_Select
FT_Error FT_Palette_Select(FT_Face face,FT_UShort palette_index,FT_Color **apalette)
Glyph Layer Management:
FT_Get_Color_Glyph_Layer
FT_Bool FT_Get_Color_Glyph_Layer(FT_Face face,FT_UInt base_glyph,FT_UInt *aglyph_index,FT_UInt *acolor_index,FT_LayerIterator *iterator)
Glyph Management:
FT_New_Glyph
FT_Error FT_New_Glyph(FT_Library library,FT_Glyph_Format format,FT_Glyph *aglyph)
FT_Get_Glyph
FT_Error FT_Get_Glyph(FT_GlyphSlot slot,FT_Glyph *aglyph)
FT_Glyph_Copy
FT_Error FT_Glyph_Copy(FT_Glyph source,FT_Glyph *target)
FT_Glyph_Transform
FT_Error FT_Glyph_Transform(FT_Glyph glyph,FT_Matrix *matrix,FT_Vector *delta)
FT_Glyph_Get_CBox
void FT_Glyph_Get_CBox(FT_Glyph glyph,FT_UInt bbox_mode,FT_BBox *acbox)
FT_Glyph_To_Bitmap
FT_Error FT_Glyph_To_Bitmap(FT_Glyph *the_glyph,FT_Render_Mode render_mode,FT_Vector *origin,FT_Bool destroy)
Size Management:
FT_New_Size
FT_Error FT_New_Size(FT_Face face,FT_Size *size)
Motivation
This packs the FreeType library into a module for Prokee.
FreeType is a high-quality font rendering library.
Please be referred to the FreeType Website at https://www.freetype.org.
Library Functions (Pointer Macros)
FT_Library_Version
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
void FT_Library_Version(FT_Library library,FT_Int *amajor,FT_Int *aminor,FT_Int *apatch)
Parameters:
| FT_Library | library | | |
| FT_Int * | amajor | | |
| FT_Int * | aminor | | |
| FT_Int * | apatch | | |
FT_Init_FreeType
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Init_FreeType(FT_Library *alibrary)
Parameters:
FT_Done_FreeType
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Done_FreeType(FT_Library library)
Parameters:
FT_New_Face
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_New_Face(FT_Library library,const char *filepathname,FT_Long face_index,FT_Face *aface)
Parameters:
| FT_Library | library | | |
| const char * | filepathname | | |
| FT_Long | face_index | | |
| FT_Face * | aface | | |
FT_Done_Face
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Done_Face(FT_Face face)
Parameters:
FT_Reference_Face
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Reference_Face(FT_Face face)
Parameters:
FT_New_Memory_Face
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_New_Memory_Face(FT_Library library,const FT_Byte *file_base,FT_Long file_size,FT_Long face_index,FT_Face *aface)
Parameters:
| FT_Library | library | | |
| const FT_Byte * | file_base | | |
| FT_Long | file_size | | |
| FT_Long | face_index | | |
| FT_Face * | aface | | |
FT_Face_Properties
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Face_Properties(FT_Face face,FT_UInt num_properties,FT_Parameter *properties)
Parameters:
| FT_Face | face | | |
| FT_UInt | num_properties | | |
| FT_Parameter * | properties | | |
FT_Open_Face
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Open_Face(FT_Library library,const FT_Open_Args *args,FT_Long face_index,FT_Face *aface)
Parameters:
| FT_Library | library | | |
| const FT_Open_Args * | args | | |
| FT_Long | face_index | | |
| FT_Face * | aface | | |
FT_Attach_File
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Attach_File(FT_Face face,const char *filepathname)
Parameters:
| FT_Face | face | | |
| const char * | filepathname | | |
FT_Attach_Stream
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Attach_Stream(FT_Face face,FT_Open_Args *parameters)
Parameters:
| FT_Face | face | | |
| FT_Open_Args * | parameters | | |
FT_Set_Char_Size
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Set_Char_Size(FT_Face face,FT_F26Dot6 char_width,FT_F26Dot6 char_height,FT_UInt horz_resolution,FT_UInt vert_resolution)
Parameters:
| FT_Face | face | | |
| FT_F26Dot6 | char_width | | |
| FT_F26Dot6 | char_height | | |
| FT_UInt | horz_resolution | | |
| FT_UInt | vert_resolution | | |
FT_Set_Pixel_Sizes
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Set_Pixel_Sizes(FT_Face face,FT_UInt pixel_width,FT_UInt pixel_height)
Parameters:
| FT_Face | face | | |
| FT_UInt | pixel_width | | |
| FT_UInt | pixel_height | | |
FT_Request_Size
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Request_Size(FT_Face face,FT_Size_Request req)
Parameters:
| FT_Face | face | | |
| FT_Size_Request | req | | |
FT_Select_Size
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Select_Size(FT_Face face,FT_Int strike_index)
Parameters:
| FT_Face | face | | |
| FT_Int | strike_index | | |
FT_Set_Transform
FT_Load_Glyph
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Load_Glyph(FT_Face face,FT_UInt glyph_index,FT_Int32 load_flags)
Parameters:
| FT_Face | face | | |
| FT_UInt | glyph_index | | |
| FT_Int32 | load_flags | | |
FT_Get_Char_Index
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_UInt FT_Get_Char_Index(FT_Face face,FT_ULong charcode)
Parameters:
| FT_Face | face | | |
| FT_ULong | charcode | | |
FT_Get_First_Char
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_ULong FT_Get_First_Char(FT_Face face,FT_UInt *agindex)
Parameters:
| FT_Face | face | | |
| FT_UInt * | agindex | | |
FT_Get_Next_Char
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_ULong FT_Get_Next_Char(FT_Face face,FT_ULong charcode,FT_UInt *agindex)
Parameters:
| FT_Face | face | | |
| FT_ULong | charcode | | |
| FT_UInt * | agindex | | |
FT_Get_Name_Index
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_UInt FT_Get_Name_Index(FT_Face face,const FT_String *glyph_name)
Parameters:
| FT_Face | face | | |
| const FT_String * | glyph_name | | |
FT_Load_Char
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Load_Char(FT_Face face,FT_ULong char_code,FT_Int32 load_flags)
Parameters:
| FT_Face | face | | |
| FT_ULong | char_code | | |
| FT_Int32 | load_flags | | |
FT_Render_Glyph
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Render_Glyph(FT_GlyphSlot slot,FT_Render_Mode render_mode)
Parameters:
| FT_GlyphSlot | slot | | |
| FT_Render_Mode | render_mode | | |
FT_Get_Kerning
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Get_Kerning(FT_Face face,FT_UInt left_glyph,FT_UInt right_glyph,FT_UInt kern_mode,FT_Vector *akerning)
Parameters:
| FT_Face | face | | |
| FT_UInt | left_glyph | | |
| FT_UInt | right_glyph | | |
| FT_UInt | kern_mode | | |
| FT_Vector * | akerning | | |
FT_Get_Track_Kerning
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Get_Track_Kerning(FT_Face face,FT_Fixed point_size,FT_Int degree,FT_Fixed *akerning)
Parameters:
| FT_Face | face | | |
| FT_Fixed | point_size | | |
| FT_Int | degree | | |
| FT_Fixed * | akerning | | |
FT_Get_Glyph_Name
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Get_Glyph_Name(FT_Face face,FT_UInt glyph_index,FT_Pointer buffer,FT_UInt buffer_max)
Parameters:
| FT_Face | face | | |
| FT_UInt | glyph_index | | |
| FT_Pointer | buffer | | |
| FT_UInt | buffer_max | | |
FT_Get_Postscript_Name
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
const char *FT_Get_Postscript_Name(FT_Face face)
Parameters:
FT_Select_Charmap
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Select_Charmap(FT_Face face,FT_Encoding encoding)
Parameters:
| FT_Face | face | | |
| FT_Encoding | encoding | | |
FT_Set_Charmap
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Set_Charmap(FT_Face face,FT_CharMap charmap)
Parameters:
| FT_Face | face | | |
| FT_CharMap | charmap | | |
FT_Get_Charmap_Index
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Int FT_Get_Charmap_Index(FT_CharMap charmap)
Parameters:
FT_Get_FSType_Flags
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_UShort FT_Get_FSType_Flags(FT_Face face)
Parameters:
FT_Get_SubGlyph_Info
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Get_SubGlyph_Info(FT_GlyphSlot glyph,FT_UInt sub_index,FT_Int *p_index,FT_UInt *p_flags,FT_Int *p_arg1,FT_Int *p_arg2,FT_Matrix *p_transform)
Parameters:
| FT_GlyphSlot | glyph | | |
| FT_UInt | sub_index | | |
| FT_Int * | p_index | | |
| FT_UInt * | p_flags | | |
| FT_Int * | p_arg1 | | |
| FT_Int * | p_arg2 | | |
| FT_Matrix * | p_transform | | |
FT_Face_GetCharVariantIndex
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_UInt FT_Face_GetCharVariantIndex(FT_Face face,FT_ULong charcode,FT_ULong variantSelector)
Parameters:
| FT_Face | face | | |
| FT_ULong | charcode | | |
| FT_ULong | variantSelector | | |
FT_Face_GetCharVariantIsDefault
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Int FT_Face_GetCharVariantIsDefault(FT_Face face,FT_ULong charcode,FT_ULong variantSelector)
Parameters:
| FT_Face | face | | |
| FT_ULong | charcode | | |
| FT_ULong | variantSelector | | |
FT_Face_GetVariantSelectors
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_UInt32 *FT_Face_GetVariantSelectors(FT_Face face)
Parameters:
FT_Face_GetVariantsOfChar
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_UInt32 *FT_Face_GetVariantsOfChar(FT_Face face,FT_ULong charcode)
Parameters:
| FT_Face | face | | |
| FT_ULong | charcode | | |
FT_Face_GetCharsOfVariant
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_UInt32 *FT_Face_GetCharsOfVariant(FT_Face face,FT_ULong variantSelector)
Parameters:
| FT_Face | face | | |
| FT_ULong | variantSelector | | |
FT_Palette_Data_Get
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Palette_Data_Get(FT_Face face,FT_Palette_Data *apalette)
Parameters:
| FT_Face | face | | |
| FT_Palette_Data * | apalette | | |
FT_Palette_Select
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Palette_Select(FT_Face face,FT_UShort palette_index,FT_Color **apalette)
Parameters:
| FT_Face | face | | |
| FT_UShort | palette_index | | |
| FT_Color ** | apalette | | |
FT_Palette_Set_Foreground_Color
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Palette_Set_Foreground_Color(FT_Face face,FT_Color foreground_color)
Parameters:
| FT_Face | face | | |
| FT_Color | foreground_color | | |
FT_Get_Color_Glyph_Layer
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Bool FT_Get_Color_Glyph_Layer(FT_Face face,FT_UInt base_glyph,FT_UInt *aglyph_index,FT_UInt *acolor_index,FT_LayerIterator *iterator)
Parameters:
| FT_Face | face | | |
| FT_UInt | base_glyph | | |
| FT_UInt * | aglyph_index | | |
| FT_UInt * | acolor_index | | |
| FT_LayerIterator * | iterator | | |
FT_New_Glyph
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_New_Glyph(FT_Library library,FT_Glyph_Format format,FT_Glyph *aglyph)
Parameters:
| FT_Library | library | | |
| FT_Glyph_Format | format | | |
| FT_Glyph * | aglyph | | |
FT_Get_Glyph
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Get_Glyph(FT_GlyphSlot slot,FT_Glyph *aglyph)
Parameters:
| FT_GlyphSlot | slot | | |
| FT_Glyph * | aglyph | | |
FT_Glyph_Copy
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Glyph_Copy(FT_Glyph source,FT_Glyph *target)
Parameters:
| FT_Glyph | source | | |
| FT_Glyph * | target | | |
FT_Glyph_Transform
FT_Glyph_Get_CBox
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
void FT_Glyph_Get_CBox(FT_Glyph glyph,FT_UInt bbox_mode,FT_BBox *acbox)
Parameters:
| FT_Glyph | glyph | | |
| FT_UInt | bbox_mode | | |
| FT_BBox * | acbox | | |
FT_Glyph_To_Bitmap
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Glyph_To_Bitmap(FT_Glyph *the_glyph,FT_Render_Mode render_mode,FT_Vector *origin,FT_Bool destroy)
Parameters:
| FT_Glyph * | the_glyph | | |
| FT_Render_Mode | render_mode | | |
| FT_Vector * | origin | | |
| FT_Bool | destroy | | |
FT_Done_Glyph
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
void FT_Done_Glyph(FT_Glyph glyph)
Parameters:
FT_New_Size
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_New_Size(FT_Face face,FT_Size *size)
Parameters:
| FT_Face | face | | |
| FT_Size * | size | | |
FT_Done_Size
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Done_Size(FT_Size size)
Parameters:
FT_Activate_Size
This is a pointer to the Function of the FreeType library.
Please be referred to the Documentation of FreeType.
Signature:
FT_Error FT_Activate_Size(FT_Size size)
Parameters:
This documenta- tion describes the current state of development.
A
aprint