FreeType-2.1.10 API Reference
Size Management
Synopsis
#FT_New_Size
FT_New_Size
#FT_Done_Size
FT_Done_Size
#FT_Activate_Size
FT_Activate_Size
When creating a new face object (e.g. with
ft2-base_interface.html#FT_New_Face
FT_New_Face
), an
ft2-base_interface.html#FT_Size
FT_Size
object is automatically created and used to store all pixel-size dependent information, available in the "face->size" field.
It is however possible to create more sizes for a given face, mostly in order to manage several character pixel sizes of the same font family and style. See
ft2-sizes_management.html#FT_New_Size
FT_New_Size
and
ft2-sizes_management.html#FT_Done_Size
FT_Done_Size
.
Note that
ft2-base_interface.html#FT_Set_Pixel_Sizes
FT_Set_Pixel_Sizes
and
ft2-base_interface.html#FT_Set_Char_Size
FT_Set_Char_Size
only modify the contents of the current "active" size; you thus need to use
ft2-sizes_management.html#FT_Activate_Size
FT_Activate_Size
to change it.
99% of applications won't need the functions provided here, especially if they use the caching sub-system, so be cautious when using these.
FT_New_Size
FT_EXPORT(
ft2-basic_types.html#FT_Error
FT_Error
)
FT_New_Size
(
ft2-base_interface.html#FT_Face
FT_Face
face,
ft2-base_interface.html#FT_Size
FT_Size
*  size );
Creates a new size object from a given face object.
input
face
A handle to a parent face object.
output
asize
A handle to a new size object.
return
FreeType error code. 0 means success.
note
You need to call
ft2-sizes_management.html#FT_Activate_Size
FT_Activate_Size
in order to select the new size for upcoming calls to
ft2-base_interface.html#FT_Set_Pixel_Sizes
FT_Set_Pixel_Sizes
,
ft2-base_interface.html#FT_Set_Char_Size
FT_Set_Char_Size
,
ft2-base_interface.html#FT_Load_Glyph
FT_Load_Glyph
,
ft2-base_interface.html#FT_Load_Char
FT_Load_Char
, etc.
FT_Done_Size
FT_EXPORT(
ft2-basic_types.html#FT_Error
FT_Error
)
FT_Done_Size
(
ft2-base_interface.html#FT_Size
FT_Size
size );
Discards a given size object. Note that
ft2-base_interface.html#FT_Done_Face
FT_Done_Face
automatically discards all size objects allocated with
ft2-sizes_management.html#FT_New_Size
FT_New_Size
.
input
size
A handle to a target size object.
return
FreeType error code. 0 means success.
FT_Activate_Size
FT_EXPORT(
ft2-basic_types.html#FT_Error
FT_Error
)
FT_Activate_Size
(
ft2-base_interface.html#FT_Size
FT_Size
size );
Even though it is possible to create several size objects for a given face (see
ft2-sizes_management.html#FT_New_Size
FT_New_Size
for details), functions like
ft2-base_interface.html#FT_Load_Glyph
FT_Load_Glyph
or
ft2-base_interface.html#FT_Load_Char
FT_Load_Char
only use the last-created one to determine the "current character pixel size".
This function can be used to "activate" a previously created size object.
input
size
A handle to a target size object.
return
FreeType error code. 0 means success.
note
If "face" is the size's parent face object, this function changes the value of "face->size" to the input size handle.
