Quick Start

This page matches SDK 2.0.0. Windows uses the C++ API in the facebetter namespace (facebetter/*.h).

This guide builds the Facebetter C++ desktop demo on Windows. The demo uses GLFW + Dear ImGui + OpenGL 3: live preview on the left, beauty controls on the right.

Requirements

Tool	Version
Visual Studio / MSVC	2019 or later (C++17)
CMake	3.16+
Ninja	Any recent version (`winget install Ninja-build.Ninja`)
Windows SDK	10.0+

MinGW-w64 also works, but MSVC is recommended.

Step 1: Clone the repository

git clone https://github.com/pixpark/facebetter-sdk.git
cd facebetter-sdk

Step 2: Place the SDK files

Unzip the Windows SDK package and place files under demo/cpp/sdk/:

demo/cpp/sdk/
├── include/
│   └── facebetter/
│       ├── beauty_effect_engine.h
│       ├── beauty_params.h
│       ├── image_frame.h
│       └── type_defines.h
├── lib/
│   ├── facebetter.lib      ← import library
│   └── facebetter.dll      ← runtime DLL
└── resource/
    ├── resource.fbd        ← models and assets (required)
    ├── resource_3d.fbd     ← optional; 3D stickers. Place next to `resource.fbd` or call `AddResourcePack`
    └── resource_body.fbd   ← optional; body reshape. Place next to `resource.fbd` or call `AddResourcePack`

On desktop, EngineConfig::resource_path must point to the resource.fbd file, not a directory. Example: demo/cpp/sdk/resource/resource.fbd.

SDK packages are on the Download page and in the Dashboard.

Step 3: Configure license

Set app_id / app_key (online v2 auth) or license_token in the demo before you run it. If license_token is non-empty, it takes priority (license token string, {token} JSON, or offline .lic contents). Details: Auth & License.

Step 4: Build

Open a Developer Command Prompt for VS (or PowerShell with the MSVC environment loaded):

cd demo\cpp
cmake -B build -G "Ninja" -DCMAKE_BUILD_TYPE=Release
cmake --build build

After the build, CMake typically:

Copies facebetter.dll next to the executable in build/
Copies resource/resource.fbd to build/resource/resource.fbd
Copies demo.png (if present) to build/resource/demo.png

Step 5: Prepare a preview image (optional)

Place a face photo named demo.png in demo/cpp/:

demo/cpp/demo.png

Step 6: Run

cd demo\cpp\build
.\facebetter_demo.exe

The window shows:

Left panel — live beauty-processed preview
Right panel — Beauty Control Panel:
- Basic beauty: smoothing / whitening / rosiness / sharpening
- Face reshape: 26 reshape params (range [-1.0, 1.0])
- Body reshape: 7 params (range [0.0, 1.0]; needs resource_body.fbd)
- Makeup: lipstick / blush / eyeshadow / eyeliner / eyebrow / eyelash / pupil / contour
- Filter / sticker / virtual background

Click Reset All to zero intensities.

Troubleshooting

Q: “facebetter.dll was not found” at startup
A: Confirm demo/cpp/sdk/lib/facebetter.dll exists, then re-run cmake --build build so CMake copies the DLL next to the executable. Q: Engine create returns nullptr / license failed
A: Point resource_path at resource.fbd, and set license_token or valid app_id + app_key. See Auth & License. Q: CMake cannot find Ninja
A: Run winget install Ninja-build.Ninja, or use -G "Visual Studio 17 2022" and --config Release.

Introduction

Android

iOS

macOS

Windows

Linux

Web

Requirements

Step 1: Clone the repository

Step 2: Place the SDK files

Step 3: Configure license

Step 4: Build

Step 5: Prepare a preview image (optional)

Step 6: Run

Troubleshooting

Next steps

Implement beauty

API reference

​Requirements

​Step 1: Clone the repository

​Step 2: Place the SDK files

​Step 3: Configure license

​Step 4: Build

​Step 5: Prepare a preview image (optional)

​Step 6: Run

​Troubleshooting

​Next steps

Implement beauty

API reference

Requirements

Step 1: Clone the repository

Step 2: Place the SDK files

Step 3: Configure license

Step 4: Build

Step 5: Prepare a preview image (optional)

Step 6: Run

Troubleshooting

Next steps