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

Light Theme

Dark Theme

UNiagaraDataInterfaceGrid2DCollection

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceRWBase

UNiagaraDataInterfaceGrid2D

UNiagaraDataInterfaceGrid2DCollection

References

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

Syntax

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

Variables

		Name	Description
	TMap< FNiagaraS...	SystemInstancesToProxyData_GT

Constructors

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

Functions

	Name	Description
bool	FillRawTexture2D ( const UNiagaraComponent* Compo..., UTextureRenderTarget2D* Dest, int& TilesX, int& TilesY )
bool	FillTexture2D ( const UNiagaraComponent* Compo..., UTextureRenderTarget2D* dest, int AttributeIndex )	Fills a texture render target 2d with the current data from the simulation #todo(dmp): this will eventually go away when we formalize how data makes it out of Niagara
void	GetCellSize ( FVectorVMContext& Context )
void	GetRawTextureSize ( const UNiagaraComponent* Compo..., int& SizeX, int& SizeY )
void	GetTextureSize ( const UNiagaraComponent* Compo..., int& SizeX, int& SizeY )
void	GetWorldBBoxSize ( FVectorVMContext& Context )

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.
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.
bool	PerInstanceTick ( void* PerInstanceData, FNiagaraSystemInstance* System..., float DeltaSeconds )	Ticks the per instance data for this interface, if it has any.
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.

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

Take our survey

Dismiss