1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceParticleRead

UNiagaraDataInterfaceParticleRead

API > API/Plugins > API/Plugins/Niagara

   
Name UNiagaraDataInterfaceParticleRead
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceParticleRead.h
Include Path #include "NiagaraDataInterfaceParticleRead.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceParticleRead ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceParticleRead.h  

Classes

Name Remarks
FShaderParameters  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
EmitterBinding FNiagaraDataInterfaceEmitterBinding Selects which emitter the data interface will bind to, i.e the emitter we are contained within or a named emitter. NiagaraDataInterfaceParticleRead.h
  • EditAnywhere
  • Category="Emitter"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void GetNumParticles ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceParticleRead.h  

void GetNumSpawnedParticles ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceParticleRead.h  

void GetParticleIndex ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceParticleRead.h  

void GetParticleIndexFromIDTable ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceParticleRead.h  

void GetSpawnedIDAtIndex ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceParticleRead.h  

void ReadBool ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadBoolByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadColor ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadColorByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadFloat ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadFloatByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadID ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadIDByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadInt ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadIntByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadPosition ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadPositionByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadQuat ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadQuatByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadVector2 ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadVector2ByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadVector3 ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadVector3ByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadVector4 ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void ReadVector4ByIndex ( FVectorVMExternalFunctionContext& Context,
FName AttributeToRead
)

   NiagaraDataInterfaceParticleRead.h  

void VMGetLocalSpace ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceParticleRead.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

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

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceParticleRead.h  

virtual void DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface. NiagaraDataInterfaceParticleRead.h  

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

 Determines if this DataInterface is the same as another. NiagaraDataInterfaceParticleRead.h  

virtual void GetEmitterDependencies ( UNiagaraSystem* Asset,
TArray< FVersionedNiagaraEmitter >& Dependencies
) const

 Allows a DI to specify data dependencies between emitters, so the system can ensure that the emitter instances are executed in the correct order. NiagaraDataInterfaceParticleRead.h  

virtual void GetEmitterReferencesByName ( TArray< FString >& EmitterReferences
) const

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

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

   NiagaraDataInterfaceParticleRead.h  

virtual void GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
FString& OutHLSL
)

   NiagaraDataInterfaceParticleRead.h  

virtual void GetVMExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
void* InstanceData,
FVMExternalFunction& OutFunc
)

 Returns the delegate for the passed function signature. NiagaraDataInterfaceParticleRead.h  

virtual bool InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface. NiagaraDataInterfaceParticleRead.h  

virtual int32 PerInstanceDataSize ()

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

virtual void ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread,
void* PerInstanceData,
const FNiagaraSystemInstanceID& SystemInstance
)

 Subclasses that wish to work with GPU systems/emitters must implement this. NiagaraDataInterfaceParticleRead.h  
Set the shader parameters will only be called if the data interface provided shader parameters. NiagaraDataInterfaceParticleRead.h  

virtual bool UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature
)

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

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceParticleRead.h  

virtual FNiagaraDataInterfaceParametersCS * CreateShaderStorage ( const FNiagaraDataInterfaceGPUParamInfo& ParameterInfo,
const FShaderParameterMap& ParameterMap
) const

   NiagaraDataInterfaceParticleRead.h  

virtual const FTypeLayoutDesc * GetShaderStorageType()

   NiagaraDataInterfaceParticleRead.h  

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

   NiagaraDataInterfaceParticleRead.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraDataInterfaceParticleRead.h  

virtual void PostInitProperties()

   NiagaraDataInterfaceParticleRead.h  

virtual void PostLoad()

   NiagaraDataInterfaceParticleRead.h  

Protected

Name Remarks Include Path Unreal Specifiers

void GetIndexFunctions ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

   NiagaraDataInterfaceParticleRead.h  

void GetPersistentIDFunctions ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

   NiagaraDataInterfaceParticleRead.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceParticleRead.h  

virtual void GetFunctionsInternal ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

   NiagaraDataInterfaceParticleRead.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
EmitterName_DEPRECATED FString   NiagaraDataInterfaceParticleRead.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page