Niagara

Filters

Classes

Name

Description

Public class UClass MinimalAPI HideCategories componentwrapperclass

ANiagaraActor

Public struct

CounterInstanceData

Public struct

CQDIPerInstanceData

Public struct

EditorExposedVectorConstant

Public struct

EditorExposedVectorCurveConstant

Public struct

FDynamicVertexColorFilterData

TODO: IMO this should be generalized fuhrer if possible and extended to a system allowing filtering based on texture color etc too.

Public struct UStruct

FEmitterCompiledScriptPair

Public struct UStruct

FMeshTriCoordinate

A coordinate on a mesh usable in Niagara.

Public class

FNDI_SkeletalMesh_GeneratedData

Public class

FNDI_StaticMesh_GeneratedData

Public struct

FNDISkeletalMesh_InstanceData

Public struct

FNDISpline_InstanceData

Public struct

FNDIStaticMesh_InstanceData

Public struct UStruct

FNDIStaticMeshSectionFilter

Public struct

FNDITransformHandler

Public struct

FNDITransformHandlerNoop

Public struct UStruct meta

FNiagaraBool

Public class

FNiagaraCollisionBatch

Public struct UStruct

FNiagaraCollisionEventPayload

Type struct for collision event payloads; collision event data set is based on this TODO: figure out how we can pipe attributes from the colliding particle in here

Public struct

FNiagaraCollisionTrace

Public class

FNiagaraCompileOptions

Public class

FNiagaraCompileRequestDataBase

External reference to the compile request data generated.

Public struct

FNiagaraComputeExecutionContext

Public struct

FNiagaraConstants

Public class

FNiagaraDataBuffer

Buffer containing one frame of Niagara simulation data.

Public class

FNiagaraDataInterfaceError

Public class

FNiagaraDataSet

General storage class for all per instance simulation data in Niagara.

Public struct

FNiagaraDataSetAccessor

Public struct

FNiagaraDataSetAccessorBase

General iterator for getting and setting data in and FNiagaraDataSet .

Public struct

FNiagaraDataSetExecutionInfo

Public struct UStruct

FNiagaraDataSetID

Public struct

FNiagaraDataSetIterator

Provide iterator to keep iterator access patterns still in use.

Public struct UStruct

FNiagaraDataSetProperties

Public struct

FNiagaraDataSetVariableIterator

Iterator that will pull or push data between a DataSet and some FNiagaraVariables it contains.

Public struct

FNiagaraDataSetVariableIteratorConst

Iterator that will pull or push data between a DataSet and some FNiagaraVariables it contains.

Public class

FNiagaraDICollisionQueryBatch

Public struct

FNiagaraDICollsionQueryResult

Public class

FNiagaraDummyRWBufferFloat

Public class

FNiagaraDummyRWBufferInt

Public struct

FNiagaraDynamicDataBase

Struct used to pass dynamic data from game thread to render thread

Public struct

FNiagaraDynamicDataLights

Public struct

FNiagaraDynamicDataMesh

Public struct UStruct

FNiagaraEmitterHandle

Stores a references to a source emitter asset, and a copy of that emitter for editing within an System.

Public struct

FNiagaraEmitterInstance

A Niagara particle simulation.

Public struct UStruct

FNiagaraEmitterScriptProperties

Public struct UStruct

FNiagaraEmitterSpawnAttributes

Public class

FNiagaraEventDataSetMgr

Public struct UStruct

FNiagaraEventGeneratorProperties

Public struct UStruct

FNiagaraEventReceiverProperties

TODO: Event action that spawns other whole Systems? One that calls a BP exposed delegate?

Public struct UStruct

FNiagaraEventScriptProperties

Public struct UStruct meta

FNiagaraFloat

Public struct UStruct

FNiagaraFunctionSignature

Public struct UStruct blueprintable, meta

FNiagaraID

Public struct UStruct meta

FNiagaraInt32

Public struct UStruct meta

FNiagaraMatrix

Public struct UStruct

FNiagaraModuleDependency

Public struct UStruct

FNiagaraNumeric

Public class

FNiagaraOpInOutInfo

Information about an input or output of a Niagara operation node.

Public class

FNiagaraParameterBindingInstance

A runtime instance of an System parameter binding.

Public struct

FNiagaraParameterDirectBinding

Direct binding to a parameter store to allow efficient gets/sets from code etc.

Public struct UStruct

FNiagaraParameterMap

Public struct UStruct

FNiagaraParameters

Public struct UStruct

FNiagaraParameterStore

Base storage class for Niagara parameter values.

Public struct

FNiagaraParameterStoreBinding

Binding from one parameter store to another.

Public struct

FNiagaraParameterStoreToDataSetBinding

TODO: Pull all the layout information here, in the data set and in parameter stores out into a single layout structure that's shared between all instances of it.

Public class

FNiagaraSceneProxy

Scene proxy for drawing niagara particle simulations.

Public struct UStruct

FNiagaraScriptDataInterfaceCompileInfo

Public struct UStruct

FNiagaraScriptDataInterfaceInfo

Public struct UStruct

FNiagaraScriptDataUsageInfo

Struct containing usage information about a script.

Public struct

FNiagaraScriptDebuggerInfo

Public struct

FNiagaraScriptExecutionContext

Public struct UStruct

FNiagaraScriptExecutionPaddingInfo

Public struct UStruct

FNiagaraScriptExecutionParameterStore

Storage class containing actual runtime buffers to be used by the VM and the GPU.

Public struct UStruct meta

FNiagaraSpawnInfo

Data controlling the spawning of particles

Public struct UStruct

FNiagaraStatScope

Public struct UStruct

FNiagaraSystemCompileRequest

Public class

FNiagaraSystemInstance

Public class

FNiagaraSystemSimulation

Simulation performing all system and emitter scripts for a instances of a UNiagaraSystem in a world.

Public struct

FNiagaraSystemUpdateContext

Public struct UStruct

FNiagaraTestStruct

Public struct UStruct

FNiagaraTestStructInner

Public struct UStruct

FNiagaraTypeDefinition

Public class

FNiagaraTypeHelper

Can convert a UStruct with fields of base types only (float, int... - will likely add native vector types here as well) to an FNiagaraTypeDefinition (internal representation)

Public struct

FNiagaraTypeLayoutInfo

Information about how this type should be laid out in an FNiagaraDataSet

Public class

FNiagaraTypeRegistry

Contains all types currently available for use in Niagara Used by UI to provide selection; new uniforms and variables may be instanced using the types provided here

Public struct UStruct

FNiagaraUserRedirectionParameterStore

Extension of the base parameter store to allow the user in the editor to use variable names without the "User." namespace prefix.

Public struct UStruct

FNiagaraVariable

Public struct UStruct

FNiagaraVariableAttributeBinding

Public struct UStruct

FNiagaraVariableDataInterfaceBinding

Public struct UStruct

FNiagaraVariableInfo

Defines all you need to know about a variable.

Public struct

FNiagaraVariableLayoutInfo

Helper class defining the layout and location of an FNiagaraVariable in an FNiagaraDataBuffer->

Public struct UStruct

FNiagaraVariableMetaData

Public class

FNiagaraViewDataMgr

Public struct UStruct

FNiagaraVMExecutableData

Struct containing all of the data needed to run a Niagara VM executable script.

Public struct UStruct

FNiagaraVMExecutableDataId

Struct containing all of the data necessary to look up a NiagaraScript's VM executable results from the Derived Data Cache.

Public class

FNiagaraWorldManager

Manager class for any data relating to a particular world.

Public class

FOnNiagaraSystemFinished

Called when the particle system is done.

Public struct

FSkeletalMeshAccessorHelper

Public struct

FSkeletalMeshSamplingRegionAreaWeightedSampler

Allows perfect area weighted sampling between different skeletal mesh Sampling regions.

Public struct

FSkeletalMeshSkinningData

Public struct

FSkeletalMeshSkinningDataHandle

Public struct

FSkeletalMeshSkinningDataUsage

Public struct

FSkelMeshVertexAccessor

Helper for accessing misc vertex data.

Public struct

FSkinnedPositionAccessorHelper

Public struct

FStaticMeshFilteredAreaWeightedSectionSampler

Allows uniform random sampling of a number of mesh sections filtered by an FNDIStaticMeshSectionFilter

Public struct UStruct

FVMExternalFunctionBindingInfo

Public class

INiagaraModule

Niagara module interface

Public class

NiagaraEmitterInstanceBatcher

Public class

NiagaraRenderer

Base class for Niagara System renderers.

Public class

NiagaraRendererLights

NiagaraRendererLights renders an FNiagaraEmitterInstance as simple lights

Public class

NiagaraRendererMeshes

NiagaraRendererSprites renders an FNiagaraEmitterInstance as sprite particles

Public class

NiagaraRendererRibbons

NiagaraRendererRibbons renders an FNiagaraEmitterInstance as a ribbon connecting all particles in order by particle age.

Public class

NiagaraRendererSprites

NiagaraRendererSprites renders an FNiagaraEmitterInstance as sprite particles

Public class

SimpleTimer

Public struct

TAreaWeightingModeBinder

External function binder choosing between template specializations based on if we're area weighting or not.

Public struct

TCurveUseLUTBinder

External function binder choosing between template specializations based on if a curve should use the LUT over full evaluation.

Public struct

TFilterModeBinder

External function binder choosing between template specializations based on filtering methods.

Public struct

TNDIExplicitBinder

Adds a known type to the parameters.

Public struct

TNDINoopBinder

Public struct

TNDIParamBinder

Binder that tests the location of an operand and adds the correct handler type to the Binding parameters.

Public struct

TSkinningModeBinder

External function binder choosing between template specializations based on skinning mode.

Public struct

TVertexAccessorBinder

External function binder choosing between template specializations based vetrex data format.

Public class UClass ClassGroup, ShowCategories, HideCategories, Meta editinlinenew

UNiagaraComponent

UNiagaraComponent is the primitive component for a Niagara System.

Public class UClass Abstract editinlinenew

UNiagaraDataInterface

Base class for all Niagara data interfaces.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceCollisionQuery

Data Interface allowing sampling of color curves.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceColorCurve

Data Interface allowing sampling of color curves.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceCurlNoise

Data Interface allowing sampling of curl noise LUT.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceCurve

Data Interface allowing sampling of float curves.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceCurveBase

Base class for curve data interfaces which facilitates handling the curve data in a standardized way.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceSimpleCounter

Data Interface allowing a counter that starts at zero when created and increases every time it is sampled.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceSkeletalMesh

Data Interface allowing sampling of static meshes.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceSpline

Data Interface allowing sampling of in-world spline components.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceStaticMesh

Data Interface allowing sampling of static meshes.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceTexture

Data Interface allowing sampling of a texture

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceVector2DCurve

Data Interface allowing sampling of vector curves.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceVector4Curve

Data Interface allowing sampling of vector curves.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceVectorCurve

Data Interface allowing sampling of vector curves.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceVectorField

Public class UClass MinimalAPI

UNiagaraEditorDataBase

A base class for editor only data which supports post loading from the runtime owner object.

Public class UClass MinimalAPI

UNiagaraEmitter

UNiagaraEmitter stores the attributes of an FNiagaraEmitterInstance that need to be serialized and are used for its initialization

Public class UClass Abstract

UNiagaraEventReceiverEmitterAction

Base class for actions that an event receiver will perform at the emitter level.

Public class UClass editinlinenew

UNiagaraEventReceiverEmitterAction_SpawnParticles

Public class UClass

UNiagaraFunctionLibrary

A C++ and Blueprint accessible library of utility functions for accessing Niagara simulations All positions & orientations are returned in Unreal reference frame & units, assuming the Leap device is located at the origin.

Public class UClass editinlinenew

UNiagaraLightRendererProperties

Public class UClass editinlinenew

UNiagaraMeshRendererProperties

Public class UClass

UNiagaraParameterCollection

Asset containing a collection of global parameters usable by Niagara.

Public class UClass

UNiagaraParameterCollectionInstance

Public class UClass Abstract

UNiagaraRendererProperties

Public class UClass editinlinenew

UNiagaraRibbonRendererProperties

Public class UClass MinimalAPI

UNiagaraScript

Runtime script for a Niagara system

Public class UClass MinimalAPI

UNiagaraScriptSourceBase

Runtime data for a Niagara system

Public class UClass Meta Config defaultconfig

UNiagaraSettings

Public class UClass editinlinenew

UNiagaraSpriteRendererProperties

Public class UClass BlueprintType

UNiagaraSystem

Container for multiple emitters that combine together to create a particle system effect.

Typedefs

Name

Description

FNiagaraDataInterfaceFix

Helper class for GUI error handling.

PerEmitterEventDataSetMap

PerSystemInstanceDataSetMap

Enums

Name

Description

Public enum

ENDISkeletalMesh_FilterMode

Public enum UEnum

ENDISkeletalMesh_SkinningMode

Public enum

ENDISkelMesh_AreaWeightingMode

Public enum UEnum

ENiagaraAgeUpdateMode

Defines modes for updating the component's age.

Public enum

ENiagaraBaseTypes

Public enum UEnum

ENiagaraCollisionMode

Public enum UEnum

ENiagaraDataSetType

Public enum UEnum

ENiagaraExecutionState

Public enum UEnum

ENiagaraExecutionStateSource

The source from which a script execution state was set.

Public enum UEnum

ENiagaraInputNodeUsage

Public enum UEnum

ENiagaraMeshFacingMode

This enum decides how a mesh particle will orient its "facing" axis relative to camera.

Public enum UEnum

ENiagaraModuleDependencyScriptConstraint

Public enum UEnum

ENiagaraModuleDependencyType

Public enum UEnum

ENiagaraNumericOutputTypeSelectionMode

Defines different modes for selecting the output numeric type of a function or operation based on the types of the inputs.

Public enum UEnum

ENiagaraRibbonAgeOffsetMode

Defines different modes for offsetting UVs by age when ordering ribbon particles using normalized age.

Public enum UEnum

ENiagaraRibbonDrawDirection

This enum decides in which order the ribbon segments will be rendered

Public enum UEnum

ENiagaraRibbonFacingMode

Public enum UEnum

ENiagaraScriptCompileStatus

Enumerates states a Niagara script can be in.

Public enum UEnum

ENiagaraScriptGroup

Public enum UEnum

ENiagaraScriptUsage

Defines different usages for a niagara script.

Public enum UEnum

ENiagaraSimTarget

Public enum UEnum

ENiagaraSortMode

Public enum UEnum

ENiagaraSpriteAlignment

This enum decides how a sprite particle will orient its "up" axis.

Public enum UEnum

ENiagaraSpriteFacingMode

This enum decides how a sprite particle will orient its "facing" axis.

Public enum UEnum

EScriptExecutionMode

Public enum UEnum

EUnusedAttributeBehaviour

Defines what will happen to unused attributes when a script is run.

Functions

Name Description

Public function

T

 

BarycentricInterpolate

(
    float BaryX,
    float BaryY,
    float BaryZ,
    T V0,
    T V1,
    T V2
)

Public function

FVector4

 

BarycentricInterpolate

(
    float BaryX,
    float BaryY,
    float BaryZ,
    const FVector4 & V0,
    const FVector4 & V1,
    const FVector4 & V2
)

Overload for FVector4 to work around C2719: (formal parameter with requested alignment of 16 won't be aligned)

Public function

FVector4

 

BarycentricInterpolate

(
    FVector BaryCoord,
    const FVector4 & V0,
    const FVector4 & V1,
    const FVector4 & V2
)

Overload for FVector4 to work around C2719: (formal parameter with requested alignment of 16 won't be aligned)

Public function

T

 

BarycentricInterpolate

(
    FVector BaryCoord,
    T V0,
    T V1,
    T V2
)

Public function

void

 

FNiagaraUtilities::CollectScriptDataInterfaceParameters

(
    const UObject & Owner,
    const TArray < UNiagaraScript * ...,
    FNiagaraParameterStore & OutDataInt...
)

Public function

FNiagaraVari ...

 

FNiagaraUtilities::ConvertVariableToRapidIterationConstantName

(
    FNiagaraVariable InVar,
    const TCHAR * InEmitterName,
    ENiagaraScriptUsage InUsage
)

Public function

FName

 

FNiagaraUtilities::GetUniqueName

(
    FName CandidateName,
    const TSet < FName >& ExistingNames
)

Builds a unique name from a candidate name and a set of existing names.

Public function

void

 

FNiagaraUtilities::PrepareRapidIterationParameters

(
    const TArray < UNiagaraScript * ...,
    const TMap < UNiagaraScript *, U ...,
    const TMap < UNiagaraScript *, F ...
)

Prepares rapid iteration parameter stores for simulation by removing old parameters no longer used by functions, by initializing new parameters added to functions, and by copying parameters across parameter stores for interscript dependencies.

Public function

bool

 

FNiagaraUtilities::SupportsGPUParticles

(
    ERHIFeatureLevel::Type FeatureLevel
)

Public function

bool

 

FNiagaraUtilities::SupportsGPUParticles

(
    EShaderPlatform ShaderPlatform
)

Public function

bool

 

FNiagaraUtilities::SupportsNiagaraRendering

(
    ERHIFeatureLevel::Type FeatureLevel
)

Public function

bool

 

FNiagaraUtilities::SupportsNiagaraRendering

(
    EShaderPlatform ShaderPlatform
)

Public function

uint32

 

GetTypeHash

(
    const FNiagaraTypeDefinition & Type
)

Public function

uint32

 

GetTypeHash

(
    const FNiagaraDataSetID & Var
)

Public function

uint32

 

GetTypeHash

(
    const FNiagaraID & ID
)

Public function

uint32

 

GetTypeHash

(
    const FNiagaraVariable & Var
)

Public function

void

 

ProcessSerializedShaderMaps

(
    UNiagaraScript * Owner,
    TArray < FNiagaraShaderScript >& Lo...,
    FNiagaraShaderScript & OutResourceF...,
    FNiagaraShaderScript *(&) OutSc...
)

Public function

FVector

 

RandomBarycentricCoord

(
    FRandomStream & RandStream
)

Public function

void

 

SerializeNiagaraShaderMaps

(
    const TMap < const ITargetPlatform &...,
    FArchive & Ar,
    TArray < FNiagaraShaderScript >& Ou...
)

Variables

Name Description

Public variable

TGlobalResource ...

 

GNiagaraViewDataManager

Public variable

const FString

 

INTERPOLATED_PARAMETER_PREFIX

Public variable

const uint32

 

NIAGARA_COMPUTE_THREADGROUP_SIZE

Public variable

const uint32

 

NIAGARA_MAX_COMPUTE_THREADGROUPS