Skip to content

Update wording on modules #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SaschaWillems wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −9
Open

Update wording on modules #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Compared to the original tutorial, this version of the tutorial is teaching up-t
* Dynamic rendering instead of render passes
* Timeline semaphores
* link:https://shader-slang.org/[Slang] as the primary shading language
* Modern C++ (20) with modules
* Modern C++ (20)
* link:https://github.com/KhronosGroup/Vulkan-Hpp[Vulkan-Hpp] with link:https://en.wikipedia.org/wiki/Resource_acquisition_is_initialization[RAII]

It also contains Vulkan usage clarifications, improved synchronization and new content.
Expand Down
2 changes: 1 addition & 1 deletion en/00_Introduction.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Compared to the original tutorial, this version of the tutorial is teaching up-t
* Dynamic rendering instead of render passes
* Timeline semaphores
* link:https://shader-slang.org/[Slang] as the primary shading language
* Modern C++ (20) with modules
* Modern C++ (20)
* link:https://github.com/KhronosGroup/Vulkan-Hpp[Vulkan-Hpp] with link:https://en.wikipedia.org/wiki/Resource_acquisition_is_initialization[RAII]

It also contains Vulkan usage clarifications, improved synchronization and new content.
Expand Down
13 changes: 6 additions & 7 deletions en/02_Development_environment.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,13 +124,12 @@ This will allow other projects that distribute via Find*.cmake to be placed
in that same folder. See the accompanying link:/attachments/CMakeLists.txt[CMakeLists.txt]
for an example of a working project.

Vulkan has support for C{pp} modules which became available with c{pp}20. A
large advantage of C{pp} modules is they give all the benefits of C{pp} without
the overhead of long compile times. To do this, the .cppm file must be compiled
for your target device. This tutorial demonstrates how to take advantage of C{pp}
modules. However, to maximize compatibility across compilers and IDEs, the
attachments template has C{pp}20 module support disabled by default, but it is
recommended to enable it if your toolchain supports it.
The Vulkan C{pp} headers also offer a C{pp} module. A large advantage of C{pp} modules is they give all the benefits of C{pp} without the overhead of long compile times. To use them, the .cppm file must be compiled for your target device.

[NOTE]
====
Module support in the Vulkan C{pp} headers is still experimental and might not work with all compilers. Unless you want to experiment, it's recommended to **not** use them.
====

To enable the Vulkan C{pp}20 module in the attachments template, configure CMake with:

Expand Down
Loading