1. Epic GamesDeveloper
  3. FBatchedElements

FBatchedElements

Batched elements for later rendering.

API > API/Runtime > API/Runtime/Engine

Batched elements for later rendering.

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

Syntax

class FBatchedElements

Constructors

Name Remarks Include Path Unreal Specifiers

FBatchedElements()

 Constructor BatchedElements.h  

Classes

Name Remarks
FAllocationInfo  

Structs

Name Remarks
FBatchedMeshElement  
FBatchedPoint  
FBatchedSprite  
FBatchedThickLines  
FBatchedWireTris  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
LineVertices TArray< FSimpleElementVertex >   BatchedElements.h  
MaxMeshIndicesAllowed int32 Max number of mesh index entries that will fit in a DrawPriUP call BatchedElements.h  
MaxMeshVerticesAllowed int32 Max number of mesh vertices that will fit in a DrawPriUP call BatchedElements.h  
MeshElements TArray< FBatchedMeshElement >   BatchedElements.h  
MeshVertices TArray< FSimpleElementVertex >   BatchedElements.h  
Points TArray< FBatchedPoint >   BatchedElements.h  
Sprites TArray< FBatchedSprite >   BatchedElements.h  
ThickLines TArray< FBatchedThickLines >   BatchedElements.h  
WireTris TArray< FBatchedWireTris >   BatchedElements.h  
WireTriVerts TResourceArray< FSimpleElementVertex >   BatchedElements.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddAllocationInfo ( FAllocationInfo& AllocationInfo
) const

 Accumulates allocation info for use calling Reserve. BatchedElements.h  

void AddLine ( const FVector& Start,
const FVector& End,
const FLinearColor& Color,
FHitProxyId HitProxyId,
float Thickness,
float DepthBias,
bool bScreenSpace
)

 Adds a line to the batch. Note only SE_BLEND_Opaque will be used for batched line rendering. BatchedElements.h  

void AddPoint ( const FVector& Position,
float Size,
const FLinearColor& Color,
FHitProxyId HitProxyId
)

 Adds a point to the batch. Note only SE_BLEND_Opaque will be used for batched point rendering. BatchedElements.h  

void AddReserveLines ( int32 NumLines,
bool bDepthBiased,
bool bThickLines
)

 Reserves space in line vertex array BatchedElements.h  

void AddReserveTriangles ( int32 NumMeshTriangles,
const FTexture* Texture,
ESimpleElementBlendMode BlendMode
)

 Reserves space in index array for a mesh element for current number plus expected number. BatchedElements.h  

void AddReserveVertices ( int32 NumMeshVerts
)

 Reserves space in mesh vertex array for current number plus expected number. BatchedElements.h  

void AddSprite ( const FVector& Position,
float SizeX,
float SizeY,
const FTexture* Texture,
const FLinearColor& Color,
FHitProxyId HitProxyId,
float U,
float UL,
float V,
float VL,
uint8 BlendMode,
float OpacityMaskRefVal
)

 Adds a sprite to the batch. BatchedElements.h  

void AddTranslucentLine ( const FVector& Start,
const FVector& End,
const FLinearColor& Color,
FHitProxyId HitProxyId,
float Thickness,
float DepthBias,
bool bScreenSpace
)

 Adds a translucent line to the batch. BatchedElements.h  

void AddTriangle ( int32 V0,
int32 V1,
int32 V2,
const FTexture* Texture,
EBlendMode BlendMode
)

 Adds a triangle to the batch. BatchedElements.h  

void AddTriangle ( int32 V0,
int32 V1,
int32 V2,
FBatchedElementParameters* BatchedElementParameters,
ESimpleElementBlendMode BlendMode
)

 Adds a triangle to the batch. BatchedElements.h  

void AddTriangle ( int32 V0,
int32 V1,
int32 V2,
const FTexture* Texture,
ESimpleElementBlendMode BlendMode,
const FDepthFieldGlowInfo& GlowInfo
)

 Adds a triangle to the batch. BatchedElements.h  

void AddTriangleExtensive ( int32 V0,
int32 V1,
int32 V2,
FBatchedElementParameters* BatchedElementParameters,
const FTexture* Texture,
ESimpleElementBlendMode BlendMode,
const FDepthFieldGlowInfo& GlowInfo
)

 Adds a triangle to the batch. Extensive version where all parameters can be passed in. BatchedElements.h  

int32 AddVertex ( const FVector4& InPosition,
const FVector2D& InTextureCoordinate,
const FLinearColor& InColor,
FHitProxyId HitProxyId
)

 This is for compatibility but should be avoided since it's slower due to conversions. BatchedElements.h  

int32 AddVertexf ( const FVector4f& InPosition,
const FVector2f& InTextureCoordinate,
const FLinearColor& InColor,
FHitProxyId HitProxyId
)

 Adds a mesh vertex to the batch. BatchedElements.h  

void Append ( FBatchedElements& Other
)

 Appends contents of another batched elements into this one and clears the other one. BatchedElements.h  

void Clear()

 Clears any batched elements BatchedElements.h  

bool Draw ( FRHICommandList& RHICmdList,
const FMeshPassProcessorRenderState& DrawRenderState,
ERHIFeatureLevel::Type FeatureLevel,
const FSceneView& View,
bool bHitTesting,
float Gamma,
EBlendModeFilter::Type Filter,
uint32 NumInstances
) const

 Draws the batch BatchedElements.h  

void EnableMobileHDREncoding ( bool bInEnableHDREncoding
)

   BatchedElements.h  

uint32 GetAllocatedSize()

 Helper function to return the amount of memory allocated by this class BatchedElements.h  

bool HasPrimsToDraw()

   BatchedElements.h  

void Reserve ( const FAllocationInfo& AllocationInfo
)

 Reserves memory for all containers. BatchedElements.h  

void ReserveTriangles ( int32 NumMeshTriangles,
const FTexture* Texture,
ESimpleElementBlendMode BlendMode
)

 Reserves space in index array for a mesh element BatchedElements.h  

void ReserveVertices ( int32 NumMeshVerts
)

 Reserves space in mesh vertex array for at least this many total verts. BatchedElements.h  

Static

Name Remarks Include Path Unreal Specifiers

static FSceneView CreateProxySceneView ( const FMatrix& ProjectionMatrix,
const FIntRect& ViewRect
)

 Creates a proxy FSceneView for operations that are not tied directly to a scene but still require batched elements to be drawn. BatchedElements.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page