1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceVolumeTexture

UNiagaraDataInterfaceVolumeTexture

Data Interface allowing sampling of a texture

API > API/Plugins > API/Plugins/Niagara

Data Interface allowing sampling of a texture

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

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceVolumeTexture ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceVolumeTexture.h  

Classes

Name Remarks
FShaderParameters  

Constants

Name Type Remarks Include Path
LoadVolumeTextureName const FName   NiagaraDataInterfaceVolumeTexture.h
SampleVolumeTextureName const FName   NiagaraDataInterfaceVolumeTexture.h
TemplateShaderFilePath const TCHAR *   NiagaraDataInterfaceVolumeTexture.h
TextureDimsName const FName   NiagaraDataInterfaceVolumeTexture.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Texture TObjectPtr< UTexture >   NiagaraDataInterfaceVolumeTexture.h
  • EditAnywhere
  • Category="Texture"
  • Meta=(AllowedClasses="/Script/Engine.VolumeTexture,/Script/Engine.TextureRenderTargetVolume")
TextureUserParameter FNiagaraUserParameterBinding   NiagaraDataInterfaceVolumeTexture.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 GetTextureDimensions ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceVolumeTexture.h  

void SampleVolumeTexture ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceVolumeTexture.h  

void SetTexture ( UTexture* InTexture
)

   NiagaraDataInterfaceVolumeTexture.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 GPU sim functionality. NiagaraDataInterfaceVolumeTexture.h  

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceVolumeTexture.h  

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

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

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

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

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

   NiagaraDataInterfaceVolumeTexture.h  

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

   NiagaraDataInterfaceVolumeTexture.h  

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

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

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceVolumeTexture.h  

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

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

virtual int32 PerInstanceDataSize ()

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

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

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

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceVolumeTexture.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceVolumeTexture.h  

Overridden from UObjectBaseUtility

Name Remarks Include Path Unreal Specifiers

virtual bool CanBeInCluster()

   NiagaraDataInterfaceVolumeTexture.h  

Protected

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceVolumeTexture.h  

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

   NiagaraDataInterfaceVolumeTexture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page