Skip to content

Configuration Guide#

Configuration options are specified via faceengine.conf file which is basically an XML document with special tag formatting. The document itself is not required to exist, in this case FSDK will fall back to some default settings, which, however, may not be suitable for several tasks.

WARNING! By changing any configuration settings from default ones it is assumed that user understands what these settings do and how they will affect performance and output results of their application. The rule of thumb is this: DO NOT change anything in configuration file unless you really have to.

Always remember that incorrect config may huck the things up very badly. Pay attention to what you configure and how. Always double-check what you deploy.

Some configuration settings may be omitted due to their obscurity and research use case only.

The location where the config file is found varies across different systems but tries to be as consistent as possible.

The config file format is optimized for deserialization of several FSDK types:

  • Int1 - scalar 32 bit integral numeric type
  • Int2 - 2-d 32 bit integral numeric type (aka Vector2i, Size)
  • Int3 - 3-d 32 bit integral numeric type
  • Int4 - 4-d 32 bit integral numeric type (aka Rect)
  • Float1 - scalar 32 bit floating point numeric type
  • Float2 - 2-d 32 bit floating point numeric type (aka Vector2f)
  • Float3 - 3-d 32 bit floating point numeric type
  • Float4 - 4-d 32 bit floating point numeric type
  • String - short null-terminated string (max. 16 characters including the null-terminator)

Configuration file location#

The location where the config file is found varies across different systems but tries to be as consistent as possible. Path resolution is the following:

Mobile platforms

  • Look for "data/faceengine.conf" in current working directory.