README.asciidoc

spvc Manual

Table of Contents

• 1. Name
• 2. Synopsis
• 3. Description
  • 3.1. Input file languages
  • 3.2. Output file naming
• 4. Command Line Options
  • 4.1. Overall Options
    • 4.1.1. --help
    • 4.1.2. --version
    • 4.1.3. --validate=<source env>
    • 4.1.4. -o

1. Name

spvc - A validating SPIR-V to GLSL/HLSL/MSL compiler with Clang-compatible options.

2. Synopsis

spvc [--help]

spvc [--version]
     [--validate=<target env>]
     [-o outfile]
     shader...

3. Description

spvc is a wrapper around SPIRV-Cross. A SPIR-V module must pass validation before it is given to SPIRV-Cross for translation.

3.1. Input file languages

Spvc accepts SPIR-V binary files as input.

3.2. Output file naming

If a name is specified via -o, the output file will be given that name. Otherwise the output file name is the same as the input file name except with a .glsl, .hlsl or .msl extension, as appropriate.

4. Command Line Options

4.1. Overall Options

4.1.1. --help

--help tells the spvc compiler to display all available options and exit.

4.1.2. --version

--version displays version information.

4.1.3. --validate=<source env>

--validate validates the input with the given environment, which is one of:

• vulkan1.0

• vulkan1.1

The default is vulkan1.0.

4.1.4. -o

-o lets you specify the output file’s name. It cannot be used when there are multiple files generated. A filename of - represents standard output.