VulkanTutorial

Tutorial de Vulkan

Este repositorio aloja el contenido de Vulkan Tutorial.com. El sitio web en sí se basa en Daux.io, que admite Markdown con sabor a GitHub. El sitio real ejecuta daux.io con un tema personalizado y algunas modificaciones (https://github.com/overv/daux.io) y esto está integrado en una imagen de Docker.

Use problemas y extraiga solicitudes para proporcionar comentarios relacionados con el sitio web. Si tiene un problema con su código, use la sección de comentarios en el capítulo relacionado para hacer una pregunta. Proporcione su sistema operativo, tarjeta gráfica, versión del controlador, código fuente, comportamiento esperado y comportamiento real.

Libro electrónico

Esta guía ahora está disponible en formatos de libros electrónicos:

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

El libro electrónico se puede construir a partir del contenido existente ejecutando:

 python3 build_ebook.py

Este script depende de que las siguientes utilidades estén disponibles en el camino:

• inkscape : conversión SVG a PNG (probado con la versión 1.0.2)
• pandoc : Construyendo un PDF y EPUB a partir del código de Markdown (probado con la versión 2.13)

También debe instalar una distribución de látex para la generación PDF.

Cambio de código en todos los capítulos

A veces es necesario cambiar el código que se reutiliza en muchos capítulos, por ejemplo, una función como createBuffer . Si realiza un cambio de este tipo, debe actualizar los archivos de código utilizando los siguientes pasos:

• Actualice cualquier capítulo que haga referencia al código modificado.
• Realice una copia del primer archivo que lo use y modifique el código allí, por ejemplo, base_code_fixed.cpp .
• Cree un parche usando diff -Naur base_code.cpp base_code_fixed.cpp > patch.txt .
• Aplique el parche al archivo de código especificado y todos los archivos en capítulos posteriores utilizando el script incremental_patch.sh . Ejecutarlo así: ./incremental_patch.sh base_code.cpp patch.txt .
• Limpie los archivos base_code_fixed.cpp y patch.txt .
• Comprometerse.

Representar el tutorial

Para representar el tutorial (es decir, convertir el markdown en HTML), tiene dos opciones:

1. Servir archivos renderizados en la marcha utilizando un servidor web que tiene PHP instalado
2. Genere archivos HTML estáticos que pueda ver localmente o poner en un servidor

Para cualquiera de estas opciones, necesitará PHP y un Daux parcheado.

Php

1. Asegúrese de que se instale PHP (daux está escrito en PHP)
   1. Las extensiones php_mbstring y php_openssl deben estar habilitadas
   2. La configuración phar.readonly debe establecerse en Off (para poder reconstruir Daux)
2. Asegúrese de que esté instalado el compositor, un administrador de dependencia de PHP que Daux usa

Clon, parche y reconstruir daux

1. Clon
   • git clone https://github.com/dauxio/daux.io.git
2. Haga una nueva rama en la revisión anterior con la que se encuentra el parche Vulkantututorial:
   • git checkout d45ccff -b vtpatch
   • Hacer una nueva rama no es estrictamente necesaria, ya que podría restablecer master , pero esto mantiene intacto al maestro.
3. Copie a través del archivo daux.patch en el directorio Daux.io, asegúrese de que las finales de línea sean un estilo UNIX (en caso de que esté usando Windows) y aplique el parche. Debe aplicarse limpiamente.
   • git am daux.patch
4. Ejecute el compositor en el directorio Daux.io para que descargue las dependencias que Daux necesita para construir
   • composer install
5. Reconstruir daux
   • php bin/compile (esto puede llevar un tiempo)
   • Un daux.phar recién hecho ahora estará en su directorio base

Usar daux para servir archivos renderizados en la marcha

Una vez que haya completado lo anterior, siga las instrucciones en el sitio Daux sobre cómo ejecutar daux usando un servidor web.

Como una opción simple teniendo en cuenta que tiene PHP instalado, también puede usar el servidor web de desarrollo integrado de PHP si solo necesita ver localmente cómo se ven las cosas:

1. En el directorio daux.io , edite global.json para que la opción docs_directory apunte en su directorio Vulkantutorial
   • "docs_directory": "../VulkanTutorial",
2. En el directorio daux.io , ejecute
   • php -S localhost:8080 index.php
3. Escriba localhost:8080 en la barra de URL de su navegador web y presione Enter. Ahora debería ver la página principal Vulkantutorial.

Uso de Daux para generar archivos HTML estáticamente

Antes de generar los archivos estáticos, necesitamos ajustar Daux y la configuración del tutorial para evitar que intente cargar algunos recursos externos (que detendrán su navegador al intentar cargar la página estática de otra manera)

1. En el directorio VulkanTutorial , edite config.json y elimine la línea google_analytics para que Daux no intente cargar eso.
2. En el directorio daux.io , edite themes/daux/config.json y elimine la línea de font para que Daux no intente cargar una fuente externa.
3. Reconstruya Daux de acuerdo con las instrucciones anteriores para que capte los cambios del tema.

Estamos trabajando en mejoras, por lo que en el futuro los pasos anteriores no serán necesarios.

Ahora con lo anterior, podemos generar los archivos estáticos. Asuming Los directorios Daux.io y Vulkantutorial están uno al lado del otro, vayan al directorio daux.io y ejecute un comando similar a: php generate -s ../VulkanTutorial -d ../VulkanTutorial/out .

-s le dice dónde encontrar la documentación, mientras que -d le dice dónde colocar los archivos generados.

NOTA: Si desea generar nuevamente los documentos, elimine primero el directorio out o Daux hará un nuevo directorio out dentro del directorio out existente.

Licencia

El contenido de este repositorio tiene licencia como CC BY-SA 4.0, a menos que se indique lo contrario. Al contribuir a este repositorio, acepta licenciar sus contribuciones al público bajo esa misma licencia.

Los listados de código en el directorio code tienen licencia como CC0 1.0 Universal. Al contribuir a ese directorio, usted acepta licenciar sus contribuciones al público bajo esa misma licencia de dominio público.