Nessuna descrizione

Young Kim 7522f066a1 Bump up version 2018, remove print for shader model 6.2 7 anni fa
.vs 4bca8da154 Fix building with VS 2017 integrated cmake (#279) 8 anni fa
cmake 7522f066a1 Bump up version 2018, remove print for shader model 6.2 7 anni fa
docs 06aadc4789 [spirv] CheckAccessFullyMapped unsupported error (#824) 7 anni fa
examples e077864885 Clean up mistakes made when fixing copyright banners. 8 anni fa
external 3caadf5001 [spirv] Update external dependencies (#779) 7 anni fa
include 7522f066a1 Bump up version 2018, remove print for shader model 6.2 7 anni fa
lib 92c66ed574 Fix build warnings (#832) 7 anni fa
projects f805233b49 Revert license text in banner comments to original llvm verbage (#33) 8 anni fa
resources 6ee4074a4b first commit 8 anni fa
test f805233b49 Revert license text in banner comments to original llvm verbage (#33) 8 anni fa
tools 7522f066a1 Bump up version 2018, remove print for shader model 6.2 7 anni fa
unittests f805233b49 Revert license text in banner comments to original llvm verbage (#33) 8 anni fa
utils 77594e8624 Change rangeID parameter for CreateHandle to const (#833) 7 anni fa
.clang-format 6ee4074a4b first commit 8 anni fa
.clang-tidy 6ee4074a4b first commit 8 anni fa
.gitignore bd2371f900 [spirv] Use git submodules for SPIR-V dependency projects (#455) 8 anni fa
.gitmodules bd2371f900 [spirv] Use git submodules for SPIR-V dependency projects (#455) 8 anni fa
CMakeLists.txt edb9905e69 Merge integration fixes (#344) 8 anni fa
CMakeSettings.json 7f65e0f0d6 Clean up crlf and mixed line ending issues. (#391) 8 anni fa
CONTRIBUTING.md 6ee4074a4b first commit 8 anni fa
LICENSE.TXT f805233b49 Revert license text in banner comments to original llvm verbage (#33) 8 anni fa
LLVMBuild.txt f805233b49 Revert license text in banner comments to original llvm verbage (#33) 8 anni fa
README.md 5a787c667a Stop mentioning ninja for testing in README (#663) 7 anni fa
ThirdPartyNotices.txt 9a74306436 Add heading text for ThirdPartyNotices.txt 8 anni fa
appveyor.yml 2295239b49 Zip artifacts built on Appveyor (#647) 7 anni fa

README.md

DirectX Shader Compiler

Build status

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.

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

  • 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).

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

Before you build, you will need to have some additional software installed. This is the most straightforward path - see Building Sources on the Wiki for more options, including Visual Studio 2015 and Ninja support.

  • Git.
  • Visual Studio 2017. Select the following workloads: Universal Windows Platform Development and Desktop Development with C++.
  • Python. 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.

After cloning the project, you can set up a build environment shortcut by double-clicking the utils\hct\hctshortcut.js file. This will create a shortcut on your desktop with a default configuration.

Tests are built using the TAEF framework. Unless you have the Windows Driver Kit installed, you should run the script at utils\hct\hctgettaef.py from your build environment before you start building to download and unzip it as an external dependency. You should only need to do this once.

To build, run this command on the HLSL Console.

hctbuild

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.

hcttest

Some tests will run shaders and verify their behavior. These tests also involve a driver that can run these execute these shaders. See the next section on how this should be currently set up.

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.

Drivers indicate they can run DXIL by reporting support for Shader Model 6, possibly in experimental mode. To enable support in these cases, the Developer mode setting must be enabled.

Hardware Support

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

NVIDIA's new r381 drivers (r381.65 and later) provide experimental mode support for DXIL 1.0 and Shader Model 6.0. Here are the release notes, and a download link.

AMD's latest driver with support for DXIL 1.0 and Shader Model 6 in experimental mode is Radeon Software Crimson ReLive Edition 17.4.2.

Software Rendering

In the absence of hardware support, tests will run using the Windows Advanced Rasterization Platform (WARP) adapter. To get the correct version of WARP working, in addition to setting Developer mode, you should install the 'Graphics Tools' optional feature via the Settings app (click the 'Apps' icon, then the 'Manage optional features' link, then 'Add a feature', and select 'Graphics Tools' from the list).

For more information, see this Wiki page.

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 [email protected] with any additional questions or comments.