FParticleSpriteVertexFactory Class Reference

#include <ParticleVertexFactory.h>

Inheritance diagram for FParticleSpriteVertexFactory:

Public Member Functions
	FParticleSpriteVertexFactory (EParticleVertexFactoryType InType, ERHIFeatureLevel::Type InFeatureLevel)
	FParticleSpriteVertexFactory (ERHIFeatureLevel::Type InFeatureLevel)
virtual ENGINE_API void	InitRHI (FRHICommandListBase &RHICmdList) override
virtual bool	RendersPrimitivesAsCameraFacingSprites () const override
ENGINE_API void	SetInstanceBuffer (const FVertexBuffer *InInstanceBuffer, uint32 StreamOffset, uint32 Stride)
ENGINE_API void	SetTexCoordBuffer (const FVertexBuffer *InTexCoordBuffer)
void	SetNumVertsInInstanceBuffer (int32 InNumVertsInInstanceBuffer)
ENGINE_API void	SetDynamicParameterBuffer (const FVertexBuffer *InDynamicParameterBuffer, uint32 StreamOffset, uint32 Stride)
void	SetUsesDynamicParameter (bool bInUsesDynamicParameter, uint32 Stride)
void	SetSpriteUniformBuffer (const FParticleSpriteUniformBufferRef &InSpriteUniformBuffer)
FRHIUniformBuffer *	GetSpriteUniformBuffer ()
void	SetCutoutParameters (int32 InNumCutoutVerticesPerFrame, FRHIShaderResourceView *InCutoutGeometrySRV)
int32	GetNumCutoutVerticesPerFrame () const
FRHIShaderResourceView *	GetCutoutGeometrySRV () const
void	SetCustomAlignment (bool bAlign)
bool	GetCustomAlignment ()
Public Member Functions inherited from FParticleVertexFactoryBase
	FParticleVertexFactoryBase (ERHIFeatureLevel::Type InFeatureLevel)
	FParticleVertexFactoryBase (EParticleVertexFactoryType Type, ERHIFeatureLevel::Type InFeatureLevel)
EParticleVertexFactoryType	GetParticleFactoryType () const
void	SetParticleFactoryType (EParticleVertexFactoryType InType)
ERHIFeatureLevel::Type	GetFeatureLevel () 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
virtual RENDERCORE_API void	ReleaseRHI ()
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
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 FRHIVertexDeclaration *	GetPSOPrecacheVertexDeclaration (bool bUsesDynamicParameter)
Static Public Member Functions inherited from FParticleVertexFactoryBase
static void	ModifyCompilationEnvironment (const FVertexFactoryShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &OutEnvironment)
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
ENGINE_API void	InitStreams ()
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)

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
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

Vertex factory for rendering particle sprites.

Constructor & Destructor Documentation

FParticleSpriteVertexFactory() [1/2]

FParticleSpriteVertexFactory::FParticleSpriteVertexFactory ( EParticleVertexFactoryType  InType, ERHIFeatureLevel::Type  InFeatureLevel  )

inline

Default constructor.

FParticleSpriteVertexFactory() [2/2]

FParticleSpriteVertexFactory::FParticleSpriteVertexFactory ( ERHIFeatureLevel::Type  InFeatureLevel )

inline

Member Function Documentation

GetCustomAlignment()

bool FParticleSpriteVertexFactory::GetCustomAlignment ( )

inline

GetCutoutGeometrySRV()

FRHIShaderResourceView * FParticleSpriteVertexFactory::GetCutoutGeometrySRV ( ) const

inline

GetNumCutoutVerticesPerFrame()

int32 FParticleSpriteVertexFactory::GetNumCutoutVerticesPerFrame ( ) const

inline

GetPSOPrecacheVertexDeclaration()

FRHIVertexDeclaration * FParticleSpriteVertexFactory::GetPSOPrecacheVertexDeclaration ( bool  bUsesDynamicParameter )

static

GetPSOPrecacheVertexFetchElements()

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

static

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

GetSpriteUniformBuffer()

FRHIUniformBuffer * FParticleSpriteVertexFactory::GetSpriteUniformBuffer ( )

inline

Retrieve the uniform buffer for this vertex factory.

InitRHI()

void FParticleSpriteVertexFactory::InitRHI ( FRHICommandListBase &  RHICmdList )

overridevirtual

Initialize the Render Hardware Interface for this vertex factory

Reimplemented from FRenderResource.

InitStreams()

void FParticleSpriteVertexFactory::InitStreams ( )

protected

Initialize streams for this vertex factory.

ModifyCompilationEnvironment()

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

static

Can be overridden by FVertexFactory subclasses to modify their compile environment just before compilation occurs.

RendersPrimitivesAsCameraFacingSprites()

virtual bool FParticleSpriteVertexFactory::RendersPrimitivesAsCameraFacingSprites ( ) const

inlineoverridevirtual

Reimplemented from FVertexFactory.

SetCustomAlignment()

void FParticleSpriteVertexFactory::SetCustomAlignment ( bool  bAlign )

inline

SetCutoutParameters()

void FParticleSpriteVertexFactory::SetCutoutParameters ( int32  InNumCutoutVerticesPerFrame, FRHIShaderResourceView *  InCutoutGeometrySRV  )

inline

SetDynamicParameterBuffer()

void FParticleSpriteVertexFactory::SetDynamicParameterBuffer	(	const FVertexBuffer *	InDynamicParameterBuffer,
		uint32	StreamOffset,
		uint32	Stride
	)

Set the source vertex buffer that contains particle dynamic parameter data.

SetInstanceBuffer()

void FParticleSpriteVertexFactory::SetInstanceBuffer	(	const FVertexBuffer *	InInstanceBuffer,
		uint32	StreamOffset,
		uint32	Stride
	)

Set the source vertex buffer that contains particle instance data.

SetNumVertsInInstanceBuffer()

void FParticleSpriteVertexFactory::SetNumVertsInInstanceBuffer ( int32  InNumVertsInInstanceBuffer )

inline

SetSpriteUniformBuffer()

void FParticleSpriteVertexFactory::SetSpriteUniformBuffer ( const FParticleSpriteUniformBufferRef &  InSpriteUniformBuffer )

inline

Set the uniform buffer for this vertex factory.

SetTexCoordBuffer()

void FParticleSpriteVertexFactory::SetTexCoordBuffer

(

const FVertexBuffer *

InTexCoordBuffer

)

SetUsesDynamicParameter()

void FParticleSpriteVertexFactory::SetUsesDynamicParameter ( bool  bInUsesDynamicParameter, uint32  Stride  )

inline

ShouldCompilePermutation()

bool FParticleSpriteVertexFactory::ShouldCompilePermutation ( const FVertexFactoryShaderPermutationParameters &  Parameters )

static

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

---

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

• Engine/Source/Runtime/Engine/Public/ParticleVertexFactory.h
• Engine/Source/Runtime/Engine/Private/Particles/ParticleVertexFactory.cpp