Trying the Samples

The best way to learn the Ultralight API is by trying out the samples.

1. Install the prerequisites

Install the prequisites for your platform if you haven't already done so.

2. Get the latest release from GitHub

Download the latest release from GitHub by clicking here.

3. Build the samples

Open up your terminal / command prompt and run the following from wherever you extracted the package:

mkdir build
cd build
cmake ..
cmake --build . --config Release

🚧

Building 64-bit on Windows

If you run the command cmake .. without any generators on Windows, it will usually select the default 32-bit Visual Studio version you have installed.

To force CMake to generate 64-bit projects instead, use
cmake .. -DCMAKE_GENERATOR_PLATFORM=x64 instead of cmake ..

4. Run the samples

On macOS and Linux the projects will be built to:

/build/samples/<Sample Name>/

On Windows the projects will be built to:

/build/samples/<Sample Name>/Release

Just navigate to each of these folders and double click the app / executable to run.