This documenta- tion describes the current state of development.
Note that interfaces and functionality may still change.

Prokee Modules:
  A
  B
  C
  D
  E
  F
  G
  I
  L
  M
  N
  O
  P
  R
  S
  T
  U
  W

     open all    |    close all

GUI Elements:
  B
  C
  I
  M
  P
  R
  S
  T

     open all    |    close all

GUI Interactions:
  B
  F
  H
  S

     open all    |    close all

GUI Layouts:
  L

     open all    |    close all

Games/Demos:
  M

     open all    |    close all

Third Party Libraries:
  P
  F
  Z

     open all    |    close all

Information about this Website / Informationen zu dieser Webseite:
In case of any questions, or comments, please feel free to contact me via email at apoll500@gmail.com.

Module ftype [Version: v01] (Interface AbsFType)

   [AbsFType]   [AbsFTypeManager]

Contents

Inheritance:
AbsFType
Implementations: FType

Constructors:
FType (version 1)
AbsFType *createFType()
FType (version 2)
AbsFType *createFType(const char *font_filename,long int face_index)

Methods:
set_sizes
int set_sizes(uint16_t width,uint16_t height)
get_lineHieght
uint16_t get_lineHieght()
get_ascender
int16_t get_ascender()
get_descender
int16_t get_descender()
draw_char
int draw_char(ImageData *image,char32_t ch,uint32_t color,uint32_t bgcolor)

Constructors

   FType (version 1)


Constructs a helper object for the FreeType library.

Constructor:
FType()

Factory Method:
AbsFType *AbsFTypeInterface::createFType()

Wrapper Class:
FTypeWrapper()

The static method AbsFTypeInterface::createFType creates a new instance of class FType.

Return value:
Returns an instance of FType.

   FType (version 2)


Constructs a helper object for the FreeType library.

Constructor:
FType(const char *font_filename,long int face_index)

Factory Method:
AbsFType *AbsFTypeInterface::createFType(const char *font_filename,long int face_index)

Wrapper Class:
FTypeWrapper(const char *font_filename,long int face_index)

The static method AbsFTypeInterface::createFType creates a new instance of class FType.

Parameters:
Type Name Direction Description
const char *font_filename
long int face_index

Return value:
Returns an instance of FType.


Methods

   set_sizes


Sets the sizes.

Signature:
int set_sizes(uint16_t width,uint16_t height)

Parameters:
Type Name Direction Description
uint16_t widthrequested width of the character in pixels
uint16_t heightrequested height of the character in pixels


Return value:
Returns 0 on successful execution. A value other than 0 indicates an error.

   get_lineHieght


...

Signature:
uint16_t get_lineHieght()

   get_ascender


...

Signature:
int16_t get_ascender()

   get_descender


...

Signature:
int16_t get_descender()

   draw_char


Draws a character glyph.

Signature:
int draw_char(ImageData *image,char32_t ch,uint32_t color,uint32_t bgcolor)

Parameters:
Type Name Direction Description
ImageData *image[IN/OUT]The ImageData.
char32_t chThe utf-32 value of the character.
uint32_t color
uint32_t bgcolor


Return value:
Returns 0 on successful execution. A value other than 0 indicates an error.


Copyright © 2017 - 2019 by Andreas Pollhammer