Skip to content

Commit cb6eb02

Browse files
authored
Merge pull request #10465 from Calinou/compiling-for-macos-vulkan-install-script
Mention Vulkan and Direct3D 12 SDK install scripts in Compiling for macOS/Windows
2 parents 8c34d97 + f1d751b commit cb6eb02

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

contributing/development/compiling/compiling_for_macos.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ For compiling under macOS, the following is required:
2121
(or the more lightweight Command Line Tools for Xcode).
2222
- `Vulkan SDK <https://sdk.lunarg.com/sdk/download/latest/mac/vulkan-sdk.dmg>`_
2323
for MoltenVK (macOS doesn't support Vulkan out of the box).
24+
The latest Vulkan SDK version can be installed quickly by running
25+
``misc/scripts/install_vulkan_sdk_macos.sh`` within the Godot source repository.
2426

2527
.. note:: If you have `Homebrew <https://brew.sh/>`_ installed, you can easily
2628
install SCons using the following command::

contributing/development/compiling/compiling_for_windows.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ the engine source code (using ``cd``) and type:
148148

149149
.. tip::
150150
If you are compiling Godot to make changes or contribute to the engine,
151-
you may want to use the SCons options ``dev_build=yes`` or ``dev_mode=yes``.
151+
you may want to use the SCons options ``dev_build=yes`` or ``dev_mode=yes``.
152152
See :ref:`doc_introduction_to_the_buildsystem_development_and_production_aliases`
153153
for more info.
154154

@@ -182,7 +182,15 @@ Compiling with support for Direct3D 12
182182
By default, builds of Godot do not contain support for the Direct3D 12 graphics
183183
API.
184184

185-
To compile Godot with Direct3D 12 support you need at least the following item:
185+
You can install the required dependencies by running
186+
``python misc/scripts/install_d3d12_sdk_windows.py``
187+
in the Godot source repository. After running this script, add the ``d3d12=yes``
188+
SCons option to enable Direct3D 12 support. This will use the default paths for
189+
the various dependencies, which match the ones used in the script.
190+
191+
You can find the detailed steps below if you wish to set up dependencies
192+
manually, but the above script handles everything for you (including the
193+
optional PIX and Agility SDK components).
186194

187195
- `godot-nir-static library <https://github.com/godotengine/godot-nir-static/releases/>`_.
188196
We compile the Mesa libraries you will need into a static library. Download it

0 commit comments

Comments
 (0)