lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-08-26 16:36:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve handling of compilers & command line for edited shaders

Browse Source 
* We store the compiler used (when known) in shader debug info and use that to
  select the compiler for editing as even higher priority than the default for a
  given language/encoding combination.
* We also ensure that for known tools we add the input and output parameters
  last, after any custom parameters, so that they are always present regardless
  of what the user puts in.
This commit is contained in:
baldurk
2022-08-10 14:56:44 +01:00
parent e29d48a2a8
commit e061ea3b2e
22 changed files with 333 additions and 203 deletions
Download Patch File Download Diff File Expand all files Collapse all files
qrenderdoc/Code/Interface/PersistantConfig.h
+4 -120
View File
@@ -30,126 +30,6 @@
class QMutex;
DOCUMENT(R"(Identifies a particular known tool used for shader processing.
.. data:: Unknown
Corresponds to no known tool.
.. data:: SPIRV_Cross
`SPIRV-Cross <https://github.com/KhronosGroup/SPIRV-Cross>`_.
.. data:: spirv_dis
`spirv-dis from SPIRV-Tools <https://github.com/KhronosGroup/SPIRV-Tools>`_.
.. data:: glslangValidatorGLSL
`glslang compiler (GLSL) <https://github.com/KhronosGroup/glslang>`_.
.. data:: glslangValidatorHLSL
`glslang compiler (HLSL) <https://github.com/KhronosGroup/glslang>`_.
.. data:: spirv_as
`spirv-as from SPIRV-Tools <https://github.com/KhronosGroup/SPIRV-Tools>`_.
.. data:: dxc
`DirectX Shader Compiler <https://github.com/microsoft/DirectXShaderCompiler>`_.
)");
enum class KnownShaderTool : uint32_t
{
Unknown,
First = Unknown,
SPIRV_Cross,
spirv_dis,
glslangValidatorGLSL,
glslangValidatorHLSL,
spirv_as,
dxc,
Count,
};
ITERABLE_OPERATORS(KnownShaderTool);
DOCUMENT(R"(Returns the default executable name with no suffix for a given :class:`KnownShaderTool`.
.. note::
The executable name is returned with no suffix, e.g. ``foobar`` which may need a platform specific
suffix like ``.exe`` appended.
:param KnownShaderTool tool: The tool to get the executable name for.
:return: The default executable name for this tool, or an empty string if the tool is unrecognised.
:rtype: str
)");
inline rdcstr ToolExecutable(KnownShaderTool tool)
{
if(tool == KnownShaderTool::SPIRV_Cross)
return "spirv-cross";
else if(tool == KnownShaderTool::spirv_dis)
return "spirv-dis";
else if(tool == KnownShaderTool::glslangValidatorGLSL)
return "glslangValidator";
else if(tool == KnownShaderTool::glslangValidatorHLSL)
return "glslangValidator";
else if(tool == KnownShaderTool::spirv_as)
return "spirv-as";
else if(tool == KnownShaderTool::dxc)
return "dxc";
return "";
}
DOCUMENT(R"(Returns the expected default input :class:`~renderdoc.ShaderEncoding` that a
:class:`KnownShaderTool` expects. This may not be accurate and may be configurable depending on the
tool.
:param KnownShaderTool tool: The tool to get the input encoding for.
:return: The encoding that this tool expects as an input by default.
:rtype: renderdoc.ShaderEncoding
)");
inline ShaderEncoding ToolInput(KnownShaderTool tool)
{
if(tool == KnownShaderTool::SPIRV_Cross || tool == KnownShaderTool::spirv_dis)
return ShaderEncoding::SPIRV;
else if(tool == KnownShaderTool::glslangValidatorGLSL)
return ShaderEncoding::GLSL;
else if(tool == KnownShaderTool::glslangValidatorHLSL)
return ShaderEncoding::HLSL;
else if(tool == KnownShaderTool::spirv_as)
return ShaderEncoding::SPIRVAsm;
else if(tool == KnownShaderTool::dxc)
return ShaderEncoding::HLSL;
return ShaderEncoding::Unknown;
}
DOCUMENT(R"(Returns the expected default output :class:`~renderdoc.ShaderEncoding` that a
:class:`KnownShaderTool` produces. This may not be accurate and may be configurable depending on the
tool.
:param KnownShaderTool tool: The tool to get the output encoding for.
:return: The encoding that this tool produces as an output by default.
:rtype: renderdoc.ShaderEncoding
)");
inline ShaderEncoding ToolOutput(KnownShaderTool tool)
{
if(tool == KnownShaderTool::SPIRV_Cross)
return ShaderEncoding::GLSL;
else if(tool == KnownShaderTool::spirv_dis)
return ShaderEncoding::SPIRVAsm;
else if(tool == KnownShaderTool::glslangValidatorGLSL ||
tool == KnownShaderTool::glslangValidatorHLSL || tool == KnownShaderTool::spirv_as ||
tool == KnownShaderTool::dxc)
return ShaderEncoding::SPIRV;
return ShaderEncoding::Unknown;
}
DOCUMENT(R"(Contains the output from invoking a :class:`ShaderProcessingTool`, including both the
actual output data desired as well as any stdout/stderr messages.
)");
@@ -241,6 +121,10 @@ struct ShaderProcessingTool
)");
ShaderToolOutput CompileShader(QWidget *window, rdcstr source, rdcstr entryPoint,
ShaderStage stage, rdcstr args) const;
private:
DOCUMENT("Internal function");
rdcstr IOArguments() const;
};
DECLARE_REFLECTION_STRUCT(ShaderProcessingTool);