ShaderConductor is a tool designed for cross-compiling HLSL to other shading languages

Перейти к файлу

Minmin Gong 4fe50bd32d Ask cmake to find git executable Related work item: Github #28		2019-01-30 22:19:38 -08:00
.github/ISSUE_TEMPLATE	Update issue templates	2018-11-09 23:11:56 -08:00
CI/AzurePipelines	[CI] Add azure pipeline rules	2018-12-01 23:09:56 -08:00
Doc	Check in initial code	2018-11-07 23:29:45 -08:00
External	Ask cmake to find git executable	2019-01-30 22:19:38 -08:00
Include/ShaderConductor	Add the ability to disassemble SPIR-V	2018-12-19 23:22:04 -08:00
Source	Return error when include file is not located	2019-01-30 09:29:06 -08:00
.clang-format	Fix some code formatting problems	2018-11-17 15:03:08 -08:00
.gitattributes	Check in initial code	2018-11-07 23:29:45 -08:00
.gitignore	Check in initial code	2018-11-07 23:29:45 -08:00
BuildAll.py	[BUILD] Change the build folder naming, put OS name in front of compiler name	2018-11-30 22:51:58 -08:00
CMakeLists.txt	On Linux, strip debug information on release build	2018-12-06 21:35:30 -08:00
CONTRIBUTING.md	Check in initial code	2018-11-07 23:29:45 -08:00
LICENSE	Initial commit	2018-11-01 18:19:28 -07:00
README.md	Ask cmake to find git executable	2019-01-30 22:19:38 -08:00
azure-pipelines.yml	[CI] Add azure pipeline rules	2018-12-01 23:09:56 -08:00

README.md

ShaderConductor

ShaderConductor is a tool designed for cross-compiling HLSL to other shading languages.

Features

Converts HLSL to readable, usable and efficient GLSL
Converts HLSL to readable, usable and efficient ESSL
Converts HLSL to readable, usable and efficient Metal Shading Language (MSL)
Converts HLSL to readable, usable and efficient old shader model HLSL
Supports all stages of shaders, vertex, pixel, hull, domain, geometry, and compute.

Note that this project is still in an early stage, and it is under active development.

Architecture

ShaderConductor is not a real compiler. Instead, it glues existing open source components to do the cross-compiling.

DirectX Shader Compiler to compile HLSL to DXIL or SPIR-V,
SPIRV-Cross to convert SPIR-V to target shading languages.

Prerequisites

Git. Put git into the PATH is recommended.
Visual Studio 2017. Select the following workloads: Universal Windows Platform Development and Desktop Development with C++.
CMake. Version 3.9 or up. It's highly recommended to choose "Add CMake to the system PATH for all users" during installation.
Python. Version 2.7 or up. You need not change your PATH variable during installation.

Building

ShaderConductor has been tested on Windows, Linux, and macOS.

The script way:

  BuildAll.py <BuildSystem> <Compiler> <Architecture> <Configuration>

where,

<BuildSystem> can be ninja or vs2017. Default is vs2017.
<Compiler> can be vc141 on Windows, gcc or clang on Linux, clang on macOS.
<Architecture> must be x64 (for now).
<Configuration> can be Debug, Release, RelWithDebInfo, or MinSizeRel. Default is Release.

This script automatically grabs external dependencies to External folder, generates project file in Build/<BuildSystem>-<Compiler>-<Platform>-<Architecture>[-<Configuration>], and builds it.

The manual way:

  mkdir Build
  cd Build
  cmake -G "Visual Studio 15" -T host=x64 -A x64 ../
  cmake --build .

After building, the output file ShaderConductor.dll can be located in <YourCMakeTargetFolder>/Bin/<Configuration>/. It depends on dxcompiler.dll in the same folder.

Artifacts

You can download the prebuilt binaries generated by CI system. Currently, artifacts for Windows, Linux, macOS are published every commit.

License

ShaderConductor is distributed under the terms of MIT License. See LICENSE 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.