UNiagaraDataInterfaceRenderTargetVolume

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceRenderTargetVolume.h

Include

#include "NiagaraDataInterfaceRenderTargetVolume.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Category="Grid", Meta=(DisplayName="Render Target Volume", Experimental),
       Blueprintable, BlueprintType)
class UNiagaraDataInterfaceRenderTargetVolume : public UNiagaraDataInterfaceRWBase

Variables

Name Description

Public variable UProperty Category, EditAnywhere

uint8: 1

 

bInheritUserParameterSettings

When enabled texture parameters (size / etc) are taken from the user provided render target.

Public variable UProperty Category, EditAnywhere

uint8: 1

 

bOverrideFormat

Public variable UProperty Category, EditAnywhere

uint8: 1

 

bPreviewRenderTarget

Protected variable UProperty Transient duplicatetransient

TMap< uint64, U...

 

ManagedRenderTargets

Public variable UProperty Category, EditAnywhere, Meta

TEnumAsByte< ET...

 

OverrideRenderTargetFormat

When enabled overrides the format of the render target, otherwise uses the project default setting.

Public variable UProperty Category, EditAnywhere, Meta

FNiagaraUserPar...

 

RenderTargetUserParameter

Public variable UProperty Category, EditAnywhere, Meta

FIntVector

 

Size

Constructors

Name Description

Public function

UNiagaraDataInterfaceRenderTargetVolume

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

GetSize

(
    FVectorVMContext& Context
)

Public function

void

 

SetSize

(
    FVectorVMContext& Context
)

Overridden from UNiagaraDataInterface

Name Description

Public function Virtual Const

bool

 

CanExecuteOnTarget

(
    ENiagaraSimTarget Target
)

VM functionality.

Public function Virtual Const

bool

 

CanExposeVariables()

Public function Virtual Const

bool

 

CopyToInternal

(
    UNiagaraDataInterface* Destina...
)

Public function Virtual

void

 

DestroyPerInstanceData

(
    void* PerInstanceData,
    FNiagaraSystemInstance* System...
)

Destroys the per instance data for this interface.

Public function Virtual Const

bool

 

Equals

(
    const UNiagaraDataInterface* O...
)

Determines if this DataInterface is the same as another.

Public function Virtual Const

void

 

GetExposedVariables

(
    TArray< FNiagaraVariableBase >& Ou...
)

Public function Virtual Const

bool

 

GetExposedVariableValue

(
    const FNiagaraVariableBase& InVari...,
    void* InPerInstanceData,
    FNiagaraSystemInstance* InSyst...,
    void* OutData
)

Public function Virtual

bool

 

GetFunctionHLSL

(
    const FNiagaraDataInterfaceGPUParam...,
    const FNiagaraDataInterfaceGenerate...,
    int FunctionInstanceIndex,
    FString& OutHLSL
)

Public function Virtual

void

 

GetFunctions

(
    TArray< FNiagaraFunctionSignature >...
)

Gets all the available functions for this data interface.

Public function Virtual

void

 

GetParameterDefinitionHLSL

(
    const FNiagaraDataInterfaceGPUParam...,
    FString& OutHLSL
)

GPU sim functionality.

Public function Virtual

void

 

GetVMExternalFunction

(
    const FVMExternalFunctionBindingInf...,
    void* InstanceData,
    FVMExternalFunction& OutFunc
)

Returns the delegate for the passed function signature.

Public function Virtual Const

bool

 

HasPostSimulateTick()

Public function Virtual Const

bool

 

HasPreSimulateTick()

Public function Virtual

bool

 

InitPerInstanceData

(
    void* PerInstanceData,
    FNiagaraSystemInstance* System...
)

Initializes the per instance data for this interface.

Public function Virtual Const

int32

 

PerInstanceDataSize()

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

Public function Virtual

bool

 

PerInstanceTick

(
    void* PerInstanceData,
    FNiagaraSystemInstance* System...,
    float DeltaSeconds
)

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

Public function Virtual

bool

 

PerInstanceTickPostSimulate

(
    void* PerInstanceData,
    FNiagaraSystemInstance* InSyst...,
    float DeltaSeconds
)

Public function Virtual

void

 

ProvidePerInstanceDataForRenderThread

(
    void* DataForRenderThread,
    void* PerInstanceData,
    const FNiagaraSystemInstanceID& Sy...
)

Subclasses that wish to work with GPU systems/emitters must implement this.

Public function Virtual

bool

 

UpgradeFunctionCall

(
    FNiagaraFunctionSignature& Functio...
)

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

Overridden from UNiagaraDataInterfaceBase

Name Description

Public function Virtual

void

 

BindParameters

(
    FNiagaraDataInterfaceParametersCS&...,
    const FNiagaraDataInterfaceGPUParam...,
    const FShaderParameterMap& Paramet...
)

Methods that operate on an instance of type FNiagaraDataInterfaceParametersCS*, created by the above CreateComputeParameters() method

Public function Virtual Const

FNiagaraData...

 

CreateComputeParameters()

Constructs the correct CS parameter type for this DI (if any).

Public function Virtual Const

const FTypeL...

 

GetComputeParametersTypeDesc()

Public function Virtual Const

void

 

SetParameters

(
    const FNiagaraDataInterfaceParamete...,
    FRHICommandList& RHICmdList,
    const FNiagaraDataInterfaceSetArgs ...
)

Public function Virtual Const

void

 

UnsetParameters

(
    const FNiagaraDataInterfaceParamete...,
    FRHICommandList& RHICmdList,
    const FNiagaraDataInterfaceSetArgs ...
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Constants

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss