Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FNiagaraMeshVertexFactory

Vertex factory for rendering instanced mesh particles with out dynamic parameter support.

Windows

MacOS

Linux

Inheritance Hierarchy

FRenderResource

FVertexFactory

FNiagaraVertexFactoryBase

FNiagaraMeshVertexFactory

References

Module	NiagaraVertexFactories
Header	/Engine/Plugins/FX/Niagara/Source/NiagaraVertexFactories/Public/NiagaraMeshVertexFactory.h
Include	#include "NiagaraMeshVertexFactory.h"

Syntax

class FNiagaraMeshVertexFactory : public FNiagaraVertexFactoryBase

Remarks

Vertex factory for rendering instanced mesh particles with out dynamic parameter support.

Variables

	Name	Description
FStaticMeshData...	Data
uint32	FloatDataStride
FNiagaraMeshIns...	InstanceVerticesCPU	Used to remember this in the case that we reuse the same vertex factory for multiple renders .
int32	LODIndex
FRHIUniformBuff...	MeshParticleUniformBuffer	Uniform buffer with mesh particle parameters.
FShaderResource...	ParticleDataFloatSRV
uint32	SortedIndicesOffset
FShaderResource...	SortedIndicesSRV

Constructors

	Name	Description
	FNiagaraMeshVertexFactory()
	FNiagaraMeshVertexFactory ( ENiagaraVertexFactoryType InType, ERHIFeatureLevel::Type InFeatureLev... )	Default constructor.

Functions

	Name	Description
void	Copy ( const FNiagaraMeshVertexFactory& O... )	Uint8* LockPreviousTransformBuffer(uint32 ParticleCount); void UnlockPreviousTransformBuffer(); FRHIShaderResourceView* GetPreviousTransformBufferSRV() const; Copy the data from another vertex factory
int32	GetFloatDataStride()
int32	GetLODIndex()
FRHIShaderRe...	GetParticleDataFloatSRV()
int32	GetSortedIndicesOffset()
FRHIShaderRe...	GetSortedIndicesSRV()
FRHIUniformB...	GetUniformBuffer()	Retrieve the uniform buffer for this vertex factory.
void	ModifyCompilationEnvironment ( const FVertexFactoryShaderPermutati..., FShaderCompilerEnvironment& OutEnv... )	Modify compile environment to enable instancing
void	SetData ( const FStaticMeshDataType& InData )	An implementation of the interface used by TSynchronizedResource to update the resource with new data from the game thread.
void	SetLODIndex ( int32 InLODIndex )
void	SetParticleData ( const FShaderResourceViewRHIRef& I..., uint32 InFloatDataStride )
void	SetSortedIndices ( const FShaderResourceViewRHIRef& I..., uint32 InSortedIndicesOffset )
void	SetUniformBuffer ( const FNiagaraMeshUniformBufferRef ... )	Set the uniform buffer for this vertex factory.
bool	ShouldCompilePermutation ( const FVertexFactoryShaderPermutati... )	Should we cache the material's shadertype on this platform with this vertex factory?
bool	SupportsTessellationShaders()

Overridden from FVertexFactory

		Name	Description
	FVertexFacto...	GetType()

Overridden from FRenderResource

		Name	Description
	void	InitRHI()	Initializes the RHI resources used by this resource.

Constants

Name	Description
StaticType

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

Take our survey

Dismiss