VulkanTutorial

Vulkan -Tutorial

In diesem Repository befindet sich der Inhalt von vulkan-tutorial.com. Die Website selbst basiert auf Daux.io, der den Markdown mit Github -Aroma unterstützt. Auf der tatsächlichen Site wird daux.io mit einem benutzerdefinierten Thema und einigen Änderungen (https://github.com/overv/daux.io) ausgeführt. Dies ist in ein Docker -Bild integriert.

Verwenden Sie Probleme und ziehen Sie Anfragen an, um Feedback im Zusammenhang mit der Website zu geben. Wenn Sie ein Problem mit Ihrem Code haben, verwenden Sie den Kommentarbereich im verwandten Kapitel, um eine Frage zu stellen. Bitte geben Sie Ihr Betriebssystem, Grafikkarte, Treiberversion, Quellcode, erwartetes Verhalten und tatsächliches Verhalten an.

E-Book

Dieser Leitfaden ist jetzt auch in E-Book-Formaten erhältlich:

• Epub (Englisch, Französisch)
• PDF (Englisch, Französisch)

Das E-Book kann aus dem vorhandenen Inhalt durch Ausführen erstellt werden:

 python3 build_ebook.py

Dieses Skript hängt davon ab, dass die folgenden Dienstprogramme auf dem Pfad verfügbar sind:

• inkscape : SVG zu PNG -Konvertierung (getestet mit Version 1.0.2)
• pandoc : Erstellen eines PDF und EPUB aus dem Markdown -Code (getestet mit Version 2.13)

Sie müssen auch eine Latexverteilung für die PDF -Erzeugung installieren.

Ändern des Codes in den Kapiteln

Manchmal ist es notwendig, Code zu ändern, der in vielen Kapiteln wiederverwendet wird, beispielsweise eine Funktion wie createBuffer . Wenn Sie eine solche Änderung vornehmen, sollten Sie die Codedateien mit den folgenden Schritten aktualisieren:

• Aktualisieren Sie alle Kapitel, die auf den geänderten Code verweisen.
• Erstellen Sie eine Kopie der ersten Datei, die sie verwendet, und ändern Sie den Code dort, z. B. base_code_fixed.cpp .
• Erstellen Sie ein Patch mit diff -Naur base_code.cpp base_code_fixed.cpp > patch.txt .
• Wenden Sie den Patch in späteren Kapiteln auf die angegebene Codedatei und alle Dateien mit dem Skript incremental_patch.sh an. Führen Sie es so aus: ./incremental_patch.sh base_code.cpp patch.txt .
• Reinigen Sie die Dateien base_code_fixed.cpp und patch.txt .
• Begehen.

Das Tutorial machen

Um das Tutorial zu rendern (dh den Markdown in HTML) haben Sie zwei Optionen:

1. Servieren Sie gerenderte Dateien im laufenden Fliegen mit einem Webserver, auf dem PHP installiert ist
2. Generieren Sie statische HTML -Dateien, die Sie lokal anzeigen oder auf einen Server setzen können

Für eine dieser Optionen benötigen Sie PHP und einen Patch'ed Daux.

Php

1. Stellen Sie sicher, dass PHP installiert ist (DAUP ist in PHP geschrieben)
   1. Sowohl die Erweiterungen php_mbstring als auch php_openssl müssen aktiviert werden
   2. Die Einstellung phar.readonly muss auf Off eingestellt werden (um Daux wieder aufzubauen)
2. Stellen Sie sicher, dass Composer installiert ist, ein PHP -Abhängigkeitsmanager, den Daux verwendet

Klon-, Patch- und Wiederaufbau -Daux

1. Klonaux
   • git clone https://github.com/dauxio/daux.io.git
2. Machen Sie eine neue Filiale bei der älteren Überarbeitung, gegen die der vulkantutorielle Patch steht:
   • git checkout d45ccff -b vtpatch
   • Eine neue Niederlassung zu machen ist nicht streng notwendig, da Sie master zurücksetzen könnten, aber dies hält den Meister intakt.
3. Kopieren Sie die Datei daux.patch in das daux.io -Verzeichnis, stellen Sie sicher, dass die Zeilenende den Unix -Stil sind (falls Sie Windows verwenden), und wenden Sie den Patch an. Es sollte sauber angewendet werden.
   • git am daux.patch
4. Führen Sie den Komponisten im Verzeichnis daux.io aus, damit die Abhängigkeiten die DAUP -Anforderungen herunterladen, um zu erstellen
   • composer install
5. Daux wieder aufbauen
   • php bin/compile (dies kann eine Weile dauern)
   • Ein neu gemachtes daux.phar wird jetzt in Ihrem Basisverzeichnis sein

Verwenden Sie Daux, um gerenderte Dateien im laufenden Fliegen zu bedienen

Sobald Sie die oben genannten abgeschlossen haben, befolgen Sie die Anweisungen auf der Daux -Website, um Daux mithilfe eines Webservers auszuführen.

Als einfache Option, wenn man bedenkt, dass Sie PHP installiert haben, können Sie auch PHP -integrierte Entwicklungs -Webserver verwenden, wenn Sie nur lokal sehen müssen, wie die Dinge aussehen:

1. Bearbeiten Sie im Verzeichnis daux.io global.json , damit die Option docs_directory in Ihrem vulkantutoriellen Verzeichnis verweist
   • "docs_directory": "../VulkanTutorial",
2. Im Verzeichnis daux.io rennen
   • php -S localhost:8080 index.php
3. Geben Sie localhost:8080 in Ihre Webbrowser -URL -Leiste ein und drücken Sie die Eingabetaste. Sie sollten jetzt die Vulkantutorial -Titelseite sehen.

Verwenden von Daux, um HTML -Dateien statisch zu generieren

Bevor wir die statischen Dateien generieren, müssen wir Daux und das Tutorial -Setup optimieren, um zu verhindern, dass ein paar externe Ressourcen geladen werden (was Ihren Browser zum Laden der ansonsten statischen Seite stellt).

1. Bearbeiten Sie im VulkanTutorial -Verzeichnis config.json und entfernen Sie die google_analytics -Linie, sodass Daux nicht versucht, dies zu laden.
2. Bearbeiten Sie im Verzeichnis daux.io themes/daux/config.json und entfernen Sie die font , damit DAUX nicht versucht, eine externe Schriftart zu laden.
3. Bauen Sie Daux gemäß den früheren Anweisungen wieder auf, sodass es die Themenänderungen aufnimmt.

Wir arbeiten an Verbesserungen, so dass in Zukunft die oben genannten Schritte nicht erforderlich sein werden.

Jetzt können wir die statischen Dateien generieren. Die Verzeichnisse daux.io und vulkantutorial befinden sich nebeneinander, gehen Sie in das Verzeichnis daux.io und führen Sie einen Befehl aus, der ähnlich ist wie: php generate -s ../VulkanTutorial -d ../VulkanTutorial/out .

-s teilt es mit, wo Sie die Dokumentation finden, während -d mitteilt, wo die generierten Dateien eingestellt werden sollen.

Hinweis: Wenn Sie die Dokumente erneut generieren möchten, löschen Sie das out -Verzeichnis zuerst oder daux wird ein neues out -Verzeichnis innerhalb des vorhandenen out -Verzeichnisses erstellen.

Lizenz

Der Inhalt dieses Repositorys wird als CC BY-SA 4.0 lizenziert, sofern nicht anders angegeben. Durch den Beitrag zu diesem Repository erklären Sie sich damit einverstanden, Ihre Beiträge für die Öffentlichkeit im Rahmen derselben Lizenz zu lizenzieren.

Die Code -Listings im code sind als CC0 1.0 Universal lizenziert. Durch den Beitrag zu diesem Verzeichnis erklären Sie sich damit einverstanden, Ihre Beiträge für die Öffentlichkeit im Rahmen derselben öffentlich-domänenartigen Lizenz zu lizenzieren.