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

Inheritance Hierarchy

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

  Type Name Description
Protected variable bool bIsFirstViewFamily  
Protected variable bool bIsLastViewFamily  
Protected variable bool bIsOutsideSceneRenderer  
Protected variable TUniquePtr< FNiagaraEmptyUAVPool > EmptyUAVPoolPtr  
Protected variable ERHIFeatureLevel::Type FeatureLevel  
Protected variable TUniquePtr< FNiagaraGpuComputeDebug > GpuComputeDebugPtr  
Protected variable TArray< TPair< FName, TUniquePtr< FNiagaraGpuComputeDataManager > > > GpuDataManagers  
Protected variable FNiagaraGPUInstanceCountManager GPUInstanceCounterManager GPU emitter instance count buffer. Contains the actual particle / instance count generate in the GPU tick.
Protected variable TUniquePtr< FNiagaraGpuReadbackManager > GpuReadbackManagerPtr  
Protected variable EShaderPlatform ShaderPlatform  
Protected variable TConstStridedView< FSceneView > SimulationSceneViews  

Constructors

  Type Name Description
Public function  

FNiagaraGpuComputeDispatchInterface ( EShaderPlatform InShaderPlatform,
ERHIFeatureLevel::Type InFeatureLevel
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Debug only function to readback data.
Public function void Add system instance proxy to the batcher for tracking.
Public function bool Register work for GPU sorting (using the GPUSortManager).
Public function void This will flush all pending ticks & readbacks from the dispatcher.
Public function void Call this to force all pending ticks to be flushed from the batcher.
Public function Static FNiagaraGpuComputeDispatchInterface *

Get ( FFXSystemInterface* FXSceneInterface
)

  
Public function Static FNiagaraGpuComputeDispatchInterface *

Get ( FSceneInterface* Scene
)

  
Public function Static FNiagaraGpuComputeDispatchInterface *

Get ( UWorld* World
)

  
Public function Const FNiagaraAsyncGpuTraceHelper &  
Public function Const FRDGTextureRef

GetBlackTexture ( FRDGBuilder& GraphBuilder,
ETextureDimension TextureDimension
)

 Helper function to return an RDG Texture where the texture contains 0 for all channels.
Public function Const FRDGTextureSRVRef

GetBlackTextureSRV ( FRDGBuilder& GraphBuilder,
ETextureDimension TextureDimension
)

 Helper function to return a RDG Texture SRV where the texture contains 0 for all channels.
Public function Const FRDGBufferSRVRef

GetEmptyBufferSRV ( FRDGBuilder& GraphBuilder,
EPixelFormat Format
)

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

GetEmptyBufferUAV ( FRDGBuilder& GraphBuilder,
EPixelFormat Format
)

 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.
Public function Const FRDGTextureUAVRef

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

 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.
Public function Const ERHIFeatureLevel::Type Get FeatureLevel the batcher is bound to
Public function Const const FGlobalDistanceFieldParameterData * 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)
Public function Const FNiagaraGpuComputeDebugInterface Public interface to Niagara compute debugging.
Public function Const FNiagaraGpuComputeDebug * Get access to Niagara's GpuComputeDebug this is for internal use
Public function FNiagaraGPUInstanceCountManager & Get access to the instance count manager.
Public function Const const FNiagaraGPUInstanceCountManager &  
Public function Const FNiagaraGPUProfilerInterface * Access to Niagara's GPU Profiler
Public function Const FNiagaraGpuReadbackManager * Get access to Niagara's GpuReadbackManager.
Public function TManager & Get or create the a data manager, must be done on the rendering thread only.
Public function Const EShaderPlatform Get ShaderPlatform the batcher is bound to
Public function Const TConstStridedView< FSceneView > Get access to the Views the simulation is being rendered with.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const void

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

  
Public function Const void

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

  
Public function void

ProcessDebugReadbacks ( FRHICommandListImmediate& RHICmdList,
bool bWaitCompletion
)

 Processes all pending debug readbacks
Public function void Remove system instance proxy from the batcher.

Deprecated Functions

  Type Name Description
Public function Const FRHIUnorderedAccessView *

GetEmptyUAVFromPool ( FRHICommandList& RHICmdList,
EPixelFormat Format,
ENiagaraEmptyUAVType Type
)

 The UAV Pool will be removed, please update your code to support RenderGraph.
Public function Const FNiagaraEmptyUAVPool * The UAV Pool will be removed, please update your code to support RenderGraph.
Public function Const void

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

 ImmediateMode is deprecated for Niagara please migrate to using a FRDGBuilder
Public function Const void

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

 ImmediateMode is deprecated for Niagara please migrate to using a FRDGBuilder

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page