Sign in Join
FPDoc Onlineexperiment

TT_Open_Face function

In unit LazFreeType

Opens a new font and returns a handle for it in the _face argument.

Declaration

pascal
function TT_Open_Face(fontname: string; var _face: TT_Face): TT_Error

Arguments

fontname

TrueType font file or collection opened in the routine.

_face

Handle for the font face opened in the routine.

Function result

Success or error status for the operation.

Description

TT_Open_Face is a function used to open a TrueType font file or collection. Overloaded variants of the routine are provided using either a file name or a stream as the source for the font face. When the source is a font collection, the first embedded font is loaded.

fontname contains the name for the TrueType font file or collection opened in the routine.

AStream is a TStream instance with the font face loaded in the routine.

_face is updated with the handle for the TrueType font loaded in the routine.

The return value is a TT_Error type which indicates the success or failure of the routine. Please note that success is indicated by the value TT_Err_Ok (0). Any other value indicates an error condition.

See also

  • TT_Error
  • TT_Err_Ok
  • TT_Open_Stream
  • Cache_New
  • error

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.