Auto Vk Toolkit

Auto-vk-toolkit v1.0

Auto-VK-Toolkit es un marco para la API de gráficos Vulkan, implementado en C ++ moderno. Su objetivo es alcanzar el punto óptimo entre la conveniencia del programador y la eficiencia, al tiempo que admite la funcionalidad vulkan completa. Para lograr este objetivo, este marco utiliza Auto-VK , una capa de conveniencia y productividad sobre Vulkan-HPP.

Auto-VK-Toolkit se ha utilizado con éxito para la prototipos rápidos, la investigación (por ejemplo, los límites conservadores de malla para el sacrificio robusto de mallas desolladas, representación rápida de objetos paramétricos en GPU modernas) y enseñanza (por ejemplo, algoritmos para la representación en tiempo real).

Esta imagen muestra algunos trabajos que se han desarrollado utilizando auto-VK-Toolkit (de izquierda a derecha): uso en un curso de gráficos avanzados para enseñar conceptos modernos de GPU de bajo nivel; visualización de 19,600 glifos de armónicos esféricos de una exploración cerebral; división de mallas en mallas y hacerlas con visión de grano fino y frustración de la espalda en la tarea y los sombreadores de malla; Ray trazó sombras y reflexiones utilizando las extensiones de dispositivos de trazado de rayos en tiempo real acelerado en hardware; Representación de 358k curvas de fibra paramétricamente definidas en tiempo real.

Algunas de sus características destacadas (además de las impresionantes características de Auto-VK ) incluyen:

• Gestión de ventanas y manejo de entrada a través de GLFW.
• Render Boort Framework con las devoluciones de llamada update() y render() en tiempos de actualización variables o fijos.
• Potente implementación de Auto -Vk - avk::root , con manejo de cadena de intercambio y gestión de vida útil automática de recursos.
• Actualizador versátil que permite la recreación de swapchain.
• En combinación con una poderosa herramienta de publicación de Post Build (solo Windows), el Updater permite la recarga en caliente del sombreador.
• Carga del modelo de una variedad de escenas 3D con la ayuda de Assimp.
• Carga de archivos .fscene de la ORCA: Archivo de contenido de investigación abierto.
• Carga de una multitud de formatos de imagen, incluidos mapas de cubos.
• Soporte de serializador versátil que permite serializar los recursos de Vulkan como avk:buffer o avk::image , y también tipos personalizados; Basado en el cereal.
• Soporte de interfaz de usuario a través de IMGUI con soporte para mostrar texturas en la interfaz de usuario.
• Soporte para el trazado de rayos en tiempo real (RTX) y la construcción conveniente de estructuras de aceleración de mallas triangulares o AABBS.
• Apoyo para dividir las mallas en mallas que se pueden representar con la tarea y los sombreadores de malla.
• Manejo de jerarquías óseas, apoyando la animación de mallas con piel.

Tabla de contenido

• Instalación
  • Visual Studio 2022
    • Requisitos
    • Instrucciones de configuración y construcción
    • Configure su propio proyecto
  • CMake
• Ejemplos
• Creando un nuevo proyecto
• Mangment de recursos y la publicación de Build Helper
• ¿Cuál es la diferencia entre Auto-VK-Toolkit y Auto-VK?
• Documentación
• Preguntas frecuentes, problemas conocidos, solución de problemas

Instalación

Auto-VK-Toolkit está listo para ir con Visual Studio o CMake. Si su sistema cumple con los requisitos del sistema, todo está configurado para construir una ejecución de la caja. Por ejemplo, para Visual Studio, Open visual_studio/auto_vk_toolkit.sln , establezca uno de los proyectos de ejemplo como proyecto de inicio, construye y ejecute.

Sugerencia: la versión en la rama de desarrollo puede estar más actualizada y contener características y correcciones adicionales. Considere usar esa versión, especialmente si encuentra problemas.

Nota: En la primera ejecución, se está construyendo la herramienta Post Build auxil . Mire la pestaña "Salida" de Visual Studio para mensajes de estado y posibles instrucciones.

Visual Studio 2022

Se proporciona una configuración de proyecto preconfigurada para Visual Studio 2022 en Windows.

Requisitos

• Windows 10 u 11
• Visual Studio 2022 con un SDK de Windows 10 o 11 (para obtener información detallada sobre la configuración del proyecto y la gestión de recursos, consulte visual_studio/README.md .)
• Un Vulkan 1.3 SDK de Lunarg, óptimamente Vulkan SDK 1.3.250.0 o más nuevo.

Instrucciones de configuración y construcción

• Clon o descargar este repositorio
• Ejecutar git submodule update --init para extraer el marco Auto-VK que se agrega como un submódulo en auto_vk
• ¡Descargue e instale uno de los últimos SDK de Vulkan para Windows!
  • Seleccione el Vulkan Memory Allocator header. Opción para que esté instalada la biblioteca Vulkan Memory Asignator (VMA).
  • NOTA: VMA se puede instalar a través del instalador Vulkan o su herramienta de mantenimiento (por ejemplo, maintenancetool.exe en Windows) seleccionando el Vulkan Memory Allocator header. opción.
• Descargue e instale Visual Studio Community 2022, o una versión más nueva.
  • ¡Seleccione el Desktop development with C++ en el instalador!
• Recomendado: ¡Instale la extensión de integración del lenguaje GLSL para la resaltura de sintaxis en archivos sombreadores!
  • Sugerencia: Vaya a Tools -> Options -> GLSL language integration . Para el desarrollo del sombreador de Vulkan, establezca Live compiling en False (solo resaltar sintaxis) o establecer el External compiler executable file en, por ejemplo, la ruta a glslangValidator.exe !
• Abra el archivo de solución de Visual Studio visual_studio/auto_vk_toolkit.sln y cree la solución
• Durante el edificio, reconocerá los mensajes de la herramienta Post Build Helper en Output de Visual Studio, algunos mensajes emergentes y un icono en la bandeja del sistema. Eche un vistazo a la gestión de recursos de la sección y la publicación de Post Built a Helper para obtener información adicional.
• Varias aplicaciones de ejemplo están disponibles en el archivo de solución. Establezca uno de ellos como proyecto de inicio y ejecute.

Configure su propio proyecto

• Para agregar auto-vk-toolkit a uno de sus repositorios personalizados, es posible que desee agregarlo como un submódulo GIT. Puede ejecutar git submodule add https://github.com/cg-tuwien/Auto-Vk-Toolkit.git auto_vk_toolkit para agregar auto-vk-toolkit como submódulo en directorio auto_vk_toolkit .
• Ejecutar git submodule update --init --recursive para extraer ambos, Auto-VK-Toolkit y Auto-VK .
• Los pasos descritos en la sección Crear un nuevo proyecto pueden ser útiles para configurar un proyecto de Visual Studio personalizado que se vincule contra Auto-VK-Toolkit .
• La forma más conveniente de configurar su propio proyecto podría ser una de las plantillas de inicio:
  • Plantilla de inicio para proyectos basados ​​en Visual Studio: Auto-VK-Toolkit-VS-Starter
  • Plantilla de inicio para proyectos basados ​​en Cmake: auto-vk-toolkit-starter

CMake

¡Consulte Docs/CMake.md!

Ejemplos

Hola Mundo	Múltiples colas	Procesamiento de imágenes de calcular	Cargador de orca

Se incluyen varias aplicaciones de ejemplo en este repositorio:

• Hello World: Cómo renderizar un solo triángulo
• Buffers de vértices: cómo usar buffers de vértices con tuberías gráficas
• FrameBuffer: cómo crear y usar FrameBuffers
• Representación de múltiples invocaciones: cómo usar múltiples invocos, cómo se podría estructurar su aplicación
• Múltiples Qeues: cómo utilizar múltiples colas (dos transferencias y una cola de gráficos)
• Procesamiento de imágenes de cálculo: cómo usar sombreadores de cómputo para un procesamiento de imágenes
• Presente del cálculo: cómo presentar a la cadena de intercambio desde una cola de cómputo
• Cargador de modelos: cómo cargar modelos 3D desde el archivo y renderizarlos
• Orca Loader: cómo cargar archivos orca .fscene y renderizarlos; también cómo usar el serializador
• Meshlets estáticos: cómo dividir un modelo 3D en mallas pequeñas y renderizarlos usando tareas y sombreadores de malla
• Meshlets de piel: cómo dividir un modelo 3D animado y desgarrado en pequeños mallets y cómo animar y renderizar eso usando tareas y sombreadores de malla
• Tracamiento de rayos con sombras y AO: cómo construir estructuras de aceleración a partir de mallas triangulares y crear una imagen con rayos. Además, agrega sombras rayas trazadas y una versión muy simple (y fea) de la oclusión ambiental al resultado renderizado por el trazado de rayos recursivo de los sombreadores de éxito más cercanos.
• Consulta de rayos en sombreadores de trazado de rayos: similar al ejemplo de "rastreo de rayos con sombras y AO", pero en lugar del trazado de rayos recursivo con una mesa de encuadernación de sombreador, etc., simplemente usa consultas de rayos de sombreadores más cercanos para lograr el mismo resultado.
• RAY RACEING Intersección personalizada: cómo construir estructuras de aceleración de AABBS y de mallas triangulares.
• Texture CubeMap: cómo cargar y usar mapas de cubos.

Maletas de piel	Consulta de rayos y trazado de rayos	Intersección personalizada RTX	Textura Cubemap

Creando un nuevo proyecto

Para los proyectos de Visual Studio, existe una herramienta de conveniencia en visual_studio/tools/executables/ que puede ayudar a configurar rápidamente un nuevo proyecto copiando uno existente (por ejemplo, una de las aplicaciones de ejemplo): create_new_project.exe

Úselo como se sigue para crear una copia de un proyecto existente:

• Abra create_new_project.exe y seleccione una de las aplicaciones de ejemplo o ingrese la ruta al proyecto que se copiará manualmente.
• Ingrese la ubicación de destino, el nombre del proyecto de destino y presione el [CREAT IT!] -Button.
• El proyecto se copia en la carpeta de destino y todas las rutas relativas se adaptan a la nueva ubicación si la carpeta de destino está en la misma unidad que el proyecto fuente. (Si no es así, se establecen rutas absolutas).
• Se conservan referencias de activos y referencias de sombreador y sus caminos se adaptan.
  Atención: ¡asegúrese de eliminar las referencias existentes si va a modificar los activos/sombreadores referenciados! Tendrá que crear copias de estos archivos manualmente y agregar referencias a las copias. Si no lo hace, terminará modificando los activos de stock o los archivos de sombreador de los ejemplos.
• Los encabezados precompilados están deshabilitados en la copia del proyecto recientemente creada. Si desea usar esta función, tendrá que habilitarla manualmente en la configuración del proyecto de Visual Studio.
• Agregue manualmente una referencia a la biblioteca Auto-VK-Toolkit Project auto_vk_toolkit.vxcproj a su solución Visual Studio y asegúrese de que el proyecto recién creado copie lo haga referencia.
• Todas las referencias de origen e incluido se eliminan de la copia del proyecto recién creada. Tendrá que agregar al menos un archivo .cpp que contiene una función main() .
• Agregue #include <auto_vk_toolkit.hpp> para usar auto-vk-toolkit .
• Después de estos pasos, debería poder vincular con éxito contra Auto-VK-Toolkit construir su proyecto recién creado.

Una buena estrategia es agregar auto-vk-toolkit como un submódulo Git a su repositorio y usar create_new_project.exe y los pasos anteriores para crear un proyecto configurado correctamente en un directorio fuera del submódulo. Asegúrese de actualizar con frecuencia el submódulo extrayendo de la rama master de Auto-VK-Toolkit para obtener las últimas actualizaciones.

Mangment de recursos y la publicación de Build Helper

Los proyectos de Visual Studio de Auto-VK-Toolkit están configurados para que Visual Studio en sí pueda usarse elegantemente para la gestión de recursos. Eso significa que los activos requeridos (modelos 3D, imágenes, archivos de escena de Orca) y los archivos de sombreador se pueden agregar a los filtros de Visual Studio en la vista "Explorador de soluciones" y una herramienta Smart Post Built Helper asegura que esos recursos se implementen en el directorio de destino de la aplicación.

En resumen/ tl; dr :

• Agregue los modelos 3D, imágenes y escenas de orca 3D requeridas al filtro assets , y
• Agregue los archivos de sombreador requeridos al filtro shaders directamente en Visual Studio. Luego, cree la aplicación, espere a que la publicación Built a Helper implementa estos recursos en el directorio de destino y ejecute su aplicación.

Esto puede verse como SIGUS, donde los filtros assets y shaders tienen un significado especial, como se insinúa anteriormente:

Una explicación más detallada y más instrucciones se dan en visual_studio/README.md .

Notará Post Build Helper Activity a través de su icono de bandeja: . La herramienta permanecerá activa después de que la implementación haya terminado por dos razones principales:

• Permite investigar registros de eventos de compilación anteriores y también cambiar la configuración.
• Continúa monitoreando archivos de recursos que es especialmente importante para habilitar la recarga caliente del sombreador .

Para obtener más información sobre Post Build Helper , consulte la sección Public Build Helper y para obtener más información sobre la recarga de Shader Hot, consulte la sección de actualizaciones de recursos automáticos a continuación.

¿Cuál es la diferencia entre Auto-VK-Toolkit y Auto-VK?

Auto-VK es una capa de conveniencia y productividad de la plataforma sobre Vulkan-HPP.

Auto-VK-Toolkit establece el enlace faltante al sistema operativo, como el manejo de la ventana, y agrega una funcionalidad adicional:

• Configuración del entorno de representación, como habilitar las extensiones de Vulkan (por ejemplo, si se utilizará VK_KHR_ray_tracing_pipeline , selecciona un dispositivo físico apropiado y permite indicadores y extensiones requeridas)
• Gestión de ventanas (a través de GLFW)
• Manejo de bucle de juego/render-bucle con los métodos de devolución de llamada convenientes para usar a través de la avk::invokee (como initialize() , update() , render() , donde el primero se llama solo una vez y se invocan los dos últimos) cada cuadro)
• Manejo de entrada de usuario
• Una clase base lista para usar para jerarquías de objetos: avk::transform
• Listo para usar clases de cámara controlables por el usuario avk::quake_camera y avk::orbit_camera (derivado de ambos, avk::transform and avk::invokee )
• Soporte de carga de recursos para:
  • Imágenes
  • Modelos 3D
  • Escenas en formato ORCA, ver: ORCA: Archivo de contenido de investigación abierto
• Carga de material y conversión en un formato de GPU ( avk::material y a vk::material_gpu_data )
• Carga y conversión de LightSource en un formato de GPU ( avk::lightsource y avk::lightsource_gpu_data )
• Manejo de recursos a través de los filtros de Visual Studio, es decir, simplemente arrastre y suelte activos y sombreadores que desea usar directamente en la jerarquía de filtros de Visual Studio y las implementen en el directorio de destino.
• Una poderosa herramienta de publicación de Post Built que se invoca como un paso de compilación personalizado.
  • Implementa activos y sombreadores en el directorio de destino
  • Los sombreadores se compilan en Spir-V
  • Si los archivos sombreadores contienen errores, se crean mensajes emergentes que muestran el error y proporcionan un botón [->VS] para navegar a la línea que contiene el error dentro de Visual Studio.
  • De manera predeterminada, "depurar" y "versión" de compilación de configuraciones de recursos de enlace simbólico para ahorrar espacio, pero "publicar" las configuraciones de compilación implementan todos los archivos requeridos en el directorio de destino para que un programa creado pueda transferirse fácilmente a otra PC. No se requiere una reunión de recursos más tediosa en tales situaciones, ya que todo lo manejan Post Build Helper.

Documentación

Hay algunas páginas de documentación que contienen más información:

• Uso de IMGUI para interfaces de usuario, que describe cómo usar Dear Imgui en un proyecto Auto-VK-Toolkit
• Instrucciones de configuración y construcción de CMake
• Meshlets Funcionalidad especificada para dividir la geometría en pequeños grupos y usarlos para renderizar tuberías de malla gráfica (aquellos con tareas y sombreadores de malla)
• Funcionalidad del serializador para almacenar y cargar recursos hacia/desde el archivo, como modelos 3D, imágenes o estructuras personalizadas
• Actualizaciones automáticas de recursos a través de la clase avk::updater , habilitando Shwapchain Recreation y Shader Hot Reloading
• Representación dinámica: cómo usar la representación dinámica en el toolkit de vía automática

Preguntas frecuentes, problemas conocidos, solución de problemas

P: ¿Se puede usar auto-vk-toolkit en Linux?
A: Sí. ¡Consulte la documentación de CMake en Docs/CMake.md!

P: ¿Se puede usar auto-vk-toolkit sin el cojinete de la construcción de post ?
A: Sí. Post Build Helper es una herramienta de conveniencia que maneja la implementación de recursos, las dependencias de activos y también las actualizaciones de archivos (útiles para la recarga en caliente del sombreador, dependiendo de la estructura del proyecto). Si no lo está utilizando, tendrá que administrar la implementación de recursos y la compilación de archivos de sombreadores en SIG-V manualmente.

P: Tengo problemas con la gestión de activos en Visual Studio. ¿Algún consejo?
R: Consulte los problemas conocidos y la resolución de problemas de manejo de activos WRT, que ofrece pautas para los siguientes casos:

• Crear errores al agregar activos
• El activo no se implementa porque no se guarda en el archivo de filtros de Visual Studio

P: Se han implementado más recursos de los que he agregado a los filtros de Visual Studio. ¿Qué está sucediendo?
R: Algunos activos hacen referencia a otros activos internamente. Por ejemplo, los modelos 3D a menudo hacen referencia a imágenes o archivos de material (en el caso de los modelos .obj ). Estos "activos dependientes" también se implementan en el directorio de destino por Post Build Helper . Consulte la implementación de activos dependientes para obtener más detalles.

P: ¿Cuáles son las diferencias entre las configuraciones de construcción de depuración , versión y publicación ?
R: En términos de configuraciones de compilación, las configuraciones de lanzamiento y publicación son las mismas. Vinculan contra construcciones de liberación de bibliotecas. La configuración de depuración tiene configuraciones de depuración clásica configuradas para los proyectos y enlaces de Visual Studio contra las compilaciones de bibliotecas de depuración . Sin embargo, existe una diferencia entre las compilaciones de publicaciones y las compilaciones que no son publicaciones WRT la implementación de recursos. Consulte los enlaces/copias simbólicas dependiendo de la configuración de compilación para obtener más detalles.

P: Tengo problemas con la publicación de Build Helper . ¿Qué hacer?
R: Consulte Post Build Helper, que ofrece pautas para los siguientes casos:

• La compilación está atascada en el paso "Voke [...] msbuild.exe", que se muestra en la pestaña de salida de Visual Studio
• Post Build Helper no se puede construir automáticamente/a través de msbuild.exe
• Se están implementando muy pocos recursos
• La aplicación no pudo comenzar al principio intenta (tal vez debido a los activos o DLL faltantes)
• Mensaje de error sobre el acceso denegado a los archivos DLL (los DLL no se redeplojan)
• Rendimiento lento al mostrar listas dentro de Post Build Helper
• Mensaje de error en la interfaz de usuario de Post Build aelper: "No pude encontrar parte de la ruta '...'"
• Mensaje de error en la consola: can't fopen , o !RUNTIME ERROR! Couldn't load image from '...' o similar

P: La aplicación tarda mucho en cargar activos como modelos e imágenes 3D. ¿Se puede acelerar?
R: Si se refiere a las compilaciones de depuración , puede configurar Post Build aelper para que implementa DLL de lanzamiento de algunas dependencias externas incluso para construcciones de depuración . Deben acelerar mucho la carga de activos. Para habilitar la implementación de DLL de lanzamiento , abra la configuración de Post Build Helper y habilite la opción "Siempre implementa DLL de lanzamiento".

P: Obtener cereal::Exception en cereal::loadBinary , o Unhandled exception at 0x00007FFE82204FD9 in ...exe: Microsoft C++ exception: cereal::Exception at memory location ...
R: Su archivo de caché serializado (por ejemplo, para sponza_and_terrain.fscene esto podría ser sponza_and_terrain.fscene.cache ) se ha corrompido (tal vez porque no estaba completamente escrito debido a un error previamente ocurrido en la aplicación, o porque la ejecución fue anulada). Elimine el archivo de caché (por ejemplo, sponza_and_terrain.fscene.cache ) y deje que se genere uno nuevo.