1. Epic GamesDeveloper
  3. FNiagaraGpuComputeDispatchInterface

FNiagaraGpuComputeDispatchInterface

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

API > API/Plugins > API/Plugins/Niagara

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

   
Name FNiagaraGpuComputeDispatchInterface
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraGpuComputeDispatchInterface.h
Include Path #include "NiagaraGpuComputeDispatchInterface.h"

Syntax

class FNiagaraGpuComputeDispatchInterface : public FFXSystemInterface

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraGpuComputeDispatchInterface ( EShaderPlatform InShaderPlatform,
ERHIFeatureLevel::Type InFeatureLevel
)

   NiagaraGpuComputeDispatchInterface.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FNiagaraGpuComputeDispatchInterface()

   NiagaraGpuComputeDispatchInterface.h  

Classes

Name Remarks
FOnPostPreRenderEvent  
FOnPreInitViewsEvent  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddDebugReadback ( FNiagaraSystemInstanceID InstanceID,
TSharedPtr< FNiagaraScriptDebuggerInfo, ESPMode::ThreadSafe > DebugInfo,
FNiagaraComputeExecutionContext* Context
)

 Debug only function to readback data. NiagaraGpuComputeDispatchInterface.h  

void AddGpuComputeProxy ( FNiagaraSystemGpuComputeProxy* ComputeProxy
)

 Add system instance proxy to the batcher for tracking. NiagaraGpuComputeDispatchInterface.h  

void AddNDCDataProxy ( FNiagaraDataChannelDataProxyPtr NDCDataProxy
)

 Add NDC Data to the batcher for tracking NiagaraGpuComputeDispatchInterface.h  
Register work for GPU sorting (using the GPUSortManager). NiagaraGpuComputeDispatchInterface.h  

virtual bool AddSortedGPUSimulation ( FNiagaraGPUSortInfo& SortInfo
)

   NiagaraGpuComputeDispatchInterface.h  
This will flush all pending ticks & readbacks from the dispatcher. NiagaraGpuComputeDispatchInterface.h  
Call this to force all pending ticks to be flushed from the batcher. NiagaraGpuComputeDispatchInterface.h  

FNiagaraAsyncGpuTraceHelper & GetAsyncGpuTraceHelper()

   NiagaraGpuComputeDispatchInterface.h  

FRDGTextureRef GetBlackTexture ( FRDGBuilder& GraphBuilder,
ETextureDimension TextureDimension
) const

 Helper function to return an RDG Texture where the texture contains 0 for all channels. NiagaraGpuComputeDispatchInterface.h  

FRDGTextureSRVRef GetBlackTextureSRV ( FRDGBuilder& GraphBuilder,
ETextureDimension TextureDimension
) const

 Helper function to return a RDG Texture SRV where the texture contains 0 for all channels. NiagaraGpuComputeDispatchInterface.h  

FRDGBufferSRVRef GetEmptyBufferSRV ( FRDGBuilder& GraphBuilder,
EPixelFormat Format
) const

 Helper function to return a Buffer SRV which will contain 1 element of 0 value, i.e. to use as a dummy binding. NiagaraGpuComputeDispatchInterface.h  

FRDGBufferUAVRef GetEmptyBufferUAV ( FRDGBuilder& GraphBuilder,
EPixelFormat Format
) const

 Helper function to return a Buffer UAV you don't care about the contents of or the results, i.e. to use as a dummy binding. NiagaraGpuComputeDispatchInterface.h  

FRDGTextureUAVRef GetEmptyTextureUAV ( FRDGBuilder& GraphBuilder,
EPixelFormat Format,
ETextureDimension TextureDimension
) const

 Helper function to return a RDG Texture UAV you don't care about the contents of or the results, i.e. to use as a dummy binding. NiagaraGpuComputeDispatchInterface.h  

FRHIUnorderedAccessView * GetEmptyUAVFromPool ( FRHICommandList& RHICmdList,
EPixelFormat Format,
ENiagaraEmptyUAVType Type
) const

 Convenience wrapper to get a UAV from the pool. NiagaraGpuComputeDispatchInterface.h  

FNiagaraEmptyUAVPool * GetEmptyUAVPool()

 Get access to Niagara's GpuReadbackManager. NiagaraGpuComputeDispatchInterface.h  

ERHIFeatureLevel::Type GetFeatureLevel()

 Get FeatureLevel the batcher is bound to NiagaraGpuComputeDispatchInterface.h  

const FGlobalDistanceFieldParameterData * GetGlobalDistanceFieldData()

 Get access to the global distance field data This will return nullptr if you attempt to access at an invalid point (i.e. before GDF is prepared or the GDF is not available) NiagaraGpuComputeDispatchInterface.h  

FNiagaraGpuComputeDebugInterface GetGpuComputeDebugInterface()

 Public interface to Niagara compute debugging. NiagaraGpuComputeDispatchInterface.h  

FNiagaraGpuComputeDebug * GetGpuComputeDebugPrivate()

 Get access to Niagara's GpuComputeDebug this is for internal use NiagaraGpuComputeDispatchInterface.h  
  NiagaraGpuComputeDispatchInterface.h  
Get access to the instance count manager. NiagaraGpuComputeDispatchInterface.h  

FNiagaraGpuReadbackManager * GetGpuReadbackManager()

 Get access to Niagara's GpuReadbackManager. NiagaraGpuComputeDispatchInterface.h  
Event that broadcast at the end of PostRenderOpaque. NiagaraGpuComputeDispatchInterface.h  

FOnPreInitViewsEvent & GetOnPreInitViewsEvent()

 Event that broadcast when we enter PreInitViews. NiagaraGpuComputeDispatchInterface.h  
Event that broadcast when we endter PreRender. NiagaraGpuComputeDispatchInterface.h  

TManager & GetOrCreateDataManager()

 Get or create the a data manager, must be done on the rendering thread only. NiagaraGpuComputeDispatchInterface.h  

EShaderPlatform GetShaderPlatform()

 Get ShaderPlatform the batcher is bound to NiagaraGpuComputeDispatchInterface.h  

TConstStridedView< FSceneView > GetSimulationSceneViews ()

 Get access to the Views the simulation is being rendered with. NiagaraGpuComputeDispatchInterface.h  

bool IsFirstViewFamily()

   NiagaraGpuComputeDispatchInterface.h  

bool IsLastViewFamily()

   NiagaraGpuComputeDispatchInterface.h  

bool IsOutsideSceneRenderer()

   NiagaraGpuComputeDispatchInterface.h  

void MultiGPUResourceModified ( FRHICommandList& RHICmdList,
FRHIBuffer* Buffer,
bool bRequiredForSimulation,
bool bRequiredForRendering
) const

   NiagaraGpuComputeDispatchInterface.h  

void MultiGPUResourceModified ( FRDGBuilder& GraphBuilder,
FRHIBuffer* Buffer,
bool bRequiredForSimulation,
bool bRequiredForRendering
) const

   NiagaraGpuComputeDispatchInterface.h  

void MultiGPUResourceModified ( FRDGBuilder& GraphBuilder,
FRHITexture* Texture,
bool bRequiredForSimulation,
bool bRequiredForRendering
) const

   NiagaraGpuComputeDispatchInterface.h  

void MultiGPUResourceModified ( FRHICommandList& RHICmdList,
FRHITexture* Texture,
bool bRequiredForSimulation,
bool bRequiredForRendering
) const

   NiagaraGpuComputeDispatchInterface.h  

void ProcessDebugReadbacks ( FRHICommandList& RHICmdList,
bool bWaitCompletion
)

 Processes all pending debug readbacks NiagaraGpuComputeDispatchInterface.h  

void RemoveGpuComputeProxy ( FNiagaraSystemGpuComputeProxy* ComputeProxy
)

 Remove system instance proxy from the batcher. NiagaraGpuComputeDispatchInterface.h  

void RemoveNDCDataProxy ( FNiagaraDataChannelDataProxyPtr NDCDataProxy
)

 Add NDC Data to the batcher for tracking NiagaraGpuComputeDispatchInterface.h  

Static

Name Remarks Include Path Unreal Specifiers
  NiagaraGpuComputeDispatchInterface.h  
  NiagaraGpuComputeDispatchInterface.h  
  NiagaraGpuComputeDispatchInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page