Auto Vk Toolkit

AUTO-VK-TOOLKIT V1.0

Auto-VK-Toolkit adalah kerangka kerja untuk API Grafis Vulkan, yang diimplementasikan dalam C ++ modern. Ini bertujuan untuk mencapai sweet spot antara programmer-convenience dan efisiensi sambil tetap mendukung fungsionalitas vulkan penuh. Untuk mencapai tujuan ini, kerangka kerja ini menggunakan Auto-VK , lapisan kenyamanan dan produktivitas di atas Vulkan-HPP.

Auto-VK-Toolkit telah berhasil digunakan untuk prototyping cepat, penelitian (misalnya, batas meshlet konservatif untuk pemusnahan jerat berkulit yang kuat, rendering objek parametrik yang cepat pada GPU modern), dan pengajaran (misalnya, algoritma untuk rending waktu-nyata).

Gambar ini menampilkan beberapa karya yang telah dikembangkan menggunakan Auto-VK-Toolkit (dari kiri ke kanan): Penggunaan dalam kursus grafis canggih untuk mengajar konsep GPU tingkat rendah modern; Visualisasi 19.600 glyph harmonik bola dari pemindaian otak; Divisi jerat menjadi meshlets dan menjadikannya dengan frustum view-berbutir halus dan culling backface dalam tugas dan shader mesh; Ray melacak bayangan dan refleksi menggunakan ekstensi perangkat penelusuran ray real-time yang dipercepat perangkat keras; Render 358K kurva serat yang ditentukan secara parametrikal secara real time.

Beberapa fitur sorotnya (selain fitur yang luar biasa dari Auto-VK ) meliputi:

• Manajemen jendela dan penanganan input melalui GLFW.
• Kerangka kerja loop render dengan update() dan render() callbacks pada waktu pembaruan yang bervariasi atau tetap.
• Auto -VK yang kuat - avk::root , dengan penanganan rantai swap dan manajemen seumur hidup sumber daya otomatis.
• Pembaruan serbaguna yang memungkinkan rekreasi swapchain.
• Dalam kombinasi dengan alat helper Build Post yang kuat (hanya Windows), pembaruan memungkinkan pemuatan ulang hot shader.
• Model pemuatan berbagai adegan 3D dengan bantuan assim.
• Memuat file .fscene dari ORCA: Open Research Content Archive.
• Memuat banyak format gambar, termasuk peta kubus.
• Dukungan Serializer Serbaguna yang memungkinkan untuk membuat serial sumber daya vulkan seperti avk:buffer atau avk::image , dan juga tipe khusus; berdasarkan sereal.
• Dukungan antarmuka pengguna melalui IMGUI dengan dukungan untuk menampilkan tekstur di UI.
• Dukungan untuk penelusuran ray real-time (RTX) dan bangunan yang nyaman dari struktur akselerasi dari jerat segitiga atau AABB.
• Dukungan untuk membagi jerat menjadi meshlets yang dapat diterjemahkan dengan Tugas dan Shaders Mesh.
• Penanganan hierarki tulang, mendukung animasi jerat berkulit.

Daftar isi

• Instalasi
  • Visual Studio 2022
    • Persyaratan
    • Mengatur dan membangun instruksi
    • Siapkan Proyek Anda Sendiri
  • Cmake
• Contoh
• Membuat proyek baru
• Sumber daya sumber daya dan penolong pembuatan pos
• Apa perbedaan antara Auto-VK-Toolkit dan Auto-VK?
• Dokumentasi
• FAQ, masalah yang diketahui, pemecahan masalah

Instalasi

Auto-VK-Toolkit siap digunakan dengan Visual Studio atau CMake. Jika sistem Anda memenuhi persyaratan sistem, semuanya diatur untuk membangun jalan keluar dari kotak. Misalnya, untuk Visual Studio, buka visual_studio/auto_vk_toolkit.sln , atur salah satu contoh proyek sebagai proyek startup, build and run!

Petunjuk: Versi di cabang pengembangan mungkin lebih mutakhir dan berisi fitur dan perbaikan tambahan. Harap pertimbangkan untuk menggunakan versi itu, terutama jika Anda mengalami masalah.

Catatan: Pada menjalankan pertama, alat pembantu Build Post sedang dibangun. Tonton tab "output" Visual Studio untuk pesan status dan kemungkinan instruksi.

Visual Studio 2022

Pengaturan proyek yang telah dikonfigurasi sebelumnya disediakan untuk Visual Studio 2022 di Windows.

Persyaratan

• Windows 10 atau 11
• Visual Studio 2022 dengan Windows 10 atau 11 SDK diinstal (untuk informasi terperinci tentang pengaturan proyek dan manajemen sumber daya silakan merujuk ke visual_studio/README.md .)
• Vulkan 1.3 SDK dari Lunarg, Optimal Vulkan SDK 1.3.250.0 atau lebih baru.

Mengatur dan membangun instruksi

• Klon atau unduh repositori ini
• Jalankan git submodule update --init untuk menarik kerangka Auto-VK yang ditambahkan sebagai submodule di bawah auto_vk
• Unduh dan instal salah satu SDK Vulkan terbaru untuk Windows!
  • Pilih Vulkan Memory Allocator header. Opsi sehingga perpustakaan Vulkan Memory Allocator (VMA) diinstal.
  • CATATAN: VMA dapat diinstal melalui pemasang Vulkan atau alat pemeliharaannya (misalnya, maintenancetool.exe pada Windows) dengan memilih Vulkan Memory Allocator header. pilihan.
• Unduh dan instal Visual Studio Community 2022, atau versi yang lebih baru.
  • Pilih Desktop development with C++ di installer!
• Direkomendasikan: Instal ekstensi integrasi bahasa GLSL untuk menyorot sintaks dalam file shader!
  • Petunjuk: Pergi ke Tools -> Options -> GLSL language integration . Untuk pengembangan vulkan shader, atur Live compiling ke False (sintaks hanya menyorot), atau atur External compiler executable file ke, misalnya, jalur ke glslangValidator.exe !
• Buka file solusi visual studio visual_studio/auto_vk_toolkit.sln , dan bangun solusinya
• Selama bangunan, Anda akan mengenali pesan dari alat pembantu Build Post di Output Visual Studio -TAB, beberapa pesan sembulan, dan ikon di baki sistem. Silakan lihat mangement sumber daya bagian dan penolong pembuatan pos untuk informasi tambahan.
• Beberapa contoh aplikasi tersedia dalam file solusi. Tetapkan salah satunya sebagai proyek startup, dan jalankan.

Siapkan Proyek Anda Sendiri

• Untuk menambahkan Auto-VK-Toolkit ke salah satu repositori khusus Anda, Anda mungkin ingin menambahkannya sebagai submodule git. Anda dapat menjalankan git submodule add https://github.com/cg-tuwien/Auto-Vk-Toolkit.git auto_vk_toolkit untuk menambahkan auto-vk-toolkit sebagai submodule di direktori auto_vk_toolkit .
• Jalankan git submodule update --init --recursive untuk menarik keduanya, Auto-VK-Toolkit dan Auto-VK .
• Langkah-langkah yang dijelaskan di bawah bagian yang membuat proyek baru mungkin bermanfaat untuk menyiapkan proyek Visual Studio khusus yang menghubungkan dengan Auto-VK-Toolkit .
• Cara paling nyaman untuk mengatur proyek Anda sendiri mungkin adalah salah satu templat pemula:
  • Template starter untuk proyek berbasis studio visual: Auto-VK-Toolkit-VS-Starter
  • Templat starter untuk proyek berbasis cmake: auto-vk-toolkit-starter

Cmake

Silakan lihat Docs/Cmake.md!

Contoh

Halo dunia	Beberapa antrian	Hitung pemrosesan gambar	Orca loader

Beberapa contoh aplikasi disertakan dalam repositori ini:

• Halo dunia: cara membuat satu segitiga tunggal
• Buffer Vertex: Cara Menggunakan Buffer Vertex dengan Pipa Grafik
• Framebuffer: Cara membuat dan menggunakan framebuffer
• Multi Invokee Rendering: Cara Menggunakan Banyak Informasi, Bagaimana Aplikasi Anda Dapat Disusun
• Beberapa QEUUS: Cara memanfaatkan beberapa antrian (dua transfer dan satu antrian grafik)
• Hitung Pemrosesan Gambar: Cara Menggunakan Shader Hitung Untuk Beberapa Pemrosesan Gambar
• Hadir dari Compute: Cara Menyajikan ke Rantai Pertukaran dari Antrian Hitung
• Model Loader: Cara memuat model 3D dari file dan render
• Orca loader: cara memuat file orca .fscene dan membuatnya; juga cara menggunakan serializer
• Meshlets statis: Cara membagi model 3D menjadi meshlet kecil dan membuatnya menggunakan Tugas dan Shaders Mesh
• Meshlets berkulit: Cara membagi model 3D berkulit animasi menjadi meshlet kecil dan bagaimana menghidupkan dan membuat yang menggunakan Tugas dan Shaders Mesh
• Penelusuran Ray dengan bayangan dan AO: Cara Membangun Struktur Akselerasi Dari Segitiga Jerat dan Membuat Gambar Jalan-Jalan. Selain itu menambahkan Ray yang dilacak bayangan dan versi oklusi ambient yang sangat sederhana (dan jelek) ke hasil yang diberikan dengan penelusuran ray rekursif dari shader hit terdekat.
• Ray Query di Ray Tracing Shaders: Mirip dengan contoh "Ray Tracing With Shadows and Ao", tetapi alih -alih penelusuran Ray rekursif dengan tabel pengikat shader dll., Ini hanya menggunakan kueri Ray dari shader hit terdekat untuk mencapai hasil yang sama.
• Ray Tracing Custom Intersection: Cara Membangun Struktur Akselerasi dari AABB dan dari Segitiga jerat.
• Tekstur CubeMap: Cara memuat dan menggunakan peta kubus.

Meshlets berkulit	Ray Query dan Ray Tracing	Persimpangan Kustom RTX	Tekstur Cubemap

Membuat proyek baru

Untuk proyek Visual Studio, ada alat kenyamanan di bawah visual_studio/tools/executables/ yang dapat membantu untuk dengan cepat mengatur proyek baru dengan menyalin yang sudah ada (misalnya salah satu aplikasi contoh): create_new_project.exe

Gunakan seperti berikut untuk membuat salinan proyek yang ada:

• Buka create_new_project.exe dan pilih salah satu contoh aplikasi atau masukkan jalur ke proyek yang akan disalin secara manual.
• Masukkan lokasi target, nama proyek target, dan tekan [buatlah!] -Tenggul.
• Proyek ini disalin ke folder target dan semua jalur relatif disesuaikan dengan lokasi baru jika folder target berada pada drive yang sama dengan proyek sumber. (Jika tidak, jalur absolut diatur.)
• Referensi aset dan referensi shader dipertahankan dan jalurnya diadaptasi.
  Perhatian: Pastikan untuk menghapus referensi yang ada jika Anda akan memodifikasi aset/shader yang direferensikan! Anda harus membuat salinan file -file ini secara manual dan menambahkan referensi ke salinannya. Jika Anda gagal melakukannya, Anda akan akhirnya memodifikasi aset stok atau file shader contoh.
• Header yang dikompilasi dinonaktifkan dalam salinan proyek yang baru dibuat. Jika Anda ingin menggunakan fitur ini, Anda harus mengaktifkannya secara manual dalam pengaturan proyek Visual Studio.
• Tambahkan referensi secara manual ke Proyek Perpustakaan Auto-VK-Toolkit auto_vk_toolkit.vxcproj ke solusi Visual Studio Anda dan memastikan bahwa salinan proyek yang baru dibuat merujuknya.
• Semua sumber dan termasuk referensi file dihapus dari salinan proyek yang baru dibuat. Anda harus menambahkan setidaknya file .cpp yang berisi fungsi main() .
• Tambahkan #include <auto_vk_toolkit.hpp> untuk menggunakan auto-vk-toolkit .
• Setelah langkah-langkah ini, Anda harus berhasil menghubungkan dengan Auto-VK-Toolkit membangun proyek yang baru Anda buat.

Strategi yang baik adalah menambahkan Auto-VK-Toolkit sebagai submodule Git ke repositori Anda dan menggunakan create_new_project.exe dan langkah-langkah di atas untuk membuat proyek yang dikonfigurasi dengan benar di direktori di luar submodule. Pastikan untuk sering memperbarui submodule dengan menarik dari cabang master Auto-VK-Toolkit untuk mendapatkan pembaruan terbaru.

Sumber daya sumber daya dan penolong pembuatan pos

Proyek Visual Studio Visual Auto-VK-Toolkit dikonfigurasi sehingga Visual Studio sendiri dapat digunakan secara elegan untuk manajemen sumber daya. Itu berarti, aset yang diperlukan (model 3D, gambar, file adegan orca) dan file shader hanya dapat ditambahkan ke filter Visual Studio di tampilan "Solution Explorer" dan alat pembantu Smart Post Build memastikan bahwa sumber daya tersebut digunakan ke direktori target aplikasi.

Singkatnya/ tl; dr :

• Tambahkan model 3D yang diperlukan, gambar, dan adegan orca ke filter assets , dan
• Tambahkan file shader yang diperlukan ke filter shaders langsung di Visual Studio. Kemudian bangun aplikasi, tunggu helper Post Build untuk menggunakan sumber daya ini ke direktori target, dan jalankan aplikasi Anda!

Ini bisa terlihat seperti berikut, di mana filter assets dan shaders memiliki makna khusus, seperti yang diisyaratkan di atas:

Penjelasan yang lebih rinci dan instruksi lebih lanjut diberikan dalam visual_studio/README.md .

Anda akan melihat Post Build Helper Activity melalui ikon baki: . Alat ini akan tetap aktif setelah penempatan selesai karena dua alasan utama:

• Ini memungkinkan untuk menyelidiki log dari acara pembangunan sebelumnya, dan juga mengubah pengaturan.
• Ini terus memantau file sumber daya yang sangat penting untuk mengaktifkan pemuatan ulang hot shader .

Untuk informasi lebih lanjut tentang Helper Build Post , silakan merujuk ke bagian Helper Build Post, dan untuk informasi lebih lanjut tentang Shader Hot Reloading, silakan merujuk ke bagian Pembaruan Sumber Daya Otomatis di bawah ini.

Apa perbedaan antara Auto-VK-Toolkit dan Auto-VK?

Auto-VK adalah lapisan kenyamanan dan produktivitas platform-agnostik di atas Vulkan-HPP.

Auto-VK-Toolkit membuat tautan yang hilang ke sistem operasi, seperti penanganan jendela, dan menambahkan fungsionalitas lebih lanjut:

• Konfigurasi lingkungan rendering, seperti mengaktifkan ekstensi vulkan (misalnya jika VK_KHR_ray_tracing_pipeline harus digunakan, ia memilih perangkat fisik yang sesuai dan memungkinkan bendera dan ekstensi yang diperlukan)
• Manajemen Jendela (melalui GLFW)
• Penanganan Game-Loop/Render-Loop dengan Metode Callback yang nyaman untuk menggunakan antarmuka avk::invokee (seperti initialize() , update() , render() , di mana yang pertama hanya dipanggil sekali dan dua yang terakhir dipanggil setiap bingkai)
• Penanganan input pengguna
• Kelas Dasar yang Siap untuk digunakan untuk Hirarki Objek: avk::transform
• Siap menggunakan kelas kamera yang dapat dikendalikan pengguna avk::quake_camera dan avk::orbit_camera (berasal dari keduanya, avk::transform and avk::invokee )
• Dukungan pemuatan sumber daya untuk:
  • Gambar
  • Model 3D
  • Adegan dalam format orca, lihat: orca: arsip konten riset terbuka
• Pemuatan materi dan konversi ke dalam format GPU-SUARTable ( avk::material dan a vk::material_gpu_data )
• Lightsource Loading dan Konversi ke dalam format GPU-Suitable ( avk::lightsource dan avk::lightsource_gpu_data )
• Penanganan sumber daya melalui filter Visual Studio, IE cukup seret dan jatuhkan aset dan shader yang ingin Anda gunakan langsung ke hierarki filter Visual Studio dan membuatnya digunakan ke direktori target.
• Alat pembangun Post Build yang kuat yang dipanggil sebagai langkah pembuatan khusus.
  • Itu menyebarkan aset dan shader ke direktori target
  • Shader dikompilasi menjadi spir-v
  • Jika file shader berisi kesalahan, pesan popup dibuat menampilkan kesalahan, dan menyediakan tombol [->VS] untuk menavigasi ke baris yang berisi kesalahan dalam Visual Studio.
  • Secara default, "debug" dan "rilis" membangun konfigurasi sumber daya symlink untuk menghemat ruang, tetapi "publikasi" membangun konfigurasi menggunakan semua file yang diperlukan ke direktori target sehingga program yang dibangun dapat dengan mudah ditransfer ke PC lain. Tidak ada lagi pengumpulan sumber daya yang membosankan yang diperlukan dalam situasi seperti itu karena itu semua ditangani oleh penolong Build.

Dokumentasi

Ada beberapa halaman dokumentasi yang berisi informasi lebih lanjut:

• Penggunaan IMGUI untuk Antarmuka Pengguna, menggambarkan cara menggunakan iMGUI yang terhormat dalam proyek Auto-VK-Toolkit
• Pengaturan CMake dan Bangun Instruksi
• Fungsionalitas meshlets-specfic untuk membagi geometri menjadi kelompok kecil dan menggunakannya untuk rendering dalam pipa grafis mesh (mereka yang memiliki tugas dan shader mesh)
• Fungsionalitas serializer untuk menyimpan dan memuat sumber daya ke/dari file, seperti model 3D, gambar, atau struct khusus
• Pembaruan Sumber Daya Otomatis Melalui avk::updater , Mengaktifkan Rekreasi Shwapchain dan Shader Hot Reloading
• Render Dynamic: Cara Menggunakan Render Dinamis di Auto-VK-Toolkit

FAQ, masalah yang diketahui, pemecahan masalah

T: Bisakah Auto-VK-Toolkit digunakan di Linux?
A: Ya. Silakan lihat dokumentasi CMake di Docs/Cmake.md!

T: Dapatkah Auto-VK-Toolkit digunakan tanpa penolong Post Build ?
A: Ya. Helper Post Build adalah alat kenyamanan yang menangani penyebaran sumber daya, dependensi aset, dan juga pembaruan file (berguna untuk pemuatan ulang hot shader, tergantung pada struktur proyek). Jika Anda tidak menggunakannya, Anda harus mengelola penyebaran sumber daya, dan kompilasi file shader menjadi spir-v secara manual.

T: Saya memiliki masalah dengan manajemen aset di Visual Studio. Ada saran?
A: Lihat masalah yang diketahui dan pemecahan masalah penanganan aset WRT, yang menawarkan pedoman untuk kasus -kasus berikut:

• Bangun kesalahan saat menambahkan aset
• Aset tidak digunakan karena tidak disimpan di file filter Visual Studio

T: Lebih banyak sumber daya telah digunakan daripada yang saya tambahkan ke filter Visual Studio. Apa yang terjadi?
A: Beberapa aset merujuk aset lain secara internal. Misalnya, model 3D sering merujuk gambar atau file material (dalam kasus .obj Model). "Aset dependen" ini juga digunakan ke direktori target oleh penolong Post Build . Silakan lihat penyebaran aset dependen untuk lebih jelasnya.

T: Apa perbedaan antara debug , rilis , dan publikasi konfigurasi build?
A: Dalam hal pengaturan kompilasi, rilis dan publikasi konfigurasi adalah sama. Mereka menghubungkan dengan rilis pembangunan perpustakaan. Konfigurasi Debug memiliki pengaturan debug klasik yang dikonfigurasi untuk proyek -proyek Visual Studio dan tautan terhadap pembangunan debug perpustakaan. Namun, ada perbedaan antara publikasi build dan non- publish membangun WRT penyebaran sumber daya. Silakan lihat tautan/salinan simbolik tergantung pada konfigurasi build untuk detail lebih lanjut.

T: Saya memiliki masalah dengan penolong Build Post . Apa yang harus dilakukan?
A: Lihat Helper Build Post, yang menawarkan pedoman untuk kasus -kasus berikut:

• Build macet di "Going to Invoke [...] msbuild.exe" langkah, ditampilkan di tab output Visual Studio
• Post Build Helper tidak dapat dibangun secara otomatis/melalui msbuild.exe
• Terlalu sedikit sumber daya yang digunakan
• Aplikasi tidak dapat dimulai pada awalnya percobaan (mungkin karena aset atau DLL yang hilang)
• Pesan kesalahan tentang akses yang ditolak ke file DLL (DLL tidak dikerahkan kembali)
• Kinerja lambat saat menampilkan daftar di dalam helper Post Build
• Pesan Kesalahan di UI Post Build Helper: "Tidak dapat menemukan bagian dari jalan '...'"
• Pesan Kesalahan di Konsol: can't fopen , Atau !RUNTIME ERROR! Couldn't load image from '...' atau yang serupa

T: Aplikasi membutuhkan waktu lama untuk memuat aset seperti model dan gambar 3D. Bisakah itu dipercepat?
A: Jika Anda mengacu pada Debug Builds, Anda dapat mengonfigurasi Helper Build Post sehingga menggunakan DLL rilis dari beberapa dependensi eksternal bahkan untuk pembuatan debug . Mereka harus banyak mempercepat pemuatan aset. Untuk mengaktifkan penyebaran rilis DLL, silakan buka pengaturan Helper Build Post dan aktifkan opsi "Selalu menggunakan DLL Release".

T: Mendapatkan cereal::Exception dalam cereal::loadBinary , atau Unhandled exception at 0x00007FFE82204FD9 in ...exe: Microsoft C++ exception: cereal::Exception at memory location ...
A: File cache serial Anda (misalnya, untuk sponza_and_terrain.fscene ini bisa jadi sponza_and_terrain.fscene.cache ) telah menjadi korup (mungkin karena tidak sepenuhnya ditulis karena kesalahan yang terjadi sebelumnya dalam aplikasi, atau karena eksekusi dibatalkan). Hapus file cache (misalnya, sponza_and_terrain.fscene.cache ) dan biarkan yang baru dihasilkan!