1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceRenderTarget2DArray

UNiagaraDataInterfaceRenderTarget2DArray

API > API/Plugins > API/Plugins/Niagara

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

Syntax

UCLASS (EditInlineNew, Category="Rendering", CollapseCategories,  
       Meta=(DisplayName="Render Target 2D Array"), Blueprintable, BlueprintType, MinimalAPI)  
class UNiagaraDataInterfaceRenderTarget2DArray : public UNiagaraDataInterfaceRWBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceRenderTarget2DArray ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceRenderTarget2DArray.h  

Constants

Name Type Remarks Include Path
ExposedRTVar FNiagaraVariableBase   NiagaraDataInterfaceRenderTarget2DArray.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. NiagaraDataInterfaceRenderTarget2DArray.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=0)
bOverrideFormat uint8   NiagaraDataInterfaceRenderTarget2DArray.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=10, EditCondition="!bInheritUserParameterSettings", EditConditionHides)
bPreviewRenderTarget uint8   NiagaraDataInterfaceRenderTarget2DArray.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. NiagaraDataInterfaceRenderTarget2DArray.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. NiagaraDataInterfaceRenderTarget2DArray.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=11, EditCondition="!bInheritUserParameterSettings && bOverrideFormat", EditConditionHides)
RenderTargetUserParameter FNiagaraUserParameterBinding   NiagaraDataInterfaceRenderTarget2DArray.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   NiagaraDataInterfaceRenderTarget2DArray.h
  • EditAnywhere
  • Category="Render Target"
  • Meta=(DisplayPriority=2, EditCondition="!bInheritUserParameterSettings", EditConditionHides)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void VMGetNumMipLevels ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceRenderTarget2DArray.h  

void VMGetSize ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceRenderTarget2DArray.h  

void VMSetFormat ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceRenderTarget2DArray.h  

void VMSetSize ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceRenderTarget2DArray.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 GPU sim functionality. NiagaraDataInterfaceRenderTarget2DArray.h  

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

 VM functionality. NiagaraDataInterfaceRenderTarget2DArray.h  

virtual bool CanExposeVariables()

   NiagaraDataInterfaceRenderTarget2DArray.h  

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceRenderTarget2DArray.h  

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

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

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

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

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

   NiagaraDataInterfaceRenderTarget2DArray.h  

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

   NiagaraDataInterfaceRenderTarget2DArray.h  

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

   NiagaraDataInterfaceRenderTarget2DArray.h  

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

   NiagaraDataInterfaceRenderTarget2DArray.h  

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

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

virtual bool HasPostSimulateTick()

   NiagaraDataInterfaceRenderTarget2DArray.h  

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceRenderTarget2DArray.h  

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

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

virtual int32 PerInstanceDataSize ()

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

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

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

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

   NiagaraDataInterfaceRenderTarget2DArray.h  

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

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

virtual bool UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature
)

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

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceRenderTarget2DArray.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceRenderTarget2DArray.h  

Protected

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

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

   NiagaraDataInterfaceRenderTarget2DArray.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page