FVertexFactory | Unreal Engine 5.5 Documentation

Unreal Engine C++ API Reference > Runtime > RenderCore

Inheritance Hierarchy

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

	Type	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)
	FVertexStreamList	Streams	The vertex streams used to render the factory.

Constructors

	Type	Name	Description
		FVertexFactory ( ERHIFeatureLevel::Type InFeatureLevel )

Functions

Type	Name	Description
FVertexElement	AccessStreamComponent ( const FVertexStreamComponent& Component, uint8 AttributeIndex, VertexStreamListType& InOutStreams )	Creates a vertex element for a vertex stream components.
FVertexElement	AccessStreamComponent ( const FVertexStreamComponent& Component, uint8 AttributeIndex, EVertexInputStreamType InputStreamType )	Creates a vertex element for a vertex stream component.
FVertexElement	AccessStreamComponent ( const FVertexStreamComponent& Component, uint8 AttributeIndex )	Creates a vertex element for a vertex stream components.
bool	AddPrimitiveIdStreamElement ( EVertexInputStreamType InputStreamType, FVertexDeclarationElementList& Elements, uint8 AttributeIndex, uint8 AttributeIndex_Mobile )
FVertexDeclarationRHIRef &	GetDeclaration ()	Accessors.
const FVertexDeclarationRHIRef &	GetDeclaration ( EVertexInputStreamType InputStreamType )
int32	GetPrimitiveIdStreamIndex ( const FStaticFeatureLevel InFeatureLevel, EVertexInputStreamType InputStreamType )
void	GetPSOPrecacheVertexFetchElements ( EVertexInputStreamType VertexInputStreamType, FVertexDeclarationElementList& Elements )	Can be overridden by FVertexFactory subclasses which have EVertexFactoryFlags::SupportsPSOPrecaching set - this function will only be called when that flag is set
void	GetStreams ( ERHIFeatureLevel::Type InFeatureLevel, EVertexInputStreamType VertexStreamType, FVertexInputStreamArray& OutVertexStreams )
FVertexFactoryType *	GetType ()
void	InitDeclaration ( const FVertexDeclarationElementList& Elements, EVertexInputStreamType StreamType )	Initializes the vertex declaration.
bool	IsCoarseProxyMesh ()
void	ModifyCompilationEnvironment ( const FVertexFactoryShaderPermutationParameters& Parameters, FShaderCompilerEnvironment& OutEnvironment )	Can be overridden by FVertexFactory subclasses to modify their compile environment just before compilation occurs.
bool	NeedsDeclaration ()
void	OffsetInstanceStreams ( uint32 InstanceOffset, EVertexInputStreamType VertexStreamType, FVertexInputStreamArray& VertexStreams )
bool	RendersPrimitivesAsCameraFacingSprites ()
void	SetDeclaration ( FVertexDeclarationRHIRef& NewDeclaration )
void	SetPrimitiveIdStreamIndex ( const FStaticFeatureLevel InFeatureLevel, EVertexInputStreamType InputStreamType, int32 StreamIndex )
bool	SupportsGPUScene ( const FStaticFeatureLevel InFeatureLevel )
bool	SupportsManualVertexFetch ( const FStaticFeatureLevel InFeatureLevel )
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& ParameterMap, TArray< FString >& OutErrors )	Can be overridden by FVertexFactory subclasses to fail a compile based on compilation output.