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 > UNiagaraDataInterfaceGrid2DCollectionReader

Light Theme

Dark Theme

UNiagaraDataInterfaceGrid2DCollectionReader

#todo(dmp): base class has all the RW attributes, even though we only care about the attributes that query the grid. Cleaning this up would be great

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceRWBase

UNiagaraDataInterfaceGrid2D

UNiagaraDataInterfaceGrid2DCollectionReader

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceGrid2DCollectionReader.h
Include	#include "NiagaraDataInterfaceGrid2DCollectionReader.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Category="Grid",
Meta=(DisplayName="Grid2D Collection Reader", Experimental), Blueprintable, BlueprintType,
HideCategories=(Grid, RW))
class UNiagaraDataInterfaceGrid2DCollectionReader : public UNiagaraDataInterfaceGrid2D

Remarks

#todo(dmp): base class has all the RW attributes, even though we only care about the attributes that query the grid. Cleaning this up would be great

Variables

	Name	Description
FString	DIName	Name of the Grid2DCollection Data Interface on the emitter.
FString	EmitterName	Name of the emitter to read from.
TMap< FNiagaraS...	SystemInstancesToProxyData_GT

Constructors

	Name	Description
	UNiagaraDataInterfaceGrid2DCollectionReader ( const FObjectInitializer& ObjectIn... )

Overridden from UNiagaraDataInterface

	Name	Description
bool	CopyToInternal ( UNiagaraDataInterface* Destina... )
void	DestroyPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* System... )	Destroys the per instance data for this interface.
bool	Equals ( const UNiagaraDataInterface* O... )	Determines if this DataInterface is the same as another.
void	GetEmitterDependencies ( UNiagaraSystem* Asset, TArray< UNiagaraEmitter* >& D... )	Allows a DI to specify data dependencies between emitters, so the system can ensure that the emitter instances are executed in the correct order.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParam..., const FNiagaraDataInterfaceGenerate..., int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctions ( TArray< FNiagaraFunctionSignature >... )	VM functionality.
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParam..., FString& OutHLSL )	GPU sim functionality.
void	GetVMExternalFunction ( const FVMExternalFunctionBindingInf..., void* InstanceData, FVMExternalFunction& OutFunc )	Returns the delegate for the passed function signature.
bool	InitPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* System... )	Initializes the per instance data for this interface.
int32	PerInstanceDataSize()	Returns the size of the per instance data for this interface.
void	ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread, void* PerInstanceData, const FNiagaraSystemInstanceID& Sy... )	Subclasses that wish to work with GPU systems/emitters must implement this.

Overridden from UNiagaraDataInterfaceBase

	Name	Description
void	BindParameters ( FNiagaraDataInterfaceParametersCS&..., const FNiagaraDataInterfaceGPUParam..., const FShaderParameterMap& Paramet... )	Methods that operate on an instance of type FNiagaraDataInterfaceParametersCS*, created by the above CreateComputeParameters() method
FNiagaraData...	CreateComputeParameters()	Constructs the correct CS parameter type for this DI (if any).
const FTypeL...	GetComputeParametersTypeDesc()
void	SetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )
void	UnsetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )

Overridden from UObject

		Name	Description
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Constants

Name	Description
GetValueFunctionName
GridName
NumTilesName
OutputGridName
SampleGridFunctionName
SamplerName

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss