1. Epic GamesDeveloper
  3. NiagaraShader

NiagaraShader

API > API/Plugins

Classes

  Type Name Description
Public class FBatchedElementNiagara2DArrayAttribute Batched element parameters for gathering attributes from different slices into a single color  
Public class FBatchedElementNiagaraInvertColorChannel Batched element parameters for inverting a color channel  
Public class FBatchedElementNiagaraSimple Simple batched element using a 2d texture  
Public class FBatchedElementNiagaraVolumeAttribute Batched element parameters for gathering attributes from a volume texture into a single color  
Public struct FNiagaraAsyncGpuTrace Mirrors structure in Engine\Plugins\FX\Niagara\Shaders\Private\NiagaraAsyncGpuTraceCommon.ush  
Public class FNiagaraAsyncGpuTraceProvider    
Public struct FNiagaraAsyncGpuTraceResult Mirrors structure in Engine\Plugins\FX\Niagara\Shaders\Private\NiagaraAsyncGpuTraceCommon.ush  
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 FNiagaraCopySVTToDenseBufferCS    
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 struct FNiagaraDataInterfaceStructIncludeInfo Shader side information about global structures includes.  
Public struct FNiagaraRibbonComputeCommon    
Public class FNiagaraRibbonSortPhase2CS Compute shader used to generate particle sort keys.  
Public class FNiagaraRibbonVertexReductionPropagateCS    
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 class FNiagaraShaderParametersBuilder    
Public struct FNiagaraShaderPermutationParameters    
Public class FNiagaraShaderScript FNiagaraShaderScript represents a Niagara script to the shader compilation process  
Public struct UStruct FNiagaraShaderScriptExternalConstant    
Public struct UStruct FNiagaraShaderScriptParametersMetadata Data provided from the translator to track information requires to bind data interface or parameters at runtime.  
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

Name Description
FNiagaraShaderRef  
TNiagaraShaderRef  

Enums

  Type Name Description
Public enum UEnum ENiagaraDirectDispatchElementType    
Public enum UEnum ENiagaraGpuDispatchType    
Public enum UEnum ENiagaraMipMapGenerationType    
Public enum UEnum ENiagaraSimStageExecuteBehavior    
Public enum UEnum FNiagaraCompileEventSeverity Defines the compile event types for translation/compilation.  
Public enum UEnum FNiagaraCompileEventSource    

Functions

  Type Name Description
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

BEGIN_SHADER_PARAMETER_STRUCT ( FNiagaraRibbonGenerateIndices,
NIAGARASHADER_API
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

BEGIN_SHADER_PARAMETER_STRUCT ( FNiagaraRibbonInitializeIndices,
NIAGARASHADER_API
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

BEGIN_SHADER_PARAMETER_STRUCT ( FNiagaraRibbonUVSettingsParams,
NIAGARASHADER_API
)

  
Public function  

BEGIN_SHADER_PARAMETER_STRUCT ( FNiagaraRibbonVertexReductionFinalizationParameters,
NIAGARASHADER_API
)

  
Public function  

BEGIN_SHADER_PARAMETER_STRUCT ( FNiagaraRibbonVertexReductionParameters,
NIAGARASHADER_API
)

  
Public function  

BEGIN_SHADER_PARAMETER_STRUCT ( FRibbonOrderSortParameters,
NIAGARASHADER_API
)

  
Public function  

BEGIN_SHADER_PARAMETER_STRUCT ( FRibbonComputeUniformParameters,
NIAGARASHADER_API
)

 Total particle Count.
Public function  

DECLARE_UNIFORM_BUFFER_STRUCT ( FSceneUniformParameters,
RENDERER_API
)

  
Public function void Dump shader stats for a given platform.
Public function FNiagaraCompileEventSeverity  
Public function bool  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function 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
)

  
Public function void

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

  
Public function void  
Public function void

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

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
NumVerticesInSlice
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( int,
TrailingEdgeMode
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( int,
bEnablePerParticleVRangeOverride
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
IndirectDrawOutputIndex
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
IndexGenThreadSize
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( float,
ViewDistance
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
TessellationMode
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
CustomTessellationFactor
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
bCustomUseScreenSpace
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( float,
GNiagaraRibbonTessellationAngle
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
GNiagaraRibbonTessellationEnabled
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
IndexBufferOffset
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
TriangleToVertexIdsCount
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
SegmentBitMask
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( uint32,
BitMaskForShape
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER ( int,
DistributionMode
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
MaterialParam2DataOffset
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
V1RangeOverrideDataOffset
)

  
Public function Common DestinationSortedIndices

SHADER_PARAMETER ( uint32,
MergeSortSourceBlockSize
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
NiagaraIntDataStride
)

 Int bindings.
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
PrevPositionDataOffset
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
WidthDataOffset
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
TwistDataOffset
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
ColorDataOffset
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
RibbonLinkOrderDataOffset
)

 Float bindings.
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
MaterialRandomDataOffset
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
MaterialParamDataOffset
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
DistanceFromStartOffset
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
V0RangeOverrideDataOffset
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf NiagaraFloatDataSt...

SHADER_PARAMETER ( int,
PrevFacingDataOffset
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER_SRV ( Buffer< uint32 >,
TriangleToVertexIds
)

 Direct and Indirect particle counts.
Public function Common TangentsAndDistances Segments

SHADER_PARAMETER_SRV ( Buffer< float >,
TessellationStats
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER_SRV ( Buffer< uint32 >,
VertexGenerationResults
)

 Direct and Indirect particle counts.
Public function TotalNumParticlesDirect

SHADER_PARAMETER_SRV ( Buffer< uint32 >,
EmitterParticleCountsBuffer
)

  
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset

SHADER_PARAMETER_SRV ( Buffer< float >,
NiagaraParticleDataFloat
)

 Niagara sim data.
Public function TotalNumParticlesDirect EmitterParticleCountsBufferOffset NiagaraParticleDataHalf

SHADER_PARAMETER_SRV ( Buffer< int >,
NiagaraParticleDataInt
)

  
Public function Common

SHADER_PARAMETER_SRV ( Buffer< uint32 >,
SortedIndices
)

  
Public function Common TangentsAndDistances

SHADER_PARAMETER_SRV ( Buffer< uint32 >,
MultiRibbonIndices
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER_SRV ( Buffer< uint32 >,
CommandBuffer
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER_STRUCT ( FNiagaraRibbonUVSettingsParams,
UV1Settings
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER_STRUCT_INCLUDE ( FRibbonComputeUniformParameters,
Common
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData

SHADER_PARAMETER_UAV ( RWBuffer< uint32 >,
OutputCommandBuffer
)

  
Public function Common InputTangentsAndDistances

SHADER_PARAMETER_UAV ( RWBuffer< float >,
OutputTangentsAndDistances
)

  
Public function Common InputTangentsAndDistances InputMultiRibbonIndices

SHADER_PARAMETER_UAV ( RWBuffer< uint32 >,
OutputMultiRibbonIndices
)

  
Public function Common InputTangentsAndDistances InputMultiRibbonIndices InputSegments

SHADER_PARAMETER_UAV ( RWBuffer< uint32 >,
OutputSegments
)

  
Public function Common InputTangentsAndDistances InputMultiRibbonIndices InputSegments InputTessellationStats

SHADER_PARAMETER_UAV ( RWBuffer< float >,
OutputTessellationStats
)

  
Public function Common TangentsAndDistances Segments PackedPerRibbonData OutputCommandBufferIndex SHADER_PARAMETER(i...

SHADER_PARAMETER_UAV ( RWBuffer< float >,
TangentsAndDistances
)

  
Public function void Called for every Niagara shader to update the appropriate stats.

Variables

  Type Name Description
Public variable FNiagaraShaderCompilationManager GNiagaraShaderCompilationManager  
Public variable int32 GNiagaraSkipVectorVMBackendOptimizations  
Public variable int32 GNiagaraTranslatorFailIfNotSetSeverity CVars

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page