NiagaraShader

Windows
MacOS
Linux

Classes

Name

Description

Public class

FBatchedElementNiagara2DArrayAttribute

Batched element parameters for gathering attributes from different slices into a single color

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 struct UStruct

FNiagaraCompileEvent

Records necessary information to give UI cues for errors/logs/warnings during compile.

Public class

FNiagaraComputeShaderCompilationOutput

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

Public struct UStruct

FNiagaraDataInterfaceGeneratedFunction

Information about a data interface function generated by the translator.

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 gpu compute shader compile jobs, applying of the shaders to their scripts, and some error handling

Public class

FNiagaraShaderMap

The set of shaders for a single script.

Public struct

FNiagaraShaderMapCompileResults

Results for a single compiled shader map.

Public class

FNiagaraShaderMapContent

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

FNiagaraShaderMapPointerTable

Public struct

FNiagaraShaderPermutationParameters

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 struct UStruct

FSimulationStageMetaData

Public class

INiagaraShaderModule

Niagara shader module interface

Public class UClass Abstract, MinimalAPI

UNiagaraScriptBase

Typedefs

Enums

Name

Description

Public enum UEnum

FNiagaraCompileEventSeverity

Defines the compile event types for translation/compilation.

Functions

Name Description

Public function

void

 

DumpComputeShaderStats

(
    EShaderPlatform Platform
)

Dump shader stats for a given platform.

Public function

void

 

NiagaraComputeGPUFreeIDs

(
    FRHICommandList& RHICmdList,
    ERHIFeatureLevel::Type FeatureLevel,
    uint32 NumIDs,
    FRHIShaderResourceView* IDToIn...,
    FRWBuffer& FreeIDList,
    FRWBuffer& FreeIDListSizes,
    uint32 FreeIDListIndex
)

Public function

void

 

NiagaraDebugShaders::ClearUAV

(
    FRHICommandList& RHICmdList,
    FRHIUnorderedAccessView* UAV,
    FUintVector4 ClearValues,
    uint32 UIntsToSet
)

Public function

void

 

NiagaraDebugShaders::DrawDebugLines

(
    FRDGBuilder& GraphBuilder,
    const FViewInfo& View,
    FRDGTextureRef SceneColor,
    FRDGTextureRef SceneDepth,
    const uint32 LineInstanceCount,
    const FShaderResourceViewRHIRef& L...
)

Public function

void

 

NiagaraDebugShaders::DrawDebugLines

(
    FRDGBuilder& GraphBuilder,
    const FViewInfo& View,
    FRDGTextureRef SceneColor,
    FRDGTextureRef SceneDepth,
    const FVertexBufferRHIRef& ArgsBuf...,
    const FShaderResourceViewRHIRef& L...
)

Public function

void

 

NiagaraDebugShaders::VisualizeTexture

(
    FRDGBuilder& GraphBuilder,
    const FViewInfo& View,
    const FScreenPassRenderTarget& Out...,
    const FIntPoint& Location,
    const int32& DisplayHeight,
    const FIntVector4& AttributesToVis...,
    FRHITexture* Texture,
    const FIntVector4& NumTextureAttri...,
    uint32 TickCounter,
    const FVector2D& PreviewDisplayRan...
)

Public function

void

 

NiagaraFillGPUIntBuffer

(
    FRHICommandList& RHICmdList,
    ERHIFeatureLevel::Type FeatureLevel,
    FRWBuffer& Buffer,
    int Value
)

Public function

void

 

NiagaraInitGPUFreeIDList

(
    FRHICommandList& RHICmdList,
    ERHIFeatureLevel::Type FeatureLevel,
    uint32 NumElementsToAlloc,
    FRWBuffer& NewBuffer,
    uint32 NumExistingElements,
    FRHIShaderResourceView* Existi...
)

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
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss