FreeType-2.8 API Reference

Linux 4gvps.4gvps.com 3.10.0-1127.18.2.vz7.163.46 #1 SMP Fri Nov 20 21:47:55 MSK 2020 x86_64
SOFT : Apache PHP : 7.4.33
/usr/share/doc/freetype-devel-2.8/reference/

38.135.39.45

[ NAME ]	[ SIZE ]	[ PERM ]	[ DATE ]	[ ACT ]
+FILE +DIR
README	0.187 KB	-rw-r--r--	2017-01-04 19:12	R E G D
ft2-auto_hinter.html	25.145 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-base_interface.html	198.186 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-basic_types.html	43.093 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-bdf_fonts.html	11.522 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-bitmap_handling.html	13.385 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-bzip2.html	6.155 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-cache_subsystem.html	53.646 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-cff_driver.html	16.08 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-cid_fonts.html	8.922 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-computations.html	26.702 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-error_code_values.html	15.395 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-error_enumerations.html	6.012 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-font_formats.html	5.684 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-gasp_table.html	8.449 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-glyph_management.html	26.622 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-glyph_stroker.html	38.704 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-glyph_variants.html	13.905 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-gx_validation.html	18.106 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-gzip.html	8.364 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-header_file_macros.html	35.23 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-header_inclusion.html	4.501 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-incremental.html	19.921 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-index.html	69.8 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-lcd_filtering.html	17.543 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-list_processing.html	18.007 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-lzw.html	6.121 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-mac_specific.html	14.808 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-module_management.html	35.532 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-multiple_masters.html	25.883 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-ot_validation.html	10.774 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-outline_processing.html	50.013 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-pcf_driver.html	6.284 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-pfr_fonts.html	10.029 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-quick_advance.html	10.396 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-raster.html	24.834 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-sfnt_names.html	16.084 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-sizes_management.html	8.944 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-system_interface.html	16.897 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-toc.html	11.575 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-truetype_engine.html	7.005 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-truetype_tables.html	102.017 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-tt_driver.html	18.04 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-type1_tables.html	44.245 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-user_allocation.html	4.151 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-version.html	9.73 KB	-rw-r--r--	2017-05-13 10:45	R E G D
ft2-winfnt_fonts.html	15.819 KB	-rw-r--r--	2017-05-13 10:45	R E G D
REQUEST EXIT

This section contains the basic data types defined by FreeType 2, ranging from simple scalar types to bitmap descriptors. More font-specific structures are defined in a different section.

#define FT_MAKE_TAG( _x1, _x2, _x3, _x4 ) \ (FT_Tag) \ ( ( (FT_ULong)_x1 << 24 ) | \ ( (FT_ULong)_x2 << 16 ) | \ ( (FT_ULong)_x3 << 8 ) | \ (FT_ULong)_x4 )

typedef struct FT_Bitmap_ { unsigned int rows; unsigned int width; int pitch; unsigned char* buffer; unsigned short num_grays; unsigned char pixel_mode; unsigned char palette_mode; void* palette; } FT_Bitmap;

typedef enum FT_Pixel_Mode_ { FT_PIXEL_MODE_NONE = 0, FT_PIXEL_MODE_MONO, FT_PIXEL_MODE_GRAY, FT_PIXEL_MODE_GRAY2, FT_PIXEL_MODE_GRAY4, FT_PIXEL_MODE_LCD, FT_PIXEL_MODE_LCD_V, FT_PIXEL_MODE_BGRA, FT_PIXEL_MODE_MAX /* do not remove */ } FT_Pixel_Mode; /* these constants are deprecated; use the corresponding `FT_Pixel_Mode' */ /* values instead. */ #define ft_pixel_mode_none FT_PIXEL_MODE_NONE #define ft_pixel_mode_mono FT_PIXEL_MODE_MONO #define ft_pixel_mode_grays FT_PIXEL_MODE_GRAY #define ft_pixel_mode_pal2 FT_PIXEL_MODE_GRAY2 #define ft_pixel_mode_pal4 FT_PIXEL_MODE_GRAY4

typedef enum FT_Glyph_Format_ { FT_IMAGE_TAG( FT_GLYPH_FORMAT_NONE, 0, 0, 0, 0 ), FT_IMAGE_TAG( FT_GLYPH_FORMAT_COMPOSITE, 'c', 'o', 'm', 'p' ), FT_IMAGE_TAG( FT_GLYPH_FORMAT_BITMAP, 'b', 'i', 't', 's' ), FT_IMAGE_TAG( FT_GLYPH_FORMAT_OUTLINE, 'o', 'u', 't', 'l' ), FT_IMAGE_TAG( FT_GLYPH_FORMAT_PLOTTER, 'p', 'l', 'o', 't' ) } FT_Glyph_Format; /* these constants are deprecated; use the corresponding */ /* `FT_Glyph_Format' values instead. */ #define ft_glyph_format_none FT_GLYPH_FORMAT_NONE #define ft_glyph_format_composite FT_GLYPH_FORMAT_COMPOSITE #define ft_glyph_format_bitmap FT_GLYPH_FORMAT_BITMAP #define ft_glyph_format_outline FT_GLYPH_FORMAT_OUTLINE #define ft_glyph_format_plotter FT_GLYPH_FORMAT_PLOTTER

#ifndef FT_IMAGE_TAG #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) \ value = ( ( (unsigned long)_x1 << 24 ) | \ ( (unsigned long)_x2 << 16 ) | \ ( (unsigned long)_x3 << 8 ) | \ (unsigned long)_x4 ) #endif /* FT_IMAGE_TAG */

FT_Byte	FT_Bool	FT_UnitVector
FT_Bytes	FT_Offset	FT_F26Dot6
FT_Char	FT_PtrDist	FT_Data
FT_Int	FT_String
FT_UInt	FT_Tag	FT_MAKE_TAG
FT_Int16	FT_Error
FT_UInt16	FT_Fixed	FT_Generic
FT_Int32	FT_Pointer	FT_Generic_Finalizer
FT_UInt32	FT_Pos
FT_Int64	FT_Vector	FT_Bitmap
FT_UInt64	FT_BBox	FT_Pixel_Mode
FT_Short	FT_Matrix	FT_Palette_Mode
FT_UShort	FT_FWord	FT_Glyph_Format
FT_Long	FT_UFWord	FT_IMAGE_TAG
FT_ULong	FT_F2Dot14

xMin	The horizontal minimum (left-most).
yMin	The vertical minimum (bottom-most).
xMax	The horizontal maximum (right-most).
yMax	The vertical maximum (top-most).

xx	Matrix coefficient.
xy	Matrix coefficient.
yx	Matrix coefficient.
yy	Matrix coefficient.

pointer	The data.
length	The length of the data in bytes.

data	A typeless pointer to any client-specified data. This field is completely ignored by the FreeType library.
finalizer	A pointer to a ‘generic finalizer’ function, which will be called when the object is destroyed. If this field is set to NULL, no code will be called.

rows	The number of bitmap rows.
width	The number of pixels in bitmap row.
pitch	The pitch's absolute value is the number of bytes taken by one bitmap row, including padding. However, the pitch is positive when the bitmap has a ‘down’ flow, and negative when it has an ‘up’ flow. In all cases, the pitch is an offset to add to a bitmap pointer in order to go down one row. Note that ‘padding’ means the alignment of a bitmap to a byte border, and FreeType functions normally align to the smallest possible integer value. For the B/W rasterizer, ‘pitch’ is always an even number. To change the pitch of a bitmap (say, to make it a multiple of 4), use FT_Bitmap_Convert. Alternatively, you might use callback functions to directly render to the application's surface; see the file ‘example2.cpp’ in the tutorial for a demonstration.
buffer	A typeless pointer to the bitmap buffer. This value should be aligned on 32-bit boundaries in most cases.
num_grays	This field is only used with FT_PIXEL_MODE_GRAY; it gives the number of gray levels used in the bitmap.
pixel_mode	The pixel mode, i.e., how pixel bits are stored. See FT_Pixel_Mode for possible values.
palette_mode	This field is intended for paletted pixel modes; it indicates how the palette is stored. Not used currently.
palette	A typeless pointer to the bitmap palette; this field is intended for paletted pixel modes. Not used currently.

FT_PIXEL_MODE_NONE	Value 0 is reserved.
FT_PIXEL_MODE_MONO	A monochrome bitmap, using 1 bit per pixel. Note that pixels are stored in most-significant order (MSB), which means that the left-most pixel in a byte has value 128.
FT_PIXEL_MODE_GRAY	An 8-bit bitmap, generally used to represent anti-aliased glyph images. Each pixel is stored in one byte. Note that the number of ‘gray’ levels is stored in the ‘num_grays’ field of the FT_Bitmap structure (it generally is 256).
FT_PIXEL_MODE_GRAY2	A 2-bit per pixel bitmap, used to represent embedded anti-aliased bitmaps in font files according to the OpenType specification. We haven't found a single font using this format, however.
FT_PIXEL_MODE_GRAY4	A 4-bit per pixel bitmap, representing embedded anti-aliased bitmaps in font files according to the OpenType specification. We haven't found a single font using this format, however.
FT_PIXEL_MODE_LCD	An 8-bit bitmap, representing RGB or BGR decimated glyph images used for display on LCD displays; the bitmap is three times wider than the original glyph image. See also FT_RENDER_MODE_LCD.
FT_PIXEL_MODE_LCD_V	An 8-bit bitmap, representing RGB or BGR decimated glyph images used for display on rotated LCD displays; the bitmap is three times taller than the original glyph image. See also FT_RENDER_MODE_LCD_V.
FT_PIXEL_MODE_BGRA	An image with four 8-bit channels per pixel, representing a color image (such as emoticons) with alpha channel. For each pixel, the format is BGRA, which means, the blue channel comes first in memory. The color channels are pre-multiplied and in the sRGB colorspace. For example, full red at half-translucent opacity will be represented as ‘00,00,80,80’, not ‘00,00,FF,80’. See also FT_LOAD_COLOR.

FT_GLYPH_FORMAT_NONE	The value 0 is reserved.
FT_GLYPH_FORMAT_COMPOSITE	The glyph image is a composite of several other images. This format is only used with FT_LOAD_NO_RECURSE, and is used to report compound glyphs (like accented characters).
FT_GLYPH_FORMAT_BITMAP	The glyph image is a bitmap, and can be described as an FT_Bitmap. You generally need to access the ‘bitmap’ field of the FT_GlyphSlotRec structure to read it.
FT_GLYPH_FORMAT_OUTLINE	The glyph image is a vectorial outline made of line segments and Bézier arcs; it can be described as an FT_Outline; you generally want to access the ‘outline’ field of the FT_GlyphSlotRec structure to read it.
FT_GLYPH_FORMAT_PLOTTER	The glyph image is a vectorial path with no inside and outside contours. Some Type 1 fonts, like those in the Hershey family, contain glyphs in this format. These are described as FT_Outline, but FreeType isn't currently capable of rendering them correctly.

x	Horizontal coordinate.
y	Vertical coordinate.

FreeType-2.8 API Reference

Basic Data Types

Synopsis

FT_Byte

FT_Bytes

FT_Char

FT_Int

FT_UInt

FT_Int16

FT_UInt16

FT_Int32

FT_UInt32

FT_Int64

FT_UInt64

FT_Short

FT_UShort

FT_Long

FT_ULong

FT_Bool

FT_Offset

FT_PtrDist

FT_String

FT_Tag

FT_Error

FT_Fixed

FT_Pointer

FT_Pos

FT_Vector

fields

FT_BBox

fields

note

FT_Matrix

fields

FT_FWord

FT_UFWord

FT_F2Dot14

FT_UnitVector

fields

FT_F26Dot6

FT_Data

fields

FT_MAKE_TAG

note

FT_Generic

fields

FT_Generic_Finalizer

input

FT_Bitmap

fields

FT_Pixel_Mode

values

FT_Glyph_Format

values

FT_IMAGE_TAG

note