NiagaraShader

Windows
MacOS
Linux

Classes

Name

Description

Public class

FNiagaraCompilationQueue

Runtime code sticks scripts to compile along with their shader map here Niagara Editor ticks in FNiagaraShaderQueueTickable, kicking off compile jobs

Public class

FNiagaraComputeShaderCompilationOutput

Stores outputs from the script compile that need to be saved.

Public struct UStruct

FNiagaraDataInterfaceGPUParamInfo

Data coming from that translator that describes parameters needed for each data interface.

Public struct

FNiagaraDataInterfaceParamRef

Shader side data needed for binding data interface parameters.

Public class

FNiagaraEmitterInstanceShader

Public class

FNiagaraShader

Base class of all shaders that need material parameters.

Public class

FNiagaraShaderCompilationManager

Handles finished shader compile jobs, applying of the shaders to their scripts, and some error handling

Public struct

FNiagaraShaderCompileWorkerInfo

Information tracked for each shader compile worker process instance.

Public class

FNiagaraShaderMap

The set of shaders for a single script.

Public struct

FNiagaraShaderMapCompileResults

Results for a single compiled shader map.

Public struct

FNiagaraShaderMapFinalizeResults

Results for a single compiled and finalized shader map.

Public class

FNiagaraShaderMapId

Contains all the information needed to uniquely identify a FNiagaraShaderMapID.

Public class

FNiagaraShaderScript

FNiagaraShaderScript represents a Niagara script to the shader compilation process

Public class

FNiagaraShaderType

A shader meta type for niagara-linked shaders.

Public class

FOnNiagaraScriptCompilationComplete

Public class

INiagaraShaderModule

Niagara shader module interface

Functions

Name Description

Public function

void

 

DumpComputeShaderStats

(
    EShaderPlatform Platform
)

Dump shader stats for a given platform.

Public function

void

 

UpdateNiagaraShaderCompilingStats

(
    const FNiagaraShaderScript* Sc...
)

Called for every Niagara shader to update the appropriate stats.

Variables

Name Description

Public variable

FNiagaraShaderC...

 

GNiagaraShaderCompilationManager

Public variable

int32

 

GNiagaraSkipVectorVMBackendOptimizations

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback