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

#include <GeometryCollectionRendering.h>

+ Inheritance diagram for FGeometryCollectionVertexFactory:

Classes

struct  FDataType
 

Public Member Functions

 DECLARE_VERTEX_FACTORY_TYPE_API (FGeometryCollectionVertexFactory, ENGINE_API)
 
 FGeometryCollectionVertexFactory (ERHIFeatureLevel::Type InFeatureLevel, bool EnableLooseParameter=false)
 
void SetData (FRHICommandListBase &RHICmdList, const FDataType &InData)
 
void Copy (const FGeometryCollectionVertexFactory &Other)
 
virtual ENGINE_API void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual ENGINE_API void ReleaseRHI () override
 
FRHIShaderResourceView * GetPositionsSRV () 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
 
FUniformBufferRHIRef GetLooseParameterBuffer () const
 
void SetBoneTransformSRV (FRHIShaderResourceView *BoneTransformSRV)
 
FRHIShaderResourceView * GetBoneTransformSRV () const
 
void SetBonePrevTransformSRV (FRHIShaderResourceView *BonePrevTransformSRV)
 
FRHIShaderResourceView * GetBonePrevTransformSRV () const
 
void SetBoneMapSRV (FRHIShaderResourceView *BoneMapSRV)
 
FRHIShaderResourceView * GetBoneMapSRV () 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 FShaderResourceViewRHIRef GetTriangleSortingPositionSRV () 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 bool UseShaderBoneTransform (EShaderPlatform ShaderPlatform)
 
- 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)
 

Public Attributes

FUniformBufferRHIRef LooseParameterUniformBuffer
 
bool EnableLooseParameter
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 

Additional Inherited Members

- Public Types inherited from FRenderResource
enum class  EInitPhase : uint8 { Pre , Default , MAX }
 
- Protected Types inherited from FVertexFactory
typedef TArray< FVertexStream, TInlineAllocator< 8 > > FVertexStreamList
 
- 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 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 inherited from FVertexFactory
FVertexStreamList Streams
 
bool bNeedsDeclaration = true
 

Detailed Description

A vertex factory for Geometry Collections

Constructor & Destructor Documentation

◆ FGeometryCollectionVertexFactory()

FGeometryCollectionVertexFactory::FGeometryCollectionVertexFactory ( ERHIFeatureLevel::Type  InFeatureLevel,
bool  EnableLooseParameter = false 
)
inline

Member Function Documentation

◆ Copy()

void FGeometryCollectionVertexFactory::Copy ( const FGeometryCollectionVertexFactory &  Other)
inline

◆ DECLARE_VERTEX_FACTORY_TYPE_API()

FGeometryCollectionVertexFactory::DECLARE_VERTEX_FACTORY_TYPE_API ( FGeometryCollectionVertexFactory  ,
ENGINE_API   
)

◆ GetBoneMapSRV()

FRHIShaderResourceView * FGeometryCollectionVertexFactory::GetBoneMapSRV ( ) const
inline

◆ GetBonePrevTransformSRV()

FRHIShaderResourceView * FGeometryCollectionVertexFactory::GetBonePrevTransformSRV ( ) const
inline

◆ GetBoneTransformSRV()

FRHIShaderResourceView * FGeometryCollectionVertexFactory::GetBoneTransformSRV ( ) const
inline

◆ GetColorComponentsSRV()

FRHIShaderResourceView * FGeometryCollectionVertexFactory::GetColorComponentsSRV ( ) const
inline

◆ GetColorIndexMask()

const uint32 FGeometryCollectionVertexFactory::GetColorIndexMask ( ) const
inline

◆ GetLightMapCoordinateIndex()

const int FGeometryCollectionVertexFactory::GetLightMapCoordinateIndex ( ) const
inline

◆ GetLooseParameterBuffer()

FUniformBufferRHIRef FGeometryCollectionVertexFactory::GetLooseParameterBuffer ( ) const
inline

◆ GetNumTexcoords()

const int FGeometryCollectionVertexFactory::GetNumTexcoords ( ) const
inline

◆ GetPositionsSRV()

FRHIShaderResourceView * FGeometryCollectionVertexFactory::GetPositionsSRV ( ) const
inline

◆ GetPSOPrecacheVertexFetchElements()

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

◆ GetTangentsSRV()

FRHIShaderResourceView * FGeometryCollectionVertexFactory::GetTangentsSRV ( ) const
inline

◆ GetTextureCoordinatesSRV()

FRHIShaderResourceView * FGeometryCollectionVertexFactory::GetTextureCoordinatesSRV ( ) const
inline

◆ GetUniformBuffer()

FRHIUniformBuffer * FGeometryCollectionVertexFactory::GetUniformBuffer ( ) const
inline

◆ InitRHI()

void FGeometryCollectionVertexFactory::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.

◆ ModifyCompilationEnvironment()

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

◆ ReleaseRHI()

void FGeometryCollectionVertexFactory::ReleaseRHI ( )
overridevirtual

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.

◆ SetBoneMapSRV()

void FGeometryCollectionVertexFactory::SetBoneMapSRV ( FRHIShaderResourceView *  BoneMapSRV)
inline

◆ SetBonePrevTransformSRV()

void FGeometryCollectionVertexFactory::SetBonePrevTransformSRV ( FRHIShaderResourceView *  BonePrevTransformSRV)
inline

◆ SetBoneTransformSRV()

void FGeometryCollectionVertexFactory::SetBoneTransformSRV ( FRHIShaderResourceView *  BoneTransformSRV)
inline

◆ SetData()

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

◆ ShouldCompilePermutation()

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

◆ UseShaderBoneTransform()

bool FGeometryCollectionVertexFactory::UseShaderBoneTransform ( EShaderPlatform  ShaderPlatform)
static

◆ ValidateCompiledResult()

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

Member Data Documentation

◆ EnableLooseParameter

bool FGeometryCollectionVertexFactory::EnableLooseParameter

◆ LooseParameterUniformBuffer

FUniformBufferRHIRef FGeometryCollectionVertexFactory::LooseParameterUniformBuffer
The documentation for this struct was generated from the following files: