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

> Unreal Engine API Reference > Runtime > Engine > FMeshParticleVertexFactory

Light Theme

Dark Theme

FMeshParticleVertexFactory

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

Windows

MacOS

Linux

Inheritance Hierarchy

FRenderResource

FVertexFactory

FParticleVertexFactoryBase

FMeshParticleVertexFactory

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/MeshParticleVertexFactory.h
Include	#include "MeshParticleVertexFactory.h"

Syntax

class FMeshParticleVertexFactory : public FParticleVertexFactoryBase

Remarks

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

Variables

	Name	Description
FDataType	Data
int32	DynamicParameterVertexStride
int32	DynamicVertexStride	Stride information for instanced mesh particles
FMeshParticleIn...	InstanceVerticesCPU	Used to remember this in the case that we reuse the same vertex factory for multiple renders .
uint8	LODIdx
FRHIUniformBuff...	MeshParticleUniformBuffer	Uniform buffer with mesh particle parameters.
FDynamicReadBuf...	PrevTransformBuffer

Constructors

	Name	Description
	FMeshParticleVertexFactory()
	FMeshParticleVertexFactory ( ERHIFeatureLevel::Type InFeatureLev... )
	FMeshParticleVertexFactory ( EParticleVertexFactoryType InType, ERHIFeatureLevel::Type InFeatureLev..., int32 InDynamicVertexStride, int32 InDynamicParameterVertexStrid... )	Default constructor.

Functions

	Name	Description
void	Copy ( const FMeshParticleVertexFactory& ... )	Copy the data from another vertex factory
FMeshParticl...	GetInstanceVerticesCPU()
uint8	GetLODIdx()
FRHIShaderRe...	GetPreviousTransformBufferSRV()
FRHIUniformB...	GetUniformBuffer()	Retrieve the uniform buffer for this vertex factory.
uint8 *	LockPreviousTransformBuffer ( uint32 ParticleCount )
void	ModifyCompilationEnvironment ( const FVertexFactoryShaderPermutati..., FShaderCompilerEnvironment& OutEnv... )	Modify compile environment to enable instancing
void	SetData ( const FDataType& InData )	An implementation of the interface used by TSynchronizedResource to update the resource with new data from the game thread.
void	SetDynamicParameterBuffer ( const FVertexBuffer* InDynamic..., uint32 StreamOffset, uint32 Stride )	Set the source vertex buffer that contains particle dynamic parameter data.
void	SetInstanceBuffer ( const FVertexBuffer* InstanceB..., uint32 StreamOffset, uint32 Stride )	Set the source vertex buffer that contains particle instance data.
void	SetLODIdx ( uint8 InLODIdx )
void	SetStrides ( int32 InDynamicVertexStride, int32 InDynamicParameterVertexStrid... )	Update the data strides (MUST HAPPEN BEFORE InitRHI is called)
void	SetUniformBuffer ( const FMeshParticleUniformBufferRef... )	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()
void	UnlockPreviousTransformBuffer()

Overridden from FVertexFactory

		Name	Description
	FVertexFacto...	GetType()

Overridden from FRenderResource

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

Classes

	Name	Description
	FBatchParametersCPU
	FDataType

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