Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > FNiagaraGpuComputeDispatchInterface

Light Theme

Dark Theme

FNiagaraGpuComputeDispatchInterface

Public API for Niagara's Compute Dispatcher This is generally used with DataInterfaces or Custom Renderers

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FFXSystemInterface

FNiagaraGpuComputeDispatchInterface

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraGpuComputeDispatchInterface.h
Include	#include "NiagaraGpuComputeDispatchInterface.h"

Syntax

class FNiagaraGpuComputeDispatchInterface : public FFXSystemInterface

Remarks

Public API for Niagara's Compute Dispatcher This is generally used with DataInterfaces or Custom Renderers

Variables

	Name	Description
TUniquePtr< FNi...	EmptyUAVPoolPtr
ERHIFeatureLeve...	FeatureLevel
TUniquePtr< FNi...	GpuComputeDebugPtr
FNiagaraGPUInst...	GPUInstanceCounterManager	GPU emitter instance count buffer. Contains the actual particle / instance count generate in the GPU tick.
TUniquePtr< FNi...	GpuReadbackManagerPtr
EShaderPlatform	ShaderPlatform

Constructors

	Name	Description
	FNiagaraGpuComputeDispatchInterface ( EShaderPlatform InShaderPlatform, ERHIFeatureLevel::Type InFeatureLev... )

Destructors

	Name	Description
	~FNiagaraGpuComputeDispatchInterface()

Functions

	Name	Description
void	AddDebugReadback ( FNiagaraSystemInstanceID InstanceID, TSharedPtr< FNiagaraScriptDebuggerI..., FNiagaraComputeExecutionContext... )	Debug only function to readback data.
void	AddGpuComputeProxy ( FNiagaraSystemGpuComputeProxy*... )	Add system instance proxy to the batcher for tracking.
bool	AddSortedGPUSimulation ( FNiagaraGPUSortInfo& SortInfo )	Register work for GPU sorting (using the GPUSortManager).
void	FlushPendingTicks_GameThread()	Call this to force all pending ticks to be flushed from the batcher.
FNiagaraGpuC...	Get ( FFXSystemInterface* FXSceneInt... )
FNiagaraGpuC...	Get ( FSceneInterface* Scene )
FNiagaraGpuC...	Get ( UWorld* World )
FRHIUnordere...	GetEmptyUAVFromPool ( FRHICommandList& RHICmdList, EPixelFormat Format, ENiagaraEmptyUAVType Type )	Convenience wrapped to get a UAV from the poo.
FNiagaraEmpt...	GetEmptyUAVPool()	Get access to Niagara's GpuReadbackManager.
ERHIFeatureL...	GetFeatureLevel()	Get FeatureLevel the batcher is bound to
FNiagaraGpuC...	GetGpuComputeDebug()	Get access to Niagara's GpuComputeDebug
FNiagaraGPUI...	GetGPUInstanceCounterManager()	Get access to the instance count manager.
const FNiaga...	GetGPUInstanceCounterManager()
FNiagaraGPUP...	GetGPUProfiler()	Access to Niagara's GPU Profiler
FNiagaraGpuR...	GetGpuReadbackManager()	Get access to Niagara's GpuReadbackManager.
EShaderPlatf...	GetShaderPlatform()	Get ShaderPlatform the batcher is bound to
void	ProcessDebugReadbacks ( FRHICommandListImmediate& RHICmdLi..., bool bWaitCompletion )	Processes all pending debug readbacks
void	RemoveGpuComputeProxy ( FNiagaraSystemGpuComputeProxy*... )	Remove system instance proxy from the batcher.