Auto Vk Toolkit

Auto-Vk-Toolkit v1.0

Auto-Vk-Toolkit ist ein Framework für die in moderne C ++ implementierte Vulkan-Grafik-API. Ziel ist es, den Sweet Spot zwischen Programmierer und Effizienz zu erreichen und gleichzeitig die volle Vulkan-Funktionalität zu unterstützen. Um dieses Ziel zu erreichen, verwendet dieses Framework Auto-VK , eine Komfort- und Produktivitätsschicht auf Vulkan-HPP.

Auto-VK-Toolkit wurde erfolgreich für schnelle Prototypen, Forschung (z.

Dieses Bild zeigt einige Arbeiten, die unter Verwendung von Auto-VK-Toolkit (von links nach rechts) entwickelt wurden: Verwendung in einem fortschrittlichen Grafikkurs zum Unterrichten moderner GPU-Konzepte auf niedriger Ebene; Visualisierung von 19.600 sphärischen Harmonischen Glyphen aus einem Gehirnscan; Aufteilung von Maschen in Meshlets und das Rendern von feinkörnigem Aussichtspunkt und Rückenwace Culling in Aufgaben- und Maschen-Shadern; Ray verfolgt Schatten und Reflexionen mithilfe der Hardware-Beschleunigten in Echtzeit-Strahlenverfolgungsgeräte. Rendering von 358K parametrisch definierten Faserkurven in Echtzeit.

Zu den Highlight-Featuren (neben den fantastischen Funktionen von Auto-VK ) gehören:

• Fensterverwaltung und Eingabehandhabung durch GLFW.
• Rendern Loop Framework mit update() und render() Rückrufen zu unterschiedlichen oder festen Update -Zeiten.
• Leistungsstarke Auto -VK - avk::root -Implementierung, mit Swap -Kettenhandhabung und automatischer Lebensdauermanagement von Ressourcen.
• Vielseitiger Updater, der die Swapchain -Erholung ermöglicht.
• In Kombination mit einem leistungsstarken Post-Build-Helfer- Tool (nur Windows) ermöglicht der Updater Shader Hot Reloading.
• Modellbelastung einer Vielzahl von 3D -Szenen mithilfe von Annahme.
• Laden von .fscene -Dateien aus dem ORCA: Open Research Content Archive.
• Laden einer Vielzahl von Bildformaten, einschließlich Würfelkarten.
• Vielseitiger Serializer -Unterstützung, mit dem Vulkan -Ressourcen wie avk:buffer oder avk::image sowie benutzerdefinierte Typen serialisieren können; basierend auf Müsli.
• Benutzeroberfläche Unterstützung durch IMGUI mit Unterstützung für die Anzeige von Texturen in der Benutzeroberfläche.
• Unterstützung für Echtzeit-Strahlenverfolgung (RTX) und bequemes Aufbau von Beschleunigungsstrukturen aus Dreiecksnetzen oder AABBs.
• Unterstützung für die Aufteilung von Maschen in Meshlets, die mit Aufgaben- und Maschen -Shadern gerendert werden können.
• Umgang mit Knochenhierarchien, Stützung der Animation von Hautnetzen.

Inhaltsverzeichnis

• Installation
  • Visual Studio 2022
    • Anforderungen
    • Anweisungen einrichten und erstellen
    • Richten Sie Ihr eigenes Projekt ein
  • Cmake
• Beispiele
• Erstellen eines neuen Projekts
• Ressourcenmangement und der Post -Build -Helfer
• Was ist der Unterschied zwischen Auto-VK-Toolkit und Auto-VK?
• Dokumentation
• FAQs, bekannte Probleme, Fehlerbehebung

Installation

Auto-Vk-Toolkit ist bereit für Visual Studio oder CMake. Wenn Ihr System die Systemanforderungen erfüllt, ist alles eingerichtet, um einen Lauf direkt aus der Schachtel zu erstellen. ZB für Visual Studio, öffnen Sie visual_studio/auto_vk_toolkit.sln , setzen Sie eines der Beispielprojekte als Startprojekt, erstellen und rennen!

Hinweis: Die Version in der Entwicklungszweig ist möglicherweise auf dem neuesten Stand und enthält zusätzliche Funktionen und Korrekturen. Bitte überlegen Sie, ob Sie diese Version verwenden, insbesondere wenn Sie auf Probleme stoßen.

Hinweis: Beim ersten Lauf wird das Post -Build -Helfer -Tool erstellt. Sehen Sie sich die Registerkarte "Ausgabe" von Visual Studios für Statusnachrichten und mögliche Anweisungen an.

Visual Studio 2022

Für Visual Studio 2022 finden Sie unter Windows ein vorkonfiguriertes Projektaufbau.

Anforderungen

• Windows 10 oder 11
• Visual Studio 2022 mit einem installierten Windows 10 oder 11 SDK (für detaillierte Informationen zu Projekteinrichtungen und Ressourcenverwaltung finden Sie unter visual_studio/README.md .)
• Ein Vulkan 1.3 SDK aus Lunarg, optimal vulkan sdk 1.3.250.0 oder neuer.

Anweisungen einrichten und erstellen

• Klonen oder Laden Sie dieses Repository herunter oder laden Sie sie herunter
• Führen Sie git submodule update --init um das auto-vk -Framework zu ziehen, das als Submodule unter auto_vk hinzugefügt wird
• Laden Sie einen der neuesten Vulkan -SDKs für Windows herunter und installieren Sie sie!
  • Wählen Sie den Vulkan Memory Allocator header. Option, damit die Bibliothek von Vulkan Memory Allocator (VMA) installiert ist.
  • HINWEIS: VMA kann über das Vulkan -Installateur oder sein Wartungstool (z. B. maintenancetool.exe unter Windows) installiert werden, indem der Vulkan Memory Allocator header. Option.
• Laden Sie die Visual Studio Community 2022 oder eine neuere Version herunter und installieren Sie sie.
  • Wählen Sie die Desktop development with C++ Workload im Installer aus!
• Empfohlen: Installieren Sie die Erweiterung der GLSL Language Integration für die Syntax -Hervorhebung in Shader -Dateien!
  • Hinweis: Gehen Sie zu Tools -> Options -> GLSL language integration . Für die Entwicklung von Vulkan Shader setzen Sie entweder Live compiling auf False (nur Syntax -Hervorhebung) oder setzen Sie den External compiler executable file auf den Pfad zu glslangValidator.exe !
• Öffnen Sie die Visual Studio -Lösungsdatei visual_studio/auto_vk_toolkit.sln und erstellen Sie die Lösung
• Während des Bauens erkennen Sie Nachrichten aus dem Post -Build -Helfer -Tool in Output -TAB von Visual Studio, einigen Popup -Nachrichten und einem Symbol im Systemfach. Bitte werfen Sie einen Blick auf die Abschnittsressourcen -Mangement und den Post -Build -Helfer, um zusätzliche Informationen zu erhalten.
• In der Lösungsdatei sind mehrere Beispielanwendungen verfügbar. Setzen Sie einen von ihnen als Startprojekt und laufen Sie aus.

Richten Sie Ihr eigenes Projekt ein

• Um einem Ihrer benutzerdefinierten Repositories automatisch-vk-toolkit hinzuzufügen, möchten Sie es möglicherweise als Git-Submodul hinzufügen. Sie können git submodule add https://github.com/cg-tuwien/Auto-Vk-Toolkit.git auto_vk_toolkit , um auto-vk-toolkit als submodule im Verzeichnis auto_vk_toolkit hinzuzufügen.
• Führen Sie git submodule update --init --recursive aus, um sowohl Auto-VK-Toolkit als auch Auto-VK zu ziehen.
• Die im Abschnitt beschriebenen Schritte, die ein neues Projekt erstellen, ist möglicherweise hilfreich, um ein benutzerdefiniertes Visual Studio-Projekt einzurichten, das mit Auto-Vk-Toolkit verknüpft wird.
• Der bequemste Weg, um Ihr eigenes Projekt einzurichten, ist möglicherweise eine der Startervorlagen:
  • Startervorlage für Visual Studio-basierte Projekte: Auto-Vk-Toolkit-VS-Starter
  • Startervorlage für CMake-basierte Projekte: Auto-VK-Toolkit-Starter

Cmake

Siehe docs/cmake.md!

Beispiele

Hallo Welt	Mehrere Warteschlangen	Bildverarbeitung berechnen	Orca -Lader

In diesem Repository sind mehrere Beispielanwendungen enthalten:

• Hallo Welt: Wie man ein einziges Dreieck macht
• Vertex -Puffer: So verwenden Sie Vertex -Puffer mit Grafikpipelines
• FrameBuffer: So erstellen und verwenden Sie Framebuffer
• Multi -Invokee -Rendering: So verwenden Sie mehrere Invokes, wie Ihre Anwendung strukturiert werden kann
• Mehrere Qeues: So verwenden Sie mehrere Warteschlangen (zwei Transfer- und eine Grafikwarteschlange)
• Berechnen Sie Bildverarbeitung
• Gegenwart von Berechnung: Wie man der Tauschkette aus einer Berechnung der Warteschlange präsentiert
• Modelllader: So laden Sie 3D -Modelle aus der Datei und rendern Sie sie
• Orca Loader: So laden Sie Orca .fscene -Dateien und rendern sie; Auch die Verwendung des Serializers
• Statische Meshlets: So teilen Sie ein 3D -Modell in kleine Meshlets und rendern sie mit Aufgaben- und Mesh -Shadern
• Skemed Meshlets: Wie man ein animiertes, gehäutiges 3D -Modell in kleine Meshlets aufteilt und wie man die Verwendung von Aufgaben- und Mesh -Shadern animiert und rendert
• Ray-Verfolgung mit Schatten und AO: So erstellen Sie Beschleunigungsstrukturen aus Dreiecksäumen und erstellen Sie ein Bild mit Strahlen. Zusätzlich fügt Ray nachverfolgte Schatten und eine sehr einfache (und hässliche) Version der Umgebungsverschlüsse zum gerenderten Ergebnis durch rekursive Strahlenverfolgung von den engsten Hit -Shadern hinzu.
• Ray -Abfrage in Ray Tracing Shaders: Ähnlich dem Beispiel "Ray Tracing mit Schatten und AO", aber anstelle einer rekursiven Strahlverfolgung mit einer Shader -Bindungstabelle usw. verwendet es einfach Ray -Abfragen von den nächstgelegenen Hit -Shadern, um dasselbe Ergebnis zu erzielen.
• Ray Tracing Custom Intersection: So baut Beschleunigungsstrukturen aus AABBs und aus Dreiecksnetzen auf.
• Textur Cubemap: So laden und verwenden Sie Würfelkarten.

Häutnetzes	Ray -Abfrage und Strahlenverfolgung	RTX Custom Intersection	Textur Cubemap

Erstellen eines neuen Projekts

Für Visual Studio -Projekte gibt es ein Convenience -Tool unter visual_studio/tools/executables/ , das dazu beitragen kann, ein neues Projekt durch das Kopieren eines vorhandenen (z. B. eine der Beispielanwendungen) schnell einzurichten: create_new_project.exe

Verwenden Sie es wie folgt, um eine Kopie eines vorhandenen Projekts zu erstellen:

• Öffnen Sie create_new_project.exe und wählen Sie entweder eine der Beispielanwendungen aus oder geben Sie den Pfad zum manuellen Projekt ein.
• Geben Sie den Zielort, den Zielprojektnamen, ein und klicken Sie auf die [erstellen!] -Button.
• Das Projekt wird in den Zielordner kopiert und alle relativen Pfade werden an den neuen Speicherort angepasst, wenn sich der Zielordner auf demselben Laufwerk wie das Quellprojekt befindet. (Wenn nicht, sind absolute Pfade eingestellt.)
• Asset -Referenzen und Shader -Referenzen werden beibehalten und ihre Wege werden angepasst.
  Achtung: Entfernen Sie die vorhandenen Referenzen, wenn Sie die referenzierten Vermögenswerte/Shader ändern möchten! Sie müssen Kopien dieser Dateien manuell erstellen und stattdessen Verweise auf die Kopien hinzufügen. Wenn Sie dies nicht tun, ändern Sie die Aktienvermögen oder die Shader -Dateien der Beispiele.
• Vorkompilierte Header sind in der neu erstellten Projektkopie deaktiviert. Wenn Sie diese Funktion verwenden möchten, müssen Sie diese in den Projekteinstellungen von Visual Studio manuell aktivieren.
• Fügen Sie manuell einen Verweis auf das Projekt Auto-VK-Toolkit Library Project auto_vk_toolkit.vxcproj zu Ihrer Visual Studio-Lösung hinzu und stellen Sie sicher, dass die neu erstellte Projektkopien sie verweisen.
• Alle Quellen und enthaltene Dateireferenzen werden aus der neu erstellten Projektkopie entfernt. Sie müssen mindestens eine .cpp -Datei mit einer main() -Funktion hinzufügen.
• Fügen Sie #include <auto_vk_toolkit.hpp> hinzu, um auto-vk-toolkit zu verwenden.
• Nach diesen Schritten sollten Sie in der Lage sein, erfolgreich mit auto-vk-toolkit zu verbinden, die Ihr neu erstelltes Projekt erstellen.

Eine gute Strategie create_new_project.exe darin, Ihrem Repository Auto-VK-Toolkit als Git-Submodule hinzuzufügen und die obigen Schritte zu verwenden, um ein ordnungsgemäß konfiguriertes Projekt in einem Verzeichnis außerhalb des Submoduls zu erstellen. Stellen Sie sicher, dass Sie das Submodul häufig aktualisieren, indem Sie aus master -Zweig von Auto-Vk-Toolkit ziehen, um die neuesten Updates zu erhalten.

Ressourcenmangement und der Post -Build -Helfer

Die Visual Studio-Projekte von Auto-VK-Toolkit sind so konfiguriert, dass Visual Studio selbst elegant für das Ressourcenmanagement verwendet werden kann. Das bedeutet, dass die erforderlichen Assets (3D -Modelle, Bilder, ORCA -Szenendateien) und Shader -Dateien nur zu den Filtern von Visual Studios in der Ansicht "Lösungxplorer" hinzugefügt werden können, und ein intelligentes Post -Build -Helfer -Tool stellt sicher, dass diese Ressourcen in das Zielverzeichnis der Anwendung bereitgestellt werden.

Kurz gesagt/ tl; dr :

• Fügen Sie dem assets die erforderlichen 3D -Modelle, Bilder und Orca -Szenen hinzu und
• Fügen Sie dem shaders -Filter den erforderlichen Shader -Dateien direkt in Visual Studio hinzu. Erstellen Sie dann die Anwendung, warten Sie, bis der Post -Build -Helfer diese Ressourcen für das Zielverzeichnis bereitstellt, und führen Sie Ihre Bewerbung aus!

Dies kann nach Folgen aussehen, wo die assets und shaders eine besondere Bedeutung haben, wie oben angedeutet:

Eine detailliertere Erklärung und weitere Anweisungen finden Sie in visual_studio/README.md .

Sie werden feststellen, dass Post -Build -Helfer -Aktivitäten durch das Tablettsymbol: . Das Tool bleibt aktiv, nachdem die Bereitstellung aus zwei Hauptgründen beendet ist:

• Es ermöglicht die Untersuchung von Protokollen aus früheren Build -Ereignissen und auch die Einstellungen.
• Es überwacht weiterhin Ressourcendateien, was besonders wichtig ist, um Shader Hot Reloading zu aktivieren.

Weitere Informationen zum Post-Build-Helfer finden Sie im Abschnitt "Post Build Helfer". Weitere Informationen zum Shader Hot Reloading finden Sie im folgenden Abschnitt Automatic Resource Updates.

Was ist der Unterschied zwischen Auto-VK-Toolkit und Auto-VK?

Auto-VK ist eine plattform-agnostische Bequemlichkeit und Produktivitätsschicht auf Vulkan-HPP.

Auto-VK-Toolkit stellt die fehlende Verbindung zum Betriebssystem wie die Umstellung des Fensters fest und fügt weitere Funktionen hinzu:

• Rendering -Umgebungskonfiguration wie Aktivieren von Vulkan -Erweiterungen (z. B. wenn VK_KHR_ray_tracing_pipeline verwendet wird, wählt ein geeignetes physisches Gerät aus und ermöglicht die erforderlichen Flags und Erweiterungen)
• Fensterverwaltung (über GLFW)
• Game-Loop/Render-Loop-Handhabung mit bequemen, um Callback-Methoden über die avk::invokee Schnittstelle (z. B. initialize() , update() , render() , wobei erstere nur einmal aufgerufen wird und die beiden beiden jeweils jeden Frame angerufen werden)
• Benutzereingangsbehandlung
• Eine Bereitschaft, Basisklasse für Objekthierarchien zu verwenden: avk::transform
• Bereit, benutzerfreundliche Kameraklassen avk::quake_camera und avk::orbit_camera (abgeleitet von beiden, avk::transform und avk::invokee )
• Ressourcenladeunterstützung für:
  • Bilder
  • 3D -Modelle
  • Szenen im Orca -Format siehe: ORCA: Open Research Content Archive
• Materialbelastung und Umwandlung in ein GPU-fähiger Format ( avk::material und a vk::material_gpu_data )
• LightSource-Laden und Umwandlung in ein GPU-bloßbares Format ( avk::lightsource und avk::lightsource_gpu_data )
• Ressourcenhandhabung über die Filter von Visual Studios, dh nur Drag & Drop -Assets und Shader, die Sie direkt in die Filterhierarchie von Visual Studio verwenden möchten, und lassen Sie sie im Zielverzeichnis bereitgestellt.
• Ein leistungsstarkes Post -Build -Helfer -Tool, das als benutzerdefinierter Build -Schritt aufgerufen wird.
  • Es stellt Vermögenswerte und Shader für das Zielverzeichnis bereit
  • Shader werden in Spire-V zusammengestellt
  • Wenn Shader-Dateien Fehler enthalten, werden Popup-Nachrichten erstellt, wobei der Fehler angezeigt wird und eine [->VS] -Taste bereitgestellt wird, um zu der Zeile zu navigieren, die den Fehler in Visual Studio enthält.
  • Standardmäßig erstellen "Debug" und "Release" -Ergestellungskonfigurationen Symlink -Ressourcen zum Speichern von Speicherplatz. "Veröffentlichen" Konfigurationen stellen jedoch alle erforderlichen Dateien in das Zielverzeichnis bereit, damit ein erstelltes Programm problemlos auf einen anderen PC übertragen werden kann. In solchen Situationen ist kein mühsames Sammeln von Ressourcen erforderlich, da dies alles vom Post -Build -Helfer behandelt wird.

Dokumentation

Es gibt einige Dokumentationsseiten mit weiteren Informationen:

• Nutzung von IMGui für Benutzeroberflächen und beschreibt, wie man liebe Imgui in einem Auto-Vk-Toolkit- Projekt verwendet
• CMAKE -SETUP- und BESTELLEN Anweisungen
• Meshlets-spezifische Funktionalität zur Aufteilung der Geometrie in kleine Cluster und zur Verwendung in Grafik-Netzpipelines (diejenigen mit Aufgaben- und Mesh-Shadern)
• Serializer -Funktionalität zum Speichern und Laden von Ressourcen in/aus Datei, z. B. 3D -Modelle, Bilder oder benutzerdefinierte Strukturen
• Automatische Ressourcen-Updates über die avk::updater -Klasse, die Shwapchain Recreation und Shader Hot Reloading ermöglicht
• Dynamisches Rendering: So verwenden Sie dynamisches Rendering in Auto-VK-Toolkit

FAQs, bekannte Probleme, Fehlerbehebung

F: Kann automatisch-vk-toolkit unter Linux verwendet werden?
A: Ja. Bitte beachten Sie die CMAKE -Dokumentation unter docs/cmake.md!

F: Kann automatisch-vk-toolkit ohne Helfer des Post-Builds verwendet werden?
A: Ja. Der Post -Build -Helfer ist ein Convenience -Tool, das die Bereitstellung von Ressourcen, Asset -Abhängigkeiten und auch Dateiaktualisierungen übernimmt (hilfreich für Shader Hot Reloading, abhängig von der Projektstruktur). Wenn Sie es nicht verwenden, müssen Sie die Bereitstellung von Ressourcen verwalten und Shader-Dateien in Spire-V manuell zusammenstellen.

F: Ich habe Probleme mit dem Asset -Management in Visual Studio. Irgendwelche Ratschläge?
A: Schauen Sie sich die bekannten Probleme an und beheben Sie die Bearbeitung von WRT -Asset, die Richtlinien für die folgenden Fälle anbieten:

• Erstellen Sie Fehler beim Hinzufügen von Vermögenswerten
• Asset wird nicht bereitgestellt

F: Es wurden mehr Ressourcen eingesetzt, als ich zu den Filtern von Visual Studio hinzugefügt habe. Was ist los?
A: Einige Vermögenswerte verweisen auf andere Vermögenswerte intern. Zum Beispiel verweisen 3D -Modelle häufig Bilder oder Materialdateien (im Fall von .obj -Modellen). Diese "abhängigen Vermögenswerte" werden auch vom Post -Build -Helfer im Zielverzeichnis eingesetzt. Weitere Informationen finden Sie unter Bereitstellung von abhängigen Vermögenswerten.

F: Was sind die Unterschiede zwischen Debug- , Release- und Publish -Build -Konfigurationen?
A: In Bezug auf die Kompilierungseinstellungen sind die Veröffentlichung und Veröffentlichungskonfigurationen gleich. Sie verknüpfen mit Veröffentlichungsbusten von Bibliotheken. Die Debug -Konfiguration verfügt über klassische Debug -Einstellungen, die für die Visual Studio -Projekte und Links gegen Debug -Builds von Bibliotheken konfiguriert sind. Es gibt jedoch einen Unterschied zwischen Veröffentlichungsbusten und Nicht- Veröffentlichungsbusten für die Bereitstellung von Ressourcen. Weitere Informationen finden Sie in symbolischen Links/Kopien je nach Build -Konfiguration.

F: Ich habe Probleme mit dem Post -Build -Helfer . Was zu tun?
A: Schauen Sie sich den Helfer für Post -Build an, der Richtlinien für die folgenden Fälle bietet:

• Build steckt in "MSBUILD.EXE" -SCHRITT, der auf der Registerkarte "Visual Studio" angezeigt wird, um [...] aufzurufen.
• Post -Build -Helfer kann nicht automatisch/über msbuild.exe erstellt werden
• Es werden zu wenige Ressourcen eingesetzt
• Die Anwendung konnte zunächst nicht starten (möglicherweise aufgrund fehlender Vermögenswerte oder DLLs)
• Fehlermeldung über den verweigerten Zugriff auf DLL-Dateien (DLLs werden nicht neu eingestellt)
• Langsame Leistung beim Anzeigen von Listen im Post -Build -Helfer
• Fehlermeldung in der Benutzeroberfläche des Post -Build -Helfer: "Konnte keinen Teil des Pfades finden '...'"
• Fehlermeldung in der Konsole: can't fopen oder !RUNTIME ERROR! Couldn't load image from '...'

F: Die Anwendung dauert lange, bis Vermögenswerte wie 3D -Modelle und Bilder geladen werden. Kann es beschleunigt werden?
A: Wenn Sie sich auf Debug -Builds beziehen, können Sie Post -Build -Helfer so konfigurieren, dass die Release -DLLs einiger externer Abhängigkeiten auch für Debug -Builds bereitgestellt werden. Sie sollten das Vermögensladen viel beschleunigen. Um die Bereitstellung von Release -DLLs zu aktivieren, öffnen Sie bitte die Einstellungen von Post Build Helper und aktivieren Sie die Option "Immer Release DLLs bereitstellen".

F: cereal::Exception in cereal::loadBinary , oder Unhandled exception at 0x00007FFE82204FD9 in ...exe: Microsoft C++ exception: cereal::Exception at memory location ...
A: Ihre serialisierte Cache -Datei (z. B. für sponza_and_terrain.fscene Dies könnte sponza_and_terrain.fscene.cache ) korrupt geworden (möglicherweise weil sie aufgrund eines zuvor vorgeschlagenen Fehlers in der Anwendung nicht vollständig geschrieben wurde oder weil die Ausführung abgebrochen wurde). Löschen Sie die Cache -Datei (z. B. sponza_and_terrain.fscene.cache ) und lassen Sie ein neues generiert werden!