FreeType-2.1.4 API Reference

BDF Fonts

Synopsys

	FT_PropertyType		BDF_PropertyRec		FT_Get_BDF_Property
	BDF_Property		FT_Get_BDF_Charset_ID

This section contains the declaration of BDF-specific functions.

FT_PropertyType


  typedef enum
  {
    BDF_PROPERTY_TYPE_NONE     = 0,
    BDF_PROPERTY_TYPE_ATOM     = 1,
    BDF_PROPERTY_TYPE_INTEGER  = 2,
    BDF_PROPERTY_TYPE_CARDINAL = 3

  } BDF_PropertyType;

list of BDF property types

values

BDF_PROPERTY_TYPE_NONE	value 0 is used to indicate a missing property
BDF_PROPERTY_TYPE_ATOM	property is a string atom
BDF_PROPERTY_TYPE_INTEGER	property is a 32-bit signed integer
BDF_PROPERTY_TYPE_CARDINAL	property is a 32-bit unsigned integer

BDF_Property


  typedef struct BDF_PropertyRec_*   BDF_Property;

handle to a BDF_PropertyRec structure used to model a given BDF/PCF property

BDF_PropertyRec


  typedef struct BDF_PropertyRec_
  {
    BDF_PropertyType   type;
    union {
      const char*   atom;
      FT_Int32      integer;
      FT_UInt32     cardinal;

    } u;

  } BDF_PropertyRec;

models a given BDF/PCF property

note

type

property type u.atom :: atom string, when type is BDF_PROPERTY_TYPE_ATOM u.integer :: signed integer, when type is BDF_PROPERTY_TYPE_INTEGER u.cardinal :: unsigned integer, when type is BDF_PROPERTY_TYPE_CARDINAL

FT_Get_BDF_Charset_ID


  FT_EXPORT( FT_Error )
  FT_Get_BDF_Charset_ID( FT_Face       face,
                         const char*  *acharset_encoding,
                         const char*  *acharset_registry );

Retrieves a BDF font character set identity, according to the BDF specification.

input

face

handle to input face

output

acharset_encoding	Charset encoding, as a C string, owned by the face.
acharset_registry	Charset registry, as a C string, owned by the face.

return

FreeType rror code. 0 means success.

note

This function only works with BDF faces, returning an error otherwise.

FT_Get_BDF_Property


  FT_EXPORT( FT_Error )
  FT_Get_BDF_Property( FT_Face           face,
                       const char*       prop_name,
                       BDF_PropertyRec  *aproperty );

Retrieves a BDF property from a BDF or PCF font file

input

face	handle to input face
name	property name

output

aproperty

the property

return

FreeType error code. 0 means success.

note

This function works with BDF and PCF fonts. It returns an error otherwise. it also returns an error when the property is not in the font.

in case of error, "aproperty->type" is always set to BDF_PROPERTY_TYPE_NONE