How to compile a GLSL shader to SPIR-V using glslang command line?

Use the standalone binary 'glslang' with the appropriate file extension (e.g., .vert for vertex shaders) and options like -V for SPIR-V output. The README provides examples based on file types for different shader stages.

Does glslang support Vulkan 1.3 SPIR-V versions?

Yes, glslang can target SPIR-V versions such as 1.5 through the setEnvTarget API or command-line options, supporting Vulkan clients up to 1.2, as shown in the C interface example for SPIR-V 1.5.

What's the difference between glslang and DXC for HLSL compilation?

Glslang has partial, non-reference HLSL support with limited validation, while DXC is Microsoft's official compiler with definitive semantics. For full HLSL compatibility, DXC is preferred, as noted in glslang's README comparing investments.

How to integrate glslang into a C++ game engine?

Use the C++ class interface from ShaderLang.h: create TShader and TProgram objects, set strings and environments with setEnvInput, then call parse and link methods, as illustrated in StandAlone.cpp for programmatic compilation.

Can glslang validate OpenGL ES 3.0 shaders?

Yes, glslang supports ESSL (OpenGL ES Shading Language) and can validate shaders against specific versions by configuring the client and version in the input settings, ensuring compliance with OpenGL ES specifications.

Is glslang suitable for web-based shader tools?

Yes, glslang can be built to WebAssembly using Emscripten with options like -DENABLE_GLSLANG_JS=ON, enabling shader compilation in browsers, though it requires disabling HLSL and optimizations for size, as per the build instructions.

Open-Awesome

glslang

NOASSERTIONC++16.4.0

A reference compiler front end for GLSL and ESSL, partial HLSL support, and a SPIR-V generator.

GitHub

3.6k stars981 forks0 contributors

What is glslang?

Glslang is the Khronos Group's official reference front-end compiler for GLSL and ESSL shader languages. It validates shader code against the OpenGL and OpenGL ES specifications, translates it into an abstract syntax tree, and can generate SPIR-V bytecode for use with Vulkan and other APIs. It solves the problem of ensuring shader correctness and portability across different graphics platforms.

Target Audience

Graphics and game engine developers working with OpenGL, OpenGL ES, or Vulkan who need to compile, validate, and translate shaders. It is also used by toolchain developers integrating shader compilation into their pipelines.

Value Proposition

Developers choose Glslang because it is the Khronos-sanctioned reference implementation, guaranteeing specification compliance. Its ability to generate SPIR-V from GLSL/ESSL and its partial HLSL support make it a versatile tool for cross-API shader development.

Overview

Khronos-reference front end for GLSL/ESSL, partial front end for HLSL, and a SPIR-V generator.

Use Cases

Best For

Validating GLSL/ESSL shaders against the official Khronos specifications
Generating SPIR-V code from GLSL for Vulkan pipelines
Integrating a reliable shader compiler into custom game engines or tools
Translating a subset of HLSL code for use in non-Direct3D environments
Extracting reflection data from shader source code for pipeline setup
Building web-based shader tools via its Emscripten/WebAssembly build

Not Ideal For

Projects requiring full, production-ready HLSL compilation and validation
Teams looking for a lightweight, easy-to-integrate shader compiler with minimal dependencies
Applications where shader compilation speed is the highest priority
Developers working exclusively with DirectX who need definitive HLSL semantics

Pros & Cons

Pros

Official Reference Validation

As the Khronos-sanctioned front-end, glslang provides specification-conformant validation for GLSL and ESSL, with results carrying similar weight as the specifications, ensuring shader correctness.

Robust SPIR-V Generation

It reliably translates GLSL/ESSL to SPIR-V for Vulkan, with virtually complete support for the intermediate language, making it essential for Vulkan pipeline development.

Comprehensive Reflection API

Offers reflection directly from the AST, extracting types and variables for pipeline setup, though it's approximate for SPIR-V output as noted in the README.

Multiple Integration Options

Provides both C++ class-based and C functional APIs, along with a standalone CLI tool, facilitating integration into various projects, as demonstrated in the code examples.

Cons

Incomplete HLSL Support

HLSL front-end is only partially complete with non-reference semantics and no validation, making it unreliable for serious HLSL work, as openly admitted in the README.

Complex Build Process

Requires dependencies like CMake, Python, and bison, and involves multiple steps for setup, which can be cumbersome for quick integration, especially on non-standard platforms.

Reflection Approximations

Reflection data is accurate for the AST but only approximate for emitted SPIR-V, limiting precision in some use cases, as stated in the project status.

Frequently Asked Questions

Related Projects

imgui

Dear ImGui: Bloat-free Graphical User interface for C++ with minimal dependencies

ncnn is a high-performance neural network inference framework optimized for the mobile platform

Stars23,573

Forks4,465

Last commit2 days ago

Bgfx

Cross-platform, graphics API agnostic, "Bring Your Own Engine/Framework" style rendering library.

Stars17,307

Forks2,114