1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceTexture

UNiagaraDataInterfaceTexture

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/NiagaraDataInterfaceTexture.h
Include #include "NiagaraDataInterfaceTexture.h"

Syntax

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

Remarks

Data Interface allowing sampling of a texture

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta TextureSizeTextureSHADER_PARAMETER_SAMPLER(SamplerState, TextureSampler) END_SHADER_PARAMETER_STRUCT... TextureUserParameter  

Constructors

  Type Name Description
Public function  

UNiagaraDataInterfaceTexture ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function  

BEGIN_SHADER_PARAMETER_STRUCT ( FShaderParameters
)

  
Public function void

SetTexture ( UTexture* InTexture
)

  
Public function TextureSize

SHADER_PARAMETER ( int32,
MipLevels
)

  
Public function void

VMGetNumMipLevels ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMGetTextureDimensions ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMSamplePseudoVolumeTexture ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMSampleTexture ( FVectorVMExternalFunctionContext& Context
)

  

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.
Public function Virtual bool Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.

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.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

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
GatherRedTexture2DName  
GetNumMipLevelsName  
GetTextureDimensionsName  
LoadTexture2DName  
SamplePseudoVolumeTextureName  
SampleTexture2DName  
TemplateShaderFilePath  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page