1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceParticleRead

UNiagaraDataInterfaceParticleRead

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS (EditInlineNew, Category="ParticleRead", CollapseCategories,  
       Meta=(DisplayName="Particle Attribute Reader"), MinimalAPI)  
class UNiagaraDataInterfaceParticleRead : public UNiagaraDataInterfaceRWBase

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function  

BEGIN_SHADER_PARAMETER_STRUCT ( FShaderParameters
)

  
Protected function Const void  
Public function void

GetNumParticles ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetNumSpawnedParticles ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetParticleIndex ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetParticleIndexFromIDTable ( FVectorVMExternalFunctionContext& Context
)

  
Protected function Const void  
Public function void

GetSpawnedIDAtIndex ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

ReadBool ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadBoolByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadColor ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadColorByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadFloat ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadFloatByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadID ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadIDByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadInt ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadIntByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadPosition ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadPositionByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadQuat ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadQuatByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadVector2 ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadVector2ByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadVector3 ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadVector3ByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadVector4 ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function void

ReadVector4ByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

  
Public function NumSpawnedParticles

SHADER_PARAMETER ( int,
SpawnedParticlesAcquireTag
)

  
Public function NumSpawnedParticles InstanceCountOffset

SHADER_PARAMETER ( uint32,
ParticleStrideFloat
)

  
Public function NumSpawnedParticles InstanceCountOffset ParticleStrideInt

SHADER_PARAMETER ( uint32,
ParticleStrideHalf
)

  
Public function NumSpawnedParticles InstanceCountOffset ParticleStrideInt AcquireTagRegisterIndex

SHADER_PARAMETER_SRV ( Buffer< int >,
SpawnedIDsBuffer
)

  
Public function NumSpawnedParticles InstanceCountOffset ParticleStrideInt AcquireTagRegisterIndex IDToIndexTable

SHADER_PARAMETER_SRV ( Buffer< float >,
InputFloatBuffer
)

  
Public function void

VMGetLocalSpace ( FVectorVMExternalFunctionContext& Context
)

  

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool 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  
Protected 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 Allows a DI to specify data dependencies between emitters, so the system can ensure that the emitter instances are executed in the correct order.
Public function Virtual Const void

GetEmitterReferencesByName ( TArray< FString >& EmitterReferences
)

  
Public function Virtual void Query the data interface to give feedback to the end user.
Public function Virtual bool

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

  
Protected function Virtual Const void  
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 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 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 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.
Public function Virtual Const FNiagaraDataInterfaceParametersCS *

CreateShaderStorage ( const FNiagaraDataInterfaceGPUParamInfo& ParameterInfo,
const FShaderParameterMap& ParameterMap
)

 Optional storage that can be created per shader when not in legacy binding mode.
Public function Virtual Const const FTypeLayoutDesc * If we create shader storage we must also supply the type of the storage so we understand how to serialize it.
Public function Virtual Const bool

HasInternalAttributeReads ( const UNiagaraEmitter* OwnerEmitter,
const UNiagaraEmitter* Provider
)

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

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual NumSpawnedParticles InstanceCountOffset ParticleStrideInt AcquireTagRegisterIndex IDToIndexTable Inp... Selects which emitter the data interface will bind to, i.e the emitter we are contained within or a named emitter.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

  Type Name Description
Protected variable UProperty FString EmitterName_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page