VulkanTutorial

Tutoriel Vulkan

Ce référentiel héberge le contenu de vulkan-tutorial.com. Le site Web lui-même est basé sur Daux.io, qui prend en charge la démarque de GitHub. Le site réel exécute daux.io avec un thème personnalisé et quelques modifications (https://github.com/overv/daux.io) et cela est intégré à une image Docker.

Utilisez des problèmes et tirez des demandes pour fournir des commentaires liés au site Web. Si vous avez un problème avec votre code, utilisez la section des commentaires dans le chapitre connexe pour poser une question. Veuillez fournir votre système d'exploitation, votre carte graphique, votre version du pilote, votre code source, votre comportement attendu et votre comportement réel.

Livre électronique

Ce guide est maintenant disponible dans des formats de livres électroniques:

• Epub (anglais, français)
• PDF (anglais, français)

Le livre électronique peut être construit à partir du contenu existant en fonctionnant:

 python3 build_ebook.py

Ce script dépend des utilitaires suivants disponibles sur le chemin:

• inkscape : Conversion SVG à PNG (testé avec la version 1.0.2)
• pandoc : Construire un PDF et EPUB à partir du code Markdown (testé avec la version 2.13)

Vous devez également installer une distribution de latex pour la génération de PDF.

Changer le code entre les chapitres

Il est parfois nécessaire de modifier le code réutilisé sur de nombreux chapitres, par exemple une fonction comme createBuffer . Si vous effectuez une telle modification, vous devez mettre à jour les fichiers de code à l'aide des étapes suivantes:

• Mettez à jour les chapitres qui font référence au code modifié.
• Faites une copie du premier fichier qui l'utilise et modifiez le code là-bas, par exemple base_code_fixed.cpp .
• Créez un patch à l'aide de diff -Naur base_code.cpp base_code_fixed.cpp > patch.txt .
• Appliquez le patch au fichier de code spécifié et à tous les fichiers des chapitres ultérieurs à l'aide du script incremental_patch.sh . Exécutez-le comme ceci: ./incremental_patch.sh base_code.cpp patch.txt .
• Nettoyez les fichiers base_code_fixed.cpp et patch.txt .
• Commettre.

Rendre le tutoriel

Pour rendre le tutoriel (c'est-à-dire convertir la marque en HTML), vous avez deux options:

1. Servir les fichiers rendus à la volée à l'aide d'un serveur Web qui a installé PHP
2. Générer des fichiers HTML statiques que vous pouvez afficher localement ou mettre sur un serveur

Pour l'une ou l'autre de ces options, vous aurez besoin de PHP et d'un DAUX patch.

Php

1. Assurez-vous que PHP est installé (DAUX est écrit en PHP)
   1. Les extensions php_mbstring et php_openssl doivent être activées
   2. Le paramètre phar.readonly doit être défini sur Off (pour pouvoir reconstruire Daux)
2. Assurez-vous que le compositeur est installé, un gestionnaire de dépendances PHP que Daux utilise

Clone, patch et reconstruire daux

1. Clone daux
   • git clone https://github.com/dauxio/daux.io.git
2. Faites une nouvelle branche lors de l'ancienne révision à laquelle le patch vulkantutorial est contre:
   • git checkout d45ccff -b vtpatch
   • Faire une nouvelle branche n'est pas strictement nécessaire, car vous pouvez réinitialiser master , mais cela maintient le maître intact.
3. Copiez sur le fichier daux.patch dans le répertoire DAUX.IO, assurez-vous que les fins de ligne sont du style UNIX (au cas où vous utilisez Windows) et appliquez le correctif. Il doit s'appliquer proprement.
   • git am daux.patch
4. Exécutez le compositeur dans le répertoire Daux.io afin qu'il télécharge les dépendances dont Daux a besoin pour être construit
   • composer install
5. Reconstruire Daux
   • php bin/compile (cela peut prendre un certain temps)
   • Un daux.phar nouvellement fabriqué sera désormais dans votre répertoire de base

Utilisation de DAUX pour servir des fichiers rendus à la volée

Une fois que vous avez terminé ce qui précède, suivez les instructions sur le site DAUX pour exécuter DAUX à l'aide d'un serveur Web.

En tant qu'option simple étant donné que PHP a installé PHP, vous pouvez également utiliser le serveur Web de développement intégré PHP si vous avez juste besoin de voir localement à quoi ressemblent les choses:

1. Dans le répertoire daux.io , modifiez global.json pour que l'option docs_directory pointe de votre répertoire vulkantutorial
   • "docs_directory": "../VulkanTutorial",
2. Dans le répertoire daux.io , exécutez
   • php -S localhost:8080 index.php
3. Tapez localhost:8080 dans votre barre d'URL du navigateur Web et appuyez sur Entrée. Vous devriez maintenant voir la première page vulkantutoriale.

Utilisation de DAUX pour générer statiquement des fichiers HTML

Avant de générer les fichiers statiques, nous devons modifier Daux et la configuration du didacticiel pour empêcher de l'essayer de charger quelques ressources extérieures (ce qui bloquera votre navigateur lorsque vous essayez de charger la page autrement statique)

1. Dans le répertoire VulkanTutorial , modifiez config.json et supprimez la ligne google_analytics pour que Daux n'essaie pas de charger cela.
2. Dans le répertoire daux.io , modifiez themes/daux/config.json et supprimez la ligne font afin que Daux n'essaie pas de charger une police externe.
3. Rebuild Daux en fonction des instructions précédentes afin qu'il prenne les changements de thème.

Nous travaillons sur des améliorations, donc à l'avenir, les étapes ci-dessus ne seront pas nécessaires.

Maintenant, avec ce qui précède, nous pouvons générer les fichiers statiques. Les répertoires Daux.io et Vulkantutorial sont à côté les uns des autres, accédez au répertoire daux.io et exécutez une commande similaire à: php generate -s ../VulkanTutorial -d ../VulkanTutorial/out .

-s dit où trouver la documentation, tandis que -d lui dit où mettre les fichiers générés.

Remarque: Si vous souhaitez générer à nouveau les documents, supprimez le répertoire out First ou DAUX fera un nouveau répertoire out dans le répertoire existant out .

Licence

Le contenu de ce référentiel est sous licence CC BY-SA 4.0, sauf indication contraire. En contribuant à ce référentiel, vous acceptez de concéder une licence à vos contributions au public en vertu de cette même licence.

Les annonces de code dans le répertoire code sont concédées sous licence CC0 1.0 Universal. En contribuant à ce répertoire, vous acceptez de concéder une licence à vos contributions au public dans le cadre de cette même licence de type domaine public.