Auto Vk Toolkit

Auto-VK-Toolkit v1.0

يعد Auto-VK-Toolkit إطارًا لواجهة برمجة تطبيقات Vulkan Graphics ، التي يتم تنفيذها في C ++ الحديثة. ويهدف إلى الوصول إلى المكان الجميل بين المبرمجين والكفاءة مع عدم دعم وظائف الفلكان الكاملة. لتحقيق هذا الهدف ، يستخدم هذا الإطار Auto-VK ، طبقة الراحة والإنتاجية فوق Vulkan-HPP.

تم استخدام Auto-VK-Toolkit بنجاح في النماذج الأولية السريعة ، والأبحاث (على سبيل المثال ، حدود Meshlet المحافظة من أجل إعدام قوي من الشبكات البشرة ، والتقديم السريع للأشياء البارامترية على وحدات معالجة الرسومات الحديثة) ، والتعليم (على سبيل المثال ، خوارزميات لتقديم الوقت الفعلي).

تعرض هذه الصورة بعض الأعمال التي تم تطويرها باستخدام Auto-VK-Toolkit (من اليسار إلى اليمين): الاستخدام في دورة رسومات متقدمة لتدريس مفاهيم GPU الحديثة ذات المستوى المنخفض ؛ تصور 19600 من الحروف الكروية الكروية من مسح الدماغ. تقسيم الشبكات إلى الأعطال وجعلها مع الرؤية الرائعة ذات الحبيبات الرائعة وإعدام الخلفية في تظليل المهام والشبكة ؛ تتبع Ray الظلال والانعكاسات باستخدام ملحقات جهاز تتبع الأشعة في الوقت الفعلي المسلسل للأجهزة ؛ تقديم 358K منحنيات الألياف المحددة بشكل حار في الوقت الحقيقي.

تشمل بعض ميزاتها البارزة (إلى جانب الميزات الرائعة لـ Auto-VK ):

• إدارة النوافذ ومعالجة المدخلات من خلال GLFW.
• قم بإعداد Framework Loop مع update() و render() عوائد في أوقات تحديث مختلفة أو ثابتة.
• Auto -VK - تطبيق avk::root ، مع معالجة سلسلة المبادلة وإدارة عمر الموارد التلقائي.
• تحديث متعدد الاستخدامات الذي يتيح الترفيه swapchain.
• بالاقتران مع أداة HERPER POST قوية (Windows فقط) ، يتيح Updater إعادة تحميل TAMER HOT.
• نموذج تحميل لمجموعة متنوعة من المشاهد ثلاثية الأبعاد بمساعدة Assimp.
• تحميل ملفات .fscene من orca: فتح أرشيف محتوى البحث.
• تحميل العديد من تنسيقات الصور ، بما في ذلك خرائط المكعب.
• دعم التسلسل متعدد الاستخدامات الذي يسمح بتسلسل موارد Vulkan مثل avk:buffer أو avk::image ، وكذلك الأنواع المخصصة ؛ على أساس الحبوب.
• دعم واجهة المستخدم من خلال IMGUI بدعم لعرض القوام في واجهة المستخدم.
• دعم تتبع الشعاع في الوقت الفعلي (RTX) وبناء مريح لهياكل التسارع من شبكات مثلث أو AABBS.
• دعم تقسيم الشبكات إلى مواقع يمكن تقديمها بمهمة وتظليلات الشبكات.
• التعامل مع التسلسلات الهرمية العظمية ، ودعم الرسوم المتحركة للشبكات البشرة.

جدول المحتويات

• تثبيت
  • Visual Studio 2022
    • متطلبات
    • الإعداد وبناء التعليمات
    • قم بإعداد مشروعك الخاص
  • cmake
• أمثلة
• إنشاء مشروع جديد
• مورد الموارد و Post Build Helper
• ما هو الفرق بين توكيت توكيت و Auto-VK؟
• الوثائق
• الأسئلة الشائعة ، القضايا المعروفة ، استكشاف الأخطاء وإصلاحها

تثبيت

Auto-VK-Toolkit جاهز للذهاب مع Visual Studio أو Cmake. إذا كان نظامك يفي بمتطلبات النظام ، فسيتم إعداد كل شيء لإنشاء تشغيل مباشرة خارج الصندوق. على سبيل المثال ، بالنسبة إلى Visual Studio ، افتح visual_studio/auto_vk_toolkit.sln ، قم بتعيين أحد المشاريع على سبيل المثال كمشروع بدء التشغيل ، والبناء والتشغيل!

تلميح: قد يكون الإصدار في فرع التطوير أكثر تحديثًا ويحتوي على ميزات وإصلاحات إضافية. يرجى النظر في استخدام هذا الإصدار ، خاصة إذا واجهت مشاكل.

ملاحظة: في المدى الأول ، يتم بناء أداة Post Build Helper . شاهد علامة التبويب "الإخراج" في Visual Studio لرسائل الحالة والتعليمات المحتملة.

Visual Studio 2022

يتم توفير إعداد مشروع تم تكوينه مسبقًا لـ Visual Studio 2022 على Windows.

متطلبات

• Windows 10 أو 11
• Visual Studio 2022 مع تثبيت Windows 10 أو 11 SDK (للحصول على معلومات مفصلة حول إعداد المشروع وإدارة الموارد ، يرجى الرجوع إلى visual_studio/README.md .)
• A Vulkan 1.3 SDK من Lunarg ، على النحو الأمثل Vulkan SDK 1.3.250.0 أو الأحدث.

الإعداد وبناء التعليمات

• استنساخ أو قم بتنزيل هذا المستودع
• تنفيذ git submodule update --init لسحب إطار Auto-VK الذي يتم إضافته كوحدة فرعية تحت auto_vk
• قم بتنزيل وتثبيت واحدة من أحدث SDKs Vulkan for Windows!
  • حدد Vulkan Memory Allocator header. الخيار بحيث يتم تثبيت مكتبة مخصص الذاكرة Vulkan (VMA).
  • ملاحظة: يمكن تثبيت VMA من خلال مثبت Vulkan أو أداة الصيانة الخاصة به (على سبيل المثال ، maintenancetool.exe على Windows) عن طريق تحديد Vulkan Memory Allocator header. خيار.
• قم بتنزيل وتثبيت Visual Studio Community 2022 ، أو إصدار أحدث.
  • حدد Desktop development with C++ في المثبت!
• موصى به: قم بتثبيت امتداد تكامل لغة GLSL لإظهار بناء الجملة في ملفات Shader!
  • تلميح: انتقل إلى Tools -> Options -> GLSL language integration . لتطوير Vulkan Shader ، إما تعيين Live compiling على False (بناء جملة تسليط الضوء فقط) ، أو اضبط External compiler executable file ، على سبيل المثال ، المسار إلى glslangValidator.exe !
• افتح ملف Visual Studio Solution File visual_studio/auto_vk_toolkit.sln ، وقم بإنشاء الحل
• أثناء البناء ، ستتعرف على الرسائل من أداة Post Build Helper في Output Visual Studio ، وبعض الرسائل المنبثقة ، ورمز في علبة النظام. يرجى إلقاء نظرة على مورد مورد القسم و Post Build Helper للحصول على معلومات إضافية.
• تتوفر العديد من تطبيقات المثال في ملف الحل. قم بتعيين أحدهم كمشروع بدء تشغيل ، وتشغيله.

قم بإعداد مشروعك الخاص

• لإضافة توكيت تلقائيًا إلى أحد مستودعاتك المخصصة ، قد ترغب في إضافتها كوحدة فرعية بالجيت. يمكنك تنفيذ git submodule add https://github.com/cg-tuwien/Auto-Vk-Toolkit.git auto_vk_toolkit لإضافة تلقائي toolkit كوحدة فرعية في الدليل auto_vk_toolkit .
• قم بتنفيذ git submodule update --init --recursive من أجل سحب كلاهما ، Auto-VK-Toolkit و Auto-VK .
• قد تكون الخطوات الموضحة تحت القسم إنشاء مشروع جديد مفيدًا لإعداد مشروع مخصص في Visual Studio يرتبط ضد Auto-VK-Toolkit .
• قد تكون الطريقة الأكثر ملاءمة لإعداد مشروعك الخاص أحد قوالب المبتدئين:
  • قالب بداية للمشاريع المستندة إلى Visual Studio: Auto-VK-Toolkit-VS-Starter
  • قالب بداية للمشاريع المستندة إلى Cmake: Auto-VK-Toolkit-Starter

cmake

يرجى الاطلاع على المستندات/cmake.md!

أمثلة

مرحبا بالعالم	طوابير متعددة	حساب معالجة الصور	orca loader

يتم تضمين العديد من تطبيقات المثال في هذا المستودع:

• مرحبًا العالم: كيف تقدم مثلثًا واحدًا
• المخازن المؤقتة في قمة الرأس: كيفية استخدام المخازن المؤقتة في Vertex مع خطوط أنابيب الرسومات
• FrameBuffer: كيفية إنشاء واستخدام Framebuffers
• عرض Multi Invokee: كيفية استخدام عمليات الاستدعاء المتعددة ، كيف يمكن تنظيم تطبيقك
• qeues متعددة: كيفية استخدام قوائم الانتظار المتعددة (نقل اثنان وواحد قائمة انتظار رسومات)
• حساب معالجة الصور: كيفية استخدام تظليلات حساب لبعض معالجة الصور
• موجود من حساب: كيفية تقديم سلسلة المبادلة من قائمة انتظار حساب
• تحميل النموذج: كيفية تحميل النماذج ثلاثية الأبعاد من الملف وتقديمها
• Orca Loader: كيفية تحميل ملفات Orca .fscene وتقديمها ؛ أيضا كيفية استخدام المسلسل
• Meshlets الثابتة: كيفية تقسيم نموذج ثلاثي الأبعاد إلى حالات صغيرة وجعلها باستخدام تظليل المهمة وشبكة
• Meshlets ذات البشرة: كيفية تقسيم نموذج ثلاثي الأبعاد متحرك ، ذي بشرة إلى أعطال صغيرة وكيفية تحريك هذا المهمة وشباك التظليل
• تتبع الأشعة مع الظلال و AO: كيفية بناء هياكل تسريع من شبكات مثلث وإنشاء صورة تتبع شعاع. بالإضافة إلى ذلك ، يضيف الظلال التي تتبعها راي وإصدار بسيط للغاية (وقبيح) من انسداد المحيط إلى النتيجة المقدمة من خلال تتبع الأشعة العودية من أقرب تظليلات ضرب.
• استعلام الشعاع في تظليل تتبع الشعاع: على غرار مثال "Ray Tracing with Shadows و AO" ، ولكن بدلاً من تتبع الأشعة العودية مع جدول ربط التظليل وما إلى ذلك ، فإنه يستخدم ببساطة استعلامات الأشعة من أقرب أظافر ضرب لتحقيق نفس النتيجة.
• تقاطع تتبع شعاع المخصص: كيفية بناء هياكل تسريع من AABBS ومن شبكات مثلث.
• cubemap نسيج: كيفية تحميل واستخدام خرائط المكعب.

حشوات بشرة	استعلام راي وتتبع الشعاع	تقاطع RTX المخصص	نسيج cubemap

إنشاء مشروع جديد

بالنسبة لمشاريع Visual Studio ، هناك أداة راحة ضمن visual_studio/tools/executables/ يمكن أن تساعد في إعداد مشروع جديد بسرعة عن طريق نسخ مشروع موجود (على سبيل المثال أحد تطبيقات المثال): create_new_project.exe

استخدمه كما يلي لإنشاء نسخة من مشروع موجود:

• افتح create_new_project.exe وإما حدد أحد تطبيقات المثال أو أدخل المسار إلى المشروع ليتم نسخه يدويًا.
• أدخل الموقع المستهدف ، واسم المشروع المستهدف ، واضغط على [Create It!] -ولكن.
• يتم نسخ المشروع إلى المجلد الهدف ويتم تكييف جميع المسارات النسبية مع الموقع الجديد إذا كان المجلد الهدف في نفس محرك الأقراص مثل المشروع المصدر. (إذا لم يكن الأمر كذلك ، يتم تعيين المسارات المطلقة.)
• يتم الاحتفاظ مراجع الأصول ومراجع التظليل وتكييف مساراتها.
  الانتباه: تأكد من إزالة المراجع الموجودة إذا كنت ستعدل الأصول/التظليلات المشار إليها! سيكون عليك إنشاء نسخ من هذه الملفات يدويًا وإضافة إشارات إلى النسخ بدلاً من ذلك. إذا فشلت في القيام بذلك ، فسوف ينتهي بك الأمر إلى تعديل أصول الأسهم أو ملفات تظليل الأمثلة.
• يتم تعطيل الرؤوس المسبقة في نسخة المشروع التي تم إنشاؤها حديثًا. إذا كنت ترغب في استخدام هذه الميزة ، فسيتعين عليك تمكينها يدويًا في إعدادات مشروع Visual Studio.
• أضف مرجعًا يدويًا إلى مشروع مكتبة VK-Toolkit Auto-Toolkit auto_vk_toolkit.vxcproj إلى حل Visual Studio والتأكد من أن نسخ المشروع الذي تم إنشاؤه حديثًا يشير إليه.
• تتم إزالة جميع المصادر وتشمل مراجع الملفات من نسخة المشروع التي تم إنشاؤها حديثًا. سيكون عليك إضافة ملف .cpp على الأقل يحتوي على وظيفة main() .
• أضف #include <auto_vk_toolkit.hpp> لاستخدام Auto-VK-toolkit .
• بعد هذه الخطوات ، يجب أن تكون قادرًا على الارتباط بنجاح ضد Auto-VK-Toolkit إنشاء مشروعك الذي تم إنشاؤه حديثًا.

تتمثل الإستراتيجية الجيدة في إضافة توكيت تلقائيًا كوحدة فرعية GIT لمستودعك واستخدام create_new_project.exe والخطوات المذكورة أعلاه لإنشاء مشروع تم تكوينه بشكل صحيح في دليل خارج الحداثة الفرعية. تأكد من تحديث الجهاز الفرعي بشكل متكرر عن طريق السحب من فرع master التلقائي لـ VK-Toolkit للحصول على آخر التحديثات.

مورد الموارد و Post Build Helper

تم تكوين مشاريع Visual Studio التلقائية لـ Auto-Toolkit بحيث يمكن استخدام Visual Studio نفسه بشكل أنيق لإدارة الموارد. هذا يعني أنه يمكن إضافة الأصول المطلوبة (النماذج ثلاثية الأبعاد ، الصور ، ملفات مشهد ORCA) وملفات التظليل فقط إلى مرشحات Visual Studio في عرض "Solution Explorer" وأداة مساعدة Smart Post Build ، تضمن نشر هذه الموارد في الدليل المستهدف للتطبيق.

باختصار/ tl ؛ د .

• إضافة النماذج ثلاثية الأبعاد والصور ومشاهد ORCA إلى مرشح assets ، و
• إضافة ملفات التظليل المطلوبة إلى مرشح shaders مباشرة في Visual Studio. ثم قم ببناء التطبيق ، وانتظر حتى يقوم المساعد البارز بنشر هذه الموارد على الدليل المستهدف ، وقم بتشغيل التطبيق الخاص بك!

يمكن أن يبدو هذا يلي ، حيث يكون assets والتظليلات shaders معنى خاص ، كما تم تلميحها أعلاه:

وترد تفسير أكثر تفصيلاً وإرشادات أخرى في visual_studio/README.md .

ستلاحظ نشاط المساعد بعد البناء من خلال أيقونة الدرج: . ستبقى الأداة نشطة بعد الانتهاء من النشر لسببين رئيسيين:

• يسمح بالتحقيق في السجلات من أحداث الإنشاء السابقة ، وكذلك تغيير الإعدادات.
• تستمر في مراقبة ملفات الموارد التي تعتبر مهمة بشكل خاص لتمكين إعادة التحميل الساخن .

لمزيد من المعلومات حول مساعد البناء ، يرجى الرجوع إلى قسم Post Build Helper ، ولمزيد من المعلومات حول إعادة التحميل الساخن Shader ، يرجى الرجوع إلى قسم الموارد التلقائي أدناه.

ما هو الفرق بين توكيت توكيت و Auto-VK؟

Auto-VK هي منصة واضحة وطبقة الإنتاجية فوق فولكان-HPP.

يحدد Auto-VK-Toolkit الرابط المفقود لنظام التشغيل ، مثل معالجة النوافذ ، ويضيف المزيد من الوظائف:

• تكوين البيئة التقديم ، مثل تمكين امتدادات Vulkan (على سبيل المثال إذا كان VK_KHR_ray_tracing_pipeline يجب استخدامه ، فإنه يختار جهازًا فعليًا مناسبًا ويمكّن الإعلامات والامتدادات المطلوبة)
• إدارة النوافذ (من خلال GLFW)
• معالجة حلقة اللعبة/حلقة العرض مع ملائمة لاستخدام أساليب رد الاتصال عبر avk::invokee (مثل initialize() ، update() ، render() ، حيث يتم استدعاء الأول مرة واحدة فقط ويتم استدعاء الاثنين الأخير كل إطار)
• معالجة إدخال المستخدم
• جاهز لاستخدام الفئة الأساسية للتسلسلات الهرمية للكائن: avk::transform
• جاهز لاستخدام فئات الكاميرا التي يمكن السيطرة عليها من قبل المستخدم avk::quake_camera و avk::orbit_camera (مشتقة من كلاهما ، avk::transform و avk::invokee )
• دعم تحميل الموارد ل:
  • الصور
  • نماذج ثلاثية الأبعاد
  • مشاهد في تنسيق ORCA ، انظر: ORCA: ARCHER ARCHIVE ARCHIVE
• تحميل المواد والتحويل إلى تنسيق قابل للمناسبة GPU ( avk::material و a vk::material_gpu_data )
• Lightsource تحميل وتحويل إلى تنسيق قابل للمناسبة ( avk::lightsource و avk::lightsource_gpu_data )
• مناولة الموارد عبر مرشحات Visual Studio ، أي مجرد اسحب وإسقاط الأصول والتظليلات التي ترغب في استخدامها مباشرة في التسلسل الهرمي لمرشح Visual Studio وينشرها في الدليل المستهدف.
• أداة مساعدة قوية للبناء تم استدعاؤها كخطوة بناء مخصصة.
  • تقوم بنشر الأصول والتظليلات على الدليل المستهدف
  • يتم تجميع التظليلات في spir-v
  • إذا كانت ملفات التظليل تحتوي على أخطاء ، يتم إنشاء رسائل منبثقة تعرض الخطأ ، وتوفير زر [->VS] للانتقال إلى السطر الذي يحتوي على الخطأ داخل Visual Studio.
  • افتراضيًا ، "Debug" و "الإصدار" تكوينات إنشاء موارد Symlink لتوفير المساحة ، ولكن "نشر" تكوينات إنشاء جميع الملفات المطلوبة في الدليل المستهدف بحيث يمكن بسهولة نقل البرنامج المبني إلى كمبيوتر آخر. لا يلزم تجميع الموارد الممل في مثل هذه المواقف حيث يتم التعامل مع كل ذلك من قِبل المساعد المنشور.

الوثائق

هناك بعض صفحات التوثيق التي تحتوي على مزيد من المعلومات:

• استخدام Imgui لواجهات المستخدم ، واصفًا كيفية استخدام Imgui العزيزة في مشروع توكيت Auto-Vk-Toolkit
• CMAKE SETUP و Build Ergans
• وظائف meshlets-spectic لتقسيم الهندسة إلى مجموعات صغيرة واستخدامها لتقديمها في خطوط أنابيب شبكة الرسومات (تلك التي لديها تظليلات المهمة والشبكة)
• وظائف المسلسل لتخزين وتحميل الموارد من/إلى الملف ، مثل النماذج ثلاثية الأبعاد أو الصور أو الهياكل المخصصة
• تحديثات الموارد التلقائية من خلال فئة avk::updater ، مما يتيح Shwapchain الترفيه وتظليل إعادة التحميل الساخن
• التقديم الديناميكي: كيفية استخدام التقديم الديناميكي في توكيت Auto-Toolkit

الأسئلة الشائعة ، القضايا المعروفة ، استكشاف الأخطاء وإصلاحها

س: هل يمكن استخدام Auto-VK-Toolkit على Linux؟
ج: نعم. يرجى الاطلاع على وثائق CMake في المستندات/cmake.md!

س: هل يمكن استخدام Auto-VK-Toolkit بدون مساعد بناء ما بعد ؟
ج: نعم. يعد Post Build Helper أداة مريحة تتعامل مع نشر الموارد ، وتبعيات الأصول ، وكذلك تحديثات الملفات (مفيدة لإعادة التحميل الساخن ، اعتمادًا على بنية المشروع). إذا كنت لا تستخدمه ، فسيتعين عليك إدارة نشر الموارد ، وتجميع ملفات التظليل في SPIR-V يدويًا.

س: لدي مشاكل في إدارة الأصول في Visual Studio. أي نصيحة؟
ج: تحقق من المشكلات المعروفة واستكشاف الأخطاء وإصلاحها معالجة أصول WRT ، والتي تقدم إرشادات للحالات التالية:

• بناء الأخطاء عند إضافة الأصول
• لم يتم نشر الأصول لأنه لا يتم حفظه في ملف مرشحات Visual Studio

س: تم نشر موارد أكثر مما أضفت إلى مرشحات Visual Studio. ماذا يحدث هنا؟
ج: بعض الأصول تشير إلى الأصول الأخرى داخليًا. على سبيل المثال ، غالبًا ما تشير النماذج ثلاثية الأبعاد إلى الصور أو ملفات المواد (في حالة نماذج .obj ). يتم نشر هذه "الأصول المعتمدة" أيضًا في الدليل المستهدف بواسطة مساعد ما بعد الإنشاء . يرجى الاطلاع على نشر الأصول التابعة لمزيد من التفاصيل.

س: ما هي الاختلافات بين تكوينات التصحيح والإصدار والنشر ؟
ج: من حيث إعدادات التجميع ، فإن تكوينات الإصدار والنشر هي نفسها. يربطون مع بنيات الإصدار من المكتبات. يحتوي تكوين التصحيح على إعدادات تصحيح التصحيح الكلاسيكي التي تم تكوينها لمشاريع Visual Studio وروابط مقابل تصميمات التصحيح للمكتبات. ومع ذلك ، هناك فرق بين Publish Builds و Publish يبني WRT نشر الموارد. يرجى الاطلاع على الروابط/النسخ الرمزية اعتمادًا على تكوين بناء لمزيد من التفاصيل.

س: لدي مشكلات مع مساعد البناء . ما يجب القيام به؟
ج: تحقق من Post Build Helper ، الذي يقدم إرشادات للحالات التالية:

• تمسك البناء في خطوة "Going to Invoke [...]
• لا يمكن بناء المساعد بعد البناء تلقائيًا/عبر msbuild.exe
• يتم نشر عدد قليل جدًا من الموارد
• لا يمكن أن يبدأ التطبيق في البداية (ربما بسبب الأصول المفقودة أو DLLs)
• رسالة خطأ حول رفض الوصول إلى ملفات DLL (لا يتم إعادة نشر DLLs)
• الأداء البطيء عند عرض القوائم داخل مساعد البناء
• رسالة خطأ في واجهة المستخدم من Post Build Helper: "لا يمكن العثور على جزء من المسار" ... ""
• رسالة الخطأ في وحدة التحكم: can't fopen ، أو !RUNTIME ERROR! Couldn't load image from '...' أو ما شابه

س: يستغرق التطبيق وقتًا طويلاً لتحميل الأصول مثل النماذج ثلاثية الأبعاد والصور. هل يمكن تسريعها؟
ج: إذا كنت تشير إلى تصميمات التصحيح ، فيمكنك تكوين Post Build Helper بحيث تقوم بنشر DLLs لبعض التبعيات الخارجية حتى بالنسبة لبنيات التصحيح . يجب عليهم تسريع تحميل الأصول كثيرًا. لتمكين نشر DLLs إصدار الإصدار ، يرجى فتح إعدادات Post Build Helper وتمكين الخيار "دائمًا نشر DLLs".

س: الحصول على cereal::Exception في cereal::loadBinary ، أو Unhandled exception at 0x00007FFE82204FD9 in ...exe: Microsoft C++ exception: cereal::Exception at memory location ...
ج: لقد أصبح ملف ذاكرة التخزين المؤقت التسلسلي الخاص بك (على سبيل المثال ، لـ sponza_and_terrain.fscene قد يكون هذا sponza_and_terrain.fscene.cache ) فاسدًا (ربما لم يكن مكتوبًا بالكامل بسبب خطأ حدث سابقًا في التطبيق ، أو بسبب تمرير التنفيذ). احذف ملف ذاكرة التخزين المؤقت (على سبيل المثال ، sponza_and_terrain.fscene.cache ) واترك منشأ جديد!