Shader Compiler

Documentation for the FidelityFX Shader Compiler tool.

Structs

Name

Description

GLSLShaderBinary

The GLSL (GSLang) specialization of “IShaderBinary“ interface. Handles everything necessary to export DXC compiled binary shader data.

HLSLDxcShaderBinary

The DXC (HLSL) specialization of “IShaderBinary“ interface. Handles everything necessary to export DXC compiled binary shader data.

HLSLFxcShaderBinary

The FXC (HLSL) specialization of “IShaderBinary“ interface. Handles everything necessary to export DXC compiled binary shader data.

IReflectionData

A structure defining the reflection data to be exported. ReflectionData is composed of a number of “ShaderResourceInfo“ structs for all required resource types.

IShaderBinary

A structure encapsulating a platform agnostic shader binary interface. Override for each language representation needed (i.e. HLSL, GLSL, etc.)

Permutation

A structure defining a shader permutation representation. Each permutation compiled generates this structure for export.

ShaderResourceInfo

A structure defining an element of shader reflection data to be exported.

Classes

Name

Description

GLSLCompiler

The GLSLCompiler specialization of ICompiler interface. Handles everything necessary to compile and extract shader reflection data for GSLS and then exports the binary and reflection data for consumption by GLSL-specific backends.

HLSLCompiler

The HLSLCompiler specialization of ICompiler interface. Handles everything necessary to compile and extract shader reflection data for HSLS and then exports the binary and reflection data for consumption by HLSL-specific backends.

ICompiler

A structure defining the compiler interface. Should be sub-classed for each language supported (i.e. HLSL, GLSL, etc.)