1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceRenderTarget2D

UNiagaraDataInterfaceRenderTarget2D

Unreal Engine C++ API Reference > Plugins > Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;EditInlineNew, Category&61;"Rendering", CollapseCategories,  
       Meta&61;&40;DisplayName&61;"Render Target 2D"&41;, Blueprintable, BlueprintType, MinimalAPI&41;  
class UNiagaraDataInterfaceRenderTarget2D : public UNiagaraDataInterfaceRWBase

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bInheritUserParameterSettings When enabled texture parameters (size / etc) are taken from the user provided render target.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverrideFormat  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bPreviewRenderTarget  
Public variable UProperty Category, EditAnywhere, Meta ENiagaraMipMapGeneration MipMapGeneration Controls if and when we generate mips for the render target.
Public variable UProperty Category, EditAnywhere, Meta ENiagaraMipMapGenerationType MipMapGenerationType  
Public variable UProperty Category, EditAnywhere, Meta TEnumAsByte< TextureFilter > OverrideRenderTargetFilter When enabled overrides the filter of the render target, otherwise uses the project default setting.
Public variable UProperty Category, EditAnywhere, Meta TEnumAsByte< ETextureRenderTargetFormat > OverrideRenderTargetFormat When enabled overrides the format of the render target, otherwise uses the project default setting.
Public variable UProperty Category, EditAnywhere, Meta FNiagaraUserParameterBinding RenderTargetUserParameter  
Public variable UProperty Category, EditAnywhere, Meta FIntPoint Size  
Protected variable TMap< FNiagaraSystemInstanceID, FRenderTarget2DRWInstanceData_GameThread * > SystemInstancesToProxyData_GT  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

VMGetNumMipLevels ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMGetSize ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMSetFormat ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMSetSize ( FVectorVMExternalFunctionContext& Context
)

  

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool GPU sim functionality.
Public function Virtual Const bool VM functionality.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public 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 Const void  
Public function Virtual Const void  
Public function Virtual Const bool

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

  
Public function Virtual bool

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

  
Public function Virtual void Gets all the available functions for this data interface.
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 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 bool

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

  
Public function Virtual void

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

 Subclasses that wish to work with GPU systems/emitters must implement this.
Public function Virtual Const bool

RenderVariableToCanvas ( FNiagaraSystemInstanceID SystemInstanceID,
FName VariableName,
FCanvas* Canvas,
const FIntRect& DrawRect
)

  
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.

Constants

Name Description
ExposedRTVar  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page