Magnum::ShaderTools namespace new in Git master

Validate shader file with AbstractConverter::validateFile()

Validate shader data with AbstractConverter::validateData(). Implies ConverterFeature::ValidateData.

Convert shader file to a file with AbstractConverter::convertFileToFile()

Convert shader data to data with AbstractConverter::convertDataToData() or any of the other AbstractConverter::convertDataToFile(), AbstractConverter::convertFileToData() combinations. Implies ConverterFeature::ConvertFile.

Link shader files together and output a file with AbstractConverter::linkFilesToFile()

Link shader data together and output a data with AbstractConverter::linkDataToData() or any of the other AbstractConverter::linkDataToFile(), AbstractConverter::linkFilesToData() combinations. Implies ConverterFeature::LinkFile.

Specifying input file callbacks for additional files referenced from the main file using AbstractConverter::setInputFileCallback(). If the converter doesn't expose this feature, the format is either single-file or input file callbacks are not supported.

See Loading shaders from memory, using file callbacks and particular converter documentation for more information.

Set preprocess definitions using AbstractConverter::setDefinitions() and the ConverterFlag::PreprocessOnly flag.

Control code optimization using AbstractConverter::setOptimizationLevel()

Control amount of debug info present in the output using AbstractConverter::setDebugInfoLevel()

Suppress warnings, print just errors. By default the converter prints both warnings and errors. Corresponds to the -q / --quiet option in magnum-shaderconverter.

Print verbose diagnostic. By default the converter only prints warnings and errors. Corresponds to the -v / --verbose option in magnum-shaderconverter.

Treat warnings as error. By default, if a warning occurs, validation or conversion succeeds. With this flag set, it fails. Corresponds to the --warning-as-error option in magnum-shaderconverter.

Only run the preprocessor. Available only if the converter supports ConverterFeature::Preprocess, not allowed in combination with AbstractConverter::linkDataToData(), AbstractConverter::linkDataToFile(), AbstractConverter::linkFilesToFile() or AbstractConverter::linkFilesToData(). Corresponds to the -E / --preprocess-only option in magnum-shaderconverter.

Either leaves format detection up to the implementation or describes a format not fitting into any other categories. This includes various application-specific languages and language flavors, compressed or encrypted data and other.

This value is guaranteed to be 0, which means you're encouraged to simply use {} in function calls and elsewhere.

GLSL

SPIR-V

Textual representation of SPIR-V.

HLSL (High-Level Shading Language), used in D3D

MSL (Metal Shading Language)

WGSL (WebGPU Shading Language)

DXIL (DirectX Intermediate Language), produced by DirectX Shader Compiler

Unspecified stage. When used in the AbstractConverter::validateFile(), convertFileToFile(), convertFileToData(), linkFilesToFile() or linkFilesToData() APIs, particular plugins may attempt to detect the stage from filename, the shader stage might also be encoded directly in certain Formats. Leaving the stage unspecified might limit validation and conversion capabilities, see documentation of a particular converter for concrete behavior.

This value is guaranteed to be 0, which means you're encouraged to simply use {} in function calls and elsewhere.

Vertex stage

Fragment stage

Geometry stage

Tessellation control stage

Tessellation evaluation stage

Compute stage

Ray generation stage

Ray any hit stage

Ray closest hit stage

Ray miss stage

Ray intersection stage

Ray callable stage

Mesh task stage

Mesh stage

Compute kernel.

Compared to Stage::Compute, which is used by graphics APIs such as Vulkan or OpenGL, this one is for use by OpenCL.