1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceSparseVolumeTexture

UNiagaraDataInterfaceSparseVolumeTexture

Data Interface allowing sampling of a sparse volume texture

API > API/Plugins > API/Plugins/Niagara

Data Interface allowing sampling of a sparse volume texture

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

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceSparseVolumeTexture ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceSparseVolumeTexture.h  

Classes

Name Remarks
FShaderParameters  

Constants

Name Type Remarks Include Path
GetNumFramesName const FName   NiagaraDataInterfaceSparseVolumeTexture.h
GetNumMipLevelsName const FName   NiagaraDataInterfaceSparseVolumeTexture.h
GetTextureDimensionsName const FName   NiagaraDataInterfaceSparseVolumeTexture.h
LoadSparseVolumeTextureName const FName   NiagaraDataInterfaceSparseVolumeTexture.h
RequestSparseVolumeTextureFrameName const FName   NiagaraDataInterfaceSparseVolumeTexture.h
SampleSparseVolumeTextureName const FName   NiagaraDataInterfaceSparseVolumeTexture.h
TemplateShaderFilePath const TCHAR *   NiagaraDataInterfaceSparseVolumeTexture.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BlockingStreamingRequests bool   NiagaraDataInterfaceSparseVolumeTexture.h
  • EditAnywhere
  • Category="SparseVolumeTexture"
SparseVolumeTexture TObjectPtr< USparseVolumeTexture >   NiagaraDataInterfaceSparseVolumeTexture.h
  • EditAnywhere
  • Category="SparseVolumeTexture"
SparseVolumeTextureUserParameter FNiagaraUserParameterBinding   NiagaraDataInterfaceSparseVolumeTexture.h
  • EditAnywhere
  • Category="SparseVolumeTexture"
  • 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 ( USparseVolumeTexture* InSparseVolumeTexture
)

   NiagaraDataInterfaceSparseVolumeTexture.h  

void VMGetNumFrames ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSparseVolumeTexture.h  

void VMGetNumMipLevels ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSparseVolumeTexture.h  

void VMGetTextureDimensions ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSparseVolumeTexture.h  

void VMRequestSparseVolumeTextureFrame ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSparseVolumeTexture.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 GPU sim functionality. NiagaraDataInterfaceSparseVolumeTexture.h  

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceSparseVolumeTexture.h  

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

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

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

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

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

   NiagaraDataInterfaceSparseVolumeTexture.h  

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

   NiagaraDataInterfaceSparseVolumeTexture.h  

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

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

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceSparseVolumeTexture.h  

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

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

virtual int32 PerInstanceDataSize ()

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

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

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

virtual bool UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature
)

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

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceSparseVolumeTexture.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceSparseVolumeTexture.h  

virtual void PostLoad()

   NiagaraDataInterfaceSparseVolumeTexture.h  

virtual void Serialize ( FArchive& Ar
)

   NiagaraDataInterfaceSparseVolumeTexture.h  

Protected

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceSparseVolumeTexture.h  

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

   NiagaraDataInterfaceSparseVolumeTexture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page