General
==============================

Before you can call the SDK functions, you must first initialize the SDK with your desired configuration options.
These configuration options will ultimately impact the behaviour of the SDK, so be sure to read through what each one does carefully.

Once you have initialized the SDK, then proceed to the the `License <license.html>`_ section.

.. important::
   By default, the SDK is initialized with the :class:`Trueface::FacialRecognitionModel::LITE` face recognition model.
   This is our fastest and most lightweight face recognition model; however, it is not the most accurate face recognition model we offer.
   To use a more accurate model, refer to the :class:`Trueface::FacialRecognitionModel` section below
   then be sure to initialize the SDK with the desired :class:`Trueface::ConfigurationOptions`.

.. doxygenfunction:: Trueface::SDK::SDK()

.. doxygenfunction:: Trueface::SDK::SDK(const ConfigurationOptions &options)

.. doxygenfunction:: Trueface::SDK::getVersion()

.. doxygenenum:: Trueface::FacialRecognitionModel

.. doxygenenum:: Trueface::ObjectDetectionModel

.. doxygenenum:: Trueface::FaceDetectionMode

.. doxygenenum:: Trueface::FaceDetectionFilter

.. doxygenenum:: Trueface::DatabaseManagementSystem

.. doxygenstruct:: Trueface::EnableGPU
   :members:

.. doxygenfunction:: Trueface::EnableGPU::EnableGPU() = default

.. doxygenfunction:: Trueface::EnableGPU::EnableGPU(bool val)

.. doxygenstruct:: Trueface::ConfigurationOptions
   :members:


.. doxygenenum:: Trueface::ErrorCode