From 462f18c7b25fe3e467f837647d07ab0a78aa8d2b Mon Sep 17 00:00:00 2001 From: marha Date: Sun, 22 Feb 2015 21:39:56 +0100 Subject: Merged origin/release (checked in because wanted to merge new stuff) --- freetype/docs/reference/ft2-sfnt_names.html | 298 +++++++++++++++------------- 1 file changed, 161 insertions(+), 137 deletions(-) (limited to 'freetype/docs/reference/ft2-sfnt_names.html') diff --git a/freetype/docs/reference/ft2-sfnt_names.html b/freetype/docs/reference/ft2-sfnt_names.html index a1720b137..3bd918d3e 100644 --- a/freetype/docs/reference/ft2-sfnt_names.html +++ b/freetype/docs/reference/ft2-sfnt_names.html @@ -3,64 +3,124 @@ -FreeType-2.5.3 API Reference +FreeType-2.5.5 API Reference - - -
[Index][TOC]
-

FreeType-2.5.3 API Reference

+
[Index][TOC]
+

FreeType-2.5.5 API Reference

-

-SFNT Names -

+

SFNT Names

Synopsis

- - - - - - -
FT_SfntName
FT_Get_Sfnt_Name_Count
FT_Get_Sfnt_Name
FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY
FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY


- -
+ + + + + + +
FT_SfntName
FT_Get_Sfnt_Name_Count
FT_Get_Sfnt_Name
FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY
FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY
+ +

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 (ftsnames.h). -

-
 
+

+
FT_SfntName

+
Defined in FT_SFNT_NAMES_H (ftsnames.h).

+
   typedef struct  FT_SfntName_
   {
     FT_UShort  platform_id;
@@ -72,161 +132,125 @@ Defined in FT_SFNT_NAMES_H (ftsnames.h).
     FT_UInt    string_len;  /* in bytes */
 
   } FT_SfntName;
+

 
-

-

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

-

-
fields
-

- -
platform_id + +

fields

+ + - - - - -
platform_id

The platform ID for ‘string’.

encoding_id +
encoding_id

The encoding ID for ‘string’.

language_id +
language_id

The language ID for ‘string’.

name_id +
name_id

An identifier for ‘string’.

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 +
string_len

The length of ‘string’ in bytes.

-
-
note
+ +

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.

See also TT_PLATFORM_XXX, TT_APPLE_ID_XXX, TT_MAC_ID_XXX, TT_ISO_ID_XXX, and TT_MS_ID_XXX.

-
-
-
- - -
[Index][TOC]
- -
-

FT_Get_Sfnt_Name_Count

-
-Defined in FT_SFNT_NAMES_H (ftsnames.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_Get_Sfnt_Name_Count

+
Defined in FT_SFNT_NAMES_H (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 + +

input

+ +
face

A handle to the source face.

-
-
return
+ +

return

The number of strings in the ‘name’ table.

-
-
-
- - -
[Index][TOC]
- -
-

FT_Get_Sfnt_Name

-
-Defined in FT_SFNT_NAMES_H (ftsnames.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_Get_Sfnt_Name

+
Defined in FT_SFNT_NAMES_H (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 + +

input

+ + -
face

A handle to the source face.

idx +
idx

The index of the ‘name’ string.

-
-
output
-

- -
aname + +

output

+ +
aname

The indexed FT_SfntName structure.

-
-
return
+ +

return

FreeType error code. 0 means success.

-
-
note
+ +

note

The ‘string’ array returned in the ‘aname’ structure is not null-terminated. The application should deallocate it if it is no longer in use.

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]
- -
-

FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY

-
-Defined in FT_SFNT_NAMES_H (ftsnames.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY

+
Defined in FT_SFNT_NAMES_H (ftsnames.h).

+
 #define FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY  FT_MAKE_TAG( 'i', 'g', 'p', 'f' )
+

 
-

-

A constant used as the tag of FT_Parameter structures to make FT_Open_Face() ignore preferred family subfamily names in ‘name’ table since OpenType version 1.4. For backwards compatibility with legacy systems that have a 4-face-per-family restriction.

-

-
-
- - -
[Index][TOC]
- -
-

FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY

-
-Defined in FT_SFNT_NAMES_H (ftsnames.h). -

-
 
+

+
[Index][Top][TOC]

+
+

+
FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY

+
Defined in FT_SFNT_NAMES_H (ftsnames.h).

+
 #define FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY  FT_MAKE_TAG( 'i', 'g', 'p', 's' )
+

 
-

-

A constant used as the tag of FT_Parameter structures to make FT_Open_Face() ignore preferred subfamily names in ‘name’ table since OpenType version 1.4. For backwards compatibility with legacy systems that have a 4-face-per-family restriction.

-

-
-
- - -
[Index][TOC]
+ +
+
[Index][Top][TOC]
-- cgit v1.2.3