1. Epic GamesDeveloper
  3. FNiagaraShaderType

FNiagaraShaderType

A shader meta type for niagara-linked shaders.

API > API/Plugins > API/Plugins/NiagaraShader

A shader meta type for niagara-linked shaders.

   
Name FNiagaraShaderType
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraShader/Public/NiagaraShaderType.h
Include Path #include "NiagaraShaderType.h"

Syntax

class FNiagaraShaderType : public FShaderType

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

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

   NiagaraShaderType.h  

Structs

Name Remarks
CompiledShaderInitializerType  
FParameters  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddUniformBufferIncludesToEnvironment ( FShaderCompilerEnvironment& OutEnvironment,
EShaderPlatform Platform
) const

 Adds include statements for uniform buffers that this shader type references, and builds a prefix for the shader file with the include statements. NiagaraShaderType.h  

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. NiagaraShaderType.h  

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
) const

 Enqueues a compilation for a new shader of this type. NiagaraShaderType.h  

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

 Either creates a new instance of this type or returns an equivalent existing shader. NiagaraShaderType.h  

bool ShouldCache ( EShaderPlatform Platform,
const FNiagaraShaderScript* Script
) const

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

Protected

Name Remarks Include Path Unreal Specifiers

void SetupCompileEnvironment ( EShaderPlatform Platform,
const FNiagaraShaderScript* Script,
FShaderCompilerEnvironment& Environment
) const

 Sets up the environment used to compile an instance of this shader type. NiagaraShaderType.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page