Auto Vk Toolkit

Auto-VK-Toolkit v1.0

Auto-VK-Toolkit é uma estrutura para a API de gráficos Vulkan, implementada no C ++ moderno. O objetivo é atingir o ponto ideal entre a conveniência do programador e a eficiência, enquanto ainda suporta a funcionalidade completa da Vulkan. Para atingir esse objetivo, essa estrutura usa o Auto-VK , uma camada de conveniência e produtividade no topo de Vulkan-HPP.

Auto-VK-Toolkit tem sido usada com sucesso para prototipagem rápida, pesquisa (por exemplo, limites conservadores de malha para abate robustos de malhas esfoladas, renderização rápida de objetos paramétricos nas GPUs modernas) e ensino (por exemplo, algoritmos para renderização em tempo real).

Esta imagem mostra algum trabalho que foi desenvolvido usando auto-vk-toolkit (da esquerda para a direita): uso em um curso de gráficos avançados para ensinar conceitos modernos de GPU de baixo nível; visualização de 19.600 glifos de harmônicos esféricos de uma varredura cerebral; Divisão de malhas em malhetas e tornando-as com visualização de granulação fina e abate de backface nos shaders de tarefas e malha; Ray rastreia sombras e reflexões usando as extensões de dispositivos de rastreamento de raios em tempo real acelerados por hardware; renderização de 358k curvas de fibra definidas parametricamente em tempo real.

Algumas de suas características de destaque (além dos impressionantes características do Auto-VK ) incluem:

• Gerenciamento de janelas e manuseio de entrada através do GLFW.
• Render LOOP Framework com update() e render() retornos de chamada em horários de atualização variados ou fixa.
• A poderosa implementação automática -VK - avk::root , com manuseio de cadeia de troca e gerenciamento automático de vida útil.
• Updater versátil que permite a recreação de Swapchain.
• Em combinação com uma poderosa ferramenta Post Build Helper (somente Windows), o Updater permite que o Shader a quente recarregue.
• Carregamento de modelo de uma variedade de cenas 3D com a ajuda do Assimp.
• Carregamento de arquivos .fscene do Orca: Open Research Content Archive.
• Carregando de uma infinidade de formatos de imagem, incluindo mapas de cubo.
• Suporte versátil do serializador que permite serializar recursos de vulkan, como avk:buffer ou avk::image Instâncias e também tipos personalizados; baseado em cereais.
• Suporte à interface do usuário através do IMGUI com suporte para exibir texturas na interface do usuário.
• Suporte para rastreamento de raios em tempo real (RTX) e construção conveniente de estruturas de aceleração a partir de malhas de triângulo ou AABBs.
• Suporte para dividir malhas em meias que podem ser renderizadas com shaders de tarefas e malha.
• Manuseio de hierarquias ósseas, apoiando a animação de malhas de pele.

Índice

• Instalação
  • Visual Studio 2022
    • Requisitos
    • Configurar e construir instruções
    • Configure seu próprio projeto
  • Cmake
• Exemplos
• Criando um novo projeto
• Mangia de Recursos e o Auxiliar de Construção Post
• Qual é a diferença entre auto-vk-toolkit e auto-vk?
• Documentação
• Perguntas frequentes, questões conhecidas, solução de problemas

Instalação

Auto-VK-Toolkit está pronto para ir com o Visual Studio ou Cmake. Se o seu sistema atender aos requisitos do sistema, tudo será configurado para criar uma corrida imediatamente. Por exemplo, para o Visual Studio, open visual_studio/auto_vk_toolkit.sln , defina um dos projetos de exemplo como projeto de inicialização, construir e executar!

Dica: a versão na filial de desenvolvimento pode estar mais atualizada e conter recursos e correções adicionais. Por favor, considere usar essa versão, especialmente se você encontrar problemas.

Nota: Na primeira execução, a ferramenta Post Build Helper está sendo construída. Assista à guia "saída" do Visual Studio para mensagens de status e possíveis instruções.

Visual Studio 2022

Uma configuração de projeto pré -configurada é fornecida para o Visual Studio 2022 no Windows.

Requisitos

• Windows 10 ou 11
• Visual Studio 2022 com um Windows 10 ou 11 SDK instalado (para obter informações detalhadas sobre a configuração do projeto e o gerenciamento de recursos, consulte o visual_studio/README.md .)
• Um SDK Vulkan 1.3 da Lunarg, otimamente Vulkan SDK 1.3.250.0 ou mais recente.

Configurar e construir instruções

• Clone ou baixe este repositório
• Execute git submodule update --init para puxar a estrutura Auto-VK , que é adicionada como um submódulo sob auto_vk
• Faça o download e instale um dos mais recentes SDKs Vulkan para Windows!
  • Selecione o Vulkan Memory Allocator header. Opção para que a biblioteca Alocador de Memória Vulkan (VMA) seja instalada.
  • NOTA: O VMA pode ser instalado através do instalador Vulkan ou de sua ferramenta de manutenção (por exemplo, maintenancetool.exe no Windows) selecionando o Vulkan Memory Allocator header. opção.
• Faça o download e instale o Visual Studio Community 2022, ou uma versão mais recente.
  • Selecione o Desktop development with C++ no instalador!
• Recomendado: Instale a extensão da integração de idiomas GLSL para destaque da sintaxe nos arquivos do shader!
  • Dica: vá para Tools -> Options -> GLSL language integration . Para o desenvolvimento de shader vulkan, defina Live compiling como False (apenas destaque da sintaxe) ou defina o External compiler executable file , por exemplo, o caminho para glslangValidator.exe !
• Abra o arquivo do Visual Studio Solution visual_studio/auto_vk_toolkit.sln e construa a solução
• Durante a construção, você reconhecerá as mensagens da ferramenta Post Build Helper na saída Output do Visual Studio, algumas mensagens pop -up e um ícone na bandeja do sistema. Por favor, dê uma olhada na seção de recursos de recursos e no ajudante de compilação para obter informações adicionais.
• Vários aplicativos de exemplo estão disponíveis no arquivo de solução. Defina um deles como projeto de inicialização e execute.

Configure seu próprio projeto

• Para adicionar auto-vk-toolkit a um de seus repositórios personalizados, convém adicioná-lo como um submódulo Git. Você pode executar git submodule add https://github.com/cg-tuwien/Auto-Vk-Toolkit.git auto_vk_toolkit para adicionar auto-vk-toolkit como submodule no diretório auto_vk_toolkit .
• Execute git submodule update --init --recursive para puxar os dois, auto-vk-toolkit e auto-VK .
• As etapas descritas na seção Criando um novo projeto podem ser úteis para a criação de um projeto de Studio Visual Studio personalizado que vincula o Auto-VK-Toolkit .
• A maneira mais conveniente de configurar seu próprio projeto pode ser um dos modelos de partida:
  • Modelo de partida para projetos baseados no Visual Studio: auto-vk-toolkit-vs-starter
  • Modelo de partida para projetos baseados em cmake: auto-vk-toolkit-starter

Cmake

Por favor, consulte Docs/cmake.md!

Exemplos

Olá mundo	Várias filas	Calcule o processamento da imagem	Carregador orca

Vários aplicativos de exemplo estão incluídos neste repositório:

• Olá mundo: como renderizar um único triângulo
• Buffers de vértices: como usar buffers de vértices com pipelines de gráficos
• Framebuffer: como criar e usar o Framebuffers
• Multi Invokee Rendering: Como usar vários invocados, como seu aplicativo pode ser estruturado
• Múltiplos Qeues: Como utilizar várias filas (duas transferências e uma fila de gráficos)
• Calcule o processamento de imagem: como usar os shaders de computação para algum processamento de imagem
• Presente da computação: como apresentar à cadeia de troca de uma fila de computação
• Modelo Loader: como carregar modelos 3D do arquivo e renderizá -los
• Orca carregador: como carregar arquivos orca .fscene e renderizá -los; também como usar o serializador
• Meshetas estáticas: como dividir um modelo 3D em pequenas meshets e renderizá -las usando tarefas e shaders de malha
• Meshetas com pele: Como dividir um modelo 3D animado e esfolado em pequenas meshets e como animar e renderizar isso usando a tarefa e os shaders de malha
• Raio Rating com sombras e AO: como construir estruturas de aceleração a partir de malhas de triângulo e criar uma imagem com traços de raios. Além disso, adiciona sombras rastreadas e uma versão muito simples (e feia) da oclusão ambiente ao resultado renderizado pelo rastreamento de raios recursivo dos shaders de sucesso mais próximos.
• Questionador de raios em shaders de rastreamento de raios: semelhante ao exemplo "Ray Tracing com sombras e AO", mas em vez de rastrear o ratamento recursivo com uma tabela de ligação ao shader etc., ele simplesmente usa consultas de raios de shaders de acerto mais próximos para alcançar o mesmo resultado.
• RAY Rastreio de interseção personalizada: como criar estruturas de aceleração a partir de AABBs e a partir de malhas de triângulo.
• TEXTURE CUBEMAP: Como carregar e usar mapas de cubo.

Meshetas com pele	Ray Query e Ray Rating	Interseção personalizada RTX	Textura cubemap

Criando um novo projeto

Para projetos do Visual Studio, existe uma ferramenta de conveniência no visual_studio/tools/executables/ que pode ajudar a configurar rapidamente um novo projeto copiando um existente (por exemplo, um dos aplicativos de exemplo): create_new_project.exe

Use -o como segue para criar uma cópia de um projeto existente:

• Open create_new_project.exe e selecione um dos aplicativos de exemplo ou insira o caminho para o projeto a ser copiado manualmente.
• Digite o local de destino, o nome do projeto de destino e pressione o [Crie!] -Button.
• O projeto é copiado para a pasta de destino e todos os caminhos relativos são adaptados ao novo local se a pasta de destino estiver na mesma unidade que o projeto de origem. (Se não for, caminhos absolutos são definidos.)
• As referências de ativos e o shader são mantidas e seus caminhos são adaptados.
  ATENÇÃO: Certifique -se de remover as referências existentes se quiser modificar os ativos/shaders referenciados! Você precisará criar cópias desses arquivos manualmente e adicionar referências às cópias. Se você não o fizer, acabará modificando os ativos de estoque ou os arquivos de shader dos exemplos.
• Os cabeçalhos pré -compilados são desativados na cópia do projeto recém -criada. Se você deseja usar esse recurso, precisará habilitá -lo manualmente nas configurações de projeto do Visual Studio.
• Adicione manualmente uma referência ao projeto da biblioteca Auto-VK-Toolkit auto_vk_toolkit.vxcproj à sua solução Visual Studio e garanta que a cópia do projeto recém-criada faça referência a ela.
• Todas as referências de origem e incluir arquivos são removidas da cópia do projeto recém -criada. Você precisará adicionar pelo menos um arquivo .cpp contendo uma função main() .
• Adicione #include <auto_vk_toolkit.hpp> para usar auto-vk-toolkit .
• Após essas etapas, você poderá vincular com êxito contra o Auto-VK-Toolkit Build seu projeto recém-criado.

Uma boa estratégia é adicionar auto-vk-toolkit como um submódulo Git ao seu repositório e usar create_new_project.exe e as etapas acima para criar um projeto configurado corretamente em um diretório fora do submódulo. Certifique-se de atualizar frequentemente o submódulo, retirando-se da filial master do Auto-VK-Toolkit para obter as atualizações mais recentes.

Mangia de Recursos e o Auxiliar de Construção Post

Os projetos do Visual Studio do Auto-VK-Toolkit são configurados para que o próprio Visual Studio possa ser elegantemente usado para gerenciamento de recursos. Isso significa que os ativos necessários (modelos 3D, imagens, arquivos de cena orca) e arquivos de shader podem ser adicionados apenas aos filtros do Visual Studio na visualização "Solution Explorer" e uma ferramenta Smart Post Build Helper garante que esses recursos sejam implantados no diretório de destino do aplicativo.

Em curto/ tl; dr :

• Adicione os modelos 3D necessários, imagens e cenas de orca ao filtro de assets e
• Adicione os arquivos de shader necessários aos shaders filtram diretamente no Visual Studio. Em seguida, crie o aplicativo, aguarde o auxiliar de compilação do post implantar esses recursos no diretório de destino e execute seu aplicativo!

Isso pode parecer seguinte, onde os filtros assets e shaders têm significado especial, como sugerido acima:

Uma explicação mais detalhada e instruções adicionais são fornecidas em visual_studio/README.md .

Você notará a atividade do Helper Helper por meio do ícone da bandeja: . A ferramenta permanecerá ativa após o término da implantação por dois motivos principais:

• Ele permite investigar logs de eventos de construção anteriores e também alterar as configurações.
• Ele continua a monitorar arquivos de recursos, especialmente importantes para ativar o recarreamento a quente do Shader .

Para obter mais informações sobre o ajudante de compilação do Post Build , consulte a seção Post Build Helper e para obter mais informações sobre o recarregamento a quente do Shader, consulte a seção Automatic Recursos-Updates abaixo.

Qual é a diferença entre auto-vk-toolkit e auto-vk?

O Auto-VK é uma camada de conveniência e produtividade de conveniência e produtividade da plataforma no topo de Vulkan-HPP.

Auto-vk-toolkit estabelece o link que falta para o sistema operacional, como o manuseio de janelas, e adiciona mais funcionalidade:

• A configuração do ambiente de renderização, como ativar extensões de vulkan (por exemplo, se VK_KHR_ray_tracing_pipeline for usado, ele seleciona um dispositivo físico apropriado e permite sinalizadores e extensões necessários)
• Gerenciamento de janelas (através da GLFW)
• Manuseio de loop de jogo/render-loop com conveniente para usar métodos de retorno de chamada através da avk::invokee (como initialize() , update() , render() , onde o primeiro é chamado apenas uma vez e os dois últimos são invocados cada quadro)
• Manuseio de entrada do usuário
• Uma classe base pronta para uso para hierarquias de objetos: avk::transform
• Pronto para usar as classes de câmera controláveis ​​pelo usuário avk::quake_camera e avk::orbit_camera (derivado de ambos, avk::transform e avk::invokee )
• Suporte de carregamento de recursos para:
  • Imagens
  • Modelos 3D
  • Cenas no formato Orca, veja: Orca: Arquivo de conteúdo de pesquisa aberta
• Carregamento e conversão de material em um formato GPU-adequado ( avk::material e a vk::material_gpu_data )
• Carregamento e conversão do LightSource em um formato protegido por GPU ( avk::lightsource e avk::lightsource_gpu_data )
• Manuseio de recursos através dos filtros do Visual Studio, ou seja, apenas arraste e solte ativos e shaders que você gostaria de usar diretamente na hierarquia de filtros do Visual Studio e fazê -los implantar no diretório de destino.
• Uma poderosa ferramenta Helper Helper, que é invocada como uma etapa de construção personalizada.
  • Ele implanta ativos e shaders no diretório de destino
  • Os shaders são compilados em SPIR-V
  • Se os arquivos do shader conterem erros, as mensagens pop-up serão criadas exibindo o erro e fornecendo um botão [->VS] para navegar até a linha que contém o erro no Visual Studio.
  • Por padrão, "Debug" e "Release" Build Configurações Symlink Resources para economizar espaço, mas "publicar" criar configurações de criação implantam todos os arquivos necessários no diretório de destino para que um programa construído possa ser facilmente transferido para outro PC. Não é necessária uma coleta de recursos mais tediosa em tais situações, pois tudo isso é tratado pelo ajudante de construção.

Documentação

Existem algumas páginas de documentação contendo mais informações:

• Uso do Imgui para interfaces de usuário, descrevendo como usar o querido imgui em um projeto automático-vk-toolkit
• Configuração do CMake e instruções de construção
• Meshlets-especificamente funcionalidade para dividir a geometria em pequenos aglomerados e usá-los para renderizar pipelines de malha gráficos (aqueles com tarefas e shaders de malha)
• Funcionalidade serializadora para armazenar e carregar recursos de para/para o arquivo, como modelos 3D, imagens ou estruturas personalizadas
• Updates de recursos automáticos através da aula avk::updater , permitindo que a recreação e recarregamento quente do shader Shwapchain
• Renderização dinâmica: como usar a renderização dinâmica no auto-vk-toolkit

Perguntas frequentes, questões conhecidas, solução de problemas

P: Pode ser usado automaticamente o Linux?
A: Sim. Consulte a documentação do CMake em docs/cmake.md!

P: Pode ser usado automaticamente o Auto-VK-Toolkit sem o ajudante de compilação ?
A: Sim. O ajudante de compilação de post é uma ferramenta de conveniência que lida com a implantação de recursos, dependências de ativos e também atualizações de arquivos (úteis para recarregamento a quente do shader, dependendo da estrutura do projeto). Se você não estiver usando, precisará gerenciar a implantação de recursos e a compilação de arquivos de shader no SPIR-V manualmente.

P: Tenho problemas com o gerenciamento de ativos no Visual Studio. Algum conselho?
R: Confira problemas conhecidos e solução de problemas de ativos da WRT, que oferece diretrizes para os seguintes casos:

• Construa erros ao adicionar ativos
• O ativo não é implantado porque não é salvo no arquivo de filtros do Visual Studio

P: Mais recursos foram implantados do que eu adicionei aos filtros do Visual Studio. O que está acontecendo?
R: Alguns ativos fazem referência a outros ativos internamente. Por exemplo, os modelos 3D geralmente referenciam imagens ou arquivos de material (em caso de modelos .obj ). Esses "ativos dependentes" também são implantados no diretório de destino pelo ajudante de construção . Consulte a implantação de ativos dependentes para obter mais detalhes.

P: Quais são as diferenças entre depuração , lançamento e publicação de configurações de construção?
R: Em termos de configurações de compilação, as configurações de liberação e publicação são as mesmas. Eles vinculam as compilações de liberação de bibliotecas. A configuração de depuração tem configurações clássicas de depuração configuradas para os projetos e links do Visual Studio contra construções de depuração de bibliotecas. Há, no entanto, uma diferença entre as compilações publicadas e as compilações não publicadas , a implantação de recursos. Consulte Links/cópias simbólicas, dependendo da configuração de construção para obter mais detalhes.

P: Tenho problemas com o ajudante de construção . O que fazer?
R: Confira o Helper Post Build, que oferece diretrizes para os seguintes casos:

• Build está preso em "vai invocar [...] msbuild.exe", exibido na guia Saída do Visual Studio
• O Helper Post Build não pode ser construído automaticamente/via msbuild.exe
• Poucos recursos estão sendo implantados
• O aplicativo não pôde começar na primeira tentativa (talvez devido à falta de ativos ou DLLs)
• Mensagem de erro sobre o acesso negado aos arquivos DLL (as DLLs não são re-implantadas)
• Desempenho lento ao mostrar listas dentro do ajudante de compilação do post
• Mensagem de erro na interface do usuário do Helper Post Build: "Não conseguiu encontrar parte do caminho '...'"
• Mensagem de erro no console: can't fopen ou !RUNTIME ERROR! Couldn't load image from '...' ou similar

P: O aplicativo leva muito tempo para carregar ativos como modelos e imagens 3D. Pode ser acelerado?
R: Se você estiver se referindo ao Debug Builds, poderá configurar o Helper Post Build para que ele implante DLLs de liberação de algumas dependências externas, mesmo para construções de depuração . Eles devem acelerar muito o carregamento de ativos. Para permitir a implantação das DLLs de liberação , abra as configurações do post Build Helper e ative a opção "Sempre implante DLLs de liberação".

P: Obtendo cereal::Exception em cereal::loadBinary ou Unhandled exception at 0x00007FFE82204FD9 in ...exe: Microsoft C++ exception: cereal::Exception at memory location ...
R: Seu arquivo de cache serializado (por exemplo, para sponza_and_terrain.fscene , isso pode ser sponza_and_terrain.fscene.cache ) se tornou corrupto (talvez porque não tenha sido totalmente escrito devido a um erro anteriormente ocorrido no aplicativo ou porque a execução foi abortada). Exclua o arquivo de cache (por exemplo, sponza_and_terrain.fscene.cache ) e deixe um novo ser gerado!