1. Epic GamesDeveloper
  3. FBatchedElements

FBatchedElements

Batched elements for later rendering.

Unreal Engine C++ API Reference > Runtime > Engine

References

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

Syntax

class FBatchedElements

Remarks

Batched elements for later rendering.

Constructors

  Type Name Description
Public function   Constructor

Functions

  Type Name Description
Public function 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.
Public function 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.
Public function void

AddReserveLines ( int32 NumLines,
bool bDepthBiased,
bool bThickLines
)

 Reserves space in line vertex array
Public function void

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

 Reserves space in index array for a mesh element for current number plus expected number.
Public function void

AddReserveVertices ( int32 NumMeshVerts
)

 Reserves space in mesh vertex array for current number plus expected number.
Public function 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.
Public function 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.
Public function void

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

 Adds a triangle to the batch.
Public function void

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

 Adds a triangle to the batch.
Public function void

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

 Adds a triangle to the batch.
Public function 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.
Public function 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.
Public function int32

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

 Adds a mesh vertex to the batch.
Public function void

Clear ()

 Clears any batched elements
Public function 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.
Public function Const bool

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

 Draws the batch
Public function void

EnableMobileHDREncoding ( bool bInEnableHDREncoding
)

  
Public function Const uint32 Helper function to return the amount of memory allocated by this class
Public function Const bool  
Public function void

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

 Reserves space in index array for a mesh element
Public function void

ReserveVertices ( int32 NumMeshVerts
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page