Niagara

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public class UClass MinimalAPI HideCategories componentwrapperclass

ANiagaraActor

Public class UClass Abstract Blueprintable Transient

ANiagaraPreviewBase

Base actor for preview actors used in UNiagaraPreviewAxis .

Public class UClass

ANiagaraPreviewGrid

Public struct

CounterInstanceData

Public struct

CQDIPerInstanceData

Public struct

EditorExposedVectorConstant

Public struct

EditorExposedVectorCurveConstant

Public struct

FAudioParticleData

Public struct

FAudioPlayerInterface_InstanceData

Public struct UStruct BlueprintType blueprintable

FBasicParticleData

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FCameraDataInterface_InstanceData

Public struct

FComponentPropertyAddress

Public struct

FDeviceProfileValueCache

Helper class for accesssing and caching the value of CVars for device profiles.

Public struct

FDistanceData

Copyright Epic Games, Inc. All Rights Reserved.

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 class

FGrid2DBuffer

Public struct

FGrid2DCollectionReaderInstanceData_GameThread

Public struct

FGrid2DCollectionReaderInstanceData_RenderThread

Public struct

FGrid2DCollectionRWInstanceData_GameThread

Public struct

FGrid2DCollectionRWInstanceData_RenderThread

Public class

FGrid3DBuffer

Public struct

FGrid3DCollectionRWInstanceData_GameThread

Public struct

FGrid3DCollectionRWInstanceData_RenderThread

Public struct UStruct

FMeshTriCoordinate

Copyright Epic Games, Inc. All Rights Reserved.

Public struct UStruct

FNCPool

Public struct UStruct

FNCPoolElement

Public class

FNDI_SkeletalMesh_GeneratedData

Public class

FNDI_StaticMesh_GeneratedData

Public struct

FNDIArrayImplHelper

Public struct

FNDIArrayImplHelperBase

Public struct

FNDIInputParam

Helper to deal with types with potentially several input registers.

Public struct

FNDILandscapeData_GameThread

Landscape data used for the game thread.

Public struct

FNDILandscapeData_RenderThread

Landscape data used on the render thread.

Public struct

FNDIOutputParam

Helper to deal with types with potentially several output registers.

Public struct

FNDIParameter

Helper class for decoding NDI parameters into a usable struct type.

Public struct

FNDIRandomHelper

Public struct

FNDISkeletalMesh_InstanceData

Public struct

FNDISpline_InstanceData

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FNDIStaticMesh_InstanceData

Public struct UStruct

FNDIStaticMeshSectionFilter

Public struct

FNDITransformHandler

Public struct

FNDITransformHandlerNoop

Public struct UStruct meta

FNiagaraBool

Public struct UStruct

FNiagaraBoundParameter

Public class

FNiagaraBoundsCalculator

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 struct

FNiagaraCompiledDataReference

FNiagaraCompiledDataReference .

Public struct

FNiagaraCompileHashVisitor

Used to store the state of a graph when deciding if it has been dirtied for recompile.

Public struct UStruct

FNiagaraCompileHashVisitorDebugInfo

Public class

FNiagaraCompileOptions

Public class

FNiagaraCompileRequestDataBase

External reference to the compile request data generated.

Public struct UStruct

FNiagaraComponentPropertyBinding

Public struct

FNiagaraComponentRenderPool

Public struct

FNiagaraComponentRenderPoolEntry

Public struct

FNiagaraComponentUpdateTask

Public struct

FNiagaraComputeExecutionContext

Public struct

FNiagaraComputeInstanceData

Public struct

FNiagaraComputeSharedContext

Public struct

FNiagaraComputeSharedContextDeleter

Public struct

FNiagaraConstantBufferToDataSetBinding

Public struct

FNiagaraConstants

Public class

FNiagaraCrashReporterScope

Public class

FNiagaraDataBuffer

Buffer containing one frame of Niagara simulation data.

Public struct

FNiagaraDataIntefaceProxyCameraQuery

Public struct

FNiagaraDataIntefaceProxyCollisionQuery

Public struct

FNiagaraDataIntefaceProxyOcclusionQuery

Public struct

FNiagaraDataInterfaceArrayImpl

Public struct

FNiagaraDataInterfaceArrayImplHelper

Public class

FNiagaraDataInterfaceError

Public class

FNiagaraDataInterfaceFeedback

Public struct

FNiagaraDataInterfaceInstanceData

Public struct

FNiagaraDataInterfaceParametersCS_ArrayImpl

Public struct

FNiagaraDataInterfaceParametersCS_CameraQuery

Public struct

FNiagaraDataInterfaceParametersCS_Curve

Public struct

FNiagaraDataInterfaceParametersCS_VectorField

Public struct

FNiagaraDataInterfaceProxy

Public struct

FNiagaraDataInterfaceProxy2DArrayTexture

Public struct

FNiagaraDataInterfaceProxyArrayImpl

Public struct

FNiagaraDataInterfaceProxyCurlNoise

Public struct

FNiagaraDataInterfaceProxyCurveBase

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FNiagaraDataInterfaceProxyGrid2DCollectionProxy

Public struct

FNiagaraDataInterfaceProxyGrid2DCollectionReaderProxy

Public struct

FNiagaraDataInterfaceProxyGrid3DCollectionProxy

Public struct

FNiagaraDataInterfaceProxyLandscape

Public struct

FNiagaraDataInterfaceProxyNeighborGrid3D

Public struct

FNiagaraDataInterfaceProxyOscilloscope

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FNiagaraDataInterfaceProxyRenderTarget2DArrayProxy

Public struct

FNiagaraDataInterfaceProxyRenderTarget2DProxy

Public struct

FNiagaraDataInterfaceProxyRenderTargetVolumeProxy

Public struct

FNiagaraDataInterfaceProxyRW

#todo(dmp): some of the stuff we'd expect to see here is on FNiagaraDataInterfaceProxy - refactor?

Public struct

FNiagaraDataInterfaceProxySkeletalMesh

Public struct

FNiagaraDataInterfaceProxySpectrum

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FNiagaraDataInterfaceProxyStaticMesh

Public struct

FNiagaraDataInterfaceProxySubmix

Niagara data interface proxy for audio submix listener.

Public struct

FNiagaraDataInterfaceProxyVectorField

Public struct

FNiagaraDataInterfaceProxyVolumeTexture

Public class

FNiagaraDataSet

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

Public struct

FNiagaraDataSetAccessor

Public struct

FNiagaraDataSetAccessorFloat

Template struct FNiagaraDataSetWriterFloat

Public struct

FNiagaraDataSetAccessorInt32

Template struct FNiagaraDataSetWriterInt

Public struct

FNiagaraDataSetAccessorStruct

Public struct

FNiagaraDataSetAccessorTypeInfo

Copyright Epic Games, Inc. All Rights Reserved.

Public struct UStruct

FNiagaraDataSetCompiledData

Public struct

FNiagaraDataSetExecutionInfo

Public struct UStruct

FNiagaraDataSetID

Public struct UStruct

FNiagaraDataSetProperties

Public struct

FNiagaraDataSetReaderFloat

Public struct

FNiagaraDataSetReaderInt32

Public struct

FNiagaraDataSetReaderStruct

Public struct

FNiagaraDataSetWriterInt32

Public struct

FNiagaraDataVariableIterator

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

Public struct UStruct

FNiagaraDetailsLevelScaleOverrides

Legacy struct for spawn count scale overrides.

Public struct UStruct

FNiagaraDeviceProfileStateEntry

Public class

FNiagaraDICollisionQueryBatch

Public struct

FNiagaraDICollsionQueryResult

Public struct

FNiagaraDISkeletalMeshPassedDataToRT

Public struct

FNiagaraDynamicDataBase

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

Public struct UStruct

FNiagaraEmitterCompiledData

Public struct

FNiagaraEmitterExecutionIndex

Public struct UStruct

FNiagaraEmitterHandle

Stores emitter information within the context of a System.

Public class

FNiagaraEmitterInstance

A Niagara particle simulation.

Public struct UStruct meta

FNiagaraEmitterNameSettingsRef

Public struct

FNiagaraEmitterParameters

Any change to this structure, or it's GetVariables implementation will require a bump in the CustomNiagaraVersion so that we properly rebuild the scripts You must pad this struct and the results of GetVariables() to a 16 byte boundry.

Public struct UStruct

FNiagaraEmitterScalabilityOverride

Public struct UStruct

FNiagaraEmitterScalabilityOverrides

Container struct for an array of emitter scalability overrides.

Public struct UStruct

FNiagaraEmitterScalabilitySettings

Scalability settings for Niagara Emitters on a particular platform set.

Public struct UStruct

FNiagaraEmitterScalabilitySettingsArray

Container struct for an array of emitter scalability settings.

Public struct UStruct

FNiagaraEmitterScriptProperties

Public struct UStruct

FNiagaraEventGeneratorProperties

Public struct

FNiagaraEventHandlingInfo

Container for data needed to process event data.

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

FNiagaraGlobalParameters

Any change to this structure, or it's GetVariables implementation will require a bump in the CustomNiagaraVersion so that we properly rebuild the scripts You must pad this struct and the results of GetVariables() to a 16 byte boundry.

Public class

FNiagaraGPUInstanceCountManager

A manager that handles the buffer containing the GPU particle count.

Public class

FNiagaraGPURendererCount

The number of GPU renderers registered in the instance count manager.

Public struct

FNiagaraGPUSortInfo

Public struct

FNiagaraGpuSpawnInfo

Public struct

FNiagaraGpuSpawnInfoParams

Public class

FNiagaraGPUSystemTick

Represents all the information needed to dispatch a single tick of a FNiagaraSystemInstance .

Public struct UStruct

FNiagaraGraphViewSettings

Public struct UStruct meta

FNiagaraHalf

Public struct UStruct meta

FNiagaraHalfVector2

Public struct UStruct meta

FNiagaraHalfVector3

Public struct UStruct meta

FNiagaraHalfVector4

Public struct UStruct BlueprintType meta

FNiagaraID

Public struct UStruct

FNiagaraInputConditionMetadata

Defines options for conditionally editing and showing script inputs in the UI.

Public struct UStruct meta

FNiagaraInt32

Public struct UStruct

FNiagaraMaterialAttributeBinding

Public struct UStruct

FNiagaraMaterialOverride

Public struct UStruct meta

FNiagaraMatrix

Public struct UStruct

FNiagaraMeshMaterialOverride

Public struct UStruct

FNiagaraModuleDependency

Public struct UStruct

FNiagaraNumeric

Public class

FNiagaraOpInOutInfo

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

Public struct

FNiagaraOwnerParameters

Any change to this structure, or it's GetVariables implementation will require a bump in the CustomNiagaraVersion so that we properly rebuild the scripts You must pad this struct and the results of GetVariables() to a 16 byte boundry.

Public struct UStruct

FNiagaraParameterDataSetBinding

Public struct UStruct

FNiagaraParameterDataSetBindingCollection

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

FNiagaraParameterScopeInfo

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 struct

FNiagaraPassedInstanceDataForRT

Public struct

FNiagaraPerInstanceDIFuncInfo

For function calls from system scripts on User DIs or those with per instance data, we build a per instance binding table that is called from a helper function in the exec context.

Public struct UStruct

FNiagaraPlatformSet

Public struct UStruct

FNiagaraPlatformSetConflictEntry

Public struct UStruct

FNiagaraPlatformSetConflictInfo

Public struct UStruct

FNiagaraPlatformSetCVarCondition

Imposes a condition that a CVar must contain a set value or range of values for a platform set to be enabled.

Public struct

FNiagaraPropertySetter

Public struct UStruct

FNiagaraRandInfo

Public class

FNiagaraRenderer

Base class for Niagara System renderers.

Public class

FNiagaraRendererComponents

NiagaraRendererComponents renders an FNiagaraEmitterInstance as scene components

Public class

FNiagaraRendererFeedback

Public struct

FNiagaraRendererLayout

Used for building renderer layouts for vertex factories

Public class

FNiagaraRendererLights

NiagaraRendererLights renders an FNiagaraEmitterInstance as simple lights

Public class

FNiagaraRendererMeshes

NiagaraRendererSprites renders an FNiagaraEmitterInstance as sprite particles

Public class

FNiagaraRendererRibbons

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

Public class

FNiagaraRendererSprites

FNiagaraRendererSprites renders an FNiagaraEmitterInstance as sprite particles

Public struct

FNiagaraRendererVariableInfo

Mapping between a variable in the source dataset and the location we place it in the GPU buffer passed to the VF.

Public class

FNiagaraRHIUniformBufferLayout

Public struct UStruct

FNiagaraRibbonUVSettings

Defines settings for UV behavior for a UV channel on ribbons.

Public struct

FNiagaraRuntimeCycleCounter

Public struct UStruct

FNiagaraScalabilityManager

Public struct

FNiagaraScalabilityState

Public class

FNiagaraSceneProxy

Scene proxy for drawing niagara particle simulations.

Public struct

FNiagaraScopedRuntimeCycleCounter

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

FNiagaraScriptExecutionContextBase

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

FNiagaraScriptHighlight

Public struct UStruct

FNiagaraScriptInstanceParameterStore

FNiagaraScriptInstanceParameterStore .

Public struct UStruct

FNiagaraScriptVariableBinding

Primarily a wrapper around an FName to be used for customizations in the Selected Details panel to select a default binding to initialize module inputs.

Public class

FNiagaraSharedObject

Base class for objects in Niagara that are owned by one object but are then passed for reading to other objects, potentially on other threads.

Public struct

FNiagaraSimStageData

Public struct UStruct BlueprintType meta

FNiagaraSpawnInfo

Data controlling the spawning of particles

Public struct

FNiagaraStaticMeshData

Public struct UStruct

FNiagaraStatScope

Public class

FNiagaraSubmixListener

Copyright Epic Games, Inc. All Rights Reserved.

Public struct UStruct

FNiagaraSystemCompiledData

Public struct UStruct

FNiagaraSystemCompileRequest

Public class

FNiagaraSystemInstance

Public struct

FNiagaraSystemParameters

Any change to this structure, or it's GetVariables implementation will require a bump in the CustomNiagaraVersion so that we properly rebuild the scripts You must pad this struct and the results of GetVariables() to a 16 byte boundry.

Public struct UStruct

FNiagaraSystemScalabilityOverride

Public struct UStruct

FNiagaraSystemScalabilityOverrides

Container struct for an array of system scalability overrides.

Public struct UStruct

FNiagaraSystemScalabilitySettings

Scalability settings for Niagara Systems for a particular platform set (unless overridden).

Public struct UStruct

FNiagaraSystemScalabilitySettingsArray

Container struct for an array of system scalability settings.

Public struct

FNiagaraSystemScriptExecutionContext

Specialized exec context for system scripts.

Public class

FNiagaraSystemSimulation

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

Public struct

FNiagaraSystemSimulationTickContext

Public struct UStruct

FNiagaraSystemUpdateContext

Helper for reseting/reinitializing Niagara systems currently active when they are being edited.

Public struct UStruct

FNiagaraTypeDefinition

Public struct UStruct

FNiagaraTypeDefinitionHandle

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 UStruct

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

FNiagaraTypeUtilities

Helper methods for basic struct definitions

Public struct UStruct

FNiagaraUserParameterBinding

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

FNiagaraVariableBase

Public struct UStruct

FNiagaraVariableDataInterfaceBinding

Public struct UStruct

FNiagaraVariableInfo

Defines all you need to know about a variable.

Public struct UStruct

FNiagaraVariableLayoutInfo

Copyright Epic Games, Inc. All Rights Reserved.

Public struct UStruct

FNiagaraVariableMetaData

Public struct UStruct

FNiagaraVariableWithOffset

Public struct UStruct

FNiagaraVariant

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

FNiagaraWorldManagerTickFunction

Public class

FOnNiagaraSystemFinished

Called when the particle system is done.

Public struct

FParticleRenderData

Public struct

FPersistentAudioParticleData

Public struct

FRenderTarget2DArrayRWInstanceData_GameThread

Public struct

FRenderTarget2DArrayRWInstanceData_RenderThread

Public struct

FRenderTarget2DRWInstanceData_GameThread

Public struct

FRenderTarget2DRWInstanceData_RenderThread

Public struct

FRenderTargetVolumeRWInstanceData_GameThread

Public struct

FRenderTargetVolumeRWInstanceData_RenderThread

Public class

FScopedNiagaraDataSetGPUReadback

Allows immediate access to GPU data on the CPU, you can then use FNiagaraDataSetAccessor to access the data.

Public struct

FScriptExecutionConstantBufferTable

Public struct

FSkeletalMeshAccessorHelper

Public class

FSkeletalMeshGpuDynamicBufferProxy

This contains dynamic data created per frame from the DI.

Public class

FSkeletalMeshGpuSpawnStaticBuffers

This contains static data created once from the DI.

Public class

FSkeletalMeshInterfaceHelper

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

Helpers for accessing misc vertex data.

Public struct

FSkelMeshVertexAccessorNoop

Public struct

FSkinnedPositionAccessorHelper

Public struct

FStaticMeshFilteredAreaWeightedSectionSampler

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

Public class

FStaticMeshGpuSpawnBuffer

Used to stored GPU data needed for an interface/mesh tuple (e.g. uniform sampling of sections according to mesh surface area).

Public struct UStruct

FVMExternalFunctionBindingInfo

Public struct UStruct

FVMFunctionSpecifier

Public struct

INiagaraDataInterfaceArrayImpl

Public class

INiagaraEditorOnlyDataUtilities

Defines utility methods for creating editor only data which is stored on runtime objects.

Public class

INiagaraMergeManager

Public class

INiagaraModule

Niagara module interface

Public class

INiagaraParticleCallbackHandler

Public struct

MemoryRuntimeEstimation

Public class

NeighborGrid3DRWInstanceData

Store all data in in a class move all data management to use per instance data remove references to push data to render thread

Public class

NiagaraEmitterInstanceBatcher

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 vertex data format.

Public class UClass ClassGroup, ShowCategories, HideCategories, Meta editinlinenew

UNiagaraComponent

UNiagaraComponent is the primitive component for a Niagara System.

Public class UClass Transient

UNiagaraComponentPool

Public class UClass MinimalAPI Meta editinlinenew

UNiagaraComponentRendererProperties

Public class UClass Config defaultconfig

UNiagaraComponentSettings

Public class UClass Abstract

UNiagaraConvertInPlaceUtilityBase

Public class UClass Abstract editinlinenew

UNiagaraDataInterface

Base class for all Niagara data interfaces.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterface2DArrayTexture

Data Interface allowing sampling of a texture

Public class UClass Abstract editinlinenew

UNiagaraDataInterfaceArray

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceArrayBool

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceArrayColor

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceArrayFloat

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceArrayFloat2

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceArrayFloat3

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceArrayFloat4

Public class UClass

UNiagaraDataInterfaceArrayFunctionLibrary

C++ and Blueprint library for accessing array types

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceArrayInt32

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceArrayQuat

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceAudioOscilloscope

Data Interface allowing sampling of recent audio data.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceAudioPlayer

This Data Interface can be used to play one-shot audio effects driven by particle data.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceAudioSpectrum

Data Interface allowing sampling of recent audio spectrum.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceAudioSubmix

Data Interface allowing sampling of recent audio data.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceCamera

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

Copyright Epic Games, Inc. All Rights Reserved.

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

UNiagaraDataInterfaceExport

This Data Interface can be used to gather particles at execution time and call either a C++ or blueprint object with the gathered particle data each tick.

Public class UClass Abstract editinlinenew

UNiagaraDataInterfaceGrid2D

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceGrid2DCollection

Public class UClass Blueprintable, BlueprintType HideCategories, Meta category, editinlinenew

UNiagaraDataInterfaceGrid2DCollectionReader

#todo(dmp): base class has all the RW attributes, even though we only care about the attributes that query the grid. Cleaning this up would be great

Public class UClass Abstract editinlinenew

UNiagaraDataInterfaceGrid3D

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceGrid3DCollection

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceLandscape

Data Interface allowing sampling of a Landscape

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceNeighborGrid3D

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceOcclusion

Copyright Epic Games, Inc. All Rights Reserved.

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfaceParticleRead

Public class UClass Meta category, editinlinenew

UNiagaraDataInterfacePlatformSet

Copyright Epic Games, Inc. All Rights Reserved.

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceRenderTarget2D

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceRenderTarget2DArray

Public class UClass Blueprintable, BlueprintType Meta category, editinlinenew

UNiagaraDataInterfaceRenderTargetVolume

Public class UClass Abstract editinlinenew

UNiagaraDataInterfaceRWBase

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 skeletal 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

Copyright Epic Games, Inc. All Rights Reserved.

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 Meta category, editinlinenew

UNiagaraDataInterfaceVolumeTexture

Data Interface allowing sampling of a texture

Public class UClass MinimalAPI

UNiagaraEditorDataBase

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

Public class UClass

UNiagaraEffectType

Contains settings and working data shared among many NiagaraSystems that share some commonality of type.

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 MinimalAPI Meta editinlinenew

UNiagaraLightRendererProperties

Public class UClass Meta editinlinenew

UNiagaraMeshRendererProperties

Public class UClass

UNiagaraMessageDataBase

Public class UClass

UNiagaraParameterCollection

Asset containing a collection of global parameters usable by Niagara.

Public class UClass

UNiagaraParameterCollectionInstance

Public class

UNiagaraParticleCallbackHandler

Public class UClass Abstract Blueprintable, BlueprintType editinlinenew

UNiagaraPreviewAxis

Base class for all preview axis types.

Public class UClass Abstract Blueprintable, BlueprintType editinlinenew

UNiagaraPreviewAxis_InterpParamBase

Public class UClass Blueprintable, BlueprintType editinlinenew

UNiagaraPreviewAxis_InterpParamFloat

Public class UClass Blueprintable, BlueprintType editinlinenew

UNiagaraPreviewAxis_InterpParamInt32

Public class UClass Blueprintable, BlueprintType editinlinenew

UNiagaraPreviewAxis_InterpParamLinearColor

Public class UClass Blueprintable, BlueprintType editinlinenew

UNiagaraPreviewAxis_InterpParamVector

Public class UClass Blueprintable, BlueprintType editinlinenew

UNiagaraPreviewAxis_InterpParamVector2D

Public class UClass Blueprintable, BlueprintType editinlinenew

UNiagaraPreviewAxis_InterpParamVector4

Public class UClass Abstract

UNiagaraRendererProperties

Emitter properties base class Each EmitterRenderer derives from this with its own class, and returns it in GetProperties; a copy of those specific properties is stored on UNiagaraEmitter (on the System) for serialization and handed back to the System renderer on load.

Public class UClass Meta 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 Abstract editinlinenew

UNiagaraSignificanceHandler

Base class for significance handlers.

Public class UClass Meta editinlinenew

UNiagaraSignificanceHandlerAge

Significance is determined by the system's age. Newer systems are more significant.

Public class UClass Meta editinlinenew

UNiagaraSignificanceHandlerDistance

Significance is determined by the system's distance to the nearest camera.

Public class UClass

UNiagaraSimulationStageBase

A base class for niagara simulation stages.

Public class UClass Meta

UNiagaraSimulationStageGeneric

Public class UClass Meta editinlinenew

UNiagaraSpriteRendererProperties

Public class UClass BlueprintType

UNiagaraSystem

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

Typedefs

Enums

Name

Description

Public enum UEnum

ENCPoolMethod

Public enum UEnum

ENDIExport_GPUAllocationMode

Public enum

ENDISkeletalMesh_FilterMode

Public enum UEnum

ENDISkeletalMesh_SkinningMode

Public enum UEnum

ENDISkeletalMesh_SourceMode

Public enum

ENDISkelMesh_AreaWeightingMode

Public enum UEnum

ENDIStaticMesh_SourceMode

Public enum UEnum

ENiagaraAgeUpdateMode

Defines modes for updating the component's age.

Public enum

ENiagaraBaseTypes

Public enum UEnum

ENiagaraBindingSource

Public enum UEnum

ENiagaraCollisionMode

Public enum UEnum

ENiagaraCompileUsageStaticSwitch

Defines different usages for a niagara script.

Public enum UEnum

ENiagaraCullReaction

Controls what action is taken by a Niagara system that fails it's cull checks.

Public enum UEnum

ENiagaraDataSetType

Public enum UEnum

ENiagaraDefaultMode

TODO: Custom will eventually mean that the default value or binding will be overridden by a subgraph default, i.e. expose it to a "Initialize variable" node.

Public enum UEnum

ENiagaraExecutionState

Public enum UEnum

ENiagaraExecutionStateSource

The source from which a script execution state was set.

Public enum UEnum

ENiagaraGpuBufferFormat

Niagara supported buffer formats on the GPU.

Public enum

ENiagaraGPUTickHandlingMode

Public enum UEnum

ENiagaraInputNodeUsage

Public enum UEnum

ENiagaraIterationSource

Public enum UEnum

ENiagaraLegacyTrailWidthMode

Controls the way that the width scale property affects animation trails.

Public enum UEnum

ENiagaraMeshFacingMode

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

Public enum UEnum

ENiagaraMeshLockedAxisSpace

Public enum UEnum

ENiagaraMeshPivotOffsetSpace

Public enum

ENiagaraMeshVFLayout::Type

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

ENiagaraParameterPanelCategory

Public enum UEnum

ENiagaraParameterScope

Public enum UEnum

ENiagaraPlatformSelectionState

Public enum UEnum

ENiagaraPlatformSetState

Public enum UEnum

ENiagaraPreviewGridResetMode

Public enum UEnum

ENiagaraRendererSourceDataMode

This enum decides how a renderer will attempt to process the incoming data from the stack.

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

ENiagaraRibbonTessellationMode

Public enum UEnum

ENiagaraRibbonUVDistributionMode

Specifies options for distributing UV values across ribbon segments.

Public enum UEnum

ENiagaraRibbonUVEdgeMode

Specifies options for handling UVs at the leading and trailing edges of ribbons.

Public enum

ENiagaraRibbonVFLayout::Type

Public enum UEnum

ENiagaraScalabilityUpdateFrequency

Controls how often should we update scalability states for these effects.

Public enum UEnum

ENiagaraScriptCompileStatus

Enumerates states a Niagara script can be in.

Public enum UEnum

ENiagaraScriptContextStaticSwitch

Defines different execution contexts for a niagara script.

Public enum UEnum

ENiagaraScriptGroup

Public enum UEnum

ENiagaraScriptLibraryVisibility

Public enum UEnum

ENiagaraScriptParameterUsage

Public enum UEnum

ENiagaraScriptUsage

Defines different usages for a niagara script.

Public enum

ENiagaraScriptUsageMask::Type

Defines common bit masks for script usage

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

ENiagaraSpriteVFLayout::Type

Public enum UEnum

ENiagaraStatDisplayMode

Public enum UEnum

ENiagaraStatEvaluationType

Public enum

ENiagaraSystemSimulationScript

All scripts that will use the system script execution context.

Public enum UEnum

ENiagaraTickBehavior

Niagara ticking behaviour

Public enum UEnum

ENiagaraVariantMode

Public enum UEnum

EParticleAllocationMode

Public enum UEnum

EScriptExecutionMode

Public enum UEnum

ESetResolutionMethod

Public enum

ETickStage

Public enum UEnum

EUnusedAttributeBehaviour

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

Functions

Name Description

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

T

 

BarycentricInterpolate

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

Public function

bool

 

FNiagaraUtilities::AllowComputeShaders

(
    EShaderPlatform ShaderPlatform
)

Whether compute shaders are allowed. Could change depending on config and runtime switches.

Public function

bool

 

FNiagaraUtilities::AllowGPUParticles

(
    EShaderPlatform ShaderPlatform
)

Whether GPU particles are currently allowed. Could change depending on config and runtime switches.

Public function

EPixelFormat

 

FNiagaraUtilities::BufferFormatToPixelFormat

(
    ENiagaraGpuBufferFormat NiagaraForm...
)

Converts a Niagara format into a EPixelFormat

Public function

ETextureRend ...

 

FNiagaraUtilities::BufferFormatToRenderTargetFormat

(
    ENiagaraGpuBufferFormat NiagaraForm...
)

Converts a Niagara format into a ETextureRenderTargetFormat

Public function

void

 

FNiagaraUtilities::CollectScriptDataInterfaceParameters

(
    const UObject & Owner,
    const TArrayView < UNiagaraScript &#...,
    FNiagaraParameterStore & OutDataInt...
)

Public function

ENiagaraScri ...

 

FNiagaraUtilities::ConvertScriptUsageToStaticSwitchContext

(
    ENiagaraScriptUsage ScriptUsage
)

Public function

ENiagaraComp ...

 

FNiagaraUtilities::ConvertScriptUsageToStaticSwitchUsage

(
    ENiagaraScriptUsage ScriptUsage
)

Public function

FNiagaraVari ...

 

FNiagaraUtilities::ConvertVariableToRapidIterationConstantName

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

Public function

void

 

FNiagaraUtilities::DumpHLSLText

(
    const FString & SourceCode,
    const FString & DebugName
)

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 *, c...
)

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

(
    EShaderPlatform ShaderPlatform
)

Whether the platform supports GPU particles. A static function that doesn't not rely on any runtime switches.

Public function

bool

 

FNiagaraUtilities::SupportsNiagaraRendering

(
    EShaderPlatform ShaderPlatform
)

Public function

bool

 

FNiagaraUtilities::SupportsNiagaraRendering

(
    ERHIFeatureLevel::Type FeatureLevel
)

Public function

FString

 

FNiagaraUtilities::SystemInstanceIDToString

Public function

uint32

 

GetTypeHash

(
    const FNiagaraTypeDefinition & Type
)

Public function

uint32

 

GetTypeHash

(
    const FNiagaraDrawIndirectArgGenTas ...
)

Public function

uint32

 

GetTypeHash

(
    const FNiagaraDataSetID & Var
)

Public function

uint32

 

GetTypeHash

(
    const FNiagaraEmitterNameSettingsRe ...
)

Public function

uint32

 

GetTypeHash

(
    const FNiagaraID & ID
)

Public function

uint32

 

GetTypeHash

(
    const FNiagaraVariableBase & Var
)

Public function

FVector

 

RandomBarycentricCoord

(
    FRandomStream & RandStream
)

Variables

Name Description

Public variable

const FName

 

CellSizeFunctionName

Public variable

const FString

 

CellSizeName

Public variable

const FName

 

ExecutionIndexToGridIndexFunctionName

Public variable

const FName

 

ExecutionIndexToUnitFunctionName

Public variable

int32

 

GbEnableMinimalGPUBuffers

Public variable

int32

 

GEnableNiagaraRuntimeCycleCounts

Public variable

int32

 

GEnableVerboseNiagaraChangeIdLogging

Public variable

float

 

GLastRenderTimeSafetyBias

Safety time to allow for the LastRenderTime coming back from the RT.

Public variable

int32

 

GNiagaraQualityLevel

Public variable

TGlobalResource ...

 

GNiagaraViewDataManager

Public variable

const FName

 

IndexToLinearFunctionName

Public variable

const FName

 

IndexToUnitFunctionName

Public variable

const FName

 

IndexToUnitStaggeredXFunctionName

Public variable

const FName

 

IndexToUnitStaggeredYFunctionName

Public variable

const FName

 

LinearToIndexFunctionName

Public variable

constexpr uint3 ...

 

NIAGARA_MAX_GPU_SPAWN_INFOS

The maximum number of spawn infos we can run on the GPU, modifying this will require a version update as it is used in the shader compiler

Public variable

constexpr uint3 ...

 

NiagaraComputeMaxThreadGroupSize

Defines The maximum ThreadGroup size we allow in Niagara.

Public variable

constexpr ETick ...

 

NiagaraFirstTickGroup

TickGroup information for Niagara.

Public variable

constexpr ETick ...

 

NiagaraLastTickGroup

Public variable

constexpr uint3 ...

 

NiagaraMaxThreadGroupCountPerDimension

Defines The maximum Thread Group Count Per Dimension.

Public variable

constexpr int

 

NiagaraNumTickGroups

Public variable

const FString

 

NumAttributesName

Global HLSL variable base names, used by HLSL.

Public variable

const FName

 

NumCellsFunctionName

Global VM function names, also used by the shaders code generation methods.

Public variable

const FString

 

NumCellsName

Public variable

const FName

 

SimulationToUnitFunctionName

Public variable

 

STATCAT_Advanced

Public variable

const FName

 

UnitToFloatIndexFunctionName

Public variable

const FName

 

UnitToIndexFunctionName

Public variable

const FName

 

UnitToSimulationFunctionName

Public variable

const FName

 

WorldBBoxSizeFunctionName

Public variable

const FString

 

WorldBBoxSizeName

Select Skin
Light
Dark

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