VulkanTutorial

Учебник Vulkan

В этом репозитории содержится содержание Vulkan-tutorial.com. Сам веб -сайт основан на daux.io, который поддерживает ароматизированную маркировку GitHub. Фактический сайт запускает daux.io с пользовательской темой и несколькими изменениями (https://github.com/overv/daux.io), и это встроено в изображение Docker.

Используйте проблемы и обращайте запросов, чтобы предоставить обратную связь, связанную с веб -сайтом. Если у вас есть проблема с вашим кодом, используйте раздел комментариев в соответствующей главе, чтобы задать вопрос. Пожалуйста, предоставьте свою операционную систему, видеокарту, версию драйвера, исходный код, ожидаемое поведение и фактическое поведение.

Электронная книга

Это руководство теперь также доступно в форматах электронной книги:

• Epub (английский, французский)
• PDF (английский, французский)

Электронная книга может быть построена из существующего контента, работая:

 python3 build_ebook.py

Этот сценарий зависит от того, что на пути доступны следующие утилиты:

• inkscape : SVG в PNG преобразование (протестировано с версией 1.0.2)
• pandoc : Создание PDF и EPUB из кода Markdown (протестировано с версией 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
2. Сгенерировать статические HTML -файлы, которые вы можете просмотреть локально или поместить на сервер

Для любого из этих вариантов вам понадобится PHP и патч Daux.

PHP

1. Убедитесь, что PHP установлен (Daux записан на PHP)
   1. Необходимо включить и расширения php_mbstring и php_openssl
   2. Настройка phar.readonly необходимо установить на Off (чтобы иметь возможность восстановить Daux)
2. Убедитесь, что композитор установлен, менеджер зависимостей PHP, который использует Daux

Клон, патч и перестроить даукс

1. Клон Дау
   • 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. Восстановите Дау
   • php bin/compile (это может занять некоторое время)
   • Недавно сделанный daux.phar теперь будет в вашем базовом каталоге

Использование Daux для обслуживания визуализированных файлов на лету

После того, как вы закончите выше, следуйте инструкциям на сайте Daux, чтобы запустить Daux с помощью веб -сервера.

В качестве простой опции, учитывая установлен PHP, вы также можете использовать встроенный веб -сервер PHP в разработке, если вам просто нужно локально посмотреть, как выглядит:

1. В каталоге daux.io , редактируйте global.json , чтобы опциона docs_directory в вашем вульманториальном каталоге
   • "docs_directory": "../VulkanTutorial",
2. В каталоге daux.io запустите
   • php -S localhost:8080 index.php
3. Введите localhost:8080 в вашем панели Url в веб -браузере и нажмите Enter. Теперь вы должны увидеть вульмантуторную первую страницу.

Использование Daux для статического генерации HTML -файлов

Прежде чем мы генерируем статические файлы, нам нужно настроить Daux и настройку учебного пособия, чтобы он не попытался загрузить несколько внешних ресурсов (которые будут задержать ваш браузер при попытке загрузить статическую страницу в противном случае)

1. В каталоге VulkanTutorial редактируйте config.json и удалите линию google_analytics , чтобы Daux не пытался загрузить это.
2. В каталоге daux.io отредактируйте themes/daux/config.json и удалите линию font , чтобы Daux не пытался загрузить внешний шрифт.
3. Восстановите Daux в соответствии с более ранними инструкциями, чтобы он поднимал изменения темы.

Мы работаем над улучшениями, поэтому в будущем вышеуказанные шаги не потребуются.

Теперь с сделанным выше, мы можем генерировать статические файлы. Обожающие каталоги daux.io и вулькантуториальные каталоги рядом друг с другом, перейдите в каталог daux.io и запустите команду, аналогичную: php generate -s ../VulkanTutorial -d ../VulkanTutorial/out .

-s сообщает, где найти документацию, а -d рассказывает ей, где разместить сгенерированные файлы.

Примечание. Если вы хотите снова сгенерировать документы, сначала удалите каталог out или Daux сделает новый out в существующем out .

Лицензия

Содержание этого репозитория лицензируется как CC By 4.0, если не указано иное. Внося вклад в этот репозиторий, вы соглашаетесь лицензировать свои взносы в общественность по той же лицензии.

Списки кодов в каталоге code лицензированы как Universal CC0 1.0. Внося вклад в этот каталог, вы соглашаетесь лицензировать свои взносы в общественность по той же лицензии, подобной общественному достоянию.