1. Epic GamesDeveloper
  3. FDynamicMeshBuilder

FDynamicMeshBuilder

A utility used to construct dynamically generated meshes, and render them to a [FPrimitiveDrawInterface](API\Runtime\Engine\FPrimitiveDrawInterface).

API > API/Runtime > API/Runtime/Engine

A utility used to construct dynamically generated meshes, and render them to a FPrimitiveDrawInterface. Note: This is meant to be easy to use, not fast. It moves the data around more than necessary, and requires dynamically allocating RHI resources. Exercise caution.

   
Name FDynamicMeshBuilder
Type class
Header File /Engine/Source/Runtime/Engine/Public/DynamicMeshBuilder.h
Include Path #include "DynamicMeshBuilder.h"

Syntax

class FDynamicMeshBuilder

Constructors

Name Remarks Include Path Unreal Specifiers

FDynamicMeshBuilder ( ERHIFeatureLevel::Type InFeatureLevel,
uint32 InNumTexCoords,
uint32 InLightmapCoordinateIndex,
bool InUse16bitTexCoord,
FDynamicMeshBufferAllocator* InDynamicMeshBufferAllocator
)

 Initialization constructor. DynamicMeshBuilder.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FDynamicMeshBuilder()

 Destructor. DynamicMeshBuilder.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DynamicMeshBufferAllocator FDynamicMeshBufferAllocator *   DynamicMeshBuilder.h  
FeatureLevel ERHIFeatureLevel::Type   DynamicMeshBuilder.h  
IndexBuffer FPooledDynamicMeshIndexBuffer *   DynamicMeshBuilder.h  
OneFrameResources FMeshBuilderOneFrameResources *   DynamicMeshBuilder.h  
VertexBuffer FPooledDynamicMeshVertexBuffer *   DynamicMeshBuilder.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddTriangle ( int32 V0,
int32 V1,
int32 V2
)

 Adds a triangle to the mesh. DynamicMeshBuilder.h  

void AddTriangles ( const TArray< uint32 >& InIndices
)

 Add many indices to the mesh. DynamicMeshBuilder.h  

int32 AddVertex ( const FVector3f& InPosition,
const FVector2f& InTextureCoordinate,
const FVector3f& InTangentX,
const FVector3f& InTangentY,
const FVector3f& InTangentZ,
const FColor& InColor
)

 Adds a vertex to the mesh. DynamicMeshBuilder.h  

int32 AddVertex ( const FDynamicMeshVertex& InVertex
)

 Adds a vertex to the mesh. DynamicMeshBuilder.h  

int32 AddVertices ( const TArray< FDynamicMeshVertex >& InVertices
)

 Adds many vertices to the mesh. DynamicMeshBuilder.h  

void Draw ( FPrimitiveDrawInterface* PDI,
const FMatrix& LocalToWorld,
const FMaterialRenderProxy* MaterialRenderProxy,
uint8 DepthPriorityGroup,
bool bDisableBackfaceCulling,
bool bReceivesDecals,
const FHitProxyId HitProxyId
)

 Draws the mesh to the given primitive draw interface. DynamicMeshBuilder.h  

void GetMesh ( const FMatrix& LocalToWorld,
const FMaterialRenderProxy* MaterialRenderProxy,
uint8 DepthPriorityGroup,
bool bDisableBackfaceCulling,
bool bReceivesDecals,
int32 ViewIndex,
FMeshElementCollector& Collector
)

 Adds a mesh of what's been built so far to the collector. DynamicMeshBuilder.h  

void GetMesh ( const FMatrix& LocalToWorld,
const FMaterialRenderProxy* MaterialRenderProxy,
uint8 DepthPriorityGroup,
const FDynamicMeshBuilderSettings& Settings,
FDynamicMeshDrawOffset const*const DrawOffset,
int32 ViewIndex,
FMeshElementCollector& Collector,
const FHitProxyId HitProxyId
)

   DynamicMeshBuilder.h  

void GetMesh ( const FMatrix& LocalToWorld,
const FMaterialRenderProxy* MaterialRenderProxy,
uint8 DepthPriorityGroup,
bool bDisableBackfaceCulling,
bool bReceivesDecals,
bool bUseSelectionOutline,
int32 ViewIndex,
FMeshElementCollector& Collector,
HHitProxy* HitProxy
)

   DynamicMeshBuilder.h  

void GetMesh ( const FMatrix& LocalToWorld,
const FMaterialRenderProxy* MaterialRenderProxy,
uint8 DepthPriorityGroup,
bool bDisableBackfaceCulling,
bool bReceivesDecals,
bool bUseSelectionOutline,
int32 ViewIndex,
FMeshElementCollector& Collector,
const FHitProxyId HitProxyId
)

   DynamicMeshBuilder.h  

void GetMesh ( const FMatrix& LocalToWorld,
const FMatrix& PrevLocalToWorld,
const FMaterialRenderProxy* MaterialRenderProxy,
uint8 DepthPriorityGroup,
const FDynamicMeshBuilderSettings& Settings,
FDynamicMeshDrawOffset const*const DrawOffset,
int32 ViewIndex,
FMeshElementCollector& Collector,
const FHitProxyId HitProxyId
)

   DynamicMeshBuilder.h  

void GetMeshElement ( const FPrimitiveUniformShaderParameters& PrimitiveParams,
const FMaterialRenderProxy* MaterialRenderProxy,
uint8 DepthPriorityGroup,
bool bDisableBackfaceCulling,
int32 ViewIndex,
FMeshBuilderOneFrameResources& OneFrameResource,
FMeshBatch& Mesh
)

   DynamicMeshBuilder.h  

void GetMeshElement ( const FMatrix& LocalToWorld,
const FMaterialRenderProxy* MaterialRenderProxy,
uint8 DepthPriorityGroup,
bool bDisableBackfaceCulling,
bool bReceivesDecals,
int32 ViewIndex,
FMeshBuilderOneFrameResources& OneFrameResource,
FMeshBatch& Mesh
)

   DynamicMeshBuilder.h  

void ReserveTriangles ( int32 InNumTriangles
)

 Pre-allocate space for the given number of triangles. DynamicMeshBuilder.h  

void ReserveVertices ( int32 InNumVertices
)

 Pre-allocate space for the given number of vertices. DynamicMeshBuilder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page