Build

This chapter will introduce the compilation methods for the GPUPixel library on various system platforms.

TIP

Starting from version v1.1.0, the source code is compiled using CMake. The latest precompiled libraries for various platforms can be found here.

iOS

Execute the following commands at the root directory of the project.

Generate Project

Arm64

cmake -G Xcode -B build -S src -DCMAKE_TOOLCHAIN_FILE=../toolchain/ios.toolchain.cmake -DPLATFORM=OS64

Compile

Release

cmake --build build --config Release

Debug

cmake --build build --config Debug

Output

The compilation output is located in the output path under the root directory of the project, containing the following:

output
├── include   # Header files
├── library   # Library files
├── models    # Models files
└── res # Resource files

For iOS, you only need to use the .framework library under library, which already contains header files and resource files.

MacOS

Execute the following commands at the root directory of the project.

Generate Project

Apple Silicon

cmake -G Xcode -B build -S src -DCMAKE_TOOLCHAIN_FILE=../toolchain/ios.toolchain.cmake -DPLATFORM=MAC_ARM64

Intel

cmake -G Xcode -B build -S src -DCMAKE_TOOLCHAIN_FILE=../toolchain/ios.toolchain.cmake -DPLATFORM=MAC -DCMAKE_BUILD_TYPE=Release

Compile

Release

cmake --build build --config Release

Debug

cmake --build build --config Debug

Output

The compilation output is located in the output path under the root directory of the project, containing the following:

output
├── include   # Header files
├── library   # Library files
├── models    # Models files
└── res # Resource files

For macOS, you only need to use the .framework library under library, which already contains header files and resource files.

Android

Open the directory src/android/java with Android Studio, which will automatically start downloading dependencies such as Gradle.

Project Structure

Gradle Command Compile

If the Gradle command environment has been configured, you can also use gradlew to compile.

./gradlew :gpupixel:assembleRelease

The output is located at: src/android/java/gpupixel/build/outputs/aar

Windows

Windows compilation requires the following environment:

Environment Requirements

• Microsoft Visual Studio >= 2017
• cmake >= 3.10

Build Environment Setup

It is recommended to use Windows Terminal and select the corresponding VS environment tab for compilation. If not using Windows Terminal, you can configure as follows:

• 64-bit compilation: Find and click vcvars64.bat (x64 Native Tools Command Prompt for VS 2017) in settings to open the VS virtual environment for compiling x64 architecture programs

WARNING

Only supports generating x86_64 Release version, x86_32 is not supported currently

Generate Project

cmake -G "NMake Makefiles" -B build -S src -DCMAKE_BUILD_TYPE=Release

Compile

cd build 
nmake

Output

The compilation output is located in the output path under the root directory of the project, containing the following:

output
├── include   # Header files
├── library   # Library files
├── models    # Models files
└── res # Resource files

Linux (Debian or Ubuntu)

Environment Configuration

# Install cmake
sudo apt-get install cmake pkg-config
# Install dependent libraries
sudo apt-get install mesa-utils libglu1-mesa-dev freeglut3-dev mesa-common-dev libglfw3-dev

Generate Project

cmake -B build -S src -DCMAKE_BUILD_TYPE=Release

cmake -B build -S src -DCMAKE_BUILD_TYPE=Debug

:::

Compile

Release

cmake --build build --config Release

Debug

cmake --build build --config Debug

Output

The compilation output is located in the output path under the root directory of the project, containing the following:

output
├── include   # Header files
├── library   # Library files
├── models    # Models files
└── res # Resource files