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

Light Theme

Dark Theme

UNiagaraDataInterfaceLandscape

Data Interface allowing sampling of a Landscape

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceLandscape

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Category="Landscape", Meta=(DisplayName="Landscape Sample"))
class UNiagaraDataInterfaceLandscape : public UNiagaraDataInterface

Remarks

Data Interface allowing sampling of a Landscape

Variables

		Name	Description
	AActor *	SourceLandscape
	ENDILandscape_S...	SourceMode

Constructors

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

Functions

		Name	Description
	void	ApplyLandscape ( const FNiagaraSystemInstance& Syst..., FNDILandscapeData_GameThread& Inst... )
	ALandscape &...	GetLandscape ( const FNiagaraSystemInstance& Syst..., ALandscape* Hint )

Overridden from UNiagaraDataInterface

	Name	Description
bool	AppendCompileHash ( FNiagaraCompileHashVisitor* In... )	Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile.
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
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	GetCommonHLSL ( FString& OutHLSL )	Allows data interfaces to provide common functionality that will be shared across interfaces on that type.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParam..., const FNiagaraDataInterfaceGenerate..., int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctions ( TArray< FNiagaraFunctionSignature >... )	Gets all the available functions for this data interface.
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParam..., FString& OutHLSL )	GPU sim functionality.
bool	HasPreSimulateTick()
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.
bool	UpgradeFunctionCall ( FNiagaraFunctionSignature& Functio... )	Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.

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
GetHeightName
GetWorldNormalName

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

Take our survey

Dismiss