Skip to content

Commit

Permalink
Improve formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
johnkslang authored Mar 4, 2020
1 parent c40c4bc commit c6a4c6d
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,36 @@ a goal as of July 20, 2020, the fifth anniversary of the release of Visual Studi

There are several components:

**Reference Validator and GLSL/ESSL -> AST Front End.** An OpenGL GLSL and OpenGL|ES GLSL (ESSL) front-end for reference validation and translation of GLSL/ESSL into an internal abstract syntax tree (AST).
### Reference Validator and GLSL/ESSL -> AST Front End

Status: Virtually complete, with results carrying similar weight as the specifications.
An OpenGL GLSL and OpenGL|ES GLSL (ESSL) front-end for reference validation and translation of GLSL/ESSL into an internal abstract syntax tree (AST).

**HLSL -> AST Front End.** An HLSL front-end for translation of an approximation of HLSL to glslang's AST form.
**Status**: Virtually complete, with results carrying similar weight as the specifications.

Status: Partially complete. Semantics are not reference quality and input is not validated.
### HLSL -> AST Front End

An HLSL front-end for translation of an approximation of HLSL to glslang's AST form.

**Status**: Partially complete. Semantics are not reference quality and input is not validated.
This is in contrast to the [DXC project](https://github.com/Microsoft/DirectXShaderCompiler), which receives a much larger investment and attempts to have definitive/reference-level semantics.

See [issue 362](https://github.com/KhronosGroup/glslang/issues/362) and [issue 701](https://github.com/KhronosGroup/glslang/issues/701) for current status.

**AST -> SPIR-V Back End.** Translates glslang's AST to the Khronos-specified SPIR-V intermediate language.
### AST -> SPIR-V Back End

Translates glslang's AST to the Khronos-specified SPIR-V intermediate language.

**Status**: Virtually complete.

### Reflector

An API for getting reflection information from the AST, reflection types/variables/etc. from the HLL source (not the SPIR-V).

**Status**: There is a large amount of functionality present, but no specification/goal to measure completeness against. It is accurate for the input HLL and AST, but only approximate for what would later be emitted for SPIR-V.

Status: Virtually complete.
### Standalone Wrapper

**Standalone Wrapper.** `glslangValidator` is command-line tool for accessing the functionality above.
`glslangValidator` is command-line tool for accessing the functionality above.

Status: Complete.

Expand Down

0 comments on commit c6a4c6d

Please sign in to comment.