UNiagaraDataInterfaceGrid2DCollection

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Niagara

Header

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

Include

#include "NiagaraDataInterfaceGrid2DCollection.h"

Syntax

UCLASS(EditInlineNew, Category="Grid", Meta=(DisplayName="Grid2D Collection", Experimental),
       Blueprintable, BlueprintType)
class UNiagaraDataInterfaceGrid2DCollection : public UNiagaraDataInterfaceGrid2D

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Meta

uint8: 1

 

bOverrideFormat

Public variable UProperty Category, EditAnywhere, Meta

uint8: 1

 

bPreviewGrid

Protected variable UProperty Transient

TMap< uint64, T...

 

ManagedRenderTargets

Public variable UProperty Category, EditAnywhere, Meta

ENiagaraGpuBuff...

 

OverrideBufferFormat

When enabled overrides the format used to store data inside the grid, otherwise uses the project default setting.

Public variable UProperty Category, EditAnywhere, Meta

FName

 

PreviewAttribute

Public variable UProperty Category, EditAnywhere

FNiagaraUserPar...

 

RenderTargetUserParameter

Reference to a user parameter if we're reading one.

Protected variable

TMap< FNiagaraS...

 

SystemInstancesToProxyData_GT

Constructors

Name Description

Public function

UNiagaraDataInterfaceGrid2DCollection

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

bool

 

CanCreateVarFromFuncName

(
    const FName& FuncName
)

Public function Virtual UFunction BlueprintCallable, Category, Meta

bool

 

FillRawTexture2D

(
    const UNiagaraComponent* Compo...,
    UTextureRenderTarget2D* Dest,
    int& TilesX,
    int& TilesY
)

Public function Virtual UFunction BlueprintCallable, Category, Meta

bool

 

FillTexture2D

(
    const UNiagaraComponent* Compo...,
    UTextureRenderTarget2D* dest,
    int AttributeIndex
)

Fills a texture render target 2d with the current data from the simulation #todo(dmp): this will eventually go away when we formalize how data makes it out of Niagara

Public function Const

void

 

FindAttributes

(
    TArray< FNiagaraVariableBase >& Ou...,
    TArray< uint32 >& OutVariableOffse...,
    int32& OutNumAttribChannelsFound,
    TArray< FText >* OutWarnings
)

Finds all attributes by locating the data interface amongst the parameter stores.

Public function Const

void

 

FindAttributesByName

(
    FName DataInterfaceName,
    TArray< FNiagaraVariableBase >& Ou...,
    TArray< uint32 >& OutVariableOffse...,
    int32& OutNumAttribChannelsFound,
    TArray< FText >* OutWarnings
)

Finds all attributes by locating the variable name inside the parameter stores.

Public function

void

 

GetAttributeIndex

(
    FVectorVMExternalFunctionContext& ...,
    const FName& InName,
    int32 NumChannels
)

Public function

void

 

GetCellSize

(
    FVectorVMExternalFunctionContext& ...
)

Public function Static

int32

 

GetComponentCountFromFuncName

(
    const FName& FuncName
)

Public function

void

 

GetNumCells

(
    FVectorVMExternalFunctionContext& ...
)

Public function Virtual UFunction BlueprintCallable, Category, Meta

void

 

GetRawTextureSize

(
    const UNiagaraComponent* Compo...,
    int& SizeX,
    int& SizeY
)

Public function Virtual UFunction BlueprintCallable, Category

void

 

GetTextureSize

(
    const UNiagaraComponent* Compo...,
    int& SizeX,
    int& SizeY
)

Public function Static

FNiagaraType...

 

GetValueTypeFromFuncName

(
    const FName& FuncName
)

Public function

void

 

GetWorldBBoxSize

(
    FVectorVMExternalFunctionContext& ...
)

Public function

void

 

SetNumCells

(
    FVectorVMExternalFunctionContext& ...
)

Protected function Const

FName

 

TypeDefinitionToGetFunctionName

(
    const FNiagaraTypeDefinition& InDe...
)

Protected function Const

const TCHAR ...

 

TypeDefinitionToHLSLTypeString

(
    const FNiagaraTypeDefinition& InDe...
)

Protected function Const

FName

 

TypeDefinitionToSetFunctionName

(
    const FNiagaraTypeDefinition& InDe...
)

Protected function

void

 

WriteAttributeGetIndexHLSL

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

Protected function

void

 

WriteGetHLSL

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

Protected function

void

 

WriteSampleHLSL

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

Protected function

void

 

WriteSetHLSL

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

Overridden from UNiagaraDataInterface

Name Description

Public function Virtual Const

bool

 

AppendCompileHash

(
    FNiagaraCompileHashVisitor* In...
)

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

Public function Virtual Const

bool

 

CanExposeVariables()

Public function Virtual Const

bool

 

CanRenderVariablesToCanvas()

Protected 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

bool

 

GenerateIterationSourceNamespaceReadAttributesHLSL

(
    FNiagaraDataInterfaceGPUParamInfo&...,
    const FNiagaraVariable& InIteratio...,
    TConstArrayView< FNiagaraVariable >...,
    TConstArrayView< FNiagaraVariable >...,
    TConstArrayView< FString > InAttrib...,
    bool bInSetToDefaults,
    bool bSpawnOnly,
    bool bPartialWrites,
    TArray< FText >& OutErrors,
    FString& OutHLSL
)

Generate the necessary plumbing HLSL at the beginning of the stage where this is used as a sim stage iteration source.

Public function Virtual Const

bool

 

GenerateIterationSourceNamespaceWriteAttributesHLSL

(
    FNiagaraDataInterfaceGPUParamInfo&...,
    const FNiagaraVariable& InIteratio...,
    TConstArrayView< FNiagaraVariable >...,
    TConstArrayView< FNiagaraVariable >...,
    TConstArrayView< FString > InAttrib...,
    bool bSpawnOnly,
    bool bPartialWrites,
    TArray< FText >& OutErrors,
    FString& OutHLSL
)

Generate the necessary plumbing HLSL at the end of the stage where this is used as a sim stage iteration source.

Public function Virtual Const

bool

 

GenerateSetupHLSL

(
    FNiagaraDataInterfaceGPUParamInfo&...,
    TConstArrayView< FNiagaraVariable >...,
    bool bSpawnOnly,
    bool bPartialWrites,
    TArray< FText >& OutErrors,
    FString& OutHLSL
)

Generate the necessary HLSL to set up data when being added as a sim stage sim source.

Public function Virtual Const

bool

 

GenerateTeardownHLSL

(
    FNiagaraDataInterfaceGPUParamInfo&...,
    TConstArrayView< FNiagaraVariable >...,
    bool bSpawnOnly,
    bool bPartialWrites,
    TArray< FText >& OutErrors,
    FString& OutHLSL
)

Generate the necessary HLSL to tear down data when being added as a sim stage sim source.

Public function Virtual Const

void

 

GetCanvasVariables

(
    TArray< FNiagaraVariableBase >& Ou...
)

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

void

 

GetFeedback

(
    UNiagaraSystem* InAsset,
    UNiagaraComponent* InComponent,
    TArray< FNiagaraDataInterfaceError ...,
    TArray< FNiagaraDataInterfaceFeedba...,
    TArray< FNiagaraDataInterfaceFeedba...
)

Query the data interface to give feedback to the end user.

Public function Virtual

bool

 

GetFunctionHLSL

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

Public function Virtual

void

 

GetFunctions

(
    TArray< FNiagaraFunctionSignature >...
)

VM functionality.

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* System...,
    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 Const

bool

 

RenderVariableToCanvas

(
    FNiagaraSystemInstanceID SystemInst...,
    FName VariableName,
    FCanvas* Canvas,
    const FIntRect& DrawRect
)

Public function Virtual Const

bool

 

SupportsIterationSourceNamespaceAttributesHLSL()

Can this data interface be used as a StackContext parameter map replacement when being used as a sim stage iteration source?

Public function Virtual Const

bool

 

SupportsSetupAndTeardownHLSL()

Does this data interface need setup and teardown for each stage when working a sim stage sim source?

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