1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceRenderTargetVolume

UNiagaraDataInterfaceRenderTargetVolume

API > API/Plugins > API/Plugins/Niagara

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

Syntax

UCLASS (EditInlineNew, Category="Rendering", CollapseCategories,  
       Meta=(DisplayName="Render Target Volume"), Blueprintable, BlueprintType, MinimalAPI)  
class UNiagaraDataInterfaceRenderTargetVolume :  
    public UNiagaraDataInterfaceRWBase ,  
    public INiagaraSimCacheCustomStorageInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceRenderTargetVolume ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceRenderTargetVolume.h  

Constants

Name Type Remarks Include Path
ExposedRTVar FNiagaraVariableBase   NiagaraDataInterfaceRenderTargetVolume.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bInheritUserParameterSettings uint8 When enabled texture parameters (size / etc) are taken from the user provided render target. NiagaraDataInterfaceRenderTargetVolume.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=0)
bOverrideFormat uint8   NiagaraDataInterfaceRenderTargetVolume.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=10, EditCondition="!bInheritUserParameterSettings", EditConditionHides)
bPreviewRenderTarget uint8   NiagaraDataInterfaceRenderTargetVolume.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=20)
OverrideRenderTargetFilter TEnumAsByte< TextureFilter > When enabled overrides the filter of the render target, otherwise uses the project default setting. NiagaraDataInterfaceRenderTargetVolume.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=12, EditCondition="!bInheritUserParameterSettings", EditConditionHides)
OverrideRenderTargetFormat TEnumAsByte< ETextureRenderTargetFormat > When enabled overrides the format of the render target, otherwise uses the project default setting. NiagaraDataInterfaceRenderTargetVolume.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=11, EditCondition="!bInheritUserParameterSettings && bOverrideFormat", EditConditionHides)
RenderTargetUserParameter FNiagaraUserParameterBinding   NiagaraDataInterfaceRenderTargetVolume.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=1, ToolTip="When valid the user parameter is used as the render target rather than creating one internal, note that the input render target will be adjusted by the Niagara simulation")
Size FIntVector   NiagaraDataInterfaceRenderTargetVolume.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=2, EditCondition="!bInheritUserParameterSettings", EditConditionHides)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void VMGetNumMipLevels ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceRenderTargetVolume.h  

void VMGetSize ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceRenderTargetVolume.h  

void VMSetFormat ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceRenderTargetVolume.h  

void VMSetSize ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceRenderTargetVolume.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile. NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

 VM functionality. NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool CanExposeVariables()

   NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceRenderTargetVolume.h  

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

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

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

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

virtual void GetExposedVariables ( TArray< FNiagaraVariableBase >& OutVariables
) const

   NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool GetExposedVariableValue ( const FNiagaraVariableBase& InVariable,
void* InPerInstanceData,
FNiagaraSystemInstance* InSystemInstance,
void* OutData
) const

   NiagaraDataInterfaceRenderTargetVolume.h  

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

   NiagaraDataInterfaceRenderTargetVolume.h  

virtual ENiagaraGpuDispatchType GetGpuDispatchType()

   NiagaraDataInterfaceRenderTargetVolume.h  

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

   NiagaraDataInterfaceRenderTargetVolume.h  

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

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

virtual bool HasPostSimulateTick()

   NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceRenderTargetVolume.h  

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

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

virtual int32 PerInstanceDataSize ()

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

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

 Ticks the per instance data for this interface, if it has any. NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool PerInstanceTickPostSimulate ( void* PerInstanceData,
FNiagaraSystemInstance* InSystemInstance,
float DeltaSeconds
)

   NiagaraDataInterfaceRenderTargetVolume.h  

virtual void ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread,
void* PerInstanceData,
const FNiagaraSystemInstanceID& SystemInstance
)

 Subclasses that wish to work with GPU systems/emitters must implement this. NiagaraDataInterfaceRenderTargetVolume.h  
Set the shader parameters will only be called if the data interface provided shader parameters. NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool ShouldCompile ( EShaderPlatform ShaderPlatform
) const

 GPU sim functionality. NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature
)

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

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceRenderTargetVolume.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceRenderTargetVolume.h  

Overridden from INiagaraSimCacheCustomStorageInterface

Name Remarks Include Path Unreal Specifiers

virtual UObject * SimCacheBeginWrite ( UObject* SimCache,
FNiagaraSystemInstance* NiagaraSystemInstance,
const void* OptionalPerInstanceData,
FNiagaraSimCacheFeedbackContext& FeedbackContext
) const

 Called when we begin to write data into a simulation cache. NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool SimCacheEndWrite ( UObject* StorageObject
) const

 Called when we complete writing data into the simulation cache. NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool SimCacheReadFrame ( const FNiagaraSimCacheDataInterfaceReadContext& ReadContext
)

 Read a frame of data from the simulation cache. NiagaraDataInterfaceRenderTargetVolume.h  

virtual bool SimCacheWriteFrame ( UObject* StorageObject,
int FrameIndex,
FNiagaraSystemInstance* SystemInstance,
const void* OptionalPerInstanceData,
FNiagaraSimCacheFeedbackContext& FeedbackContext
) const

 Called when we are ready to write data into the simulation cache. NiagaraDataInterfaceRenderTargetVolume.h  

Protected

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

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

   NiagaraDataInterfaceRenderTargetVolume.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page