#include <InstancedStaticMesh.h>

Inheritance diagram for FInstancedStaticMeshVertexFactory:

Public Member Functions
	DECLARE_VERTEX_FACTORY_TYPE_API (FInstancedStaticMeshVertexFactory, ENGINE_API)

	FInstancedStaticMeshVertexFactory (ERHIFeatureLevel::Type InFeatureLevel)

void	SetData (FRHICommandListBase &RHICmdList, const FDataType &InData, const FInstancedStaticMeshDataType *InInstanceData)

ENGINE_API void	Copy (const FInstancedStaticMeshVertexFactory &Other)

virtual ENGINE_API void	InitRHI (FRHICommandListBase &RHICmdList) override

FRHIShaderResourceView *	GetInstanceOriginSRV () const

FRHIShaderResourceView *	GetInstanceTransformSRV () const

FRHIShaderResourceView *	GetInstanceLightmapSRV () const

FRHIShaderResourceView *	GetInstanceCustomDataSRV () const

FRHIUniformBuffer *	GetUniformBuffer () const

Public Member Functions inherited from FLocalVertexFactory
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 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	GetPSOPrecacheVertexFetchElements (EVertexInputStreamType VertexInputStreamType, FVertexDeclarationElementList &Elements)

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

static ENGINE_API void	InitInstancedStaticMeshVertexFactoryComponents (const FStaticMeshVertexBuffers &VertexBuffers, const FColorVertexBuffer ColorVertexBuffer, const FStaticMeshInstanceBuffer InstanceBuffer, const FInstancedStaticMeshVertexFactory *VertexFactory, int32 LightMapCoordinateIndex, bool bRHISupportsManualVertexFetch, FInstancedStaticMeshVertexFactory::FDataType &OutData, FInstancedStaticMeshDataType &OutInstanceData)

static constexpr uint32	NumBitsForVisibilityMask ()

Static Public Member Functions inherited from FLocalVertexFactory
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)

Static Protected Member Functions
static ENGINE_API void	GetVertexElements (ERHIFeatureLevel::Type FeatureLevel, EVertexInputStreamType InputStreamType, bool bSupportsManualVertexFetch, FDataType &Data, FInstancedStaticMeshDataType &InstanceData, FVertexDeclarationElementList &Elements, FVertexStreamList &Streams)

Static Protected Member Functions inherited from FLocalVertexFactory
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 ()

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

Protected Member Functions inherited from FLocalVertexFactory
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)

Protected Attributes inherited from FLocalVertexFactory
FDataType	Data

TUniformBufferRef< FLocalVertexFactoryUniformShaderParameters >	UniformBuffer

int32	ColorStreamIndex

bool	bGPUSkinPassThrough = false

struct FLocalVertexFactory::FDebugName	DebugName

Protected Attributes inherited from FVertexFactory
FVertexStreamList	Streams

bool	bNeedsDeclaration = true

Detailed Description

A vertex factory for instanced static meshes

Constructor & Destructor Documentation

◆ FInstancedStaticMeshVertexFactory()

FInstancedStaticMeshVertexFactory::FInstancedStaticMeshVertexFactory ( ERHIFeatureLevel::Type InFeatureLevel )

inline

Member Function Documentation

◆ Copy()

void FInstancedStaticMeshVertexFactory::Copy ( const FInstancedStaticMeshVertexFactory & Other )

Copy the data from another vertex factory

Parameters

Other - factory to copy from

◆ DECLARE_VERTEX_FACTORY_TYPE_API()

FInstancedStaticMeshVertexFactory::DECLARE_VERTEX_FACTORY_TYPE_API	(	FInstancedStaticMeshVertexFactory	,
		ENGINE_API
	)

◆ GetInstanceCustomDataSRV()

FRHIShaderResourceView * FInstancedStaticMeshVertexFactory::GetInstanceCustomDataSRV ( ) const

inline

◆ GetInstanceLightmapSRV()

FRHIShaderResourceView * FInstancedStaticMeshVertexFactory::GetInstanceLightmapSRV ( ) const

inline

◆ GetInstanceOriginSRV()

FRHIShaderResourceView * FInstancedStaticMeshVertexFactory::GetInstanceOriginSRV ( ) const

inline

◆ GetInstanceTransformSRV()

FRHIShaderResourceView * FInstancedStaticMeshVertexFactory::GetInstanceTransformSRV ( ) const

inline

◆ GetPSOPrecacheVertexFetchElements()

void FInstancedStaticMeshVertexFactory::GetPSOPrecacheVertexFetchElements	(	EVertexInputStreamType	VertexInputStreamType,
		FVertexDeclarationElementList &	Elements
	)

static

Get vertex elements used when during PSO precaching materials using this vertex factory type

◆ GetUniformBuffer()

FRHIUniformBuffer * FInstancedStaticMeshVertexFactory::GetUniformBuffer ( ) const

inline

◆ GetVertexElements() [1/2]

void FInstancedStaticMeshVertexFactory::GetVertexElements	(	ERHIFeatureLevel::Type	FeatureLevel,
		EVertexInputStreamType	InputStreamType,
		bool	bSupportsManualVertexFetch,
		FDataType &	Data,
		FInstancedStaticMeshDataType &	InstanceData,
		FVertexDeclarationElementList &	Elements
	)

static

◆ GetVertexElements() [2/2]

void FInstancedStaticMeshVertexFactory::GetVertexElements	(	ERHIFeatureLevel::Type	FeatureLevel,
		EVertexInputStreamType	InputStreamType,
		bool	bSupportsManualVertexFetch,
		FDataType &	Data,
		FInstancedStaticMeshDataType &	InstanceData,
		FVertexDeclarationElementList &	Elements,
		FVertexStreamList &	Streams
	)

staticprotected

◆ InitInstancedStaticMeshVertexFactoryComponents()

void FInstancedStaticMeshVertexFactory::InitInstancedStaticMeshVertexFactoryComponents	(	const FStaticMeshVertexBuffers &	VertexBuffers,
		const FColorVertexBuffer *	ColorVertexBuffer,
		const FStaticMeshInstanceBuffer *	InstanceBuffer,
		const FInstancedStaticMeshVertexFactory *	VertexFactory,
		int32	LightMapCoordinateIndex,
		bool	bRHISupportsManualVertexFetch,
		FInstancedStaticMeshVertexFactory::FDataType &	OutData,
		FInstancedStaticMeshDataType &	OutInstanceData
	)

static

◆ InitRHI()

void FInstancedStaticMeshVertexFactory::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 FLocalVertexFactory.

◆ ModifyCompilationEnvironment()

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

static

Modify compile environment to enable instancing

Parameters

OutEnvironment - shader compile environment to modify

◆ NumBitsForVisibilityMask()

static constexpr uint32 FInstancedStaticMeshVertexFactory::NumBitsForVisibilityMask ( )

inlinestaticconstexpr

Make sure we account for changes in the signature of GetStaticBatchElementVisibility()

◆ SetData()

void FInstancedStaticMeshVertexFactory::SetData	(	FRHICommandListBase &	RHICmdList,
		const FDataType &	InData,
		const FInstancedStaticMeshDataType *	InInstanceData
	)

inline

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

◆ ShouldCompilePermutation()

bool FInstancedStaticMeshVertexFactory::ShouldCompilePermutation ( const FVertexFactoryShaderPermutationParameters & Parameters )

static

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

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

Engine/Source/Runtime/Engine/Classes/Engine/InstancedStaticMesh.h
Engine/Source/Runtime/Engine/Private/InstancedStaticMesh.cpp

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FInstancedStaticMeshVertexFactory()

Member Function Documentation

◆ Copy()

◆ DECLARE_VERTEX_FACTORY_TYPE_API()

◆ GetInstanceCustomDataSRV()

◆ GetInstanceLightmapSRV()

◆ GetInstanceOriginSRV()

◆ GetInstanceTransformSRV()

◆ GetPSOPrecacheVertexFetchElements()

◆ GetUniformBuffer()

◆ GetVertexElements() [1/2]

◆ GetVertexElements() [2/2]

◆ InitInstancedStaticMeshVertexFactoryComponents()

◆ InitRHI()

◆ ModifyCompilationEnvironment()

◆ NumBitsForVisibilityMask()

◆ SetData()

◆ ShouldCompilePermutation()