UNiagaraDataInterfaceBase

Base class for all Niagara data interfaces.

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterface2DArrayTexture

UNiagaraDataInterfaceArray

UNiagaraDataInterfaceArrayBool

UNiagaraDataInterfaceArrayColor

UNiagaraDataInterfaceArrayFloat

UNiagaraDataInterfaceArrayFloat2

UNiagaraDataInterfaceArrayFloat3

UNiagaraDataInterfaceArrayFloat4

UNiagaraDataInterfaceArrayInt32

UNiagaraDataInterfaceArrayQuat

UNiagaraDataInterfaceAudioOscilloscope

UNiagaraDataInterfaceAudioPlayer

UNiagaraDataInterfaceAudioSubmix

UNiagaraDataInterfaceAudioSpectrum

UNiagaraDataInterfaceCamera

UNiagaraDataInterfaceChaosDestruction

UNiagaraDataInterfaceCollisionQuery

UNiagaraDataInterfaceCubeTexture

UNiagaraDataInterfaceCurlNoise

UNiagaraDataInterfaceCurveBase

UNiagaraDataInterfaceColorCurve

UNiagaraDataInterfaceCurve

UNiagaraDataInterfaceVector2DCurve

UNiagaraDataInterfaceVector4Curve

UNiagaraDataInterfaceVectorCurve

UNiagaraDataInterfaceExport

UNiagaraDataInterfaceHairStrands

UNiagaraDataInterfaceLandscape

UNiagaraDataInterfaceMeshRendererInfo

UNiagaraDataInterfaceOcclusion

UNiagaraDataInterfacePhysicsAsset

UNiagaraDataInterfacePhysicsField

UNiagaraDataInterfacePlatformSet

UNiagaraDataInterfaceRWBase

UNiagaraDataInterfaceGrid2D

UNiagaraDataInterfaceGrid2DCollection

UNiagaraDataInterfaceGrid2DCollectionReader

UNiagaraDataInterfaceGrid3D

UNiagaraDataInterfaceGrid3DCollection

UNiagaraDataInterfaceNeighborGrid3D

UNiagaraDataInterfaceIntRenderTarget2D

UNiagaraDataInterfaceParticleRead

UNiagaraDataInterfaceRenderTarget2D

UNiagaraDataInterfaceRenderTarget2DArray

UNiagaraDataInterfaceRenderTargetCube

UNiagaraDataInterfaceRenderTargetVolume

UNiagaraDataInterfaceVelocityGrid

UNiagaraDataInterfacePressureGrid

UNiagaraDataInterfaceSimpleCounter

UNiagaraDataInterfaceSkeletalMesh

UNiagaraDataInterfaceSpline

UNiagaraDataInterfaceStaticMesh

UNiagaraDataInterfaceTexture

UNiagaraDataInterfaceVectorField

UNiagaraDataInterfaceVolumeTexture

UNiagaraDataInterfaceWater

References

Module

NiagaraCore

Header

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

Include

#include "NiagaraDataInterfaceBase.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(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 ...
)

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