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

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

   
Name FShaderParameterParser
Type class
Header File /Engine/Source/Runtime/RenderCore/Public/ShaderParameterParser.h
Include Path #include "ShaderParameterParser.h"

Syntax

class FShaderParameterParser

Constructors

Name Remarks Include Path Unreal Specifiers

FShaderParameterParser ( const FPlatformConfiguration& InPlatformConfiguration
)

   ShaderParameterParser.h  
  ShaderParameterParser.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FShaderParameterParser()

   ShaderParameterParser.h  

Structs

Name Remarks
FParsedShaderParameter  
FPlatformConfiguration  

Constants

Name Type Remarks Include Path
kBindlessSamplerArrayPrefix const TCHAR *   ShaderParameterParser.h
kBindlessSamplerPrefix const TCHAR *   ShaderParameterParser.h
kBindlessSRVArrayPrefix const TCHAR * Prefix used to declare arrays of samplers/resources for bindless. ShaderParameterParser.h
kBindlessSRVPrefix const TCHAR *   ShaderParameterParser.h
kBindlessUAVArrayPrefix const TCHAR *   ShaderParameterParser.h
kBindlessUAVPrefix const TCHAR *   ShaderParameterParser.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool DidModifyShader()

   ShaderParameterParser.h  

const FParsedShaderParameter & FindParameterInfos ( const FString& ParameterName
) const

 Gets parsing information from a parameter binding name. ShaderParameterParser.h  

const FParsedShaderParameter * FindParameterInfosUnsafe ( const FString& ParameterName
) const

   ShaderParameterParser.h  

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

 Gets file and line of the parameter in the shader source code. ShaderParameterParser.h  

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

   ShaderParameterParser.h  

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

   ShaderParameterParser.h  

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

 Validates the shader parameter in code is compatible with the shader parameter structure. ShaderParameterParser.h  

void ValidateShaderParameterTypes ( const FShaderCompilerInput& CompilerInput,
FShaderCompilerOutput& CompilerOutput
) const

   ShaderParameterParser.h  

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

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

Protected

Name Remarks Include Path Unreal Specifiers

void ApplyBindlessModifications ( FString& PreprocessedShaderSource
)

 Converts parsed parameters into their bindless forms. ShaderParameterParser.h  

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

   ShaderParameterParser.h  

virtual FString GenerateBindlessParameterDeclaration ( const FParsedShaderParameter& ParsedParameter
) const

 Generates shader source code to declare a bindless resource or sampler (for automatic bindless conversion). ShaderParameterParser.h  

bool MoveShaderParametersToRootConstantBuffer ( const FShaderParametersMetadata* RootParametersStructure,
EShaderFrequency ShaderFrequency,
FString& PreprocessedShaderSource
)

 Moves parsed parameters into the root constant buffer. ShaderParameterParser.h  

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

 Parses the preprocessed shader code ShaderParameterParser.h  

EShaderParameterType ParseParameterType ( FStringView InType
)

   ShaderParameterParser.h  

void RemoveMovingParametersFromSource ( FString& PreprocessedShaderSource
)

   ShaderParameterParser.h  

Static

Name Remarks Include Path Unreal Specifiers

static FStringView GetBindlessParameterPrefix ( EShaderParameterType InShaderParameterType
)

   ShaderParameterParser.h  
  ShaderParameterParser.h  
  ShaderParameterParser.h  

static bool RemoveBindlessParameterPrefix ( FString& InName
)

   ShaderParameterParser.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page