VulkanTutorial

Tutorial de Vulkan

Este repositório hospeda o conteúdo de vulkan-tutorial.com. O site em si é baseado no daux.io, que suporta o Markdown com sabor do GitHub. O site real é executado daux.io com um tema personalizado e algumas modificações (https://github.com/overv/daux.io) e isso é incorporado em uma imagem do docker.

Use problemas e puxe solicitações para fornecer feedback relacionado ao site. Se você tiver um problema com seu código, use a seção de comentários no capítulo relacionado para fazer uma pergunta. Forneça seu sistema operacional, placa gráfica, versão do driver, código -fonte, comportamento esperado e comportamento real.

E-book

Este guia também está disponível nos formatos de livros eletrônicos:

• Epub (inglês, francês)
• PDF (inglês, francês)

O e-book pode ser construído a partir do conteúdo existente em execução:

 python3 build_ebook.py

Este script depende dos seguintes utilitários disponíveis no caminho:

• inkscape : SVG para PNG Conversão (testada com a versão 1.0.2)
• pandoc : Construindo um PDF e Epub a partir do código de marcação (testado com a versão 2.13)

Você também precisa instalar uma distribuição de látex para geração em PDF.

Mudança de código entre os capítulos

Às vezes, é necessário alterar o código que é reutilizado em muitos capítulos, por exemplo, uma função como createBuffer . Se você fizer essa alteração, atualize os arquivos de código usando as seguintes etapas:

• Atualize todos os capítulos que referenciam o código modificado.
• Faça uma cópia do primeiro arquivo que o usa e modifique o código lá, por exemplo, base_code_fixed.cpp .
• Crie um patch usando diff -Naur base_code.cpp base_code_fixed.cpp > patch.txt .
• Aplique o patch no arquivo de código especificado e em todos os arquivos nos capítulos posteriores usando o script incremental_patch.sh . Execute o seguinte: ./incremental_patch.sh base_code.cpp patch.txt .
• Limpe os arquivos base_code_fixed.cpp e patch.txt .
• Comprometer-se.

Renderizando o tutorial

Para renderizar o tutorial (ou seja, converter o Markdown para HTML), você tem duas opções:

1. Sirva arquivos renderizados em tempo real usando um servidor da web que possui o PHP instalado
2. Gere arquivos HTML estáticos que você pode visualizar localmente ou colocar em um servidor

Para qualquer uma dessas opções, você precisará de PHP e um remendo da DAUX.

Php

1. Verifique se o PHP está instalado (daux está escrito no PHP)
   1. As extensões php_mbstring e php_openssl precisam ser ativadas
   2. A configuração phar.readonly precisa ser definida para Off (para poder reconstruir DAUX)
2. Verifique se o Composer está instalado, um gerente de dependência do PHP que o DAUX usa

Clone, remendo e reconstruir daux

1. Clone daux
   • git clone https://github.com/dauxio/daux.io.git
2. Faça um novo ramo na revisão mais antiga do qual o patch vulkantatorial é contra:
   • git checkout d45ccff -b vtpatch
   • Fazer um novo ramo não é estritamente necessário, pois você pode redefinir master , mas isso mantém o mestre intacto.
3. Copie o arquivo daux.patch no diretório daux.io, verifique se as finais da linha são o estilo Unix (caso você esteja usando o Windows) e aplique o patch. Deve se aplicar de maneira limpa.
   • git am daux.patch
4. Execute o compositor no diretório daux.io para baixar as dependências necessárias para serem construídas
   • composer install
5. Reconstrua Daux
   • php bin/compile (isso pode demorar um pouco)
   • Um daux.phar recém -fabricado agora estará em seu diretório básico

Usando daux para servir arquivos renderizados em tempo real

Depois de concluir o acima, siga as instruções no site daux para como executar o DAUX usando um servidor da web.

Como uma opção simples, considerando que você tem o PHP instalado, você também pode usar o servidor web de desenvolvimento incorporado do PHP se precisar ver localmente como é:

1. No diretório daux.io , edit global.json para que a opção docs_directory aponte seu diretório vulkantutorial
   • "docs_directory": "../VulkanTutorial",
2. No diretório daux.io , execute
   • php -S localhost:8080 index.php
3. Digite localhost:8080 na barra de URL do navegador da web e pressione Enter. Agora você deve ver a primeira página da Vulkantatorial.

Usando DAUX para gerar estaticamente arquivos HTML

Antes de gerarmos os arquivos estáticos, precisamos ajustar a DAUX e a configuração do tutorial para impedir que ele tente carregar alguns recursos externos (o que paro seu navegador ao tentar carregar a página estática)

1. No Diretório VulkanTutorial , Edit config.json e remova a linha google_analytics para que o DAUX não tente carregar isso.
2. No diretório daux.io , edite themes/daux/config.json e remova a linha font para que o daux não tente carregar uma fonte externa.
3. Reconstrua o DAUX de acordo com as instruções anteriores, para que ele consiga as mudanças no tema.

Estamos trabalhando em melhorias, portanto, no futuro, as etapas acima não serão necessárias.

Agora, com o que foi feito acima, podemos gerar os arquivos estáticos. Os diretórios de daux.io e vulkantatorial estão próximos um do outro, entre no diretório daux.io e execute um comando semelhante a: php generate -s ../VulkanTutorial -d ../VulkanTutorial/out .

-s informa onde encontrar a documentação, enquanto -d indica onde colocar os arquivos gerados.

NOTA: Se você deseja gerar os documentos novamente, exclua o diretório out First ou a DAUX fará um novo out no out existente.

Licença

O conteúdo deste repositório é licenciado como CC BY-SA 4.0, a menos que indicado de outra forma. Ao contribuir para este repositório, você concorda em licenciar suas contribuições ao público sob a mesma licença.

As listagens de código no diretório code são licenciadas como CC0 1.0 Universal. Ao contribuir para esse diretório, você concorda em licenciar suas contribuições ao público sob a mesma licença de domínio público.