FShaderConductorContext

Wrapper class to handle interface between UE and ShaderConductor.

Unreal Engine C++ API Reference > Developer > ShaderCompilerCommon

References

   
Module ShaderCompilerCommon
Header /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h
Include #include "ShaderConductorContext.h"

Syntax

class FShaderConductorContext  

Remarks

Wrapper class to handle interface between UE and ShaderConductor. Use to compile HLSL shaders to SPIR-V or high-level languages such as Metal.

Constructors

Type Name Description
  FShaderConductorContext () Initializes the context with internal buffers used for the conversion of input and option descriptors between UE and ShaderConductor.
  FShaderConductorContext ( FShaderConductorContext&& Rhs ) Move constructor to take ownership of internal buffers from 'Rhs'.
  FShaderConductorContext ( const FShaderConductorContext& )  

Destructors

Type Name Description
  ~FShaderConductorContext () Release the internal buffers.

Functions

Type Name Description
bool CompileHlslToSpirv ( const FShaderConductorOptions& Opt..., TArray< uint32 >& OutSpirv ) Compiles the specified HLSL shader source code to SPIR-V.
bool CompileSpirvToSource ( const FShaderConductorOptions& Opt..., const FShaderConductorTarget& Targ..., const void* InSpirv, uint32 InSpirvByteSize, FString& OutSource ) Compiles the specified SPIR-V shader binary code to high level source code (Metal or GLSL).
bool CompileSpirvToSourceAnsi ( const FShaderConductorOptions& Opt..., const FShaderConductorTarget& Targ..., const void* InSpirv, uint32 InSpirvByteSize, TArray< ANSICHAR >& OutSource ) Compiles the specified SPIR-V shader binary code to high level source code (Metal or GLSL) stored as null terminated ANSI string.
bool CompileSpirvToSourceBuffer ( const FShaderConductorOptions& Opt..., const FShaderConductorTarget& Targ..., const void* InSpirv, uint32 InSpirvByteSize, const TFunction< void(const void&#... ) Compiles the specified SPIR-V shader binary code to high level source code (Metal or GLSL) stored as byte buffer (without null terminator as it comes from ShaderConductor).
void ConvertCompileErrors ( TArray< FString >&& ErrorStringLin..., TArray< FShaderCompilerError >& Ou... ) Convert array of error string lines into array of .
bool Disassemble ( EShaderConductorIR Language, const void* Binary, uint32 BinaryByteSize, TArray< ANSICHAR >& OutAssemblyTex... ) Disassembles the specified SPIR-V module and returns its assembly as text representation.
void FlushErrors ( TArray< FShaderCompilerError >& Ou... ) Flushes the list of current compile errors and moves the ownership to the caller.
const TArray... GetErrors () Returns the list of current compile errors.
const FShade... GetIdentifierTable () Returns the table of special identifiers generated by ShaderConductor.
const TCHAR ... GetShaderFileExt ( EShaderConductorLanguage Language, EShaderFrequency ShaderStage ) Returns a filename extension for the specified shading language and shader stage, e.g. "frag" for a GLSL pixel shader.
int32 GetSourceLength () Returns a length of the internal loaded sources (excluding the null terminator).
const ANSICH... GetSourceString () Returns a pointer to a null terminated ANSI string of the internal loaded sources, or null if no source has been loaded yet.
bool IsIntermediateSpirvOutputVariable ( const ANSICHAR* SpirvVariableN... ) Returns whether the specified variable name denotes an intermediate output variable.
bool LoadSource ( const FString& ShaderSource, const FString& Filename, const FString& EntryPoint, EShaderFrequency ShaderStage, const FShaderCompilerDefinitions&#..., const TArray< FString >* Extra... ) Loads the shader source and converts the input descriptor to a format suitable for ShaderConductor.
bool LoadSource ( const ANSICHAR* ShaderSource, const ANSICHAR* Filename, const ANSICHAR* EntryPoint, EShaderFrequency ShaderStage, const FShaderCompilerDefinitions&#..., const TArray< FString >* Extra... ) Loads the shader source and converts the input descriptor to a format suitable for ShaderConductor.
bool OptimizeSpirv ( TArray< uint32 >& Spirv, const ANSICHAR*const* Opt..., int32 OptConfigCount ) Performs the specified optimization passes (e.g. "-O" or "--strip-reflect") on the SPIR-V module.
bool RewriteHlsl ( const FShaderConductorOptions& Opt..., FString* OutSource ) Rewrites the specified HLSL shader source code.
void Shutdown () Explicitly shut down ShaderConductor and DXC shared libraries.

Operators

Type Name Description
FShaderCondu... operator= ( FShaderConductorContext&& Rhs ) Move operator to take ownership of internal buffers from 'Rhs'.
FShaderCondu... operator= ( const FShaderConductorContext& )  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library