This repo hosts the source for the DirectX Shader Compiler which is based on LLVM/Clang.
Перейти к файлу
Nathan Gauër 9b9442cd86
Update bug_report_spirv.md (#6988)
Removes shader playground link. Shader playground hasn't been updated
since earlier this year, hence DXC version is very stale.
2024-11-19 17:06:11 +00:00
.github Update bug_report_spirv.md (#6988) 2024-11-19 17:06:11 +00:00
autoconf Added e2k support (MCST Elbrus 2000) (#5222) 2023-09-11 14:09:48 -07:00
azure-pipelines Remove DXC.Release pipeline (#5073) 2023-03-01 17:56:34 -08:00
cmake Add llvm assertions trap and no strings (#6838) 2024-08-01 15:37:02 -04:00
docs [NFC] Fix a spelling mistake (#6946) 2024-10-04 16:05:20 -04:00
examples Clean up mistakes made when fixing copyright banners. 2017-01-25 14:36:50 -08:00
external [SPIR-V] Fixes SPV_KHR_fragment_shading_rate preventing optimizations (#6980) 2024-10-28 10:30:10 -04:00
gcp-pipelines Enable lit by default. (#5133) 2023-06-05 10:35:24 -07:00
include Do not require __STDC_LIMIT_MACROS and others (#6976) 2024-10-22 11:43:41 -04:00
lib PIX: Implement shader access tracking for descriptor-heap-indexed TLAS for TraceRay (#6950) 2024-10-10 17:44:15 -07:00
projects [Validator] Check content of PSV0 part in validation (#6859) 2024-09-19 07:24:28 -07:00
resources Generate new version for each DX Compiler build (#2200) 2019-06-28 15:16:34 -07:00
test [tools] add -help option for opt. (#7002) 2024-11-16 02:59:29 +00:00
tools [SPIRV] Emit DebugFunction/Definition for both wrapper and real functions (#6966) 2024-11-18 17:01:12 -08:00
unittests Open source DxilHash (#6846) 2024-08-07 11:43:10 -07:00
utils [Validator] Check size of PSV. (#6924) 2024-10-02 20:48:32 -07:00
.clang-format first commit 2016-12-28 11:52:27 -08:00
.clang-tidy first commit 2016-12-28 11:52:27 -08:00
.gitattributes Adding line ending settings to .gitattributes (#4026) 2021-10-20 20:58:43 -05:00
.gitignore Correct build exclusion in gitignore (#6870) 2024-08-20 15:24:50 -07:00
.gitmodules [lit][SPIRV] convert runCodeTest to lit and remove dependence on effcee (#6077) 2023-12-14 06:50:32 -08:00
CMakeLists.txt Add llvm assertions trap and no strings (#6838) 2024-08-01 15:37:02 -04:00
CMakeSettings.json [BUILD] add clang-cl to CMakeSettings (#5596) 2023-08-28 20:13:06 +00:00
CONTRIBUTING.md Add Release Notes Guidance to CONTRIBUTING (#6778) 2024-07-16 10:48:05 -07:00
LICENSE.TXT Inline sub-licenses into root license file (#5569) 2023-08-21 10:05:09 -04:00
LLVMBuild.txt Revert license text in banner comments to original llvm verbage (#33) 2017-01-24 17:54:00 -08:00
README.md Typo fix in Readme file (#6890) 2024-09-03 09:17:54 -07:00
SECURITY.md Adding Microsoft SECURITY.MD (#4464) 2022-05-19 11:49:07 -07:00
ThirdPartyNotices.txt Add heading text for ThirdPartyNotices.txt 2017-02-24 16:30:31 -08:00
azure-pipelines.yml [Build] Update to clang-18 for linux clang pipeline (#6876) 2024-08-26 10:09:55 -07:00

README.md

DirectX Shader Compiler

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.

Visit the DirectX Landing Page for more resources for DirectX developers.

Features and Goals

The starting point of the project is a fork of the LLVM and Clang projects, modified to accept HLSL and emit a validated container that can be consumed by GPU drivers.

At the moment, the DirectX HLSL Compiler provides the following components:

  • dxc.exe, a command-line tool that can compile HLSL programs for shader model 6.0 or higher

  • dxcompiler.dll, a DLL providing a componentized compiler, assembler, disassembler, and validator

  • dxilconv.dll, a DLL providing a converter from DXBC (older shader bytecode format)

  • various other tools based on the above components

The Microsoft Windows SDK releases include a supported version of the compiler and validator.

The goal of the project is to allow the broader community of shader developers to contribute to the language and representation of shader programs, maintaining the principles of compatibility and supportability for the platform. It's currently in active development across two axes: language evolution (with no impact to DXIL representation), and surfacing hardware capabilities (with impact to DXIL, and thus requiring coordination with GPU implementations).

Pre-built Releases

Development kits containing only the dxc.exe driver app, the dxcompiler.dll, and the dxil.dll signing binary are available here, or in the releases tab.

SPIR-V CodeGen

As an example of community contribution, this project can also target the SPIR-V intermediate representation. Please see the doc for how HLSL features are mapped to SPIR-V, and the wiki page for how to build, use, and contribute to the SPIR-V CodeGen.

Building Sources

See the full documentation for Building and testing DXC for detailed instructions.

Running Shaders

To run shaders compiled as DXIL, you will need support from the operating system as well as from the driver for your graphics adapter. Windows 10 Creators Update is the first version to support DXIL shaders. See the Wiki for information on using experimental support or the software adapter.

Hardware Support

Hardware GPU support for DXIL is provided by the following vendors:

NVIDIA

NVIDIA's r396 drivers (r397.64 and later) provide release mode support for DXIL 1.1 and Shader Model 6.1 on Win10 1709 and later, and experimental mode support for DXIL 1.2 and Shader Model 6.2 on Win10 1803 and later. These drivers also support DXR in experimental mode.

Drivers can be downloaded from geforce.com.

AMD

AMDs driver (Radeon Software Adrenalin Edition 18.4.1 or later) provides release mode support for DXIL 1.1 and Shader Model 6.1. Drivers can be downloaded from AMD's download site.

Intel

Intel's 15.60 drivers (15.60.0.4849 and later) support release mode for DXIL 1.0 and Shader Model 6.0 as well as release mode for DXIL 1.1 and Shader Model 6.1 (View Instancing support only).

Drivers can be downloaded from the following link Intel Graphics Drivers

Direct access to 15.60 driver (latest as of this update) is provided below:

Installer

Release Notes related to DXIL

Making Changes

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:

License

DirectX Shader Compiler is distributed under the terms of the University of Illinois Open Source License.

See LICENSE.txt and ThirdPartyNotices.txt for details.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.