This repository hosts the contents of vulkan-tutorial.com.
The website itself is based on daux.io,
which supports GitHub flavored Markdown.
A few changes were made to daux.io and its themes, which are included in
daux.patch and are licensed as MIT. The
patch is based on commit
Use issues and pull requests to provide feedback related to the website. If you have a problem with your code, then use the comments section in the related chapter to ask a question. Please provide your operating system, graphics card, driver version, source code, expected behaviour and actual behaviour.
This guide is now available in e-book formats as well:
The e-book can be built from the existing content by running:
This script depends on the following utilities being available on the path:
inkscape: SVG to PNG conversion
pandoc: Building a PDF and EPUB from the Markdown code
You also need to install a LaTeX distribution for PDF generation.
Changing code across chapters
It is sometimes necessary to change code that is reused across many chapters,
for example a function like
createBuffer. If you make such a change, then you
should update the code files using the following steps:
- Update any chapters that reference the modified code.
- Make a copy of the first file that uses it and modify the code there, e.g.
- Create a patch using
diff -Naur base_code.cpp base_code_fixed.cpp > patch.txt.
- Apply the patch to the specified code file and all files in later chapters
incremental_patch.shscript. Run it like this:
./incremental_patch.sh base_code.cpp patch.txt.
- Clean up the
Rendering the tutorial
To render the tutorial (i.e. convert the markdown to html), you have two options:
- Serve rendered files on the fly using a web server that has php installed
- Generate static html files that you can view locally or put on a server
For either of these options, you'll need php and a patch'ed daux.
- Make sure PHP is installed (Daux is written
- Both the
php_opensslextensions need to be enabled
phar.readonlysetting needs to be set to
Off(to be able to rebuild Daux)
- Both the
- Make sure Composer is installed, a php dependency manager that Daux uses
Clone, patch, and rebuild daux
- Clone daux
git clone https://github.com/dauxio/daux.io.git
- Make a new branch at the older revision that the VulkanTutorial patch is
git checkout d45ccff -b vtpatch
- Making a new branch isn't strictly necessary, as you could reset
master, but this keeps master intact.
- Copy over the
daux.patchfile into the daux.io directory, make sure line endings are UNIX style (in case you're using Windows), and apply the patch. It should apply cleanly.
git am daux.patch
- Run composer in the daux.io directory so that it downloads the dependencies
Daux needs in order to be built
- Rebuild Daux
php bin/compile(this can take a while)
- A newly made
daux.pharwill now be in your base directory
Using Daux to serve rendered files on the fly
Once you've completed the above, follow the instructions on the daux site for how to run daux using a web server.
As a simple option considering you have php installed, you can also use php's built in development web server if you just need to locally see what things look like:
- In the
global.jsonso that the
docs_directoryoption points at your VulkanTutorial directory
- In the
php -S localhost:8080 index.php
localhost:8080in your web browser URL bar and hit enter. You should now see the VulkanTutorial front page.
Using Daux to statically generate html files
Before we generate the static files, we need to tweak daux and the tutorial setup to prevent it from trying to load a few outside resources (which will stall your browser when trying to load the otherwise static page)
- In the
config.jsonand remove the
google_analyticsline so daux doesn't try to load that.
- In the
themes/daux/config.jsonand remove the
fontline so that daux doesn't try to load an external font.
- Rebuild daux according to the earlier instructions so it picks up the theme changes.
We're working on improvements so in the future the above steps won't be necessary.
Now with the above done, we can generate the static files. Asuming the daux.io
and VulkanTutorial directories are next to each other, go into the
directory and run a command similar to:
php generate -s ../VulkanTutorial -d ../VulkanTutorial\out.
-s tells it where to find the documentation, while
-d tells it where to put
the generated files.
Note: if you want to generate the docs again, delete the
out directory first
or daux will make a new
out directory within the existing
The contents of this repository are licensed as CC BY-SA 4.0, unless stated otherwise. By contributing to this repository, you agree to license your contributions to the public under that same license.
The code listings in the
code directory are licensed as CC0 1.0 Universal.
By contributing to that directory, you agree to license your contributions to
the public under that same public domain-like license.