FParticleSpriteVertexFactory | Unreal Engine 5.7 Documentation

Vertex factory for rendering particle sprites.


Name	FParticleSpriteVertexFactory
Type	class
Header File	/Engine/Source/Runtime/Engine/Public/ParticleVertexFactory.h
Include Path	#include "ParticleVertexFactory.h"

Syntax

class FParticleSpriteVertexFactory : public FParticleVertexFactoryBase

Name	Remarks	Include Path	Unreal Specifiers
FParticleSpriteVertexFactory ( EParticleVertexFactoryType InType, ERHIFeatureLevel::Type InFeatureLevel )	Default constructor.	ParticleVertexFactory.h
FParticleSpriteVertexFactory ( ERHIFeatureLevel::Type InFeatureLevel )		ParticleVertexFactory.h

Name	Type	Remarks	Include Path
StaticType	FVertexFactoryType		ParticleVertexFactory.h

Name	Type	Remarks	Include Path
bCustomAlignment	bool		ParticleVertexFactory.h
bUsesDynamicParameter	bool		ParticleVertexFactory.h
CutoutGeometrySRV	FRHIShaderResourceView *		ParticleVertexFactory.h
DynamicParameterStride	uint32		ParticleVertexFactory.h
NumCutoutVerticesPerFrame	int32		ParticleVertexFactory.h
NumVertsInInstanceBuffer	int32		ParticleVertexFactory.h
SpriteUniformBuffer	FUniformBufferRHIRef	Uniform buffer with sprite paramters.	ParticleVertexFactory.h

Name	Remarks	Include Path
bool GetCustomAlignment()		ParticleVertexFactory.h
FRHIShaderResourceView * GetCutoutGeometrySRV()		ParticleVertexFactory.h
int32 GetNumCutoutVerticesPerFrame()		ParticleVertexFactory.h
FRHIUniformBuffer * GetSpriteUniformBuffer()	Retrieve the uniform buffer for this vertex factory.	ParticleVertexFactory.h
void SetCustomAlignment ( bool bAlign )		ParticleVertexFactory.h
void SetCutoutParameters ( int32 InNumCutoutVerticesPerFrame, FRHIShaderResourceView* InCutoutGeometrySRV )		ParticleVertexFactory.h
void SetDynamicParameterBuffer ( const FVertexBuffer* InDynamicParameterBuffer, uint32 StreamOffset, uint32 Stride )	Set the source vertex buffer that contains particle dynamic parameter data.	ParticleVertexFactory.h
void SetInstanceBuffer ( const FVertexBuffer* InInstanceBuffer, uint32 StreamOffset, uint32 Stride )	Set the source vertex buffer that contains particle instance data.	ParticleVertexFactory.h
void SetNumVertsInInstanceBuffer ( int32 InNumVertsInInstanceBuffer )		ParticleVertexFactory.h
void SetSpriteUniformBuffer ( const FParticleSpriteUniformBufferRef& InSpriteUniformBuffer )	Set the uniform buffer for this vertex factory.	ParticleVertexFactory.h
void SetTexCoordBuffer ( const FVertexBuffer* InTexCoordBuffer )		ParticleVertexFactory.h
void SetUsesDynamicParameter ( bool bInUsesDynamicParameter, uint32 Stride )		ParticleVertexFactory.h

Name	Remarks	Include Path	Unreal Specifiers
virtual FVertexFactoryType * GetType()		ParticleVertexFactory.h
virtual bool RendersPrimitivesAsCameraFacingSprites()		ParticleVertexFactory.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void InitRHI ( FRHICommandListBase& RHICmdList )	Initialize the Render Hardware Interface for this vertex factory	ParticleVertexFactory.h

Name	Remarks	Include Path	Unreal Specifiers
void InitStreams()	Initialize streams for this vertex factory.	ParticleVertexFactory.h

Name	Remarks	Include Path
static FRHIVertexDeclaration * GetPSOPrecacheVertexDeclaration ( bool bUsesDynamicParameter )		ParticleVertexFactory.h
static void GetPSOPrecacheVertexFetchElements ( EVertexInputStreamType VertexInputStreamType, FVertexDeclarationElementList& Elements )	Get vertex elements used when during PSO precaching materials using this vertex factory type	ParticleVertexFactory.h
static void ModifyCompilationEnvironment ( const FVertexFactoryShaderPermutationParameters& Parameters, FShaderCompilerEnvironment& OutEnvironment )	Can be overridden by FVertexFactory subclasses to modify their compile environment just before compilation occurs.	ParticleVertexFactory.h
static bool ShouldCompilePermutation ( const FVertexFactoryShaderPermutationParameters& Parameters )	Should we cache the material's shadertype on this platform with this vertex factory?	ParticleVertexFactory.h