1. Epic GamesDeveloper
  3. FShaderParameterParser

FShaderParameterParser

Validates and moves all the shader loose data parameter defined in the root scope of the shader into the root uniform buffer.

API > API/Runtime > API/Runtime/RenderCore

References

   
Module RenderCore
Header /Engine/Source/Runtime/RenderCore/Public/ShaderParameterParser.h
Include #include "ShaderParameterParser.h"

Syntax

class FShaderParameterParser

Remarks

Validates and moves all the shader loose data parameter defined in the root scope of the shader into the root uniform buffer.

Variables

  Type Name Description
Protected variable bool bBindlessResources  
Protected variable bool bBindlessSamplers  
Protected variable bool bMovedLoosedParametersToRootConstantBuffer Indicates that parameters were actually moved to the root constant buffer.
Protected variable bool bNeedToMoveToRootConstantBuffer Indicates that parameters should be moved to the root cosntant buffer.
Protected variable const TCHAR * ConstantBufferType  
Protected variable TConstArrayView< const TCHAR * > ExtraSRVTypes  
Protected variable TConstArrayView< const TCHAR * > ExtraUAVTypes  
Protected variable FString OriginalParsedShader  
Protected variable TMap< FString, FParsedShaderParameter > ParsedParameters  

Constructors

  Type Name Description
Public function    
Public function  

FShaderParameterParser ( const TCHAR* InConstantBufferType
)

 Use FShaderParameterParser constructor which accepts FShaderCompilerFlags
Public function  

FShaderParameterParser ( const TCHAR* InConstantBufferType,
TConstArrayView< const TCHAR* > InExtraSRVTypes,
TConstArrayView< const TCHAR* > InExtraUAVTypes
)

 Use FShaderParameterParser constructor which accepts FShaderCompilerFlags
Public function  

FShaderParameterParser ( FShaderCompilerFlags CompilerFlags,
const TCHAR* InConstantBufferType,
TConstArrayView< const TCHAR* > InExtraSRVTypes,
TConstArrayView< const TCHAR* > InExtraUAVTypes
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function void

ApplyBindlessModifications ( FString& PreprocessedShaderSource
)

 Converts parsed parameters into their bindless forms.
Protected function Const void

ExtractFileAndLine ( int32 PragamLineoffset,
int32 LineOffset,
FString& OutFile,
FString& OutLine
)

  
Public function Const const FParsedShaderParameter &

FindParameterInfos ( const FString& ParameterName
)

 Gets parsing information from a parameter binding name.
Protected function Virtual Const FString Generates shader source code to declare a bindless resource or sampler (for automatic bindless conversion).
Public function Const void

GetParameterFileAndLine ( const FParsedShaderParameter& ParsedParameter,
FString& OutFile,
FString& OutLine
)

 Gets file and line of the parameter in the shader source code.
Protected function bool

MoveShaderParametersToRootConstantBuffer ( const FShaderParametersMetadata* RootParametersStructure,
FString& PreprocessedShaderSource
)

 Moves parsed parameters into the root constant buffer.
Public function bool

ParseAndModify ( const FShaderCompilerInput& CompilerInput,
TArray< FShaderCompilerError >& OutErrors,
FString& PreprocessedShaderSource
)

  
Public function Static EShaderParameterType  
Public function Static EShaderParameterType

ParseAndRemoveBindlessParameterPrefix ( FStringView& InName
)

  
Protected function bool

ParseParameters ( const FShaderParametersMetadata* RootParametersStructure,
TArray< FShaderCompilerError >& OutErrors
)

 Parses the preprocessed shader code
Public function Static EShaderParameterType

ParseParameterType ( FStringView InType,
TConstArrayView< const TCHAR* > InExtraSRVTypes,
TConstArrayView< const TCHAR* > InExtraUAVTypes
)

  
Public function Static bool  
Protected function void

RemoveMovingParametersFromSource ( FString& PreprocessedShaderSource
)

  
Public function Const void

ValidateShaderParameterType ( const FShaderCompilerInput& CompilerInput,
const FString& ShaderBindingName,
int32 ReflectionOffset,
int32 ReflectionSize,
FShaderCompilerOutput& CompilerOutput
)

  
Public function Const void

ValidateShaderParameterType ( const FShaderCompilerInput& CompilerInput,
const FString& ShaderBindingName,
int32 ReflectionOffset,
int32 ReflectionSize,
bool bPlatformSupportsPrecisionModifier,
FShaderCompilerOutput& CompilerOutput
)

 Validates the shader parameter in code is compatible with the shader parameter structure.
Public function Const void

ValidateShaderParameterTypes ( const FShaderCompilerInput& CompilerInput,
FShaderCompilerOutput& CompilerOutput
)

  
Public function Const void

ValidateShaderParameterTypes ( const FShaderCompilerInput& CompilerInput,
bool bPlatformSupportsPrecisionModifier,
FShaderCompilerOutput& CompilerOutput
)

 Validates shader parameter map is compatible with the shader parameter structure.

Operators

  Type Name Description
Public function FShaderParameterParser &  

Classes

  Type Name Description
Public struct FParsedShaderParameter    

Constants

Name Description
kBindlessResourcePrefix  
kBindlessSamplerPrefix  

Deprecated Functions

  Type Name Description
Public function  

FShaderParameterParser ( const TCHAR* InConstantBufferType,
TConstArrayView< const TCHAR* > InExtraSRVTypes,
TConstArrayView< const TCHAR* > InExtraUAVTypes
)

 Use FShaderParameterParser constructor which accepts FShaderCompilerFlags
Public function  

FShaderParameterParser ( const TCHAR* InConstantBufferType
)

 Use FShaderParameterParser constructor which accepts FShaderCompilerFlags
Public function bool

ParseAndModify ( const FShaderCompilerInput& CompilerInput,
FShaderCompilerOutput& CompilerOutput,
FString& PreprocessedShaderSource
)

 Use ParseAndModify overload accepting array of FShaderCompilerError instead of passing FShaderCompilerOutput
Public function bool

ParseAndModify ( const FShaderCompilerInput& CompilerInput,
FShaderCompilerOutput& CompilerOutput,
FString& PreprocessedShaderSource,
const TCHAR* InConstantBufferType
)

 ParseAndModify doesn't need ConstantBufferType anymore

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page