1. Epic GamesDeveloper
  3. UNiagaraDataChannelLibrary

UNiagaraDataChannelLibrary

A C++ and Blueprint accessible library of utility functions for accessing Niagara DataChannel

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • UNiagaraDataChannelLibrary

References

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

Syntax

UCLASS ()  
class UNiagaraDataChannelLibrary : public UBlueprintFunctionLibrary

Remarks

A C++ and Blueprint accessible library of utility functions for accessing Niagara DataChannel

Constructors

  Type Name Description
Public function  

UNiagaraDataChannelLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static UNiagaraDataChannelReader *

CreateDataChannelReader ( const UObject* WorldContextObject,
const UNiagaraDataChannel* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
bool bReadPreviousFrame
)

  
Public function Static UNiagaraDataChannelWriter *

CreateDataChannelWriter ( const UObject* WorldContextObject,
const UNiagaraDataChannel* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
int32 Count,
bool bVisibleToGame,
bool bVisibleToCPU,
bool bVisibleToGPU,
const FString& DebugSource
)

  
Public function Static UNiagaraDataChannelHandler *

FindDataChannelHandler ( const UObject* WorldContextObject,
const UNiagaraDataChannel* Channel
)

  
Public function Static UFunction BlueprintCallable, Category, Meta int32

GetDataChannelElementCount ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
bool bReadPreviousFrame
)

 Returns the number of readable elements in the given data channel
Public function Static UFunction Category, Meta blueprintinternaluseonly UNiagaraDataChannelHandler *

GetNiagaraDataChannel ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel
)

  
Public function Static UFunction BlueprintCallable, Category, Meta displayname UNiagaraDataChannelReader *

ReadFromNiagaraDataChannel ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
bool bReadPreviousFrame
)

 Initializes and returns the Niagara Data Channel reader for the given data channel.
Public function Static UFunction Category, Meta blueprintinternaluseonly, displayname void

ReadFromNiagaraDataChannelSingle ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
int32 Index,
FNiagaraDataChannelSearchParameters SearchParams,
bool bReadPreviousFrame,
ENiagartaDataChannelReadResult& ReadResult
)

 Reads a single entry from the given data channel, if possible.
Public function Static UFunction BlueprintCallable, Category, Meta displayname UNiagaraDataChannelWriter *

WriteToNiagaraDataChannel ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
int32 Count,
UPARAM(DisplayName="Visible to Blueprint") bool bVisibleToGame,
UPARAM(DisplayName="Visible to Niagara CPU") bool bVisibleToCPU,
UPARAM(DisplayName="Visible to Niagara GPU") bool bVisibleToGPU,
const FString& DebugSource
)

 Initializes and returns the Niagara Data Channel writer to write N elements to the given data channel.
Public function Static UFunction Category, Meta blueprintinternaluseonly, displayname void

WriteToNiagaraDataChannelSingle ( const UObject* WorldContextObject,
const UNiagaraDataChannelAsset* Channel,
FNiagaraDataChannelSearchParameters SearchParams,
bool bVisibleToBlueprint,
bool bVisibleToNiagaraCPU,
bool bVisibleToNiagaraGPU
)

 Writes a single element to a Niagara Data Channel.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page