|
@@ -1,6 +1,8 @@
|
|
|
# DirectX Shader Compiler
|
|
|
|
|
|
-The DirectX Shader Compiler is a compiler and related set of tools used to compile High-Level Shader Language (HLSL) programs into DirectX Intermediate Language (DXIL) representation. Applications that make use of DirectX for graphics, games, and computation can use it to generate shader programs.
|
|
|
+The DirectX Shader Compiler project includes a compiler and related tools used to compile High-Level Shader Language (HLSL) programs into DirectX Intermediate Language (DXIL) representation. Applications that make use of DirectX for graphics, games, and computation can use it to generate shader programs.
|
|
|
+
|
|
|
+For more information, see the [Wiki](https://github.com/Microsoft/DirectXShaderCompiler/wiki).
|
|
|
|
|
|
## Features and Goals
|
|
|
|
|
@@ -23,19 +25,21 @@ The goal of the project is to allow the broader community of shader developers t
|
|
|
Before you build, you will need to have some additional software installed.
|
|
|
|
|
|
* [Git](http://git-scm.com/downloads).
|
|
|
-* [Visual Studio 2015](https://www.visualstudio.com/downloads). Update 3 is the supported version. This will install the Windows Development Kit as a side effect. We also need the common tools for visual C++ to get the atl headers (e.g. atlbase.h). In the install options, make sure the following options are checked:
|
|
|
+* [Visual Studio 2015](https://www.visualstudio.com/downloads), Update 3. This will install the Windows Development Kit. In the install options, make sure the following options are checked:
|
|
|
* Windows 10 SDK (10.0.10240.0)
|
|
|
* Common Tools for Visual C++ 2015
|
|
|
-* [Windows 10 SDK](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk). This is needed to build tests that reference the D3D12 runtime.
|
|
|
-* [Windows Driver Kit](https://developer.microsoft.com/en-us/windows/hardware/windows-driver-kit). Or download and install the [Windows Driver Kit 8.1 Update 1](http://www.microsoft.com/en-us/download/details.aspx?id=42273), no need to download and install tests. This will target your common Windows Kits path, on a 64-bit machine this will likely be C:\Program Files (x86)\Windows Kits\8.1. WDK for Windows 10 should also work. This is currently needed to run TAEF tests and build with the TAEF framework.
|
|
|
+* [Windows 10 SDK](https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk). This is needed to build tests that reference the D3D12 runtime. You may get this as part of installing/updating Visual Studio.
|
|
|
+* [Windows Driver Kit](https://developer.microsoft.com/en-us/windows/hardware/windows-driver-kit). No need to download and install tests. This is used to build and run tests.
|
|
|
* [CMake](https://cmake.org/files/v3.4/cmake-3.4.3-win32-x86.exe). Version 3.4.3 is the supported version. You need not change your PATH variable during installation.
|
|
|
* [Python](https://www.python.org/downloads/). Version 2.7.x is required, 3.x might work but it's not officially supported. You need not change your PATH variable during installation.
|
|
|
|
|
|
To setup the build environment run the `utils\hct\hctstart.cmd` script passing the path to the source and build directories. For example:
|
|
|
|
|
|
- git clone <DirectXShaderCompiler repo> C:\DirectXShaderCompiler
|
|
|
- cd C:\DirectXShaderCompiler
|
|
|
- utils\hct\hctstart.cmd C:\DirectXShaderCompiler C:\DirectXShaderCompiler.bin
|
|
|
+```
|
|
|
+git clone https://github.com/Microsoft/DirectXShaderCompiler.git C:\DirectXShaderCompiler
|
|
|
+cd C:\DirectXShaderCompiler
|
|
|
+utils\hct\hctstart.cmd C:\DirectXShaderCompiler C:\DirectXShaderCompiler.bin
|
|
|
+```
|
|
|
|
|
|
To create a shortcut to the build environment with the default build directory, double-click on the `utils\hct\hctshortcut.js` file.
|
|
|
|
|
@@ -47,6 +51,8 @@ You can also clean, build and run tests with this command.
|
|
|
|
|
|
hctcheckin
|
|
|
|
|
|
+To see a list of additional commands available, run `hcthelp`
|
|
|
+
|
|
|
## Running Tests
|
|
|
|
|
|
To run tests, open the HLSL Console and run this command after a successful build.
|
|
@@ -71,19 +77,12 @@ To make contributions, see the CONTRIBUTING.md file in this project.
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
-You can find documentation for this project in the docs/ directory. These contain the original LLVM documentation files, as well as two new files worth nothing:
|
|
|
+You can find documentation for this project in the `docs` directory. These contain the original LLVM documentation files, as well as two new files worth nothing:
|
|
|
|
|
|
* HLSLChanges.rst: this is the starting point for how this fork diverges from the original llvm/clang sources
|
|
|
* DXIL.rst: this file contains the specification for the DXIL format
|
|
|
* tools/clang/docs/UsingDxc.rst: this file contains a user guide for dxc.exe
|
|
|
|
|
|
-## Other Useful Tools
|
|
|
-
|
|
|
-These are recommendations from experience to improve your coding, not official endorsements.
|
|
|
-
|
|
|
-* [Text Macros](https://visualstudiogallery.msdn.microsoft.com/8e2103b6-87cf-4fef-9410-a580c434b602). This adds record/playback for keyboard sequenhces.
|
|
|
-* [clang-format plugin for Visual Studio](http://llvm.org/builds/). This is the code standard we are looking to use.
|
|
|
-
|
|
|
## License
|
|
|
|
|
|
DirectX Shader Compiler is distributed under the terms of the MIT license.
|