1. Epic GamesDeveloper
  3. FNiagaraSystemRenderData

FNiagaraSystemRenderData

This class wraps all data and functionality needed by a scene render proxy to render a single Niagara System Instance.

API > API/Plugins > API/Plugins/Niagara

This class wraps all data and functionality needed by a scene render proxy to render a single Niagara System Instance.

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

Syntax

class FNiagaraSystemRenderData

Constructors

Name Remarks Include Path Unreal Specifiers
  NiagaraSystemRenderData.h  

FNiagaraSystemRenderData ( const FNiagaraSystemInstanceController& SystemInstanceController,
const FNiagaraSystemInstance& SystemInstance,
ERHIFeatureLevel::Type FeatureLevel
)

   NiagaraSystemRenderData.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FNiagaraSystemRenderData()

   NiagaraSystemRenderData.h  

Structs

Name Remarks
FMaterialOverride  
FSetDynamicDataCommand  

Typedefs

Name Type Remarks Include Path
FSetDynamicDataCommandList TArray< FSetDynamicDataCommand, TInlineAllocator< 8 > >   NiagaraSystemRenderData.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
LWCRenderTile FVector3f   NiagaraSystemRenderData.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bAnyHeterogeneousVolumesEnabled bool   NiagaraSystemRenderData.h  
bAnyMotionBlurEnabled bool   NiagaraSystemRenderData.h  
bRenderingEnabled_GT bool   NiagaraSystemRenderData.h  
bRenderingEnabled_RT bool   NiagaraSystemRenderData.h  
EmitterRenderers_GT TArray< FNiagaraRenderer * > Emitter Renderers in the order they appear in the emitters. To be accessed by the GameThread NiagaraSystemRenderData.h  
EmitterRenderers_RT TArray< FNiagaraRenderer * > Emitter Renderers in the order they appear in the emitters. To be accessed by the RenderThread NiagaraSystemRenderData.h  
FeatureLevel ERHIFeatureLevel::Type   NiagaraSystemRenderData.h  
RendererDrawOrder TArray< int32 > Indices of renderers in the order they should be rendered. NiagaraSystemRenderData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CreateRenderThreadResources ( FRHICommandListBase& RHICmdList
)

 Called from the render thread to give renderers an opportunity to create resources needed for rendering. NiagaraSystemRenderData.h  

void Destroy_RenderThread()

 This must be called on the RenderThread before destruction to properly clean up resources without data race issues (i.e. from a scene proxy's destructor) NiagaraSystemRenderData.h  

void DestroyRenderState_Concurrent()

 Gives the system's renderers an opportunity to free resources NiagaraSystemRenderData.h  

void GatherSimpleLights ( FSimpleLightArray& OutParticleLights
) const

   NiagaraSystemRenderData.h  

void GenerateSetDynamicDataCommands ( FSetDynamicDataCommandList& Commands,
const FNiagaraSceneProxy& SceneProxy,
const FNiagaraSystemInstance* SystemInstance,
TConstArrayView< FMaterialOverride > MaterialOverrides
)

 Called at the end of the frame, before rendering when necessary to provide renderers with render thread data NiagaraSystemRenderData.h  

uint32 GetDynamicDataSize()

 Gets the total size of dynamic data allocated NiagaraSystemRenderData.h  

void GetDynamicMeshElements ( const TArray< const FSceneView* >& Views,
const FSceneViewFamily& ViewFamily,
uint32 VisibilityMap,
FMeshElementCollector& Collector,
const FNiagaraSceneProxy& SceneProxy
)

 Gets the dynamic mesh elements from all renderers NiagaraSystemRenderData.h  

int32 GetNumRenderers()

   NiagaraSystemRenderData.h  

FPrimitiveViewRelevance GetViewRelevance ( const FSceneView& View,
const FNiagaraSceneProxy& SceneProxy
) const

 Gets the relevance of this NiagaraSystem for this view NiagaraSystemRenderData.h  

bool HasAnyHeterogeneousVolumesEnabled()

   NiagaraSystemRenderData.h  

bool HasAnyMotionBlurEnabled()

   NiagaraSystemRenderData.h  

bool IsRenderingEnabled_GT()

   NiagaraSystemRenderData.h  

bool IsRenderingEnabled_RT()

   NiagaraSystemRenderData.h  

void OnSystemComplete ( const FNiagaraSystemInstance& SystemInstance
)

   NiagaraSystemRenderData.h  

void PostTickRenderers ( const FNiagaraSystemInstance& SystemInstance
)

   NiagaraSystemRenderData.h  

void RecacheRenderers ( const FNiagaraSystemInstance& SystemInstance,
const FNiagaraSystemInstanceController& Controller
)

   NiagaraSystemRenderData.h  

void ReleaseRenderThreadResources()

 Called from the render thread to give renderers an opportunity to release their resources. NiagaraSystemRenderData.h  

void SetRenderingEnabled_GT ( bool bInEnabled
)

   NiagaraSystemRenderData.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ExecuteDynamicDataCommands_RenderThread ( const FSetDynamicDataCommandList& Commands
)

   NiagaraSystemRenderData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page