ShaderParameterUtils.h File Reference

#include "CoreMinimal.h"
#include "RHI.h"
#include "RHIUtilities.h"
#include "ShaderParameters.h"
#include "ShaderCore.h"
#include "Misc/App.h"

Go to the source code of this file.

Macros
#define	GUARD_SETSHADERVALUE(_TYPE)

Typedefs
template<typename ShaderType >
using	TShaderRef = TShaderRefBase< ShaderType, FShaderMapPointerTable >

Functions
template<class ParameterType >
void	SetShaderValue (FRHIBatchedShaderParameters &BatchedParameters, const FShaderParameter &Parameter, const ParameterType &Value, uint32 ElementIndex=0)
template<class ParameterType >
void	SetShaderValueArray (FRHIBatchedShaderParameters &BatchedParameters, const FShaderParameter &Parameter, const ParameterType *Values, uint32 NumElements, uint32 ElementIndex=0)
void	SetTextureParameter (FRHIBatchedShaderParameters &BatchedParameters, const FShaderResourceParameter &Parameter, FRHITexture *TextureRHI)
void	SetSamplerParameter (FRHIBatchedShaderParameters &BatchedParameters, const FShaderResourceParameter &Parameter, FRHISamplerState *SamplerStateRHI)
void	SetTextureParameter (FRHIBatchedShaderParameters &BatchedParameters, const FShaderResourceParameter &TextureParameter, const FShaderResourceParameter &SamplerParameter, FRHISamplerState *SamplerStateRHI, FRHITexture *TextureRHI)
void	SetTextureParameter (FRHIBatchedShaderParameters &BatchedParameters, const FShaderResourceParameter &TextureParameter, const FShaderResourceParameter &SamplerParameter, const FTexture *Texture)
void	SetSRVParameter (FRHIBatchedShaderParameters &BatchedParameters, const FShaderResourceParameter &Parameter, FRHIShaderResourceView *SRV)
void	SetUAVParameter (FRHIBatchedShaderParameters &BatchedParameters, const FShaderResourceParameter &Parameter, FRHIUnorderedAccessView *UAV)
void	UnsetSRVParameter (FRHIBatchedShaderUnbinds &BatchedUnbinds, const FShaderResourceParameter &Parameter)
void	UnsetUAVParameter (FRHIBatchedShaderUnbinds &BatchedUnbinds, const FShaderResourceParameter &Parameter)
void	SetUniformBufferParameter (FRHIBatchedShaderParameters &BatchedParameters, const FShaderUniformBufferParameter &Parameter, FRHIUniformBuffer *UniformBufferRHI)
template<typename TBufferStruct >
void	SetUniformBufferParameter (FRHIBatchedShaderParameters &BatchedParameters, const TShaderUniformBufferParameter< TBufferStruct > &Parameter, const TUniformBufferRef< TBufferStruct > &UniformBufferRef)
template<typename TBufferStruct >
void	SetUniformBufferParameter (FRHIBatchedShaderParameters &BatchedParameters, const TShaderUniformBufferParameter< TBufferStruct > &Parameter, const TUniformBuffer< TBufferStruct > &UniformBuffer)
template<typename TBufferStruct >
void	SetUniformBufferParameterImmediate (FRHIBatchedShaderParameters &BatchedParameters, const TShaderUniformBufferParameter< TBufferStruct > &Parameter, const TBufferStruct &UniformBufferValue)
template<typename TRHICmdList , typename TShaderTypeRHI , class ParameterType >
void	SetSingleShaderValue (TRHICmdList &RHICmdList, TShaderTypeRHI *InShaderRHI, const FShaderParameter &Parameter, const ParameterType &Value)
template<typename TShaderType , typename... TArguments>
void	SetBatchedShaderParametersMixed (FRHIBatchedShaderParameters &BatchedParameters, const TShaderRef< TShaderType > &InShader, const typename TShaderType::FParameters &Parameters, TArguments &&... InArguments)
	Utility to set all legacy and non-legacy parameters for a shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename TShaderTypeRHI , typename... TArguments>
void	SetShaderParametersMixed (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, TShaderTypeRHI *InShaderRHI, const typename TShaderType::FParameters &Parameters, TArguments &&... InArguments)
	Utility to set all legacy and non-legacy parameters for a shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersMixedVS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, const typename TShaderType::FParameters &Parameters, TArguments &&... InArguments)
	Utility to set all legacy and non-legacy parameters for a Vertex shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersMixedMS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, const typename TShaderType::FParameters &Parameters, TArguments &&... InArguments)
	Utility to set all legacy and non-legacy parameters for a Mesh shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersMixedAS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, const typename TShaderType::FParameters &Parameters, TArguments &&... InArguments)
	Utility to set all legacy and non-legacy parameters for an Amplification shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersMixedPS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, const typename TShaderType::FParameters &Parameters, TArguments &&... InArguments)
	Utility to set all legacy and non-legacy parameters for a Pixel shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersMixedGS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, const typename TShaderType::FParameters &Parameters, TArguments &&... InArguments)
	Utility to set all legacy and non-legacy parameters for a Geometry shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersMixedCS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, const typename TShaderType::FParameters &Parameters, TArguments &&... InArguments)
	Utility to set all legacy and non-legacy parameters for a Compute shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename TShaderTypeRHI , typename... TArguments>
void	SetShaderParametersLegacy (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, TShaderTypeRHI *InShaderRHI, TArguments &&... InArguments)
	Utility to set all legacy parameters for a shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersLegacyVS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, TArguments &&... InArguments)
	Utility to set all legacy parameters for a Vertex shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersLegacyMS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, TArguments &&... InArguments)
	Utility to set all legacy parameters for a Mesh shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersLegacyAS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, TArguments &&... InArguments)
	Utility to set all legacy parameters for an Amplification shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersLegacyPS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, TArguments &&... InArguments)
	Utility to set all legacy parameters for a Pixel shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersLegacyGS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, TArguments &&... InArguments)
	Utility to set all legacy parameters for a Geometry shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType , typename... TArguments>
void	SetShaderParametersLegacyCS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader, TArguments &&... InArguments)
	Utility to set all legacy parameters for a Compute shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)
template<typename TRHICmdList , typename TShaderType >
void	UnsetShaderParametersLegacyPS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader)
	Utility to unset all legacy parameters for a Pixel shader. Requires the shader type to implement UnsetParameters(FRHIBatchedShaderUnbinds& BatchedUnbinds)
template<typename TRHICmdList , typename TShaderType >
void	UnsetShaderParametersLegacyCS (TRHICmdList &RHICmdList, const TShaderRef< TShaderType > &InShader)
	Utility to unset all legacy parameters for a Compute shader. Requires the shader type to implement UnsetParameters(FRHIBatchedShaderUnbinds& BatchedUnbinds)
template<typename TRHIShader , typename TRHICmdList >
void	SetTextureParameter (TRHICmdList &RHICmdList, TRHIShader *Shader, const FShaderResourceParameter &TextureParameter, const FShaderResourceParameter &SamplerParameter, FRHISamplerState *SamplerStateRHI, FRHITexture *TextureRHI)

Macro Definition Documentation

GUARD_SETSHADERVALUE

#define GUARD_SETSHADERVALUE

(

_TYPE

)

Value:

template<typename ShaderRHIParamRef, typename TRHICmdList>                                                                                                                              \
void SetShaderValue(  TRHICmdList& RHICmdList,  const ShaderRHIParamRef& Shader, const FShaderParameter& Parameter,                                                                     \
    const _TYPE##d& Value, uint32 ElementIndex = 0) { static_assert(sizeof(ShaderRHIParamRef) == 0, "Passing unsupported "#_TYPE"d. Requires "#_TYPE"f"); }                             \
template<typename ShaderRHIParamRef>                                                                                                                                                    \
void SetShaderValueOnContext(IRHICommandContext& RHICmdListContext, const ShaderRHIParamRef& Shader, const FShaderParameter& Parameter,                                                 \
    const _TYPE##d& Value, uint32 ElementIndex = 0) { static_assert(sizeof(ShaderRHIParamRef) == 0, "Passing unsupported "#_TYPE"d. Requires "#_TYPE"f"); }                             \
template<typename ShaderRHIParamRef, typename TRHICmdList>                                                                                                                              \
void SetShaderValueArray(TRHICmdList& RHICmdList, const ShaderRHIParamRef& Shader, const FShaderParameter& Parameter,                                                                   \
    const _TYPE##d* Values, uint32 NumElements, uint32 BaseElementIndex = 0) { static_assert(sizeof(ShaderRHIParamRef) == 0, "Passing unsupported "#_TYPE"d*. Requires "#_TYPE"f*"); }  \

Typedef Documentation

TShaderRef

template<typename ShaderType >

using TShaderRef = TShaderRefBase<ShaderType, FShaderMapPointerTable>

Function Documentation

SetBatchedShaderParametersMixed()

template<typename TShaderType , typename... TArguments>

void SetBatchedShaderParametersMixed ( FRHIBatchedShaderParameters &  BatchedParameters, const TShaderRef< TShaderType > &  InShader, const typename TShaderType::FParameters &  Parameters, TArguments &&...  InArguments  )

inline

Utility to set all legacy and non-legacy parameters for a shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetSamplerParameter()

void SetSamplerParameter ( FRHIBatchedShaderParameters &  BatchedParameters, const FShaderResourceParameter &  Parameter, FRHISamplerState *  SamplerStateRHI  )

inline

SetShaderParametersLegacy()

template<typename TRHICmdList , typename TShaderType , typename TShaderTypeRHI , typename... TArguments>

void SetShaderParametersLegacy ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, TShaderTypeRHI *  InShaderRHI, TArguments &&...  InArguments  )

inline

Utility to set all legacy parameters for a shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersLegacyAS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersLegacyAS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, TArguments &&...  InArguments  )

inline

Utility to set all legacy parameters for an Amplification shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersLegacyCS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersLegacyCS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, TArguments &&...  InArguments  )

inline

Utility to set all legacy parameters for a Compute shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersLegacyGS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersLegacyGS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, TArguments &&...  InArguments  )

inline

Utility to set all legacy parameters for a Geometry shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersLegacyMS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersLegacyMS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, TArguments &&...  InArguments  )

inline

Utility to set all legacy parameters for a Mesh shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersLegacyPS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersLegacyPS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, TArguments &&...  InArguments  )

inline

Utility to set all legacy parameters for a Pixel shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersLegacyVS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersLegacyVS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, TArguments &&...  InArguments  )

inline

Utility to set all legacy parameters for a Vertex shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersMixed()

template<typename TRHICmdList , typename TShaderType , typename TShaderTypeRHI , typename... TArguments>

void SetShaderParametersMixed ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, TShaderTypeRHI *  InShaderRHI, const typename TShaderType::FParameters &  Parameters, TArguments &&...  InArguments  )

inline

Utility to set all legacy and non-legacy parameters for a shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersMixedAS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersMixedAS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, const typename TShaderType::FParameters &  Parameters, TArguments &&...  InArguments  )

inline

Utility to set all legacy and non-legacy parameters for an Amplification shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersMixedCS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersMixedCS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, const typename TShaderType::FParameters &  Parameters, TArguments &&...  InArguments  )

inline

Utility to set all legacy and non-legacy parameters for a Compute shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersMixedGS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersMixedGS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, const typename TShaderType::FParameters &  Parameters, TArguments &&...  InArguments  )

inline

Utility to set all legacy and non-legacy parameters for a Geometry shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersMixedMS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersMixedMS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, const typename TShaderType::FParameters &  Parameters, TArguments &&...  InArguments  )

inline

Utility to set all legacy and non-legacy parameters for a Mesh shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersMixedPS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersMixedPS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, const typename TShaderType::FParameters &  Parameters, TArguments &&...  InArguments  )

inline

Utility to set all legacy and non-legacy parameters for a Pixel shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderParametersMixedVS()

template<typename TRHICmdList , typename TShaderType , typename... TArguments>

void SetShaderParametersMixedVS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader, const typename TShaderType::FParameters &  Parameters, TArguments &&...  InArguments  )

inline

Utility to set all legacy and non-legacy parameters for a Vertex shader. Requires the shader type to implement SetParameters(FRHIBatchedShaderParameters& BatchedParameters, ...)

SetShaderValue()

template<class ParameterType >

void SetShaderValue	(	FRHIBatchedShaderParameters &	BatchedParameters,
		const FShaderParameter &	Parameter,
		const ParameterType &	Value,
		uint32	ElementIndex = 0
	)

SetShaderValueArray()

template<class ParameterType >

void SetShaderValueArray	(	FRHIBatchedShaderParameters &	BatchedParameters,
		const FShaderParameter &	Parameter,
		const ParameterType *	Values,
		uint32	NumElements,
		uint32	ElementIndex = 0
	)

SetSingleShaderValue()

template<typename TRHICmdList , typename TShaderTypeRHI , class ParameterType >

void SetSingleShaderValue	(	TRHICmdList &	RHICmdList,
		TShaderTypeRHI *	InShaderRHI,
		const FShaderParameter &	Parameter,
		const ParameterType &	Value
	)

SetSRVParameter()

void SetSRVParameter ( FRHIBatchedShaderParameters &  BatchedParameters, const FShaderResourceParameter &  Parameter, FRHIShaderResourceView *  SRV  )

inline

SetTextureParameter() [1/4]

void SetTextureParameter ( FRHIBatchedShaderParameters &  BatchedParameters, const FShaderResourceParameter &  Parameter, FRHITexture *  TextureRHI  )

inline

SetTextureParameter() [2/4]

void SetTextureParameter ( FRHIBatchedShaderParameters &  BatchedParameters, const FShaderResourceParameter &  TextureParameter, const FShaderResourceParameter &  SamplerParameter, const FTexture *  Texture  )

inline

SetTextureParameter() [3/4]

void SetTextureParameter ( FRHIBatchedShaderParameters &  BatchedParameters, const FShaderResourceParameter &  TextureParameter, const FShaderResourceParameter &  SamplerParameter, FRHISamplerState *  SamplerStateRHI, FRHITexture *  TextureRHI  )

inline

SetTextureParameter() [4/4]

template<typename TRHIShader , typename TRHICmdList >

void SetTextureParameter ( TRHICmdList &  RHICmdList, TRHIShader *  Shader, const FShaderResourceParameter &  TextureParameter, const FShaderResourceParameter &  SamplerParameter, FRHISamplerState *  SamplerStateRHI, FRHITexture *  TextureRHI  )

inline

Sets the value of a shader texture parameter. Template'd on shader type.

SetUAVParameter()

void SetUAVParameter ( FRHIBatchedShaderParameters &  BatchedParameters, const FShaderResourceParameter &  Parameter, FRHIUnorderedAccessView *  UAV  )

inline

SetUniformBufferParameter() [1/3]

void SetUniformBufferParameter ( FRHIBatchedShaderParameters &  BatchedParameters, const FShaderUniformBufferParameter &  Parameter, FRHIUniformBuffer *  UniformBufferRHI  )

inline

SetUniformBufferParameter() [2/3]

template<typename TBufferStruct >

void SetUniformBufferParameter ( FRHIBatchedShaderParameters &  BatchedParameters, const TShaderUniformBufferParameter< TBufferStruct > &  Parameter, const TUniformBuffer< TBufferStruct > &  UniformBuffer  )

inline

SetUniformBufferParameter() [3/3]

template<typename TBufferStruct >

void SetUniformBufferParameter ( FRHIBatchedShaderParameters &  BatchedParameters, const TShaderUniformBufferParameter< TBufferStruct > &  Parameter, const TUniformBufferRef< TBufferStruct > &  UniformBufferRef  )

inline

SetUniformBufferParameterImmediate()

template<typename TBufferStruct >

void SetUniformBufferParameterImmediate ( FRHIBatchedShaderParameters &  BatchedParameters, const TShaderUniformBufferParameter< TBufferStruct > &  Parameter, const TBufferStruct &  UniformBufferValue  )

inline

UnsetShaderParametersLegacyCS()

template<typename TRHICmdList , typename TShaderType >

void UnsetShaderParametersLegacyCS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader  )

inline

Utility to unset all legacy parameters for a Compute shader. Requires the shader type to implement UnsetParameters(FRHIBatchedShaderUnbinds& BatchedUnbinds)

UnsetShaderParametersLegacyPS()

template<typename TRHICmdList , typename TShaderType >

void UnsetShaderParametersLegacyPS ( TRHICmdList &  RHICmdList, const TShaderRef< TShaderType > &  InShader  )

inline

Utility to unset all legacy parameters for a Pixel shader. Requires the shader type to implement UnsetParameters(FRHIBatchedShaderUnbinds& BatchedUnbinds)

UnsetSRVParameter()

void UnsetSRVParameter ( FRHIBatchedShaderUnbinds &  BatchedUnbinds, const FShaderResourceParameter &  Parameter  )

inline

UnsetUAVParameter()

void UnsetUAVParameter ( FRHIBatchedShaderUnbinds &  BatchedUnbinds, const FShaderResourceParameter &  Parameter  )

inline