FreeType-2.3.9 API Reference

SFNT Names

Synopsis

The TrueType and OpenType specifications allow the inclusion of a special ‘names table’ in font files. This table contains textual (and internationalized) information regarding the font, like family name, copyright, version, etc.

The definitions below are used to access them if available.

Note that this has nothing to do with glyph names!

FT_SfntName

Defined in FT_SFNT_NAMES_H (freetype/ftsnames.h).


  typedef struct  FT_SfntName_
  {
    FT_UShort  platform_id;
    FT_UShort  encoding_id;
    FT_UShort  language_id;
    FT_UShort  name_id;

    FT_Byte*   string;      /* this string is *not* null-terminated! */
    FT_UInt    string_len;  /* in bytes */

  } FT_SfntName;

A structure used to model an SFNT ‘name’ table entry.

fields

platform_id	The platform ID for ‘string’.
encoding_id	The encoding ID for ‘string’.
language_id	The language ID for ‘string’.
name_id	An identifier for ‘string’.
string	The ‘name’ string. Note that its format differs depending on the (platform,encoding) pair. It can be a Pascal String, a UTF-16 one, etc. Generally speaking, the string is not zero-terminated. Please refer to the TrueType specification for details.
string_len	The length of ‘string’ in bytes.

note

Possible values for ‘platform_id’, ‘encoding_id’, ‘language_id’, and ‘name_id’ are given in the file ‘ttnameid.h’. For details please refer to the TrueType or OpenType specification.

[Index]

[TOC]

FT_Get_Sfnt_Name_Count

Defined in FT_SFNT_NAMES_H (freetype/ftsnames.h).


  FT_EXPORT( FT_UInt )
  FT_Get_Sfnt_Name_Count( FT_Face  face );

Retrieve the number of name strings in the SFNT ‘name’ table.

input

face

A handle to the source face.

return

The number of strings in the ‘name’ table.

[Index]

[TOC]

FT_Get_Sfnt_Name

Defined in FT_SFNT_NAMES_H (freetype/ftsnames.h).


  FT_EXPORT( FT_Error )
  FT_Get_Sfnt_Name( FT_Face       face,
                    FT_UInt       idx,
                    FT_SfntName  *aname );

Retrieve a string of the SFNT ‘name’ table for a given index.

input

face	A handle to the source face.
idx	The index of the ‘name’ string.

output

aname

The indexed FT_SfntName structure.

return

FreeType error code. 0 means success.

note

The ‘string’ array returned in the ‘aname’ structure is not null-terminated.

Use FT_Get_Sfnt_Name_Count to get the total number of available ‘name’ table entries, then do a loop until you get the right platform, encoding, and name ID.

[Index]

[TOC]