1. Epic GamesDeveloper
  3. NiagaraShader

NiagaraShader

API > API/Plugins

   
Name NiagaraShader
Type Plugin
Part of Plugins Niagara
Location /Engine/Plugins/FX/Niagara/Source/NiagaraShader/
Module Build Rules NiagaraShader.Build.cs

Classes

Name Remarks
FBatchedElementNiagara2DArrayAttribute Batched element parameters for gathering attributes from different slices into a single color
FBatchedElementNiagaraInvertColorChannel Batched element parameters for inverting a color channel
FBatchedElementNiagaraSimple Simple batched element using a 2d texture
FBatchedElementNiagaraVolumeAttribute Batched element parameters for gathering attributes from a volume texture into a single color
FNiagaraAsyncGpuTraceProvider  
FNiagaraBlendSVTsToDenseBufferCS  
FNiagaraCompilationQueue Runtime code sticks scripts to compile along with their shader map here Niagara Editor ticks in FNiagaraShaderQueueTickable, kicking off compile jobs
FNiagaraCopySVTToDenseBufferCS  
FNiagaraGPUSceneUtils  
FNiagaraRibbonAggregationApplyCS  
FNiagaraRibbonAggregationApplyParameters  
FNiagaraRibbonAggregationStepCS  
FNiagaraRibbonAggregationStepParameters  
FNiagaraRibbonCreateIndexBufferCS  
FNiagaraRibbonCreateIndexBufferParamsCS  
FNiagaraRibbonGenerateIndices  
FNiagaraRibbonInitializeIndices  
FNiagaraRibbonSortPhase1CS Compute shader used to generate particle sort keys.
FNiagaraRibbonSortPhase2CS Compute shader used to generate particle sort keys.
FNiagaraRibbonUVParamCalculationCS  
FNiagaraRibbonUVSettingsParams  
FNiagaraRibbonVertexFinalizationParameters  
FNiagaraRibbonVertexReductionFinalizationParameters  
FNiagaraRibbonVertexReductionFinalizeCS  
FNiagaraRibbonVertexReductionInitializationCS  
FNiagaraRibbonVertexReductionParameters  
FNiagaraShader Base class of all shaders that need material parameters.
FNiagaraShaderCompilationManager Handles gpu compute shader compile jobs, applying of the shaders to their scripts, and some error handling
FNiagaraShaderMap The set of shaders for a single script.
FNiagaraShaderMapContent  
FNiagaraShaderMapId Contains all the information needed to uniquely identify a FNiagaraShaderMapID.
FNiagaraShaderMapPointerTable  
FNiagaraShaderParametersBuilder  
FNiagaraShaderScript FNiagaraShaderScript represents a Niagara script to the shader compilation process
FNiagaraShaderType A shader meta type for niagara-linked shaders.
FOnNiagaraScriptCompilationComplete  
FRibbonComputeUniformParameters  
FRibbonHasFullRibbonID  
FRibbonHasHighSliceComplexity  
FRibbonHasRibbonID  
FRibbonHasTwist  
FRibbonLinkIsFloat  
FRibbonOrderSortParameters  
FRibbonWantsAutomaticTessellation  
FRibbonWantsConstantTessellation  
UNiagaraScriptBase  

Structs

Name Remarks
FNiagaraAsyncGpuTrace Mirrors structure in Engine\Plugins\FX\Niagara\Shaders\Private\NiagaraAsyncGpuTraceCommon.ush
FNiagaraAsyncGpuTraceResult Mirrors structure in Engine\Plugins\FX\Niagara\Shaders\Private\NiagaraAsyncGpuTraceCommon.ush
FNiagaraCompileEvent Records necessary information to give UI cues for errors/logs/warnings during compile.
FNiagaraDataInterfaceGeneratedFunction Information about a data interface function generated by the translator.
FNiagaraDataInterfaceGPUParamInfo Data coming from that translator that describes parameters needed for each data interface.
FNiagaraDataInterfaceParamRef Shader side data needed for binding data interface parameters.
FNiagaraDataInterfaceStructIncludeInfo Shader side information about global structures includes.
FNiagaraRibbonComputeCommon  
FNiagaraShaderMapCompileResults Results for a single compiled shader map.
FNiagaraShaderMapFinalizeResults Results for a single compiled and finalized shader map.
FNiagaraShaderPermutationParameters  
FNiagaraShaderScriptExternalConstant  
FNiagaraShaderScriptParametersMetadata Data provided from the translator to track information requires to bind data interface or parameters at runtime.
FSimulationStageMetaData  

Interfaces

Name Remarks
INiagaraShaderModule Niagara shader module interface

Typedefs

Name Type Remarks Include Path
FNiagaraShaderRef TNiagaraShaderRef< FNiagaraShader >   NiagaraShared.h
TNiagaraShaderRef TShaderRefBase< ShaderType, FNiagaraShaderMapPointerTable >   NiagaraShared.h

Enums

Public

Name Remarks
ENiagaraDirectDispatchElementType  
ENiagaraGpuDispatchType  
ENiagaraMipMapGenerationType  
ENiagaraSimStageExecuteBehavior  
FNiagaraCompileEventSeverity Defines the compile event types for translation/compilation.
FNiagaraCompileEventSource  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
GbNiagaraEnableTraversalCache int32   NiagaraShared.h  
GNiagaraShaderCompilationManager FNiagaraShaderCompilationManager   NiagaraShaderCompilationManager.h  
GNiagaraSkipVectorVMBackendOptimizations int32   NiagaraShader.h  
GNiagaraTranslatorFailIfNotSetSeverity int32 CVars NiagaraShared.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DumpComputeShaderStats ( EShaderPlatform Platform
)

 Dump shader stats for a given platform. NiagaraShaderType.h  

FNiagaraCompileEventSeverity FNiagaraCVarUtilities::GetCompileEventSeverityForFailIfNotSet()

   NiagaraShared.h  

bool FNiagaraCVarUtilities::GetShouldEmitMessagesForFailIfNotSet()

   NiagaraShared.h  

void FNiagaraDistanceFieldHelper::SetGlobalDistanceFieldParameters ( const FGlobalDistanceFieldParameterData* OptionalParameterData,
FGlobalDistanceFieldParameters2& ShaderParameters
)

   NiagaraDistanceFieldHelper.h  

RENDERER_API const FShaderParametersMetadata * GetForwardDeclaredShaderParametersStructMetadata ( const FSceneUniformParameters* DummyPtr
)

   NiagaraGPUSceneUtils.h  

void NiagaraClearCounts::ClearCountsInt ( FRDGBuilder& GraphBuilder,
FRDGBufferUAVRef UAV,
TConstArrayView< TPair< uint32, int32 > > IndexAndValueArray
)

   NiagaraClearCounts.h  

void NiagaraClearCounts::ClearCountsInt ( FRHICommandList& RHICmdList,
FRHIUnorderedAccessView* UAV,
TConstArrayView< TPair< uint32, int32 > > IndexAndValueArray
)

   NiagaraClearCounts.h  

void NiagaraClearCounts::ClearCountsUInt ( FRDGBuilder& GraphBuilder,
FRDGBufferUAVRef UAV,
TConstArrayView< TPair< uint32, uint32 > > IndexAndValueArray
)

   NiagaraClearCounts.h  

void NiagaraClearCounts::ClearCountsUInt ( FRHICommandList& RHICmdList,
FRHIUnorderedAccessView* UAV,
TConstArrayView< TPair< uint32, uint32 > > IndexAndValueArray
)

   NiagaraClearCounts.h  

void NiagaraComputeGPUFreeIDs ( FRHICommandList& RHICmdList,
ERHIFeatureLevel::Type FeatureLevel,
FRHIShaderResourceView* IDToIndexTableSRV,
uint32 NumIDs,
FRHIUnorderedAccessView* FreeIDUAV,
FRHIUnorderedAccessView* FreeIDListSizesUAV,
uint32 FreeIDListIndex
)

   NiagaraShaderParticleID.h  

void NiagaraDebugShaders::ClearUAV ( FRDGBuilder& GraphBuilder,
FRDGBufferUAVRef UAV,
FUintVector4 ClearValues,
uint32 UIntsToSet
)

   NiagaraDebugShaders.h  

void NiagaraDebugShaders::DrawDebugLines ( FRDGBuilder& GraphBuilder,
const FSceneView& View,
FRDGTextureRef SceneColor,
FRDGTextureRef SceneDepth,
const uint32 LineInstanceCount,
FRDGBufferRef LineBuffer
)

   NiagaraDebugShaders.h  

void NiagaraDebugShaders::DrawDebugLines ( FRDGBuilder& GraphBuilder,
const FSceneView& View,
FRDGTextureRef SceneColor,
FRDGTextureRef SceneDepth,
FRDGBufferRef ArgsBuffer,
FRDGBufferRef LineBuffer
)

   NiagaraDebugShaders.h  

void NiagaraDebugShaders::VisualizeTexture ( FRDGBuilder& GraphBuilder,
const FSceneView& View,
const FScreenPassRenderTarget& Output,
const FIntPoint& Location,
const int32& DisplayHeight,
const FIntVector4& AttributesToVisualize,
FRDGTextureRef Texture,
const FIntVector4& NumTextureAttributes,
uint32 TickCounter,
const FVector2D& PreviewDisplayRange
)

   NiagaraDebugShaders.h  

void NiagaraFillGPUIntBuffer ( FRHICommandList& RHICmdList,
ERHIFeatureLevel::Type FeatureLevel,
FRHIUnorderedAccessView* BufferUAV,
uint32 NumElements,
int32 FillValue
)

   NiagaraShaderParticleID.h  

void NiagaraGenerateMips::GenerateMips ( FRDGBuilder& GraphBuilder,
FRDGTextureRef RDGTexture,
ENiagaraMipMapGenerationType GenType
)

   NiagaraGenerateMips.h  

void NiagaraInitGPUFreeIDList ( FRHICommandList& RHICmdList,
ERHIFeatureLevel::Type FeatureLevel,
FRHIUnorderedAccessView* NewBufferUAV,
uint32 NewBufferNumElements,
FRHIShaderResourceView* ExistingBufferSRV,
uint32 ExistingBufferNumElements
)

   NiagaraShaderParticleID.h  
Called for every Niagara shader to update the appropriate stats. NiagaraShaderType.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page