1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceVolumeTexture

UNiagaraDataInterfaceVolumeTexture

Data Interface allowing sampling of a texture

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

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

Remarks

Data Interface allowing sampling of a texture

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta TextureSize TextureSampler END_SHADER_PARAMETER_STRUCT() public FNiagaraUserParameterBinding TextureUserParameter  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function  

BEGIN_SHADER_PARAMETER_STRUCT ( FShaderParameters
)

  
Public function void

GetTextureDimensions ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

SampleVolumeTexture ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

SetTexture ( UTexture* InTexture
)

  
Public function TextureSize  

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool GPU sim functionality.
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual void

DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface.
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

 Determines if this DataInterface is the same as another.
Public function Virtual bool

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

  
Protected function Virtual Const void  
Public function Virtual void  
Public function Virtual void

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

 Returns the delegate for the passed function signature.
Public function Virtual Const bool  
Public function Virtual bool

InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface.
Public function Virtual Const int32 Returns the size of the per instance data for this interface.
Public function Virtual bool

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

 Ticks the per instance data for this interface, if it has any.
Public function Virtual Const void Set the shader parameters will only be called if the data interface provided shader parameters.

Overridden from UNiagaraDataInterfaceBase

  Type Name Description
Public function Virtual Const void 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
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Overridden from UObjectBaseUtility

  Type Name Description
Public function Virtual Const bool Called during cluster construction if the object can be added to a cluster

Constants

Name Description
LoadVolumeTextureName  
SampleVolumeTextureName  
TemplateShaderFilePath  
TextureDimsName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page