1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceTexture

UNiagaraDataInterfaceTexture

Data Interface allowing sampling of a texture

API > API/Plugins > API/Plugins/Niagara

Data Interface allowing sampling of a texture

   
Name UNiagaraDataInterfaceTexture
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceTexture.h
Include Path #include "NiagaraDataInterfaceTexture.h"

Syntax

UCLASS (EditInlineNew, Category="Texture", CollapseCategories, Meta=(DisplayName="Texture Sample"),  
       MinimalAPI)  
class UNiagaraDataInterfaceTexture : public UNiagaraDataInterface

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceTexture ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceTexture.h  

Classes

Name Remarks
FShaderParameters  

Constants

Name Type Remarks Include Path
GatherRedTexture2DName const FName   NiagaraDataInterfaceTexture.h
GetNumMipLevelsName const FName   NiagaraDataInterfaceTexture.h
GetTextureDimensionsName const FName   NiagaraDataInterfaceTexture.h
LoadTexture2DName const FName   NiagaraDataInterfaceTexture.h
SamplePseudoVolumeTextureName const FName   NiagaraDataInterfaceTexture.h
SampleTexture2DName const FName   NiagaraDataInterfaceTexture.h
TemplateShaderFilePath const TCHAR *   NiagaraDataInterfaceTexture.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Texture TObjectPtr< UTexture >   NiagaraDataInterfaceTexture.h
  • EditAnywhere
  • Category="Texture"
TextureUserParameter FNiagaraUserParameterBinding   NiagaraDataInterfaceTexture.h
  • EditAnywhere
  • Category="Texture"
  • Meta=(ToolTip="When valid the user parameter is used as the texture rather than the one on the data interface")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetTexture ( UTexture* InTexture
)

   NiagaraDataInterfaceTexture.h  

void VMGetNumMipLevels ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceTexture.h  

void VMGetTextureDimensions ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceTexture.h  

void VMSamplePseudoVolumeTexture ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceTexture.h  

void VMSampleTexture ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceTexture.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 GPU sim functionality. NiagaraDataInterfaceTexture.h  

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceTexture.h  

virtual void DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface. NiagaraDataInterfaceTexture.h  

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

 Determines if this DataInterface is the same as another. NiagaraDataInterfaceTexture.h  

virtual bool GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
FString& OutHLSL
)

   NiagaraDataInterfaceTexture.h  

virtual void GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
FString& OutHLSL
)

   NiagaraDataInterfaceTexture.h  

virtual void GetVMExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
void* InstanceData,
FVMExternalFunction& OutFunc
)

 Returns the delegate for the passed function signature. NiagaraDataInterfaceTexture.h  

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceTexture.h  

virtual bool InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface. NiagaraDataInterfaceTexture.h  

virtual int32 PerInstanceDataSize ()

 Returns the size of the per instance data for this interface. NiagaraDataInterfaceTexture.h  

virtual bool PerInstanceTick ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance,
float DeltaSeconds
)

 Ticks the per instance data for this interface, if it has any. NiagaraDataInterfaceTexture.h  
Set the shader parameters will only be called if the data interface provided shader parameters. NiagaraDataInterfaceTexture.h  

virtual bool UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature
)

 Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade. NiagaraDataInterfaceTexture.h  

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceTexture.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceTexture.h  

virtual void PostLoad()

   NiagaraDataInterfaceTexture.h  

virtual void Serialize ( FArchive& Ar
)

   NiagaraDataInterfaceTexture.h  

Overridden from UObjectBaseUtility

Name Remarks Include Path Unreal Specifiers

virtual bool CanBeInCluster()

   NiagaraDataInterfaceTexture.h  

Protected

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceTexture.h  

virtual void GetFunctionsInternal ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

   NiagaraDataInterfaceTexture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page