Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > RenderCore > FVertexFactory

Light Theme

Dark Theme

FVertexFactory

Encapsulates a vertex data source which can be linked into a vertex shader.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FRenderResource

FVertexFactory

FGeometryCacheVertexVertexFactory

FGeomCacheVertexFactory

FGeometryCollectionVertexFactory

FGPUBaseSkinVertexFactory

TGPUSkinVertexFactory

TGPUSkinAPEXClothVertexFactory

TMultipleInfluenceClothVertexFactory

TGPUSkinMorphVertexFactory

FHairCardsVertexFactory

FHairStrandsVertexFactory

FLandscapeVertexFactory

FLandscapeFixedGridVertexFactory

FLandscapeVertexFactoryMobile

FLandscapeFixedGridVertexFactoryMobile

FLandscapeXYOffsetVertexFactory

FLocalVertexFactory

	FCanvasTileRendererItem::FTileVertexFactory
	FCanvasTriangleRendererItem::FTriangleVertexFactory
	FGPUSkinPassthroughVertexFactory
	FInstancedStaticMeshVertexFactory

FNiagaraVertexFactoryBase

FNiagaraMeshVertexFactory

FNiagaraMeshVertexFactoryEx

FNiagaraRibbonVertexFactory

FNiagaraSpriteVertexFactory

FNiagaraSpriteVertexFactoryEx

FParticleVertexFactoryBase

	FMeshParticleVertexFactory
	FParticleBeamTrailVertexFactory
	FParticleSpriteVertexFactory

TWaterVertexFactory

References

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

Syntax

class FVertexFactory : public FRenderResource

Remarks

Encapsulates a vertex data source which can be linked into a vertex shader.

Variables

	Name	Description
bool	bNeedsDeclaration	VF can explicitly set this to false to avoid errors without decls; this is for VFs that fetch from buffers directly (e.g. Niagara)
bool	bSupportsManualVertexFetch
TArray< FVertex...	Streams	The vertex streams used to render the factory.

Constructors

	Name	Description
	FVertexFactory ( ERHIFeatureLevel::Type InFeatureLev... )

Functions

	Name	Description
FVertexEleme...	AccessStreamComponent ( const FVertexStreamComponent& Comp..., uint8 AttributeIndex, EVertexInputStreamType InputStreamT... )	Creates a vertex element for a vertex stream component.
FVertexEleme...	AccessStreamComponent ( const FVertexStreamComponent& Comp..., uint8 AttributeIndex )	Creates a vertex element for a vertex stream components.
bool	AddPrimitiveIdStreamElement ( EVertexInputStreamType InputStreamT..., FVertexDeclarationElementList& Ele..., uint8 AttributeIndex, uint8 AttributeIndex_Mobile )
FVertexDecla...	GetDeclaration()	Accessors.
const FVerte...	GetDeclaration ( EVertexInputStreamType InputStreamT... )
int32	GetPrimitiveIdStreamIndex ( const FStaticFeatureLevel InFeature..., EVertexInputStreamType InputStreamT... )
void	GetStreams ( ERHIFeatureLevel::Type InFeatureLev..., EVertexInputStreamType VertexStream..., FVertexInputStreamArray& OutVertex... )
FVertexFacto...	GetType()
void	InitDeclaration ( const FVertexDeclarationElementList..., EVertexInputStreamType StreamType )	Initializes the vertex declaration.
bool	IsCoarseProxyMesh()
void	ModifyCompilationEnvironment ( const FVertexFactoryShaderPermutati..., FShaderCompilerEnvironment& OutEnv... )	Can be overridden by FVertexFactory subclasses to modify their compile environment just before compilation occurs.
bool	NeedsDeclaration()
void	OffsetInstanceStreams ( uint32 InstanceOffset, EVertexInputStreamType VertexStream..., FVertexInputStreamArray& VertexStr... )
bool	RendersPrimitivesAsCameraFacingSprites()
void	SetDeclaration ( FVertexDeclarationRHIRef& NewDecla... )
void	SetPrimitiveIdStreamIndex ( const FStaticFeatureLevel InFeature..., EVertexInputStreamType InputStreamT..., int32 StreamIndex )
bool	SupportsGPUScene ( const FStaticFeatureLevel InFeature... )
bool	SupportsManualVertexFetch ( const FStaticFeatureLevel InFeature... )
bool	SupportsNullPixelShader()	Indicates whether the vertex factory supports a null pixel shader.
bool	SupportsPositionAndNormalOnlyStream()	Indicates whether the vertex factory supports a position-and-normal-only stream.
bool	SupportsPositionOnlyStream()	Indicates whether the vertex factory supports a position-only stream.
void	ValidateCompiledResult ( const FVertexFactoryType* Type, EShaderPlatform Platform, const FShaderParameterMap& Paramet..., TArray< FString >& OutErrors )	Can be overridden by FVertexFactory subclasses to fail a compile based on compilation output.

Overridden from FRenderResource

		Name	Description
	void	ReleaseRHI()	Releases the RHI resources used by this resource.

Classes

	Name	Description
	FVertexStream	Information needed to set a vertex stream.

Constants

Name	Description
PrimitiveIdStreamStride