FNiagaraShaderType

A shader meta type for niagara-linked shaders.

Windows
MacOS
Linux

Inheritance Hierarchy

FShaderType

FNiagaraShaderType

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

Name Description

Public function

FNiagaraShaderType

(
    FTypeLayoutDesc& InTypeLayout,
    const TCHAR* InName,
    const TCHAR* InSourceFilename,
    const TCHAR* InFunctionName,
    uint32 InFrequency,
    int32 InTotalPermutationCount,
    ConstructSerializedType InConstruct...,
    ConstructCompiledType InConstructCo...,
    ModifyCompilationEnvironmentType In...,
    ShouldCompilePermutationType InShou...,
    ValidateCompiledResultType InValida...,
    uint32 InTypeSize,
    const FShaderParametersMetadata...
)

Functions

Name Description

Public function

void

 

AddReferencedUniformBufferIncludes

(
    FShaderCompilerEnvironment& OutEnv...,
    FString& OutSourceFilePrefix,
    EShaderPlatform Platform
)

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

TSharedRef< ...

 

BeginCompileShader

(
    uint32 ShaderMapId,
    const FNiagaraShaderScript* Sc...,
    FShaderCompilerEnvironment* Co...,
    EShaderPlatform Platform,
    TArray< TSharedRef< class FShaderCo...,
    FShaderTarget Target,
    TArray< FNiagaraDataInterfaceGPUPar...
)

Enqueues a compilation for a new shader of this type.

Public function

void

 

CacheUniformBufferIncludes

(
    TMap< const TCHAR*, FCachedUni...,
    EShaderPlatform Platform
)

Public function

FShader *...

 

FinishCompileShader

(
    const FSHAHash& NiagaraShaderMapHa...,
    const FShaderCompileJob& CurrentJo...,
    const FString& InDebugDescription
)

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

Protected function Const

void

 

SetupCompileEnvironment

(
    EShaderPlatform Platform,
    const FNiagaraShaderScript* Sc...,
    FShaderCompilerEnvironment& Enviro...
)

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

Public function Const

bool

 

ShouldCache

(
    EShaderPlatform Platform,
    const FNiagaraShaderScript* Sc...
)

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

Classes

Constants

Name

Description

ExtraParamInfo
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss