Add a python script to install Direct3D 12 SDK components. #86717
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| #!/usr/bin/env python | ||
|
|
||
| import os | ||
| import urllib.request | ||
| import shutil | ||
|
|
||
| # Base Godot dependencies path | ||
| deps_folder = os.path.join(f"{os.getenv('LOCALAPPDATA')}", "Godot", "build_deps") | ||
| # DirectX Shader Compiler | ||
| dxc_version = "v1.7.2308" | ||
| dxc_filename = "dxc_2023_08_14.zip" | ||
| dxc_archive = os.path.join(deps_folder, dxc_filename) | ||
| dxc_folder = os.path.join(deps_folder, "dxc") | ||
| # Mesa NIR | ||
| mesa_version = "23.1.0-devel" | ||
| mesa_filename = "godot-nir-23.1.0-1-devel.zip" | ||
| mesa_archive = os.path.join(deps_folder, mesa_filename) | ||
| mesa_folder = os.path.join(deps_folder, "mesa") | ||
| # WinPixEventRuntime | ||
| pix_version = "1.0.231030001" | ||
| pix_archive = os.path.join(deps_folder, f"WinPixEventRuntime_{pix_version}.nupkg") | ||
| pix_folder = os.path.join(deps_folder, "pix") | ||
| # DirectX 12 Agility SDK | ||
| agility_sdk_version = "1.610.4" | ||
| agility_sdk_archive = os.path.join(deps_folder, f"Agility_SDK_{agility_sdk_version}.nupkg") | ||
| agility_sdk_folder = os.path.join(deps_folder, "agility_sdk") | ||
|
|
||
| # Create dependencies folder | ||
| if not os.path.exists(deps_folder): | ||
| os.makedirs(deps_folder) | ||
|
|
||
| # DirectX Shader Compiler | ||
| print("[1/4] DirectX Shader Compiler") | ||
| if os.path.isfile(dxc_archive): | ||
| os.remove(dxc_archive) | ||
| print(f"Downloading DirectX Shader Compiler {dxc_filename} ...") | ||
| urllib.request.urlretrieve( | ||
| f"https://github.com/microsoft/DirectXShaderCompiler/releases/download/{dxc_version}/{dxc_filename}", | ||
| dxc_archive, | ||
| ) | ||
| if os.path.exists(dxc_folder): | ||
| print(f"Removing existing local DirectX Shader Compiler installation in {dxc_folder} ...") | ||
| shutil.rmtree(dxc_folder) | ||
| print(f"Extracting DirectX Shader Compiler {dxc_filename} to {dxc_folder} ...") | ||
| shutil.unpack_archive(dxc_archive, dxc_folder) | ||
| os.remove(dxc_archive) | ||
| print(f"DirectX Shader Compiler {dxc_filename} installed successfully.\n") | ||
|
|
||
| # Mesa NIR | ||
| print("[2/4] Mesa NIR") | ||
| if os.path.isfile(mesa_archive): | ||
| os.remove(mesa_archive) | ||
| print(f"Downloading Mesa NIR {mesa_filename} ...") | ||
| urllib.request.urlretrieve( | ||
| f"https://github.com/godotengine/godot-nir-static/releases/download/{mesa_version}/{mesa_filename}", | ||
| mesa_archive, | ||
| ) | ||
| if os.path.exists(mesa_folder): | ||
| print(f"Removing existing local Mesa NIR installation in {mesa_folder} ...") | ||
| shutil.rmtree(mesa_folder) | ||
| print(f"Extracting Mesa NIR {mesa_filename} to {mesa_folder} ...") | ||
| shutil.unpack_archive(mesa_archive, mesa_folder) | ||
| os.remove(mesa_archive) | ||
| print(f"Mesa NIR {mesa_filename} installed successfully.\n") | ||
|
|
||
| # WinPixEventRuntime | ||
| print("[3/4] WinPixEventRuntime") | ||
| if os.path.isfile(pix_archive): | ||
| os.remove(pix_archive) | ||
| print(f"Downloading WinPixEventRuntime {pix_version} ...") | ||
| urllib.request.urlretrieve(f"https://www.nuget.org/api/v2/package/WinPixEventRuntime/{pix_version}", pix_archive) | ||
| if os.path.exists(pix_folder): | ||
| print(f"Removing existing local WinPixEventRuntime installation in {pix_folder} ...") | ||
| shutil.rmtree(pix_folder) | ||
| print(f"Extracting WinPixEventRuntime {pix_version} to {pix_folder} ...") | ||
| shutil.unpack_archive(pix_archive, pix_folder, "zip") | ||
| os.remove(pix_archive) | ||
| print(f"WinPixEventRuntime {pix_version} installed successfully.\n") | ||
|
|
||
| # DirectX 12 Agility SDK | ||
| print("[4/4] DirectX 12 Agility SDK") | ||
| if os.path.isfile(agility_sdk_archive): | ||
| os.remove(agility_sdk_archive) | ||
| print(f"Downloading DirectX 12 Agility SDK {agility_sdk_version} ...") | ||
| urllib.request.urlretrieve( | ||
| f"https://www.nuget.org/api/v2/package/Microsoft.Direct3D.D3D12/{agility_sdk_version}", agility_sdk_archive | ||
| ) | ||
| if os.path.exists(agility_sdk_folder): | ||
| print(f"Removing existing local DirectX 12 Agility SDK installation in {agility_sdk_folder} ...") | ||
| shutil.rmtree(agility_sdk_folder) | ||
| print(f"Extracting DirectX 12 Agility SDK {agility_sdk_version} to {agility_sdk_folder} ...") | ||
| shutil.unpack_archive(agility_sdk_archive, agility_sdk_folder, "zip") | ||
| os.remove(agility_sdk_archive) | ||
| print(f"DirectX 12 Agility SDK {agility_sdk_version} installed successfully.\n") | ||
|
|
||
| # Complete message | ||
| print(f"All Direct3D 12 SDK components were installed to {deps_folder} successfully!") | ||
| print('You can now build Godot with Direct3D 12 support enabled by running "scons d3d12=yes".') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -164,6 +164,9 @@ def get_opts(): | |
|
|
||
| mingw = os.getenv("MINGW_PREFIX", "") | ||
|
|
||
| # Direct3D 12 SDK dependencies folder | ||
| d3d12_deps_folder = os.path.join(os.getenv("LOCALAPPDATA"), "Godot", "build_deps") | ||
|
|
||
| return [ | ||
| ("mingw_prefix", "MinGW prefix", mingw), | ||
| # Targeted Windows version: 7 (and later), minimum supported version | ||
|
|
@@ -188,15 +191,31 @@ def get_opts(): | |
| BoolVariable("incremental_link", "Use MSVC incremental linking. May increase or decrease build times.", False), | ||
| ("angle_libs", "Path to the ANGLE static libraries", ""), | ||
| # Direct3D 12 support. | ||
| ( | ||
| "mesa_libs", | ||
| "Path to the MESA/NIR static libraries (required for D3D12)", | ||
| os.path.join(d3d12_deps_folder, "mesa"), | ||
| ), | ||
| ( | ||
| "dxc_path", | ||
| "Path to the DirectX Shader Compiler distribution (required for D3D12)", | ||
| os.path.join(d3d12_deps_folder, "dxc"), | ||
| ), | ||
| ( | ||
| "agility_sdk_path", | ||
| "Path to the Agility SDK distribution (optional for D3D12)", | ||
| os.path.join(d3d12_deps_folder, "agility_sdk"), | ||
| ), | ||
| BoolVariable( | ||
| "agility_sdk_multiarch", | ||
| "Whether the Agility SDK DLLs will be stored in arch-specific subdirectories", | ||
| False, | ||
| ), | ||
| ( | ||
| "pix_path", | ||
| "Path to the PIX runtime distribution (optional for D3D12)", | ||
| os.path.join(d3d12_deps_folder, "pix"), | ||
| ), | ||
| ] | ||
|
|
||
|
|
||
|
|
@@ -441,6 +460,16 @@ def configure_msvc(env, vcvars_msvc_config): | |
| LIBS += ["vulkan"] | ||
|
|
||
| if env["d3d12"]: | ||
| # Check whether we have d3d12 dependencies installed. | ||
| if not os.path.exists(env["mesa_libs"]) or not os.path.exists(env["dxc_path"]): | ||
| print("The Direct3D 12 rendering driver requires dependencies to be installed.") | ||
| print("You can install them by running `python misc\scripts\install_d3d12_sdk_windows.py`.") | ||
| print("See the documentation for more information:") | ||
| print( | ||
| "https://docs.godotengine.org/en/latest/contributing/development/compiling/compiling_for_windows.html" | ||
| ) | ||
| sys.exit(255) | ||
|
|
||
| env.AppendUnique(CPPDEFINES=["D3D12_ENABLED", "RD_ENABLED"]) | ||
| LIBS += ["d3d12", "dxgi", "dxguid"] | ||
| LIBS += ["version"] # Mesa dependency. | ||
|
|
@@ -452,15 +481,10 @@ def configure_msvc(env, vcvars_msvc_config): | |
| arch_subdir = "arm64" if env["arch"] == "arm64" else "x64" | ||
|
|
||
| # PIX | ||
| if env["pix_path"] != "" and os.path.exists(env["pix_path"]): | ||
|
There was a problem hiding this comment. Also, I do not think we should enable PIX by default (or enable it only for debug builds only), it's a debugging tool, and unnecessary for release templates. There was a problem hiding this comment. I could add changes to #87609, but it's maybe better if you do a follow-up directly to handle making PIX opt-in / debug only. There was a problem hiding this comment. OK, Contact me if there is anything that needs me to do🫡 |
||
| env.Append(LIBPATH=[env["pix_path"] + "/bin/" + arch_subdir]) | ||
| LIBS += ["WinPixEventRuntime"] | ||
|
|
||
| env.Append(LIBPATH=[env["mesa_libs"] + "/bin"]) | ||
| LIBS += ["libNIR.windows." + env["arch"]] | ||
|
|
||
|
|
@@ -663,16 +687,21 @@ def configure_mingw(env): | |
|
|
||
| arch_subdir = "arm64" if env["arch"] == "arm64" else "x64" | ||
|
|
||
| # Check whether we have d3d12 dependencies installed. | ||
| if not os.path.exists(env["mesa_libs"]) or not os.path.exists(env["dxc_path"]): | ||
| print("The Direct3D 12 rendering driver requires dependencies to be installed.") | ||
| print("You can install them by running `python misc\scripts\install_d3d12_sdk_windows.py`.") | ||
| print("See the documentation for more information:") | ||
| print( | ||
| "https://docs.godotengine.org/en/latest/contributing/development/compiling/compiling_for_windows.html" | ||
| ) | ||
| sys.exit(255) | ||
|
|
||
| # PIX | ||
| if env["pix_path"] != "" and os.path.exists(env["pix_path"]): | ||
| env.Append(LIBPATH=[env["pix_path"] + "/bin/" + arch_subdir]) | ||
| env.Append(LIBS=["WinPixEventRuntime"]) | ||
|
|
||
| env.Append(LIBPATH=[env["mesa_libs"] + "/bin"]) | ||
| env.Append(LIBS=["libNIR.windows." + env["arch"]]) | ||
| env.Append(LIBS=["version"]) # Mesa dependency. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bit too late but DXC is not required for building. Mesa libs is the only requirement.