1. Epic GamesDeveloper
  3. FMeshRenderBufferSetConversionUtil

FMeshRenderBufferSetConversionUtil

Parameters and accompanying functions used to build and update FMeshRenderBuffers from a dynamic mesh.

API > API/Runtime > API/Runtime/GeometryFramework

Parameters and accompanying functions used to build and update FMeshRenderBuffers from a dynamic mesh. For usage, see FBaseDynamicMeshSceneProxy or the simple converter below FDynamicMeshComponentToMeshRenderBufferSet

Note: This is low-level and methods assume, but do not check, all input data is consistent (e.g. that all overlays, the triangle count and enumerator are all consistent with the provided mesh. )

   
Name FMeshRenderBufferSetConversionUtil
Type struct
Header File /Engine/Source/Runtime/GeometryFramework/Public/Components/MeshRenderBufferSet.h
Include Path #include "Components/MeshRenderBufferSet.h"

Syntax

struct FMeshRenderBufferSetConversionUtil

Typedefs

Name Type Remarks Include Path
FIndex2i UE::Geometry::FIndex2i   Components/MeshRenderBufferSet.h
FIndex3i UE::Geometry::FIndex3i   Components/MeshRenderBufferSet.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bApplyVertexColorRemapping bool If true, VertexColorRemappingFunc is called on Vertex Colors provided from Mesh to remap them to a different color Components/MeshRenderBufferSet.h  
bIgnoreVertexColors bool If true, vertex colors on the FDynamicMesh will be ignored Components/MeshRenderBufferSet.h  
bUsePerTriangleColor bool If true, a per-triangle color is used to set vertex colors Components/MeshRenderBufferSet.h  
bUsePerTriangleNormals bool If true, a facet normals are used instead of mesh normals Components/MeshRenderBufferSet.h  
bUseSecondaryTriBuffers bool If true, populate secondary buffers using SecondaryTriFilterFunc Components/MeshRenderBufferSet.h  
ColorSpaceTransformMode EDynamicMeshVertexColorTransformMode Color Space Transform/Conversion applied to Vertex Colors provided from Mesh Color Overlay Attribute Color Space Conversion is applied after any Vertex Color Remapping. Components/MeshRenderBufferSet.h  
ConstantVertexColor FColor Constant color assigned to vertices if no other vertex color is specified Components/MeshRenderBufferSet.h  
PerTriangleColorFunc TFunction< FColor(const FDynamicMesh3 *, int)> Per-triangle color function. Only called if bUsePerTriangleColor=true Components/MeshRenderBufferSet.h  
SecondaryTriFilterFunc TUniqueFunction< bool(const FDynamicMesh3 *, int32)> Filter predicate for secondary triangle index buffer. Only called if bUseSecondaryTriBuffers=true Components/MeshRenderBufferSet.h  
VertexColorRemappingFunc TUniqueFunction< void(FVector4f &)> Vertex color remapping function. Components/MeshRenderBufferSet.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FColor GetOverlayColorAsFColor ( const FDynamicMeshColorOverlay* ColorOverlay,
int32 ElementID
)

 Get the overlay color the FColor, respecting the ColorSpaceTransformMode utilizing the VertexColorRemappingFunc if requested. Components/MeshRenderBufferSet.h  

void InitializeBuffersFromOverlays ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh,
int NumTriangles,
const TriangleEnumerable& Enumerable,
const FDynamicMeshUVOverlay* UVOverlay,
const FDynamicMeshNormalOverlay* NormalOverlay,
const FDynamicMeshColorOverlay* ColorOverlay,
TFunctionRef< void(int, int, int, const FVector3f&, FVector3f&, FVector3f&)> TangentsFunc,
bool bTrackTriangles,
bool bParallel
)

 Initialize rendering buffers from given attribute overlays. Components/MeshRenderBufferSet.h  

void InitializeBuffersFromOverlays ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh,
int NumTriangles,
const TriangleEnumerable& Enumerable,
const TArray< const FDynamicMeshUVOverlay*, UVOverlayListAllocator >& UVOverlays,
const FDynamicMeshNormalOverlay* NormalOverlay,
const FDynamicMeshColorOverlay* ColorOverlay,
TFunctionRef< void(int, int, int, const FVector3f&, FVector3f&, FVector3f&)> TangentsFunc,
bool bTrackTriangles,
bool bParallel
)

 Initialize rendering buffers from given attribute overlays. Components/MeshRenderBufferSet.h  

void RecomputeRenderBufferTriangleIndexSets ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh
)

 RecomputeRenderBufferTriangleIndexSets re-sorts the existing set of triangles in a FMeshRenderBufferSet into primary and secondary index buffers. Components/MeshRenderBufferSet.h  

void UpdateSecondaryTriangleBuffer ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh,
bool bDuplicate
)

 ------------FMeshRenderBufferSetConversionUtil --------------- /// Components/MeshRenderBufferSet.h  

void UpdateVertexBuffersFromOverlays ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh,
int NumTriangles,
const TriangleEnumerable& Enumerable,
const FDynamicMeshNormalOverlay* NormalOverlay,
const FDynamicMeshColorOverlay* ColorOverlay,
TFunctionRef< void(int, int, int, const FVector3f&, FVector3f&, FVector3f&)> TangentsFunc,
bool bUpdatePositions,
bool bUpdateNormals,
bool bUpdateColors
)

 Update vertex positions/normals/colors of an existing set of render buffers. Components/MeshRenderBufferSet.h  

void UpdateVertexUVBufferFromOverlays ( FMeshRenderBufferSet* RenderBuffers,
const FDynamicMesh3* Mesh,
int32 NumTriangles,
const TriangleEnumerable& Enumerable,
const TArray< const FDynamicMeshUVOverlay*, UVOverlayListAllocator >& UVOverlays
)

 Update vertex uvs of an existing set of render buffers. Components/MeshRenderBufferSet.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page