Navigation
| Name | Niagara |
| Type | Plugin |
| Part of Plugins | Niagara |
| Location | /Engine/Plugins/FX/Niagara/Source/Niagara/ |
| Module Build Rules | Niagara.Build.cs |
Classes
| Name | Remarks |
|---|---|
| ANiagaraActor | |
| ANiagaraLensEffectBase | Niagara equivalent of AEmitterCameraLensEffectBase. |
| ANiagaraPerfBaselineActor | Actor that controls how the baseline system behaves and also controls stats gathering for. |
| ANiagaraPreviewBase | Base actor for preview actors used in UNiagaraPreviewAxis. |
| ANiagaraPreviewGrid | |
| FNDI_GeneratedData | |
| FNDI_SharedResourceHandle | |
| FNDI_SharedResourceUsage | |
| FNDI_SkeletalMesh_GeneratedData | |
| FNDIGpuComputeDispatchArgsGenParameters | |
| FNiagaraActiveCompilation | |
| FNiagaraActorSceneComponentUtils | Implementation for AActor & UActorComponents. |
| FNiagaraBoundsCalculator | |
| FNiagaraCompileOptions | |
| FNiagaraCompileRequestDataBase | External reference to the compile request data generated. |
| FNiagaraCompileRequestDuplicateDataBase | External reference to the compile request data generated. |
| FNiagaraCrashReporterScope | |
| FNiagaraDataBuffer | Buffer containing one frame of Niagara simulation data. |
| FNiagaraDataBufferReadback | |
| FNiagaraDataInterfaceError | |
| FNiagaraDataInterfaceFeedback | |
| FNiagaraDataSet | General storage class for all per instance simulation data in Niagara. |
| FNiagaraDataSetReadback | |
| FNiagaraDeferredMethodQueue | This class is used to defer the execution of object methods that would otherwise be executing at an unsafe point, due to concurrent processing. |
| FNiagaraDICollisionQueryBatch | |
| FNiagaraEmitterInstance | Base class for different emitter instances |
| FNiagaraEmptyUAVPool | Empty UAV pool used for ensuring we bind a buffer when one does not exist. |
| FNiagaraGpuComputeDataManager | Abstract class for managing GPU data for Niagara. |
| FNiagaraGpuComputeDebugInterface | |
| FNiagaraGpuComputeDispatchInterface | Public API for Niagara's Compute Dispatcher This is generally used with DataInterfaces or Custom Renderers |
| FNiagaraGPUInstanceCountManager | A manager that handles the buffer containing the GPU particle count. |
| FNiagaraGpuReadbackManager | |
| FNiagaraGPURendererCount | The number of GPU renderers registered in the instance count manager. |
| FNiagaraGPUSystemTick | Represents all the information needed to dispatch a single tick of a FNiagaraSystemInstance. |
| FNiagaraOpInOutInfo | Information about an input or output of a Niagara operation node. |
| FNiagaraRenderer | Base class for Niagara System renderers. |
| FNiagaraRendererComponents | NiagaraRendererComponents renders an FNiagaraEmitterInstance as scene components |
| FNiagaraRendererDecals | |
| FNiagaraRendererFeedback | |
| FNiagaraRendererLights | NiagaraRendererLights renders an FNiagaraEmitterInstance as simple lights |
| FNiagaraRendererMeshes | NiagaraRendererSprites renders an FNiagaraEmitterInstance as sprite particles |
| FNiagaraRendererRibbons | NiagaraRendererRibbons renders an FNiagaraEmitterInstance as a ribbon connecting all particles in order by particle age. |
| FNiagaraRendererSprites | FNiagaraRendererSprites renders an FNiagaraEmitterInstance as sprite particles |
| FNiagaraRendererVolumes | |
| FNiagaraRHIUniformBufferLayout | |
| FNiagaraSceneProxy | Scene proxy for drawing niagara particle simulations. |
| 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. |
| FNiagaraSimCacheCapture | |
| FNiagaraSubmixListener | |
| FNiagaraSystemGpuComputeProxy | |
| FNiagaraSystemInstance | |
| FNiagaraSystemInstanceController | This is the main asynchronous interface for controlling operation of a single instance of a Niagara System. |
| FNiagaraSystemInstanceFixLayout | Hacky base class to avoid 8 bytes of padding after the vtable. |
| FNiagaraSystemRenderData | This class wraps all data and functionality needed by a scene render proxy to render a single Niagara System Instance. |
| FNiagaraSystemSimulation | Simulation performing all system and emitter scripts for a instances of a UNiagaraSystem in a world. |
| 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) |
| 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 |
| FNiagaraTypeRegistryTLSProxy | Helper class to trigger access to a TLS of NiagaraTypeDefinition. |
| FNiagaraVersionedObject | |
| FNiagaraWorldManager | Manager class for any data relating to a particular world. |
| FOnNewNiagaraDataChannelPublish | |
| FOnNiagaraSystemFinished | Called when the particle system is done. |
| FScopedNiagaraDataSetGPUReadback | Allows immediate access to GPU data on the CPU, you can then use FNiagaraDataSetAccessor to access the data. |
| FSkeletalMeshGpuDynamicBufferProxy | This contains dynamic data created per frame from the DI. |
| FSkeletalMeshGpuSpawnStaticBuffers | This contains static data created once from the DI. |
| FSkeletalMeshInterfaceHelper | |
| FVolumeCacheData | |
| RasterizationGrid3DRWInstanceData | Store all data in in a class move all data management to use per instance data remove references to push data to render thread |
| UAsyncNiagaraCaptureSimCache | |
| UMovieSceneNiagaraBoolParameterTrack | A track for animating boolean niagara parameters. |
| UMovieSceneNiagaraColorParameterTrack | A track for animating color niagara parameters. |
| UMovieSceneNiagaraFloatParameterTrack | A track for animating float niagara parameters. |
| UMovieSceneNiagaraIntegerParameterTrack | A track for animating integer niagara parameters. |
| UMovieSceneNiagaraParameterTrack | A base class for tracks that animate niagara parameters. |
| UMovieSceneNiagaraSystemSpawnSection | |
| UMovieSceneNiagaraSystemTrack | |
| UMovieSceneNiagaraTrack | |
| UMovieSceneNiagaraVectorParameterTrack | A track for animating float niagara parameters. |
| UNDIArraySimCacheData | |
| UNDILandscapeSimCacheData | |
| UNiagaraAssetTagDefinitions | An Asset Tag Definition defines a tag that can be added to various Niagara assets for sorting & filtering purposes. |
| UNiagaraBakerOutput | |
| UNiagaraBakerOutputSimCache | |
| UNiagaraBakerOutputSparseVolumeTexture | |
| UNiagaraBakerOutputStaticMesh | |
| UNiagaraBakerOutputTexture2D | |
| UNiagaraBakerOutputVolumeTexture | |
| UNiagaraBakerSettings | |
| UNiagaraBaselineController | Base class for baseline controllers. |
| UNiagaraBaselineController_Basic | Simple controller that will just spawn the given system N times. |
| UNiagaraComponent | UNiagaraComponent is the primitive component for a Niagara System. |
| UNiagaraComponentPool | |
| UNiagaraComponentRendererProperties | |
| UNiagaraConvertInPlaceUtilityBase | |
| UNiagaraCullProxyComponent | A specialization of UNiagaraComponent that can act as a proxy for many other NiagaraComponents that have been culled by scalability. |
| UNiagaraDataChannel | |
| UNiagaraDataChannel_Global | Simple DataChannel handler that makes all data visible globally. |
| UNiagaraDataChannel_Islands | Data channel that will automatically sub-divide the world into discreet "islands" based on location. |
| UNiagaraDataChannelAsset | Niagara Data Channels are a system for communication between Niagara Systems and with game code/Blueprint. |
| UNiagaraDataChannelHandler | |
| UNiagaraDataChannelHandler_Global | Basic DataChannel handler that makes all data visible globally. |
| UNiagaraDataChannelHandler_Islands | |
| UNiagaraDataChannelLibrary | A C++ and Blueprint accessible library of utility functions for accessing Niagara DataChannel |
| UNiagaraDataChannelReader | Initial simple API for reading and writing data in a data channel from game code / BP. |
| UNiagaraDataChannelWriter | |
| UNiagaraDataInterface | Base class for all Niagara data interfaces. |
| UNiagaraDataInterface2DArrayTexture | Data Interface allowing sampling of a texture |
| UNiagaraDataInterfaceArray | |
| UNiagaraDataInterfaceArrayBool | |
| UNiagaraDataInterfaceArrayColor | |
| UNiagaraDataInterfaceArrayFloat | |
| UNiagaraDataInterfaceArrayFloat2 | |
| UNiagaraDataInterfaceArrayFloat3 | |
| UNiagaraDataInterfaceArrayFloat4 | |
| UNiagaraDataInterfaceArrayFunctionLibrary | C++ and Blueprint library for accessing array types |
| UNiagaraDataInterfaceArrayInt32 | |
| UNiagaraDataInterfaceArrayMatrix | |
| UNiagaraDataInterfaceArrayNiagaraID | |
| UNiagaraDataInterfaceArrayPosition | |
| UNiagaraDataInterfaceArrayQuat | |
| UNiagaraDataInterfaceArrayUInt8 | |
| UNiagaraDataInterfaceAsyncGpuTrace | Data interface for handling latent (delayed 1 frame) traces against the scene for GPU simulations. |
| UNiagaraDataInterfaceAudioOscilloscope | Data Interface allowing sampling of recent audio data. |
| UNiagaraDataInterfaceAudioPlayer | This Data Interface can be used to play one-shot audio effects driven by particle data. |
| UNiagaraDataInterfaceAudioPlayerSettings | |
| UNiagaraDataInterfaceAudioSpectrum | Data Interface allowing sampling of recent audio spectrum. |
| UNiagaraDataInterfaceAudioSubmix | Data Interface allowing sampling of recent audio data. |
| UNiagaraDataInterfaceCamera | |
| UNiagaraDataInterfaceCollisionQuery | Data Interface that can be used to query collision related data, like geometry traces or sampling the depth buffer. |
| UNiagaraDataInterfaceColorCurve | Data Interface allowing sampling of color curves. |
| UNiagaraDataInterfaceCubeTexture | Data Interface allowing sampling of a texture |
| UNiagaraDataInterfaceCurlNoise | Data Interface allowing sampling of curl noise LUT. |
| UNiagaraDataInterfaceCurve | |
| UNiagaraDataInterfaceCurveBase | |
| 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. |
| UNiagaraDataInterfaceGrid2D | |
| UNiagaraDataInterfaceGrid2DCollection | |
| UNiagaraDataInterfaceGrid2DCollectionReader | |
| UNiagaraDataInterfaceGrid3D | |
| UNiagaraDataInterfaceGrid3DCollection | |
| UNiagaraDataInterfaceGrid3DCollectionReader | |
| UNiagaraDataInterfaceIntRenderTarget2D | |
| UNiagaraDataInterfaceLandscape | Data Interface allowing sampling of a Landscape |
| UNiagaraDataInterfaceMeshRendererInfo | This Data Interface can be used to query information about the mesh renderers of an emitter |
| UNiagaraDataInterfaceNeighborGrid3D | |
| UNiagaraDataInterfaceOcclusion | |
| UNiagaraDataInterfaceParticleRead | |
| UNiagaraDataInterfacePhysicsAsset | Data Interface for interacting with PhysicsAssets |
| UNiagaraDataInterfacePlatformSet | |
| UNiagaraDataInterfaceRasterizationGrid3D | |
| UNiagaraDataInterfaceRenderTarget2D | |
| UNiagaraDataInterfaceRenderTarget2DArray | |
| UNiagaraDataInterfaceRenderTargetCube | |
| UNiagaraDataInterfaceRenderTargetVolume | |
| UNiagaraDataInterfaceRigidMeshCollisionQuery | Data Interface used to collide against static meshes - whether it is the mesh distance field or a physics asset's collision primitive |
| UNiagaraDataInterfaceRWBase | |
| UNiagaraDataInterfaceSkeletalMesh | Data Interface allowing sampling of skeletal meshes. |
| UNiagaraDataInterfaceSparseVolumeTexture | Data Interface allowing sampling of a sparse volume texture |
| UNiagaraDataInterfaceSpline | Data Interface allowing sampling of in-world spline components. |
| UNiagaraDataInterfaceSpriteRendererInfo | This Data Interface can be used to query information about the sprite renderers of an emitter |
| UNiagaraDataInterfaceTexture | Data Interface allowing sampling of a texture |
| UNiagaraDataInterfaceVector2DCurve | |
| UNiagaraDataInterfaceVector4Curve | Data Interface allowing sampling of vector curves. |
| UNiagaraDataInterfaceVectorCurve | Data Interface allowing sampling of vector curves. |
| UNiagaraDataInterfaceVectorField | |
| UNiagaraDataInterfaceVolumeCache | |
| UNiagaraDataInterfaceVolumeTexture | Data Interface allowing sampling of a texture |
| UNiagaraDebugHUDSettings | |
| UNiagaraDecalRendererProperties | |
| UNiagaraDIRigidMeshCollisionFunctionLibrary | C++ and Blueprint library for accessing array types |
| UNiagaraEditorDataBase | A base class for editor only data which supports post loading from the runtime owner object. |
| UNiagaraEditorParametersAdapterBase | A base class for editor only data which owns UNiagaraScriptVariables and supports synchronizing them with definitions. |
| UNiagaraEffectType | Contains settings and working data shared among many Niagara systems that share some commonality of type, for example ImpactFX vs EnvironmentalFX. |
| UNiagaraEmitter | Niagara Emitters are particle spawners that can be reused for different effects by putting them into Niagara systems. |
| UNiagaraEventReceiverEmitterAction | Base class for actions that an event receiver will perform at the emitter level. |
| UNiagaraEventReceiverEmitterAction_SpawnParticles | |
| 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. |
| UNiagaraLightRendererProperties | |
| UNiagaraMeshRendererProperties | |
| UNiagaraMessageDataBase | |
| UNiagaraParameterCollection | Asset containing a collection of global parameters usable by Niagara. |
| UNiagaraParameterCollectionInstance | Can be used to override selected parameters from a Niagara parameter collection with another value. |
| UNiagaraParameterDefinitionsBase | Stub class. Collection of UNiagaraScriptVariables to synchronize between UNiagaraScripts. |
| UNiagaraParticleCallbackHandler | |
| UNiagaraPhysicsAssetDICollectorInterface | |
| UNiagaraPreviewAxis | Base class for all preview axis types. |
| UNiagaraPreviewAxis_InterpParamBase | |
| UNiagaraPreviewAxis_InterpParamFloat | |
| UNiagaraPreviewAxis_InterpParamInt32 | |
| UNiagaraPreviewAxis_InterpParamLinearColor | |
| UNiagaraPreviewAxis_InterpParamVector | |
| UNiagaraPreviewAxis_InterpParamVector2D | |
| UNiagaraPreviewAxis_InterpParamVector4 | |
| UNiagaraRenderableMeshArrayInterface | |
| UNiagaraRenderableMeshInterface | Interface for UObjects to implement renderable mesh. |
| 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. |
| UNiagaraRibbonRendererProperties | |
| UNiagaraScratchPadContainer | Wrapper class for scratch pad scripts in an emitter. |
| UNiagaraScript | Scripts are function graphs that define the runtime execution for a Niagara system (similar to a Blueprint). |
| UNiagaraScriptSourceBase | Runtime data for a Niagara system |
| UNiagaraSettings | |
| UNiagaraSignificanceHandler | Base class for significance handlers. |
| UNiagaraSignificanceHandlerAge | Significance is determined by the system's age. Newer systems are more significant. |
| UNiagaraSignificanceHandlerDistance | Significance is determined by the system's distance to the nearest camera. |
| UNiagaraSimCache | Recording of multiple frames of simulation data from a running Niagara system. |
| UNiagaraSimCacheCustomStorageInterface | Interface for UObjects to implement renderable mesh. |
| UNiagaraSimCacheFunctionLibrary | |
| UNiagaraSimulationStageBase | A base class for niagara simulation stages. |
| UNiagaraSimulationStageGeneric | |
| UNiagaraSpriteRendererProperties | |
| UNiagaraSystem | A Niagara System contains multiple Niagara Emitters to create various effects. |
| UNiagaraValidationRule | Base class for system validation logic. |
| UNiagaraValidationRuleSet | A set of reusable validation rules to check Niagara System assets. |
| UNiagaraVolumeRendererProperties | |
| UVolumeCache |
Structs
Interfaces
| Name | Remarks |
|---|---|
| INiagaraDebuggerClient | |
| INiagaraEditorOnlyDataUtilities | Defines utility methods for creating editor only data which is stored on runtime objects. |
| INiagaraMergeManager | |
| INiagaraModule | Niagara module interface |
| INiagaraParameterDefinitionsSubscriber | Interface for classes which subscribe to parameter definitions. |
| INiagaraParticleCallbackHandler | |
| INiagaraPhysicsAssetDICollectorInterface | |
| INiagaraRenderableMesh | Abstact class that for a renderable mesh While Niagara holds a reference to one of these it is expected that the data will exist |
| INiagaraRenderableMeshArrayInterface | Interface defintion for UObjects. |
| INiagaraRenderableMeshInterface | Interface defintion for UObjects. |
| INiagaraSceneComponentUtils | Helper class to abstract how we need to search the scene for components in various data interfaces This is temporary until scene graph is folded into the core engine, or we have more official APIs to abstract Actors/Entity/Desc DO NOT USE THIS IN EXTERNAL CODE as it is subject to change |
| INiagaraSimCacheCustomStorageInterface | The current API for storing data inside a simulation cache. |
| INiagaraVerseReflectionUtilities |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FGrid2DBuffer | FNiagaraPooledRWTexture | NiagaraDataInterfaceGrid2DCollection.h | |
| FGrid3DBuffer | FNiagaraPooledRWTexture | NiagaraDataInterfaceGrid3DCollection.h | |
| FNDICpuPostStageContext | FNDICpuPrePostStageContext | NiagaraDataInterface.h | |
| FNDICpuPreStageContext | FNDICpuPrePostStageContext | NiagaraDataInterface.h | |
| FNDIRandomHelper | TNDIRandomHelper< FNDIRandomInfoPolicy > | NiagaraDataInterface.h | |
| FNDIRandomHelperFromStream | TNDIRandomHelper< FNDIRandomStreamPolicy > | NiagaraDataInterface.h | |
| FNiagaraBoundParameterArray | TArray< FNiagaraBoundParameter > | NiagaraParameterStore.h | |
| FNiagaraCompilationTaskHandle | int32 | NiagaraCompilationTypes.h | |
| FNiagaraDataBufferRef | TRefCountPtr< FNiagaraDataBuffer > | NiagaraCommon.h | |
| FNiagaraDataChannelDataProxyPtr | TSharedPtr< struct FNiagaraDataChannelDataProxy > | NiagaraGpuComputeDispatchInterface.h | |
| FNiagaraDataChannelDataProxyPtr | TSharedPtr< struct FNiagaraDataChannelDataProxy > | NiagaraDataChannelCommon.h | |
| FNiagaraDataChannelDataProxyPtr | TSharedPtr< struct FNiagaraDataChannelDataProxy > | NiagaraDataChannel.h | |
| FNiagaraDataChannelDataPtr | TSharedPtr< FNiagaraDataChannelData > | NiagaraDataChannelPublic.h | |
| FNiagaraDataChannelGameDataPtr | TSharedPtr< FNiagaraDataChannelGameData > | NiagaraDataChannelPublic.h | |
| FNiagaraDataChannelLayoutInfoPtr | TSharedPtr< FNiagaraDataChannelLayoutInfo > | NiagaraDataChannelPublic.h | |
| FNiagaraDataChannelLayoutInfoPtr | TSharedPtr< FNiagaraDataChannelLayoutInfo > | NiagaraDataChannel.h | |
| FNiagaraDataInterfaceFix | TBaseDelegate_NoParams< bool > | Helper class for GUI error handling. | NiagaraDataInterface.h |
| FNiagaraDataInterfaceProxySkeletalMeshData | FNiagaraDISkeletalMeshPassedDataToRT | NiagaraDataInterfaceSkeletalMesh.h | |
| FNiagaraEmitterInstancePtr | TSharedPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > | NiagaraEmitterInstance.h | |
| FNiagaraEmitterInstanceRef | TSharedRef< FNiagaraEmitterInstance, ESPMode::ThreadSafe > | NiagaraEmitterInstance.h | |
| FNiagaraMaterialAndScaleArray | TArray< FNiagaraMaterialAndScale, TInlineAllocator< 16 > > | NiagaraSystemInstanceController.h | |
| FNiagaraRenderableMeshPtr | TSharedPtr< INiagaraRenderableMesh, ESPMode::ThreadSafe > | NiagaraRenderableMeshInterface.h | |
| FNiagaraRendererFeedbackFix | TBaseDelegate_NoParams< void > | Helper class for GUI error handling. | NiagaraRendererProperties.h |
| FNiagaraScriptAsyncOptimizeTaskStatePtr | TSharedPtr< FNiagaraScriptAsyncOptimizeTaskState, ESPMode::ThreadSafe > | NiagaraScript.h | |
| FNiagaraShaderMapRef | TRefCountPtr< FNiagaraShaderMap > | NiagaraCommon.h | |
| FNiagaraSimStageExecutionDataPtr | TSharedPtr< FNiagaraSimStageExecutionData > | NiagaraSimStageExecutionData.h | |
| FNiagaraStatelessRangeColor | FNiagaraStatelessRange< FLinearColor > | Stateless/NiagaraStatelessRange.h | |
| FNiagaraStatelessRangeFloat | FNiagaraStatelessRange< float > | Stateless/NiagaraStatelessRange.h | |
| FNiagaraStatelessRangeInt | FNiagaraStatelessRange< int32 > | Stateless/NiagaraStatelessRange.h | |
| FNiagaraStatelessRangeVector2 | FNiagaraStatelessRange< FVector2f > | Stateless/NiagaraStatelessRange.h | |
| FNiagaraStatelessRangeVector3 | FNiagaraStatelessRange< FVector3f > | Stateless/NiagaraStatelessRange.h | |
| FNiagaraStatelessRangeVector4 | FNiagaraStatelessRange< FVector4f > | Stateless/NiagaraStatelessRange.h | |
| FNiagaraSystemInstanceControllerConstPtr | TSharedPtr< const FNiagaraSystemInstanceController, ESPMode::ThreadSafe > | NiagaraSceneProxy.h | |
| FNiagaraSystemInstanceControllerConstPtr | TSharedPtr< const FNiagaraSystemInstanceController, ESPMode::ThreadSafe > | NiagaraSystemInstanceController.h | |
| FNiagaraSystemInstanceControllerConstPtr | TSharedPtr< const FNiagaraSystemInstanceController, ESPMode::ThreadSafe > | NiagaraComponent.h | |
| FNiagaraSystemInstanceControllerPtr | TSharedPtr< FNiagaraSystemInstanceController, ESPMode::ThreadSafe > | NiagaraSystemInstanceController.h | |
| FNiagaraSystemInstanceControllerPtr | TSharedPtr< FNiagaraSystemInstanceController, ESPMode::ThreadSafe > | NiagaraComponent.h | |
| FNiagaraSystemInstancePtr | TSharedPtr< FNiagaraSystemInstance, ESPMode::ThreadSafe > | NiagaraSystemInstance.h | |
| FNiagaraSystemSimulationPtr | TSharedPtr< FNiagaraSystemSimulation, ESPMode::ThreadSafe > | NiagaraSystemSimulation.h | |
| FNiagaraSystemSimulationRef | TSharedRef< FNiagaraSystemSimulation, ESPMode::ThreadSafe > | NiagaraWorldManager.h | |
| FNiagaraSystemTickBatch | TArray< FNiagaraSystemInstance *, TInlineAllocator< 4 > > | NiagaraSystemSimulation.h | |
| FNiagaraValidationFixDelegate | TBaseDelegate_NoParams< void > | NiagaraValidationRule.h | |
| FOnDataChannelCreated | TMulticastDelegate_OneParam< void, const UNiagaraDataChannel * > | NiagaraDataChannel.h | |
| FOnNiagaraDebuggerClientOutlinerCapture | TBaseDelegate_OneParam< void, const FNiagaraOutlinerData & > | NiagaraDebuggerCommon.h | |
| FOnNiagaraDebuggerClientSimCacheCapture | TBaseDelegate_TwoParams< void, const FNiagaraSystemSimCacheCaptureRequest &, TObjectPtr< UNiagaraSimCache > > | Temporary interface allowing direct access to the local debugger client until we can get a unified messaging system that works in all required cases. i.e. when WITH_UNREAL_TARGET_DEVELOPER_TOOLS = 0 and/or we don't have assess to the messaging or sessions systems. | NiagaraDebuggerCommon.h |
| FOnSubscribedParameterDefinitionsChanged | TMulticastDelegate_NoParams< void > | NiagaraParameterDefinitionsDelegates.h | |
| FSkeletalMeshUvMappingHandle | TTypedMeshUvMappingHandle< FSkeletalMeshUvMapping > | Experimental/NiagaraMeshUvMappingHandle.h | |
| FStaticMeshUvMappingHandle | TTypedMeshUvMappingHandle< FStaticMeshUvMapping > | Experimental/NiagaraMeshUvMappingHandle.h | |
| TNDISkelMesh_AreaWeightingOff | TIntegralConstant< ENDISkelMesh_AreaWeightingMode, ENDISkelMesh_AreaWeightingMode::None > | NDISkeletalMeshCommon.h | |
| TNDISkelMesh_AreaWeightingOn | TIntegralConstant< ENDISkelMesh_AreaWeightingMode, ENDISkelMesh_AreaWeightingMode::AreaWeighted > | NDISkeletalMeshCommon.h | |
| TNDISkelMesh_FilterModeMulti | TIntegralConstant< ENDISkeletalMesh_FilterMode, ENDISkeletalMesh_FilterMode::MultiRegion > | NDISkeletalMeshCommon.h | |
| TNDISkelMesh_FilterModeNone | TIntegralConstant< ENDISkeletalMesh_FilterMode, ENDISkeletalMesh_FilterMode::None > | NDISkeletalMeshCommon.h | |
| TNDISkelMesh_FilterModeSingle | TIntegralConstant< ENDISkeletalMesh_FilterMode, ENDISkeletalMesh_FilterMode::SingleRegion > | NDISkeletalMeshCommon.h | |
| TNDISkelMesh_SkinningModeInvalid | TIntegralConstant< ENDISkeletalMesh_SkinningMode, ENDISkeletalMesh_SkinningMode::Invalid > | NDISkeletalMeshCommon.h | |
| TNDISkelMesh_SkinningModeNone | TIntegralConstant< ENDISkeletalMesh_SkinningMode, ENDISkeletalMesh_SkinningMode::None > | NDISkeletalMeshCommon.h | |
| TNDISkelMesh_SkinningModeOnTheFly | TIntegralConstant< ENDISkeletalMesh_SkinningMode, ENDISkeletalMesh_SkinningMode::SkinOnTheFly > | NDISkeletalMeshCommon.h | |
| TNDISkelMesh_SkinningModePreSkin | TIntegralConstant< ENDISkeletalMesh_SkinningMode, ENDISkeletalMesh_SkinningMode::PreSkin > | NDISkeletalMeshCommon.h |
Enums
Public
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| GNiagaraVectorFieldUseIspc | bool | Support run-time toggling on supported platforms in non-shipping configurations. | NiagaraDataInterfaceVectorField.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GEnableVerboseNiagaraChangeIdLogging | int32 | NiagaraModule.h | ||
| NIAGARA_MAX_GPU_SPAWN_INFOS | uint32 | 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 | NiagaraCommon.h | |
| NiagaraComputeMaxThreadGroupSize | uint32 | Defines The maximum ThreadGroup size we allow in Niagara. | NiagaraCommon.h | |
| NiagaraFirstTickGroup | ETickingGroup | TickGroup information for Niagara. | NiagaraCommon.h | |
| NiagaraLastTickGroup | ETickingGroup | NiagaraCommon.h | ||
| NiagaraNumTickGroups | int | NiagaraCommon.h | ||
| STATCAT_Niagara | NiagaraDataChannel.h | |||
| STATCAT_Niagara | NiagaraScript.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
T BarycentricInterpolate
(
FVector3f BaryCoord, |
NiagaraDataInterfaceMeshCommon.h | ||
FVector4 BarycentricInterpolate
(
FVector3f BaryCoord, |
Overload for FVector4 to work around C2719: (formal parameter with requested alignment of 16 won't be aligned) | NiagaraDataInterfaceMeshCommon.h | |
T BarycentricInterpolate
(
float BaryX, |
NiagaraDataInterfaceMeshCommon.h | ||
FVector4 BarycentricInterpolate
(
float BaryX, |
Overload for FVector4 to work around C2719: (formal parameter with requested alignment of 16 won't be aligned) | NiagaraDataInterfaceMeshCommon.h | |
bool EvalConditional
(
ENiagaraConditionalOperator Op, |
NiagaraCommon.h | ||
void FNiagaraDataInterfaceUtilities::ForEachDataInterface
(
FNiagaraSystemInstance* SystemInstance, |
Loops over all data interfaces inside the SystemInstance The action should return True to continue iteration or False to stop | NiagaraDataInterfaceUtilities.h | |
void FNiagaraDataInterfaceUtilities::ForEachDataInterface
(
FNiagaraSystemInstance* SystemInstance, |
Loops over all data interfaces inside the SystemInstance The action should return True to continue iteration or False to stop | NiagaraDataInterfaceUtilities.h | |
void FNiagaraDataInterfaceUtilities::ForEachDataInterface
(
UNiagaraSystem* NiagaraSystem, |
Loops over all data interfaces inside the NiagaraSystem The action should return True to continue iteration or False to stop | NiagaraDataInterfaceUtilities.h | |
void FNiagaraDataInterfaceUtilities::ForEachGpuFunction
(
UNiagaraDataInterface* ResolvedRuntimeDataInterface, |
The same function call made be made multiple times across different scripts so you may see the same function multiple times The action should return True to continue iteration or False to stop | NiagaraDataInterfaceUtilities.h | |
void FNiagaraDataInterfaceUtilities::ForEachGpuFunction
(
UNiagaraDataInterface* ResolvedRuntimeDataInterface, |
NiagaraDataInterfaceUtilities.h | ||
void FNiagaraDataInterfaceUtilities::ForEachGpuFunction
(
UNiagaraDataInterface* ResolvedRuntimeDataInterface, |
NiagaraDataInterfaceUtilities.h | ||
void FNiagaraDataInterfaceUtilities::ForEachVMFunction
(
UNiagaraDataInterface* ResolvedRuntimeDataInterface, |
The same function call made be made multiple times across different scripts so you may see the same function multiple times The action should return True to continue iteration or False to stop | NiagaraDataInterfaceUtilities.h | |
void FNiagaraDataInterfaceUtilities::ForEachVMFunction
(
UNiagaraDataInterface* ResolvedRuntimeDataInterface, |
NiagaraDataInterfaceUtilities.h | ||
void FNiagaraDataInterfaceUtilities::ForEachVMFunction
(
UNiagaraDataInterface* ResolvedRuntimeDataInterface, |
NiagaraDataInterfaceUtilities.h | ||
| Whether compute shaders are allowed. Could change depending on config and runtime switches. | NiagaraCommon.h | ||
bool FNiagaraUtilities::AllowComputeShaders
(
EShaderPlatform ShaderPlatform |
NiagaraCommon.h | ||
| Are we able to use the GPU for culling? | NiagaraCommon.h | ||
bool FNiagaraUtilities::AllowGPUCulling
(
EShaderPlatform ShaderPlatform |
NiagaraCommon.h | ||
| Whether GPU particles are currently allowed. Could change depending on config and runtime switches. | NiagaraCommon.h | ||
bool FNiagaraUtilities::AllowGPUParticles
(
EShaderPlatform ShaderPlatform |
NiagaraCommon.h | ||
| Are we able to use the GPU for sorting? | NiagaraCommon.h | ||
bool FNiagaraUtilities::AllowGPUSorting
(
EShaderPlatform ShaderPlatform |
NiagaraCommon.h | ||
bool FNiagaraUtilities::AreBufferSRVsAlwaysCreated
(
EShaderPlatform ShaderPlatform |
Helper function to detect if SRVs are always created for buffers or not. | NiagaraCommon.h | |
bool FNiagaraUtilities::AreTypesAssignable
(
const FNiagaraTypeDefinition& FromType, |
NiagaraCommon.h | ||
EPixelFormat FNiagaraUtilities::BufferFormatToPixelFormat
(
ENiagaraGpuBufferFormat NiagaraFormat |
NiagaraCommon.h | ||
TOptional< EPixelFormat > FNiagaraUtilities::BufferFormatToPixelFormat
(
ENiagaraGpuBufferFormat NiagaraFormat, |
Converts a Niagara format into a EPixelFormat, will look for fallback options if the requested format can not be satisfied based on the RequiredCapabilities. | NiagaraCommon.h | |
| NiagaraCommon.h | |||
TOptional< ETextureRenderTargetFormat > FNiagaraUtilities::BufferFormatToRenderTargetFormat
(
ENiagaraGpuBufferFormat NiagaraFormat, |
Converts a Niagara format into a ETextureRenderTargetFormat, will look for fallback options if the requested format can not be satisfied based on the RequiredCapabilities. | NiagaraCommon.h | |
ENiagaraScriptContextStaticSwitch FNiagaraUtilities::ConvertScriptUsageToStaticSwitchContext
(
ENiagaraScriptUsage ScriptUsage |
NiagaraCommon.h | ||
ENiagaraCompileUsageStaticSwitch FNiagaraUtilities::ConvertScriptUsageToStaticSwitchUsage
(
ENiagaraScriptUsage ScriptUsage |
NiagaraCommon.h | ||
FNiagaraVariable FNiagaraUtilities::ConvertVariableToRapidIterationConstantName
(
FNiagaraVariable InVar, |
NiagaraCommon.h | ||
FString FNiagaraUtilities::CreateRapidIterationConstantName
(
FName InVariableName, |
NiagaraCommon.h | ||
void FNiagaraUtilities::DumpHLSLText
(
const FString& SourceCode, |
NiagaraCommon.h | ||
FName FNiagaraUtilities::GetUniqueName
(
FName CandidateName, |
Builds a unique name from a candidate name and a set of existing names. | NiagaraCommon.h | |
bool FNiagaraUtilities::LogVerboseWarnings() |
When enabled log more information for the end user. | NiagaraCommon.h | |
void FNiagaraUtilities::PrepareRapidIterationParameters
(
const TArray< UNiagaraScript* >& Scripts, |
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. | NiagaraCommon.h | |
FNiagaraVariable FNiagaraUtilities::ResolveAliases
(
const FNiagaraVariable& InVar, |
NiagaraCommon.h | ||
FString FNiagaraUtilities::SanitizeNameForObjectsAndPackages
(
const FString& InName |
NiagaraCommon.h | ||
bool FNiagaraUtilities::ShouldSyncCpuToGpu
(
ENiagaraGpuSyncMode SyncMode |
Helper function to determine if we should sync data from CPU to GPU. | NiagaraCommon.h | |
bool FNiagaraUtilities::ShouldSyncGpuToCpu
(
ENiagaraGpuSyncMode SyncMode |
Helper function to determine if we should sync data from GPU to CPU. | NiagaraCommon.h | |
bool FNiagaraUtilities::SupportsNiagaraRendering
(
ERHIFeatureLevel::Type FeatureLevel |
NiagaraCommon.h | ||
bool FNiagaraUtilities::SupportsNiagaraRendering
(
EShaderPlatform ShaderPlatform |
NiagaraCommon.h | ||
FString FNiagaraUtilities::SystemInstanceIDToString
(
FNiagaraSystemInstanceID ID |
NiagaraCommon.h | ||
uint32 GetTypeHash
(
const FNiagaraDrawIndirectArgGenTaskInfo& Info |
NiagaraGPUInstanceCountManager.h | ||
uint32 GetTypeHash
(
const FNiagaraAssetTagDefinition& AssetTagDefinition |
NiagaraAssetTagDefinitions.h | ||
uint32 GetTypeHash
(
const FNiagaraDataSetID& Var |
NiagaraCommon.h | ||
const FNiagaraDataSetCompiledData & NiagaraDataSetPrivate::GetCompiledData
(
const FNiagaraDataSet& DataSet |
NiagaraDataSet.h | ||
const FNiagaraDataSetCompiledData & NiagaraDataSetPrivate::GetCompiledData
(
const FNiagaraDataBuffer* DataBuffer |
NiagaraDataSet.h | ||
uint8 * NiagaraDataSetPrivate::GetComponentPtrFloat
(
FNiagaraDataBuffer* DataBuffer, |
NiagaraDataSet.h | ||
const uint8 * NiagaraDataSetPrivate::GetComponentPtrFloat
(
const FNiagaraDataBuffer* DataBuffer, |
NiagaraDataSet.h | ||
uint8 * NiagaraDataSetPrivate::GetComponentPtrHalf
(
FNiagaraDataBuffer* DataBuffer, |
NiagaraDataSet.h | ||
const uint8 * NiagaraDataSetPrivate::GetComponentPtrHalf
(
const FNiagaraDataBuffer* DataBuffer, |
NiagaraDataSet.h | ||
uint8 * NiagaraDataSetPrivate::GetComponentPtrInt32
(
FNiagaraDataBuffer* DataBuffer, |
NiagaraDataSet.h | ||
const uint8 * NiagaraDataSetPrivate::GetComponentPtrInt32
(
const FNiagaraDataBuffer* DataBuffer, |
NiagaraDataSet.h | ||
uint32 NiagaraDataSetPrivate::GetComponentStride
(
const FNiagaraDataBuffer* DataBuffer |
NiagaraDataSet.h | ||
FNiagaraDataBuffer * NiagaraDataSetPrivate::GetCurrentData
(
const FNiagaraDataSet& DataSet |
NiagaraDataSet.h | ||
FNiagaraDataBuffer * NiagaraDataSetPrivate::GetDestinationData
(
const FNiagaraDataSet& DataSet |
NiagaraDataSet.h | ||
uint32 NiagaraDataSetPrivate::GetNumInstances
(
const FNiagaraDataBuffer* DataBuffer |
NiagaraDataSet.h | ||
bool operator!
(
ENiagaraAssetLibraryAssetTypes E |
NiagaraAssetTagDefinitions.h | ||
bool operator!
(
ENiagaraParameterBindingUsage E |
NiagaraParameterBinding.h | ||
bool operator!
(
ENiagaraTypeRegistryFlags E |
NiagaraTypeRegistry.h | ||
| NiagaraAssetTagDefinitions.h | |||
| NiagaraParameterBinding.h | |||
| NiagaraTypeRegistry.h | |||
| NiagaraAssetTagDefinitions.h | |||
| NiagaraParameterBinding.h | |||
| NiagaraTypeRegistry.h | |||
| NiagaraAssetTagDefinitions.h | |||
| NiagaraParameterBinding.h | |||
| NiagaraTypeRegistry.h | |||
| NiagaraAssetTagDefinitions.h | |||
| NiagaraParameterBinding.h | |||
| NiagaraTypeRegistry.h | |||
| NiagaraAssetTagDefinitions.h | |||
| NiagaraParameterBinding.h | |||
| NiagaraTypeRegistry.h | |||
| NiagaraAssetTagDefinitions.h | |||
| NiagaraParameterBinding.h | |||
| NiagaraTypeRegistry.h | |||
| NiagaraAssetTagDefinitions.h | |||
| NiagaraParameterBinding.h | |||
| NiagaraTypeRegistry.h | |||
FVector3f RandomBarycentricCoord
(
FRandomStream& RandStream |
NiagaraDataInterfaceMeshCommon.h | ||
void SetGNiagaraDeviceProfile
(
UDeviceProfile* Profile |
NiagaraPlatformSet.h | ||
ENCPoolMethod ToNiagaraPooling
(
EPSCPoolMethod PoolingMethod |
NiagaraCommon.h | ||
EPSCPoolMethod ToPSCPoolMethod
(
ENCPoolMethod PoolingMethod |
NiagaraCommon.h | ||
UE_TRACE_CHANNEL_EXTERN
(
NiagaraChannel, |
NiagaraTrace.h |