VulkanTutorial

Vulkan教程

该存储库托管Vulkan-Tutorial.com的内容。该网站本身基于Daux.io，该网站支持GitHub调味的Markdown。实际网站通过自定义主题和一些修改（https://github.com/overv/daux.io）运行daux.io，并且它内置在docker映像中。

使用问题并提取请求提供与网站相关的反馈。如果您对代码有问题，请使用相关章节中的“评论”部分提出问题。请提供您的操作系统，图形卡，驱动程序版本，源代码，预期行为和实际行为。

电子书

本指南现在也以电子书格式提供：

• epub（英语，法语）
• PDF（英语，法语）

可以通过运行从现有内容构建电子书：

 python3 build_ebook.py

该脚本取决于路径上可用的以下实用程序：

• inkscape ：SVG到PNG转换（使用版本1.0.2测试）
• pandoc ：从Markdown代码构建PDF和EPUB（使用版本2.13进行测试）

您还需要为PDF生成安装乳胶发行版。

跨章节更改代码

有时有必要更改许多章节中重复使用的代码，例如诸如createBuffer之类的函数。如果您进行了这样的更改，则应使用以下步骤更新代码文件：

• 更新引用修改代码的任何章节。
• 制作第一个文件的副本，该文件使用它并修改那里的代码，例如base_code_fixed.cpp 。
• 使用diff -Naur base_code.cpp base_code_fixed.cpp > patch.txt创建一个补丁。
• 使用incremental_patch.sh脚本将补丁程序应用于指定的代码文件和所有文件。这样运行： ./incremental_patch.sh base_code.cpp patch.txt 。
• 清理base_code_fixed.cpp和patch.txt文件。
• 犯罪。

渲染教程

要渲染教程（即将降价转换为HTML），您有两个选择：

1. 使用已安装PHP的Web服务器即时提供渲染的文件
2. 生成可以在本地查看或在服务器上查看的静态HTML文件

对于这些选项中的任何一个，您都需要PHP和一个补丁的Daux。

php

1. 确保安装PHP（Daux用PHP编写）
   1. 需要启用php_mbstring和php_openssl扩展
   2. phar.readonly设置需要设置为Off （才能重建Daux）
2. 确保安装了作曲家，Daux使用的PHP依赖管理器

克隆，补丁和重建Daux

1. 克隆daux
   • git clone https://github.com/dauxio/daux.io.git
2. 在较旧的修订版中制作一个新分支，该修订版反对：
   • git checkout d45ccff -b vtpatch
   • 正如您可以重置master一样，制作新分支并不是必需的，但这使主保持完好无损。
3. 通过daux.patch文件复制到daux.io目录中，确保行结尾为unix样式（如果您使用Windows），然后应用补丁程序。它应该干净地涂抹。
   • git am daux.patch
4. 在daux.io目录中运行作曲家，以便下载依赖项Daux的需求以构建
   • composer install
5. 重建Daux
   • php bin/compile （这可能需要一段时间）
   • 新制作的daux.phar现在将在您的基本目录中

使用daux即时提供渲染的文件

完成以上内容后，请按照Daux网站上的说明进行使用，以了解如何使用Web服务器运行DAUX。

考虑到您已经安装了PHP，作为一个简单的选项，如果您只需要在本地查看什么样，也可以使用PHP内置的Web服务器：

1. 在daux.io目录中，编辑global.json ，以便docs_directory选项指向您的vulkantutorial目录
   • "docs_directory": "../VulkanTutorial",
2. 在daux.io目录中，运行
   • php -S localhost:8080 index.php
3. 在Web浏览器URL栏中输入localhost:8080并点击Enter。现在，您应该查看vulkantutorial的头版。

使用Daux静态生成HTML文件

在生成静态文件之前，我们需要调整DAUX和教程设置，以防止其尝试加载一些外部资源（在尝试加载原本静态页面时，这会使您的浏览器停滞不前）

1. 在VulkanTutorial目录中，编辑config.json并删除google_analytics行，以便Daux不会尝试加载它。
2. 在daux.io目录中，编辑themes/daux/config.json并删除font行，以使daux不会尝试加载外部字体。
3. 根据较早的说明重建Daux，以便拾取主题更改。

我们正在努力改进，因此将来无需上述步骤。

现在完成以上完成，我们可以生成静态文件。 Asuming Daux.io和Vulkantutorial Directories彼此相邻，进入daux.io目录并运行类似于以下命令： php generate -s ../VulkanTutorial -d ../VulkanTutorial/out 。

-s告诉它在哪里可以找到文档，而-d告诉它在哪里放置生成的文件。

注意：如果要再次生成文档，请先删除out目录，否则DAUX将在现有的out目录中创建一个新的out目录。

执照

除非另有说明，否则该存储库的内容被许可为CC BY-SA 4.0。通过为此存储库做出贡献，您同意根据同一许可证向公众许可您的捐款。

code目录中的代码列表被许可为CC0 1.0通用。通过为该目录做出贡献，您同意根据同一公共领域的许可证向公众许可您的捐款。