1. Epic GamesDeveloper
  3. FShader

FShader

A compiled shader and its parameter bindings.

API > API/Runtime > API/Runtime/RenderCore

Inheritance Hierarchy

References

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

Syntax

class FShader

Remarks

A compiled shader and its parameter bindings.

Variables

  Type Name Description
Public variable FShaderParameterBindings Bindings  
Protected variable FSHAHash OutputHash Hash of the compiled output from this shader and the resulting parameter map.
Public variable FShaderParameterMapInfo ParameterMapInfo  
Protected variable FSHAHash SourceHash Hash of this shader's source files generated at compile time, and stored to allow creating an FShaderId.
Protected variable TMemoryImageArray< FShaderUniformBufferParameter > UniformBufferParameters  
Protected variable TMemoryImageArray< FHashedName > UniformBufferParameterStructs  
Protected variable FSHAHash VFSourceHash Vertex factory source hash, stored so that an FShaderId can be constructed from this shader.

Constructors

  Type Name Description
Public function  

FShader ()

 Used to construct a shader for deserialization.
Public function  

FShader ( const CompiledShaderInitializerType& Initializer
)

 Construct a shader from shader compiler output.

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

DumpDebugInfo ( const FShaderMapPointerTable& InPtrTable
)

  
Public function void  
Public function Const const FShaderParametersMetadata *  
Public function Const uint32  
Public function Const EShaderFrequency  
Public function Const const FSHAHash &

GetHash ()

 Returns the hash of the shader file that this shader was compiled with.
Public function Const uint32  
Public function Const uint32  
Public function Const const FSHAHash &  
Public function Static ERayTracingPayloadType

GetRayTracingPayloadType ( const int32 PermutationId
)

 Can be overriden by FShader subclasses to specify which raytracing payload should be used.
Public function Const int32  
Public function Static const FShaderParametersMetadata * Returns the meta data for the root shader parameter struct.
Public function Const EShaderPlatform  
Public function Const uint32 Returns an identifier suitable for deterministic sorting of shaders between sessions.
Public function Const const FShaderTarget  
Public function Const FShaderType *

GetType ( const FPointerTableBase* InPointerTable
)

  
Public function Const FShaderType *

GetType ( const FShaderMapPointerTable& InPointerTable
)

 Accessors.
Public function Const RENDERCORE_API const FTypeLayoutDesc &  
Public function Const FShaderType *  
Public function Const const TShaderUniformBufferParameter< UniformBufferStructType > & Finds an automatically bound uniform buffer matching the given uniform buffer type if one exists, or returns an unbound parameter.
Public function Const const FShaderUniformBufferParameter & Finds an automatically bound uniform buffer matching the given uniform buffer struct if one exists, or returns an unbound parameter.
Public function Const const FShaderUniformBufferParameter &

GetUniformBufferParameter ( const FHashedName SearchName
)

 Finds an automatically bound uniform buffer matching the HashedName if one exists, or returns an unbound parameter.
Public function Const const FSHAHash &  
Public function Const FVertexFactoryType *

GetVertexFactoryType ( const FShaderMapPointerTable& InPointerTable
)

  
Public function Const FVertexFactoryType *

GetVertexFactoryType ( const FPointerTableBase* InPointerTable
)

  
Public function Const bool  
Public function Static void Can be overridden by FShader subclasses to modify their compile environment just before compilation occurs.
Public function void

SaveShaderStableKeys ( const FShaderMapPointerTable& InPtrTable,
EShaderPlatform TargetShaderPlatform,
int32 PermutationId,
const FStableShaderKeyAndValue& SaveKeyVal
)

  
Public function void

SetNumInstructions ( uint32 Value
)

  
Public function Static bool Can be overridden by FShader subclasses to determine whether a specific permutation should be compiled.
Public function Static RENDERCORE_API FTypeLayoutDesc &  
Public function Static bool

ValidateCompiledResult ( EShaderPlatform InPlatform,
const FShaderParameterMap& InParameterMap,
TArray< FString >& OutError
)

 Can be overridden by FShader subclasses to determine whether compilation is valid.

Classes

  Type Name Description
Public struct InternalLinkType    
Public struct InternalLinkType< COUNTER-CounterBase >    

Typedefs

Name Description
CompiledShaderInitializerType  
DerivedType  
FPermutationDomain  
FPermutationParameters  
InternalBaseType  
ShaderMetaType  

Constants

Name Description
CounterBase  
InterfaceType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page