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通用。通過為該目錄做出貢獻，您同意根據同一公共領域的許可證向公眾許可您的捐款。