UNiagaraDataInterfaceBase

Base class for all Niagara data interfaces.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterface2DArrayTexture

UNiagaraDataInterfaceAudioOscilloscope

UNiagaraDataInterfaceAudioPlayer

UNiagaraDataInterfaceAudioSubmix

UNiagaraDataInterfaceAudioSpectrum

UNiagaraDataInterfaceCamera

UNiagaraDataInterfaceChaosDestruction

UNiagaraDataInterfaceCollisionQuery

UNiagaraDataInterfaceCubeTexture

UNiagaraDataInterfaceCurlNoise

UNiagaraDataInterfaceCurveBase

UNiagaraDataInterfaceColorCurve

UNiagaraDataInterfaceCurve

UNiagaraDataInterfaceVector2DCurve

UNiagaraDataInterfaceVector4Curve

UNiagaraDataInterfaceVectorCurve

UNiagaraDataInterfaceExport

UNiagaraDataInterfaceGeometryCollection

UNiagaraDataInterfaceHairStrands

UNiagaraDataInterfaceLandscape

UNiagaraDataInterfaceMeshRendererInfo

UNiagaraDataInterfaceOcclusion

UNiagaraDataInterfacePhysicsAsset

UNiagaraDataInterfacePhysicsField

UNiagaraDataInterfacePlatformSet

UNiagaraDataInterfaceRigidMeshCollisionQuery

UNiagaraDataInterfaceRWBase

UNiagaraDataInterfaceArray

UNiagaraDataInterfaceArrayBool

UNiagaraDataInterfaceArrayColor

UNiagaraDataInterfaceArrayFloat

UNiagaraDataInterfaceArrayFloat2

UNiagaraDataInterfaceArrayFloat3

UNiagaraDataInterfaceArrayFloat4

UNiagaraDataInterfaceArrayInt32

UNiagaraDataInterfaceArrayNiagaraID

UNiagaraDataInterfaceArrayPosition

UNiagaraDataInterfaceArrayQuat

UNiagaraDataInterfaceGrid2D

UNiagaraDataInterfaceGrid2DCollection

UNiagaraDataInterfaceGrid2DCollectionReader

UNiagaraDataInterfaceGrid3D

UNiagaraDataInterfaceGrid3DCollection

UNiagaraDataInterfaceGrid3DCollectionReader

UNiagaraDataInterfaceNeighborGrid3D

UNiagaraDataInterfaceRasterizationGrid3D

UNiagaraDataInterfaceIntRenderTarget2D

UNiagaraDataInterfaceParticleRead

UNiagaraDataInterfaceRenderTarget2D

UNiagaraDataInterfaceRenderTarget2DArray

UNiagaraDataInterfaceRenderTargetCube

UNiagaraDataInterfaceRenderTargetVolume

UNiagaraDataInterfaceVelocityGrid

UNiagaraDataInterfacePressureGrid

UNiagaraDataInterfaceSkeletalMesh

UNiagaraDataInterfaceSpline

UNiagaraDataInterfaceTexture

UNiagaraDataInterfaceVectorField

UNiagaraDataInterfaceVolumeTexture

UNiagaraDataInterfaceWater

References

Module

NiagaraCore

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraCore/Public/NiagaraDataInterfaceBase.h

Include

#include "NiagaraDataInterfaceBase.h"

Syntax

UCLASS(Abstract, EditInlineNew)
class UNiagaraDataInterfaceBase : public UNiagaraMergeable

Remarks

Base class for all Niagara data interfaces.

Constructors

Name Description

Public function

UNiagaraDataInterfaceBase

(
    const FObjectInitializer& ObjectIn...
)

Functions

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

bool

 

HasInternalAttributeReads

(
    const UNiagaraEmitter* OwnerEm...,
    const UNiagaraEmitter* Provide...
)

Returns true if the DI (owned by OwnerEmitter) reads any attributes from the Provider emitter

Public function Virtual Const

void

 

SetParameters

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

Public function Virtual Const

void

 

UnsetParameters

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