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

Light Theme

Dark Theme

UNiagaraDataInterfaceTexture

Data Interface allowing sampling of a texture

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceTexture

References

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

Syntax

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

Remarks

Data Interface allowing sampling of a texture

Variables

		Name	Description
	UTexture *	Texture
	FIntPoint	TextureSize

Constructors

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

Functions

		Name	Description
	void	GetTextureDimensions ( FVectorVMContext& Context )
	void	SamplePseudoVolumeTexture ( FVectorVMContext& Context )
	void	SampleTexture ( FVectorVMContext& Context )
	void	SetTexture ( UTexture* InTexture )

Overridden from UNiagaraDataInterface

	Name	Description
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
bool	CopyToInternal ( UNiagaraDataInterface* Destina... )
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 >... )	Gets all the available functions for this data interface.
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	HasPreSimulateTick()
bool	PerInstanceTick ( void* PerInstanceData, FNiagaraSystemInstance* System..., float DeltaSeconds )	Ticks the per instance data for this interface, if it has any.
void	PushToRenderThreadImpl()

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	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Constants

Name	Description
DimensionsBaseName
SamplePseudoVolumeTextureName
SamplerName
SampleTexture2DName
SampleVolumeTextureName
TextureDimsName
TextureName	FRWBuffer& GetGPUBuffer();.

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

Take our survey

Dismiss