Documentation

hlsl is a QuasiQuoter which produces HLSL source code with a #line directive inserted so that error locations point to the correct location in the Haskell source file. It also permits basic string interpolation.

• Interpolated variables are prefixed with $
• They can optionally be surrounded with braces like ${foo}
• Interpolated variables are converted to strings with show
• To escape a $ use \$

It is intended to be used in concert with compileShaderQ like so

myConstant = 3.141 -- Note that this will have to be in a different module
myFragmentShader = $(compileShaderQ "frag" [hlsl|
  static const float myConstant = ${myConstant};
  float main (){
    return myConstant;
  }
|])

An explicit example (interactive is from doctest):

>>> let foo = 450 :: Int in [hlsl|const float foo = $foo|]
"#line 31 \"<interactive>\"\nconst float foo = 450"

Note that line number will be thrown off if any of the interpolated variables contain newlines.

QuasiQuoter for creating a compute shader.

Equivalent to calling $(compileShaderQ "comp" [hlsl|...|]) without interpolation support.

QuasiQuoter for creating a fragment shader.

Equivalent to calling $(compileShaderQ "frag" [hlsl|...|]) without interpolation support.

QuasiQuoter for creating a geometry shader.

Equivalent to calling $(compileShaderQ "geom" [hlsl|...|]) without interpolation support.

QuasiQuoter for creating a tessellation control shader.

Equivalent to calling $(compileShaderQ "tesc" [hlsl|...|]) without interpolation support.

QuasiQuoter for creating a tessellation evaluation shader.

Equivalent to calling $(compileShaderQ "tese" [hlsl|...|]) without interpolation support.

QuasiQuoter for creating a vertex shader.

Equivalent to calling $(compileShaderQ "vert" [hlsl|...|]) without interpolation support.

Compile a HLSL shader to SPIR-V using glslc (from the shaderc project)

Messages are converted to GHC warnings or errors depending on compilation success.

Compile a HLSL shader to spir-v using glslc