UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
FLocalVertexFactory Class Reference

#include <LocalVertexFactory.h>

+ Inheritance diagram for FLocalVertexFactory:

Classes

struct  FDataType
 
struct  FDebugName
 

Public Member Functions

ENGINE_API FLocalVertexFactory (ERHIFeatureLevel::Type InFeatureLevel, const char *InDebugName)
 
virtual ENGINE_API ~FLocalVertexFactory ()
 
ENGINE_API void SetData (FRHICommandListBase &RHICmdList, const FDataType &InData)
 
ENGINE_API void SetData (const FDataType &InData)
 
ENGINE_API void Copy (const FLocalVertexFactory &Other)
 
virtual ENGINE_API void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual void ReleaseRHI () override
 
void SetColorOverrideStream (FRHICommandList &RHICmdList, const FVertexBuffer *ColorVertexBuffer) const
 
void GetColorOverrideStream (const FVertexBuffer *ColorVertexBuffer, FVertexInputStreamArray &VertexStreams) const
 
virtual FShaderResourceViewRHIRef GetTriangleSortingPositionSRV () const override
 
FRHIShaderResourceView * GetPositionsSRV () const
 
FRHIShaderResourceView * GetPreSkinPositionSRV () const
 
FRHIShaderResourceView * GetTangentsSRV () const
 
FRHIShaderResourceView * GetTextureCoordinatesSRV () const
 
FRHIShaderResourceView * GetColorComponentsSRV () const
 
const uint32 GetColorIndexMask () const
 
const int GetLightMapCoordinateIndex () const
 
const int GetNumTexcoords () const
 
FRHIUniformBuffer * GetUniformBuffer () const
 
- Public Member Functions inherited from FVertexFactory
 FVertexFactory (ERHIFeatureLevel::Type InFeatureLevel)
 
virtual RENDERCORE_API ~FVertexFactory ()
 
virtual FVertexFactoryType * GetType () const
 
RENDERCORE_API void GetStreams (ERHIFeatureLevel::Type InFeatureLevel, EVertexInputStreamType VertexStreamType, FVertexInputStreamArray &OutVertexStreams) const
 
RENDERCORE_API void OffsetInstanceStreams (uint32 InstanceOffset, EVertexInputStreamType VertexStreamType, FVertexInputStreamArray &VertexStreams) const
 
FVertexDeclarationRHIRef & GetDeclaration ()
 
void SetDeclaration (FVertexDeclarationRHIRef &NewDeclaration)
 
const FVertexDeclarationRHIRef & GetDeclaration (EVertexInputStreamType InputStreamType) const
 
virtual bool SupportsPositionOnlyStream () const
 
virtual bool SupportsPositionAndNormalOnlyStream () const
 
bool SupportsNullPixelShader () const
 
bool SupportsTriangleSorting () const
 
virtual bool RendersPrimitivesAsCameraFacingSprites () const
 
bool NeedsDeclaration () const
 
bool SupportsManualVertexFetch (const FStaticFeatureLevel InFeatureLevel) const
 
int32 GetPrimitiveIdStreamIndex (const FStaticFeatureLevel InFeatureLevel, EVertexInputStreamType InputStreamType) const
 
bool SupportsGPUScene (const FStaticFeatureLevel InFeatureLevel) const
 
- Public Member Functions inherited from FRenderResource
RENDERCORE_API FRenderResource ()
 
RENDERCORE_API FRenderResource (ERHIFeatureLevel::Type InFeatureLevel)
 
RENDERCORE_API FRenderResource (const FRenderResource &)
 
RENDERCORE_API FRenderResource (FRenderResource &&)
 
RENDERCORE_API FRenderResource & operator= (const FRenderResource &Other)
 
RENDERCORE_API FRenderResource & operator= (FRenderResource &&Other)
 
virtual RENDERCORE_API ~FRenderResource ()
 
virtual RENDERCORE_API void InitResource (FRHICommandListBase &RHICmdList)
 
virtual RENDERCORE_API void ReleaseResource ()
 
RENDERCORE_API void UpdateRHI (FRHICommandListBase &RHICmdList)
 
virtual FString GetFriendlyName () const
 
bool IsInitialized () const
 
int32 GetListIndex () const
 
EInitPhase GetInitPhase () const
 
void SetOwnerName (FName InOwnerName)
 
FName GetOwnerName () const
 
void SetResourceName (FName InResourceName)
 
FName GetResourceName () const
 

Static Public Member Functions

static ENGINE_API bool ShouldCompilePermutation (const FVertexFactoryShaderPermutationParameters &Parameters)
 
static ENGINE_API void ModifyCompilationEnvironment (const FVertexFactoryShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &OutEnvironment)
 
static ENGINE_API void ValidateCompiledResult (const FVertexFactoryType *Type, EShaderPlatform Platform, const FShaderParameterMap &ParameterMap, TArray< FString > &OutErrors)
 
static ENGINE_API void GetPSOPrecacheVertexFetchElements (EVertexInputStreamType VertexInputStreamType, FVertexDeclarationElementList &Elements)
 
static ENGINE_API void GetVertexElements (ERHIFeatureLevel::Type FeatureLevel, EVertexInputStreamType InputStreamType, bool bSupportsManualVertexFetch, FDataType &Data, FVertexDeclarationElementList &Elements)
 
- Static Public Member Functions inherited from FVertexFactory
static void ModifyCompilationEnvironment (const FVertexFactoryShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &OutEnvironment)
 
static void ValidateCompiledResult (const FVertexFactoryType *Type, EShaderPlatform Platform, const FShaderParameterMap &ParameterMap, TArray< FString > &OutErrors)
 
static void GetPSOPrecacheVertexFetchElements (EVertexInputStreamType VertexInputStreamType, FVertexDeclarationElementList &Elements)
 
- Static Public Member Functions inherited from FRenderResource
static RENDERCORE_API void ReleaseRHIForAllResources ()
 
static RENDERCORE_API void InitPreRHIResources ()
 
static RENDERCORE_API void ChangeFeatureLevel (ERHIFeatureLevel::Type NewFeatureLevel)
 
static RENDERCORE_API FName SetScopeName (FName Name)
 

Protected Member Functions

const FDataType & GetData () const
 
- Protected Member Functions inherited from FVertexFactory
void SetPrimitiveIdStreamIndex (const FStaticFeatureLevel InFeatureLevel, EVertexInputStreamType InputStreamType, int32 StreamIndex)
 
RENDERCORE_API bool AddPrimitiveIdStreamElement (EVertexInputStreamType InputStreamType, FVertexDeclarationElementList &Elements, uint8 AttributeIndex, uint8 AttributeIndex_Mobile)
 
FVertexElement AccessStreamComponent (const FVertexStreamComponent &Component, uint8 AttributeIndex)
 
RENDERCORE_API FVertexElement AccessStreamComponent (const FVertexStreamComponent &Component, uint8 AttributeIndex, EVertexInputStreamType InputStreamType)
 
RENDERCORE_API void InitDeclaration (const FVertexDeclarationElementList &Elements, EVertexInputStreamType StreamType=EVertexInputStreamType::Default)
 
- Protected Member Functions inherited from FRenderResource
void SetFeatureLevel (const FStaticFeatureLevel InFeatureLevel)
 
const FStaticFeatureLevel GetFeatureLevel () const
 
bool HasValidFeatureLevel () const
 
template<typename T >
FBufferRHIRef CreateRHIBuffer (FRHICommandListBase &RHICmdList, T &InOutResourceObject, uint32 ResourceCount, EBufferUsageFlags InBufferUsageFlags, const TCHAR *InDebugName)
 
void SetInitPhase (EInitPhase InInitPhase)
 

Static Protected Member Functions

static ENGINE_API void GetVertexElements (ERHIFeatureLevel::Type FeatureLevel, EVertexInputStreamType InputStreamType, bool bSupportsManualVertexFetch, FDataType &Data, FVertexDeclarationElementList &Elements, FVertexStreamList &InOutStreams, int32 &OutColorStreamIndex)
 
- Static Protected Member Functions inherited from FVertexFactory
template<typename VertexStreamListType >
static FVertexElement AccessStreamComponent (const FVertexStreamComponent &Component, uint8 AttributeIndex, VertexStreamListType &InOutStreams)
 
- Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBase & GetImmediateCommandList ()
 

Protected Attributes

FDataType Data
 
TUniformBufferRef< FLocalVertexFactoryUniformShaderParameters > UniformBuffer
 
int32 ColorStreamIndex
 
bool bGPUSkinPassThrough = false
 
struct FLocalVertexFactory::FDebugName DebugName
 
- Protected Attributes inherited from FVertexFactory
FVertexStreamList Streams
 
bool bNeedsDeclaration = true
 

Friends

class FLocalVertexFactoryShaderParameters
 
class FSkeletalMeshSceneProxy
 

Additional Inherited Members

- Public Types inherited from FRenderResource
enum class  EInitPhase : uint8 { Pre , Default , MAX }
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 
- Protected Types inherited from FVertexFactory
typedef TArray< FVertexStream, TInlineAllocator< 8 > > FVertexStreamList
 

Detailed Description

A vertex factory which simply transforms explicit vertex attributes from local to world space.

Constructor & Destructor Documentation

◆ FLocalVertexFactory()

FLocalVertexFactory::FLocalVertexFactory ( ERHIFeatureLevel::Type  InFeatureLevel,
const char *  InDebugName 
)

◆ ~FLocalVertexFactory()

FLocalVertexFactory::~FLocalVertexFactory ( )
virtualdefault

Member Function Documentation

◆ Copy()

void FLocalVertexFactory::Copy ( const FLocalVertexFactory &  Other)

Copy the data from another vertex factory

Parameters
Other- factory to copy from

◆ GetColorComponentsSRV()

FRHIShaderResourceView * FLocalVertexFactory::GetColorComponentsSRV ( ) const
inline

◆ GetColorIndexMask()

const uint32 FLocalVertexFactory::GetColorIndexMask ( ) const
inline

◆ GetColorOverrideStream()

void FLocalVertexFactory::GetColorOverrideStream ( const FVertexBuffer *  ColorVertexBuffer,
FVertexInputStreamArray &  VertexStreams 
) const
inline

◆ GetData()

const FDataType & FLocalVertexFactory::GetData ( ) const
inlineprotected

◆ GetLightMapCoordinateIndex()

const int FLocalVertexFactory::GetLightMapCoordinateIndex ( ) const
inline

◆ GetNumTexcoords()

const int FLocalVertexFactory::GetNumTexcoords ( ) const
inline

◆ GetPositionsSRV()

FRHIShaderResourceView * FLocalVertexFactory::GetPositionsSRV ( ) const
inline

◆ GetPreSkinPositionSRV()

FRHIShaderResourceView * FLocalVertexFactory::GetPreSkinPositionSRV ( ) const
inline

◆ GetPSOPrecacheVertexFetchElements()

void FLocalVertexFactory::GetPSOPrecacheVertexFetchElements ( EVertexInputStreamType  VertexInputStreamType,
FVertexDeclarationElementList &  Elements 
)
static

Return the vertex elements used when manual vertex fetch is used

◆ GetTangentsSRV()

FRHIShaderResourceView * FLocalVertexFactory::GetTangentsSRV ( ) const
inline

◆ GetTextureCoordinatesSRV()

FRHIShaderResourceView * FLocalVertexFactory::GetTextureCoordinatesSRV ( ) const
inline

◆ GetTriangleSortingPositionSRV()

virtual FShaderResourceViewRHIRef FLocalVertexFactory::GetTriangleSortingPositionSRV ( ) const
inlineoverridevirtual

Reimplemented from FVertexFactory.

◆ GetUniformBuffer()

FRHIUniformBuffer * FLocalVertexFactory::GetUniformBuffer ( ) const
inline

◆ GetVertexElements() [1/2]

void FLocalVertexFactory::GetVertexElements ( ERHIFeatureLevel::Type  FeatureLevel,
EVertexInputStreamType  InputStreamType,
bool  bSupportsManualVertexFetch,
FDataType &  Data,
FVertexDeclarationElementList &  Elements 
)
static

◆ GetVertexElements() [2/2]

void FLocalVertexFactory::GetVertexElements ( ERHIFeatureLevel::Type  FeatureLevel,
EVertexInputStreamType  InputStreamType,
bool  bSupportsManualVertexFetch,
FDataType &  Data,
FVertexDeclarationElementList &  Elements,
FVertexStreamList &  InOutStreams,
int32 &  OutColorStreamIndex 
)
staticprotected

◆ InitRHI()

void FLocalVertexFactory::InitRHI ( FRHICommandListBase &  RHICmdList)
overridevirtual

Initializes the RHI resources used by this resource. Called when entering the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FRenderResource.

Reimplemented in FInstancedStaticMeshVertexFactory, FSingleTriangleMeshVertexFactory, and FQuadMeshVertexFactory.

◆ ModifyCompilationEnvironment()

void FLocalVertexFactory::ModifyCompilationEnvironment ( const FVertexFactoryShaderPermutationParameters &  Parameters,
FShaderCompilerEnvironment &  OutEnvironment 
)
static

◆ ReleaseRHI()

virtual void FLocalVertexFactory::ReleaseRHI ( )
inlineoverridevirtual

Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FVertexFactory.

◆ SetColorOverrideStream()

void FLocalVertexFactory::SetColorOverrideStream ( FRHICommandList &  RHICmdList,
const FVertexBuffer *  ColorVertexBuffer 
) const
inline

◆ SetData() [1/2]

void FLocalVertexFactory::SetData ( const FDataType &  InData)

◆ SetData() [2/2]

void FLocalVertexFactory::SetData ( FRHICommandListBase &  RHICmdList,
const FDataType &  InData 
)

An implementation of the interface used by TSynchronizedResource to update the resource with new data from the game thread.

◆ ShouldCompilePermutation()

bool FLocalVertexFactory::ShouldCompilePermutation ( const FVertexFactoryShaderPermutationParameters &  Parameters)
static

Should we cache the material's shadertype on this platform with this vertex factory?

◆ ValidateCompiledResult()

void FLocalVertexFactory::ValidateCompiledResult ( const FVertexFactoryType *  Type,
EShaderPlatform  Platform,
const FShaderParameterMap &  ParameterMap,
TArray< FString > &  OutErrors 
)
static

Friends And Related Symbol Documentation

◆ FLocalVertexFactoryShaderParameters

friend class FLocalVertexFactoryShaderParameters
friend

◆ FSkeletalMeshSceneProxy

friend class FSkeletalMeshSceneProxy
friend

Member Data Documentation

◆ bGPUSkinPassThrough

bool FLocalVertexFactory::bGPUSkinPassThrough = false
protected

◆ ColorStreamIndex

int32 FLocalVertexFactory::ColorStreamIndex
protected

◆ Data

FDataType FLocalVertexFactory::Data
protected

◆ DebugName

struct FLocalVertexFactory::FDebugName FLocalVertexFactory::DebugName
protected

◆ UniformBuffer

TUniformBufferRef<FLocalVertexFactoryUniformShaderParameters> FLocalVertexFactory::UniformBuffer
protected
The documentation for this class was generated from the following files: