KhronosGroup / KhronosGroup/glslang

Add descriptions to GlslangToSpv.h

Open
#3,759 0 comments 0 reactions 1 assignee Claimed by @arcady-lunarg View on GitHub
enhancement
Dominant language
C++
Stars
3.6k
Forks
989
Avg merge
1d 2h
Merged PRs (30d)
31

Description

Inside https://github.com/KhronosGroup/glslang/blob/main/SPIRV/GlslangToSpv.h there is

```c++
struct SpvOptions {
bool generateDebugInfo {false};
bool stripDebugInfo {false};
bool disableOptimizer {true};
bool optimizeSize {false};
bool disassemble {false};
bool validate {false};
bool emitNonSemanticShaderDebugInfo {false};
bool emitNonSemanticShaderDebugSource{ false };
bool compileOnly{false};
bool optimizerAllowExpandedIDBound{false};
};
```

and no good way without reading the code or experimenting to know what these do.

Some simple comments on these to explain either what they do, or even the equivalent command line argument they emulate

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.