Vulkan.Utils.ShaderQQ.GLSL.Glslang

Documentation

glsl :: QuasiQuoter

glsl is a QuasiQuoter which produces GLSL source code with #line directives 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 Nothing "frag" Nothing [glsl|
  #version 450
  const float myConstant = ${myConstant};
  main (){
  }
|])

An explicit example (interactive is from doctest):

>>> let version = 450 :: Int in [glsl|#version $version|]
"#version 450\n#extension GL_GOOGLE_cpp_style_line_directive : enable\n#line 32 \"<interactive>\"\n"

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

comp :: QuasiQuoter

QuasiQuoter for creating a compute shader.

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

frag :: QuasiQuoter

QuasiQuoter for creating a fragment shader.

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

geom :: QuasiQuoter

QuasiQuoter for creating a geometry shader.

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

tesc :: QuasiQuoter

QuasiQuoter for creating a tessellation control shader.

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

tese :: QuasiQuoter

QuasiQuoter for creating a tessellation evaluation shader.

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

vert :: QuasiQuoter

QuasiQuoter for creating a vertex shader.

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

rgen :: QuasiQuoter

QuasiQuoter for creating a ray generation shader.

Equivalent to calling $(compileShaderQ (Just "spirv1.4") "rgen" Nothing [glsl|...|]) without interpolation support.

rint :: QuasiQuoter

QuasiQuoter for creating an intersection shader.

Equivalent to calling $(compileShaderQ (Just "spirv1.4") "rint" Nothing [glsl|...|]) without interpolation support.

rahit :: QuasiQuoter

QuasiQuoter for creating an any-hit shader.

Equivalent to calling $(compileShaderQ (Just "spirv1.4") "rahit" Nothing [glsl|...|]) without interpolation support.

rchit :: QuasiQuoter

QuasiQuoter for creating a closest hit shader.

Equivalent to calling $(compileShaderQ (Just "spirv1.4") "rchit" Nothing [glsl|...|]) without interpolation support.

rmiss :: QuasiQuoter

QuasiQuoter for creating a miss shader.

Equivalent to calling $(compileShaderQ (Just "spirv1.4") "rmiss" Nothing [glsl|...|]) without interpolation support.

rcall :: QuasiQuoter

QuasiQuoter for creating a callable shader.

Equivalent to calling $(compileShaderQ (Just "spirv1.4") "rcall" Nothing [glsl|...|]) without interpolation support.

task :: QuasiQuoter

QuasiQuoter for creating a task shader.

Equivalent to calling $(compileShaderQ Nothing "task" Nothing [glsl|...|]) without interpolation support.

mesh :: QuasiQuoter

QuasiQuoter for creating a mesh shader.

Equivalent to calling $(compileShaderQ Nothing "mesh" Nothing [glsl|...|]) without interpolation support.

compileShaderQ

Arguments

:: Maybe String

Argument to pass to `--target-env`

-> String

stage

-> Maybe String

Argument name to pass to `-e name --source-entry-point main` to specify entry-point function name

-> String

glsl shader code

-> Q Exp

Spir-V bytecode

Compile a GLSL shader to spir-v using glslangValidator.

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

compileShader

Arguments

:: MonadIO m

=> Maybe Loc

Source location

-> Maybe String

Argument to pass to `--target-env`

-> String

stage

-> Maybe String

Argument name to pass to `-e name --source-entry-point main` to specify entry-point function name

-> String

glsl shader code

-> m ([GlslangWarning], Either [GlslangError] ByteString)

Spir-V bytecode with warnings or errors

Compile a GLSL shader to spir-v using glslangValidator.