UNiagaraDataInterfaceSparseVolumeTexture | Unreal Engine 5.2 Documentation

Inheritance Hierarchy

UObjectBase
UObjectBaseUtility
UObject
UNiagaraMergeable
UNiagaraDataInterfaceBase
UNiagaraDataInterface
UNiagaraDataInterfaceSparseVolumeTexture

References


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

Syntax

UCLASS&40;EditInlineNew, Category&61;"Texture", CollapseCategories,  
       Meta&61;&40;DisplayName&61;"Sparse Volume Texture Sample"&41;, MinimalAPI&41;  
class UNiagaraDataInterfaceSparseVolumeTexture : public UNiagaraDataInterface

Remarks

Data Interface allowing sampling of a sparse volume texture

Variables

	Type	Name	Description
	TObjectPtr< USparseVolumeTexture >	SparseVolumeTexture
	FNiagaraUserParameterBinding	SparseVolumeTextureUserParameter

Constructors

	Type	Name	Description
		UNiagaraDataInterfaceSparseVolumeTexture ( const FObjectInitializer& ObjectInitializer )

Functions

	Type	Name	Description
	void	SetTexture ( USparseVolumeTexture* InSparseVolumeTexture )
	void	VMGetNumMipLevels ( FVectorVMExternalFunctionContext& Context )
	void	VMGetTextureDimensions ( FVectorVMExternalFunctionContext& Context )

Overridden from UNiagaraDataInterface

Type	Name	Description
bool	AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor )	GPU sim functionality.
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
bool	CopyToInternal ( UNiagaraDataInterface* Destination )
void	DestroyPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* SystemInstance )	Destroys the per instance data for this interface.
bool	Equals ( const UNiagaraDataInterface* Other )	Determines if this DataInterface is the same as another.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo, int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctions ( TArray< FNiagaraFunctionSignature >& OutFunctions )	Gets all the available functions for this data interface.
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, FString& OutHLSL )
void	GetVMExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo, void* InstanceData, FVMExternalFunction& OutFunc )	Returns the delegate for the passed function signature.
bool	HasPreSimulateTick ()
bool	InitPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* SystemInstance )	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* SystemInstance, float DeltaSeconds )	Ticks the per instance data for this interface, if it has any.
void	SetShaderParameters ( const FNiagaraDataInterfaceSetShaderParametersContext& Context )	Set the shader parameters will only be called if the data interface provided shader parameters.
bool	UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature )	Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.

Overridden from UNiagaraDataInterfaceBase

	Type	Name	Description
	void	BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder )	Override this method to provide parameters to the GPU (SRV / UAV / Constants / etc) The most common usage will be to provide a single structure which is nested with other parameters.

Overridden from UObject

Type	Name	Description
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.