1. Epic GamesDeveloper
  3. FMeshParticleVertexFactory

FMeshParticleVertexFactory

Vertex factory for rendering instanced mesh particles with out dynamic parameter support.

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/MeshParticleVertexFactory.h
Include #include "MeshParticleVertexFactory.h"

Syntax

class FMeshParticleVertexFactory : public FParticleVertexFactoryBase

Remarks

Vertex factory for rendering instanced mesh particles with out dynamic parameter support.

Variables

  Type Name Description
Protected variable FDataType Data  
Protected variable int32 DynamicParameterVertexStride  
Protected variable int32 DynamicVertexStride Stride information for instanced mesh particles
Protected variable FMeshParticleInstanceVertices * InstanceVerticesCPU Used to remember this in the case that we reuse the same vertex factory for multiple renders .
Protected variable uint8 LODIdx  
Protected variable FRHIUniformBuffer * MeshParticleUniformBuffer Uniform buffer with mesh particle parameters.
Protected variable FDynamicReadBuffer PrevTransformBuffer  

Constructors

  Type Name Description
Public function    
Public function    
Public function  

FMeshParticleVertexFactory ( EParticleVertexFactoryType InType,
ERHIFeatureLevel::Type InFeatureLevel,
int32 InDynamicVertexStride,
int32 InDynamicParameterVertexStride
)

 Default constructor.

Functions

  Type Name Description
Public function void

Copy ( const FMeshParticleVertexFactory& Other
)

 Copy the data from another vertex factory
Public function FMeshParticleInstanceVertices *&  
Public function Const uint8  
Public function Const FRHIShaderResourceView *  
Public function Static void

GetPSOPrecacheVertexFetchElements ( EVertexInputStreamType VertexInputStreamType,
FVertexDeclarationElementList& Elements
)

 Get vertex elements used when during PSO precaching materials using this vertex factory type
Public function FRHIUniformBuffer * Retrieve the uniform buffer for this vertex factory.
Public function Static void

GetVertexElements ( ERHIFeatureLevel::Type FeatureLevel,
int32 InDynamicVertexStride,
int32 InDynamicParameterVertexStride,
FDataType& Data,
FVertexDeclarationElementList& Elements
)

  
Protected function Static void

GetVertexElements ( ERHIFeatureLevel::Type FeatureLevel,
int32 InDynamicVertexStride,
int32 InDynamicParameterVertexStride,
FDataType& Data,
FVertexDeclarationElementList& Elements,
FVertexStreamList& InOutStreams
)

  
Public function uint8 *

LockPreviousTransformBuffer ( FRHICommandListBase& RHICmdList,
uint32 ParticleCount
)

  
Public function Static void Modify compile environment to enable instancing
Public function void

SetData ( const FDataType& InData
)

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

SetDynamicParameterBuffer ( const FVertexBuffer* InDynamicParameterBuffer,
uint32 StreamOffset,
uint32 Stride
)

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

SetInstanceBuffer ( const FVertexBuffer* InstanceBuffer,
uint32 StreamOffset,
uint32 Stride
)

 Set the source vertex buffer that contains particle instance data.
Public function void

SetLODIdx ( uint8 InLODIdx
)

  
Public function void

SetStrides ( int32 InDynamicVertexStride,
int32 InDynamicParameterVertexStride
)

 Update the data strides (MUST HAPPEN BEFORE InitRHI is called)
Public function void

SetUniformBuffer ( const FMeshParticleUniformBufferRef& InMeshParticleUniformBuffer
)

 Set the uniform buffer for this vertex factory.
Public function Static bool Should we cache the material's shadertype on this platform with this vertex factory?
Public function void  

Overridden from FVertexFactory

  Type Name Description
Public function Virtual Const FVertexFactoryType *

GetType ()

  

Overridden from FRenderResource

  Type Name Description
Public function Virtual void

InitRHI ( FRHICommandListBase& RHICmdList
)

 Initializes the RHI resources used by this resource.

Classes

  Type Name Description
Public class FBatchParametersCPU    
Public struct FDataType    

Constants

Name Description
StaticType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page