{"id":13664710,"url":"https://github.com/microsoft/ShaderConductor","last_synced_at":"2025-04-26T01:33:31.842Z","repository":{"id":44437910,"uuid":"155796641","full_name":"microsoft/ShaderConductor","owner":"microsoft","description":"ShaderConductor is a tool designed for cross-compiling HLSL to other shading languages","archived":false,"fork":false,"pushed_at":"2023-01-13T15:18:42.000Z","size":185,"stargazers_count":1807,"open_issues_count":26,"forks_count":254,"subscribers_count":93,"default_branch":"master","last_synced_at":"2025-04-20T10:15:12.792Z","etag":null,"topics":["compiler","d3d10","d3d11","d3d12","d3d9","dxil","glsl","graphics","hlsl","metal","opengl","opengl-es","shader","spir-v","vulkan"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2018-11-02T01:19:25.000Z","updated_at":"2025-04-15T02:50:47.000Z","dependencies_parsed_at":"2023-02-09T16:01:12.877Z","dependency_job_id":null,"html_url":"https://github.com/microsoft/ShaderConductor","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FShaderConductor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FShaderConductor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FShaderConductor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FShaderConductor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/ShaderConductor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250919721,"owners_count":21508000,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compiler","d3d10","d3d11","d3d12","d3d9","dxil","glsl","graphics","hlsl","metal","opengl","opengl-es","shader","spir-v","vulkan"],"created_at":"2024-08-02T05:03:05.173Z","updated_at":"2025-04-26T01:33:31.837Z","avatar_url":"https://github.com/microsoft.png","language":"C++","readme":"# ShaderConductor\n\n[![Build Status](https://dev.azure.com/msft-ShaderConductor/public/_apis/build/status/ShaderConductor-CI)](https://dev.azure.com/msft-ShaderConductor/public/_build/latest?definitionId=1)\n[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)\n\n\nShaderConductor is a tool designed for cross-compiling HLSL to other shading languages.\n\n## Features\n\n* Converts HLSL to readable, usable and efficient GLSL\n* Converts HLSL to readable, usable and efficient ESSL\n* Converts HLSL to readable, usable and efficient Metal Shading Language (MSL)\n* Converts HLSL to readable, usable and efficient old shader model HLSL\n* Supports all stages of shaders, vertex, pixel, hull, domain, geometry, and compute.\n\nNote that this project is still in an early stage, and it is under active development.\n\n## Architecture\n\nShaderConductor is not a real compiler. Instead, it glues existing open source components to do the cross-compiling.\n1. [DirectX Shader Compiler](https://github.com/Microsoft/DirectXShaderCompiler) to compile HLSL to [DXIL](https://github.com/Microsoft/DirectXShaderCompiler/blob/master/docs/DXIL.rst) or [SPIR-V](https://www.khronos.org/registry/spir-v/),\n1. [SPIRV-Cross](https://github.com/KhronosGroup/SPIRV-Cross) to convert SPIR-V to target shading languages.\n\n![Architecture](Doc/Arch.svg)\n\n## Prerequisites\n\n* [Git](http://git-scm.com/downloads). Put git into the PATH is recommended.\n* [Visual Studio 2017](https://www.visualstudio.com/downloads). Select the following workloads: Universal Windows Platform Development and Desktop Development with C++.\n* [CMake](https://www.cmake.org/download/). Version 3.9 or up. It's highly recommended to choose \"Add CMake to the system PATH for all users\" during installation.\n* [Python](https://www.python.org/downloads/). Version 2.7 or up. You need not change your PATH variable during installation.\n\n## Building\n\nShaderConductor has been tested on Windows, Linux, and macOS.\n\n### The script way:\n\n```\n  BuildAll.py \u003cBuildSystem\u003e \u003cCompiler\u003e \u003cArchitecture\u003e \u003cConfiguration\u003e\n```\nwhere,\n* \\\u003cBuildSystem\\\u003e can be ninja or vs2017. Default is vs2017.\n* \\\u003cCompiler\\\u003e can be vc141 on Windows, gcc or clang on Linux, clang on macOS.\n* \\\u003cArchitecture\\\u003e must be x64 (for now).\n* \\\u003cConfiguration\\\u003e can be Debug, Release, RelWithDebInfo, or MinSizeRel. Default is Release.\n \nThis script automatically grabs external dependencies to External folder, generates project file in Build/\\\u003cBuildSystem\\\u003e-\\\u003cCompiler\\\u003e-\\\u003cPlatform\\\u003e-\\\u003cArchitecture\\\u003e[-\\\u003cConfiguration\\\u003e], and builds it.\n\n### The manual way:\n\n```\n  mkdir Build\n  cd Build\n  cmake -G \"Visual Studio 15\" -T host=x64 -A x64 ../\n  cmake --build .\n```\n\nAfter building, the output file ShaderConductor.dll can be located in \\\u003cYourCMakeTargetFolder\\\u003e/Bin/\\\u003cConfiguration\\\u003e/. It depends on dxcompiler.dll in the same folder.\n\n### Artifacts\n\nYou can download [the prebuilt binaries generated by CI system](https://dev.azure.com/msft-ShaderConductor/public/_build/latest?definitionId=1\u0026view=results). Currently, artifacts for Windows, Linux, macOS are published every commit.\n\n## License\n\nShaderConductor is distributed under the terms of MIT License. See [LICENSE](LICENSE) for details.\n\n## Code of Conduct\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n","funding_links":[],"categories":["ComputerGraphics \u0026\u0026 Shadingv","Graphics","C++","vulkan"],"sub_categories":["Google Analytics"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2FShaderConductor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2FShaderConductor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2FShaderConductor/lists"}