Piccolo

Moteur Piccolo (anciennement Pilot Engine)

Conditions préalables

Pour construire Piccolo, vous devez d'abord installer les outils suivants.

Windows 10/11

• Visual Studio 2019 (ou plus récent)

• CMake 3.19 (ou plus récent)

• Git 2.1 (ou plus récent)

macOS >= 10.15 (x86_64)

• Xcode 12.3 (ou plus récent)

• CMake 3.19 (ou plus récent)

• Git 2.1 (ou plus récent)

Ubuntu 20.04

• apt installer les packages suivants

sudo apt install libxrandr-dev
sudo apt install libxrender-dev
sudo apt install libxinerama-dev
sudo apt install libxcursor-dev
sudo apt install libxi-dev
sudo apt install libglvnd-dev
sudo apt install libvulkan-dev
sudo apt install cmake
sudo apt install clang
sudo apt install libc++-dev
sudo apt install libglew-dev
sudo apt install libglfw3-dev
sudo apt install vulkan-validationlayers
sudo apt install mesa-vulkan-drivers

• Pilote NVIDIA (le pilote AMD et Intel est open source et est donc installé automatiquement par mesa-vulkan-drivers)

Construire Piccolo

Construire sur Windows

Vous pouvez exécuter le build_windows.bat . Ce fichier batch générera les projets et construira automatiquement la configuration Release de Piccolo Engine . Une fois la construction réussie, vous pouvez trouver PiccoloEditor.exe dans le répertoire bin .

Vous pouvez également utiliser la commande suivante pour générer d'abord le projet Visual Studio , puis ouvrir la solution dans le répertoire de construction et la générer manuellement.

cmake -S . -B build

Construire sur macOS

Les instructions de construction suivantes ont été testées uniquement sur du matériel spécifique de x86_64 et ne prennent pas en charge les puces M1. Pour compatible M1, nous publierons plus tard.

Pour compiler Piccolo, vous devez avoir installé la version la plus récente de Xcode. Exécutez ensuite 'cmake' depuis le répertoire racine du projet pour générer un projet Xcode.

cmake -S . -B build -G "Xcode"

et vous pouvez construire le projet avec

cmake --build build --config Release

Ou vous pouvez exécuter build_macos.sh pour créer les binaires.

Construire sur Ubuntu 20.04

Vous pouvez exécuter build_linux.sh pour créer les binaires.

Documentation

Pour la documentation, veuillez vous référer à la section Wiki.

Supplémentaire

Couche de validation Vulkan : erreur de validation

Nous avons remarqué que certains développeurs sous Windows ont constaté que PiccoloEditor.exe pouvait s'exécuter normalement, mais ont signalé une exception Vulkan Validation Layer : erreur de validation lors du débogage. Vous pouvez résoudre ce problème en installant le SDK Vulkan (la dernière version officielle fera l'affaire).

Générer une base de données de compilation

Vous pouvez créer compile_commands.json avec les commandes suivantes lorsque les générateurs Unix Makefiles sont disponibles. compile_commands.json est le fichier requis par le serveur de langage clangd , qui est un backend pour le mode cpp lsp dans Emacs.

Pour Windows :

 cmake -DCMAKE_TRY_COMPILE_TARGET_TYPE="STATIC_LIBRARY" -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -S . -B compile_db_temp -G "Makefiles Unix" copie compile_db_tempcompile_commands.json .

Utilisation du moteur de rendu de débogage physique

Actuellement, Physics Debug Renderer n’est disponible que sous Windows. Vous pouvez utiliser la commande suivante pour générer la solution avec le projet de débogueur.

 cmake -S . -B build -DENABLE_PHYSICS_DEBUG_RENDERER=ON

Note:

1. Veuillez nettoyer le répertoire de construction avant de régénérer la solution. Nous avons rencontré des problèmes de construction lors de la régénération directe avec le précédent CMakeCache.

2. Physics Debug Renderer s'exécutera lorsque vous démarrerez PiccoloEditor. Nous avons synchronisé la position de la caméra entre les deux scènes. Mais le mode caméra initial dans Physics Debug Renderer est erroné. Faire défiler la molette de la souris une fois fera passer la caméra de Physics Debug Renderer au mode correct.

Construire Linux
Créer macOS