FNiagaraShaderType

A shader meta type for niagara-linked shaders.

API > API/Plugins > API/Plugins/NiagaraShader

Inheritance Hierarchy

References

   
Module NiagaraShader
Header /Engine/Plugins/FX/Niagara/Source/NiagaraShader/Public/NiagaraShaderType.h
Include #include "NiagaraShaderType.h"

Syntax

class FNiagaraShaderType : public FShaderType

Remarks

A shader meta type for niagara-linked shaders.

Constructors

  Type Name Description
Public function  

FNiagaraShaderType ( FTypeLayoutDesc& InTypeLayout,
const TCHAR* InName,
const TCHAR* InSourceFilename,
const TCHAR* InFunctionName,
uint32 InFrequency,
int32 InTotalPermutationCount,
ConstructSerializedType InConstructSerializedRef,
ConstructCompiledType InConstructCompiledRef,
ShouldCompilePermutationType InShouldCompilePermutationRef,
GetRayTracingPayloadTypeType InGetRayTracingPayloadTypeRef,
ModifyCompilationEnvironmentType InModifyCompilationEnvironmentRef,
ValidateCompiledResultType InValidateCompiledResultRef,
uint32 InTypeSize,
const FShaderParametersMetadata* InRootParametersMetadata
)

  

Functions

  Type Name Description
Public function Const void Adds include statements for uniform buffers that this shader type references, and builds a prefix for the shader file with the include statements.
Public function void

BeginCompileShader ( uint32 ShaderMapId,
int32 PermutationId,
const FNiagaraShaderScript* Script,
FSharedShaderCompilerEnvironment* CompilationEnvironment,
EShaderPlatform Platform,
TArray< TRefCountPtr< FShaderCommonCompileJob > >& NewJobs,
FShaderTarget Target
)

 Enqueues a compilation for a new shader of this type.
Public function Const void

BeginCompileShaderFromSource ( FStringView FriendlyName,
uint32 ShaderMapId,
int32 PermutationId,
TSharedRef< FNiagaraShaderScriptParametersMetadata > ShaderParameters,
FSharedShaderCompilerEnvironment* CompilationEnvironment,
FStringView ScriptSource,
EShaderPlatform Platform,
const FSimulationStageMetaData& SimStageMetaData,
FShaderTarget Target,
TArray< TRefCountPtr< FShaderCommonCompileJob > >& NewJobs
)

 Enqueues a compilation for a new shader of this type.
Public function Const FShader *

FinishCompileShader ( const FSHAHash& NiagaraShaderMapHash,
const FShaderCompileJob& CurrentJob
)

 Either creates a new instance of this type or returns an equivalent existing shader.
Protected function Const void Sets up the environment used to compile an instance of this shader type.
Public function Const bool

ShouldCache ( EShaderPlatform Platform,
const FNiagaraShaderScript* Script
)

 Checks if the shader type should be cached for a particular platform and script.

Classes

  Type Name Description
Public struct CompiledShaderInitializerType    
Public struct FParameters    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page