VulkanTutorial

Vulkanチュートリアル

このリポジトリは、Vulkan-tutorial.comの内容をホストしています。ウェブサイト自体は、Githubフレーバーのマークダウンをサポートするdaux.ioに基づいています。実際のサイトは、カスタムテーマといくつかの変更（https://github.com/overv/daux.io）でdaux.ioを実行し、これはDocker画像に組み込まれています。

問題を使用してリクエストをプルして、Webサイトに関連するフィードバックを提供します。コードに問題がある場合は、関連章のコメントセクションを使用して質問してください。オペレーティングシステム、グラフィックカード、ドライバーバージョン、ソースコード、予想される動作、実際の動作を提供してください。

電子書籍

このガイドは、電子書籍形式でも利用できます。

• 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に変換）、2つのオプションがあります。

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. クローンドーックス
   • git clone https://github.com/dauxio/daux.io.git
2. Vulkantutorial Patchが反対しているという古い改訂で新しいブランチを作成します。
   • git checkout d45ccff -b vtpatch
   • masterをリセットできるため、新しいブランチを作成する必要はありませんが、これはマスターをそのままに保ちます。
3. daux.patchファイルをdaux.ioディレクトリにコピーし、行の終了がUnixスタイルであることを確認し、パッチを適用します。きれいに適用する必要があります。
   • git am daux.patch
4. daux.ioディレクトリで作曲家を実行して、dauxのニーズを構築するために依存関係をダウンロードするようにします
   • composer install
5. Dauxを再構築します
   • php bin/compile （これにはしばらく時間がかかります）
   • 新しく作られたdaux.pharがあなたのベースディレクトリにあるようになりました

Dauxを使用して、その場でレンダリングされたファイルを提供します

上記を完了したら、Webサーバーを使用してDauxを実行する方法については、Dauxサイトの指示に従ってください。

PHPがインストールされていることを考慮すると、簡単なオプションとして、PHPのビルドイン開発Webサーバーを使用することもできます。

1. daux.ioディレクトリで、 global.jsonを編集して、 docs_directoryオプションがVulkantutorial Directoryをポイントするように
   • "docs_directory": "../VulkanTutorial",
2. daux.ioディレクトリで、実行します
   • php -S localhost:8080 index.php
3. localhost:8080 web browser url barに入力し、Enterを押します。これで、Vulkantutorialのフロントページを表示する必要があります。

Dauxを使用して、HTMLファイルを静的に生成します

静的ファイルを生成する前に、Dauxとチュートリアルのセットアップを調整して、いくつかの外部リソースをロードしようとするのを防ぐ必要があります（それ以外の静的ページをロードしようとするときにブラウザを停止します）

1. VulkanTutorial Directoryで、 config.jsonを編集し、 google_analytics行を削除して、Dauxがそれをロードしようとしないようにします。
2. daux.ioディレクトリで、 themes/daux/config.jsonを編集し、 font行を削除して、Dauxが外部フォントをロードしようとしないようにします。
3. 以前の指示に従ってDauxを再構築して、テーマの変更を取り上げます。

私たちは改善に取り組んでいるので、将来上記の手順は必要ありません。

これで、上記が完了すると、静的ファイルを生成できます。 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ユニバーサルとしてライセンスされています。そのディレクトリに貢献することにより、お客様は、同じパブリックドメインのようなライセンスに基づいて、一般に貢献をライセンスすることに同意します。