ezShaderCompilerHLSL Class Reference

Inheritance diagram for ezShaderCompilerHLSL:

Public Member Functions
virtual void	GetSupportedPlatforms (ezHybridArray< ezString, 4 > &out_platforms) override
	Returns the platforms that this shader compiler supports. More...
virtual ezResult	ModifyShaderSource (ezShaderProgramData &inout_data, ezLogInterface *pLog) override
virtual ezResult	Compile (ezShaderProgramData &inout_data, ezLogInterface *pLog) override
Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Additional Inherited Members
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Member Function Documentation

Compile()

ezResult ezShaderCompilerHLSL::Compile ( ezShaderProgramData &  inout_data, ezLogInterface *  pLog  )

overridevirtual

Compiles the shader comprised of multiple stages defined in inout_data.

Parameters

inout_data	The state of the shader compiler. m_Resources and m_ByteCode should be written to on successful return code.
pLog	Logging interface to be used when outputting any errors.

Returns

Returns whether the shader was compiled successfully. On failure, errors should be written to pLog.

Implements ezShaderProgramCompiler.

GetSupportedPlatforms()

virtual void ezShaderCompilerHLSL::GetSupportedPlatforms ( ezHybridArray< ezString, 4 > &  out_platforms )

inlineoverridevirtual

Returns the platforms that this shader compiler supports.

Parameters

out_platforms

Filled with the platforms this compiler supports.

Implements ezShaderProgramCompiler.

ModifyShaderSource()

ezResult ezShaderCompilerHLSL::ModifyShaderSource ( ezShaderProgramData &  inout_data, ezLogInterface *  pLog  )

overridevirtual

Allows the shader compiler to modify the shader source before hashing and compiling. This allows it to implement custom features by injecting code before the compile process. Mostly used to define resource bindings that do not cause conflicts across shader stages.

Parameters

inout_data	The state of the shader compiler. Only m_sShaderSource should be modified by the implementation.
pLog	Logging interface to be used when outputting any errors.

Returns

Returns whether the shader could be modified. On failure, the shader won't be compiled.

Implements ezShaderProgramCompiler.

---

The documentation for this class was generated from the following files:

• /home/runner/work/ezEngine/ezEngine/Code/Engine/ShaderCompilerHLSL/ShaderCompilerHLSL.h
• /home/runner/work/ezEngine/ezEngine/Code/Engine/ShaderCompilerHLSL/ShaderCompilerHLSL.cpp