UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FViewElementPDI Class Reference

#include <DynamicPrimitiveDrawing.h>

+ Inheritance diagram for FViewElementPDI:

Public Member Functions

 FViewElementPDI (FViewInfo *InViewInfo, FHitProxyConsumer *InHitProxyConsumer, FGPUScenePrimitiveCollector *InDynamicPrimitiveCollector)
 
virtual bool IsHitTesting () override
 
virtual void SetHitProxy (HHitProxy *HitProxy) override
 
virtual void RegisterDynamicResource (FDynamicPrimitiveResource *DynamicResource) override
 
virtual void AddReserveLines (uint8 DepthPriorityGroup, int32 NumLines, bool bDepthBiased=false, bool bThickLines=false) override
 
virtual void DrawSprite (const FVector &Position, float SizeX, float SizeY, const FTexture *Sprite, const FLinearColor &Color, uint8 DepthPriorityGroup, float U, float UL, float V, float VL, uint8 BlendMode=SE_BLEND_Masked, float OpacityMaskRefVal=.5f) override
 
virtual void DrawLine (const FVector &Start, const FVector &End, const FLinearColor &Color, uint8 DepthPriorityGroup, float Thickness=0.0f, float DepthBias=0.0f, bool bScreenSpace=false) override
 
virtual void DrawTranslucentLine (const FVector &Start, const FVector &End, const FLinearColor &Color, uint8 DepthPriorityGroup, float Thickness=0.0f, float DepthBias=0.0f, bool bScreenSpace=false) override
 
virtual void DrawPoint (const FVector &Position, const FLinearColor &Color, float PointSize, uint8 DepthPriorityGroup) override
 
virtual int32 DrawMesh (const FMeshBatch &Mesh) override
 
- Public Member Functions inherited from FPrimitiveDrawInterface
 FPrimitiveDrawInterface (const FSceneView *InView)
 
virtual ~FPrimitiveDrawInterface ()
 

Additional Inherited Members

- Public Attributes inherited from FPrimitiveDrawInterface
const FSceneView * View
 

Detailed Description

A primitive draw interface which adds the drawn elements to the view's batched elements.

Constructor & Destructor Documentation

◆ FViewElementPDI()

FViewElementPDI::FViewElementPDI ( FViewInfo *  InViewInfo,
FHitProxyConsumer *  InHitProxyConsumer,
FGPUScenePrimitiveCollector *  InDynamicPrimitiveCollector 
)
inline

Member Function Documentation

◆ AddReserveLines()

void FViewElementPDI::AddReserveLines ( uint8  DepthPriorityGroup,
int32  NumLines,
bool  bDepthBiased = false,
bool  bThickLines = false 
)
inlineoverridevirtual

Implements FPrimitiveDrawInterface.

◆ DrawLine()

void FViewElementPDI::DrawLine ( const FVector &  Start,
const FVector &  End,
const FLinearColor &  Color,
uint8  DepthPriorityGroup,
float  Thickness = 0.0f,
float  DepthBias = 0.0f,
bool  bScreenSpace = false 
)
inlineoverridevirtual

Implements FPrimitiveDrawInterface.

◆ DrawMesh()

int32 FViewElementPDI::DrawMesh ( const FMeshBatch &  Mesh)
inlineoverridevirtual

Draw a mesh element. This should only be called through the DrawMesh function.

Returns
Number of passes rendered for the mesh

Implements FPrimitiveDrawInterface.

◆ DrawPoint()

void FViewElementPDI::DrawPoint ( const FVector &  Position,
const FLinearColor &  Color,
float  PointSize,
uint8  DepthPriorityGroup 
)
inlineoverridevirtual

Implements FPrimitiveDrawInterface.

◆ DrawSprite()

void FViewElementPDI::DrawSprite ( const FVector &  Position,
float  SizeX,
float  SizeY,
const FTexture *  Sprite,
const FLinearColor &  Color,
uint8  DepthPriorityGroup,
float  U,
float  UL,
float  V,
float  VL,
uint8  BlendMode = SE_BLEND_Masked,
float  OpacityMaskRefVal = .5f 
)
inlineoverridevirtual

Implements FPrimitiveDrawInterface.

◆ DrawTranslucentLine()

void FViewElementPDI::DrawTranslucentLine ( const FVector &  Start,
const FVector &  End,
const FLinearColor &  Color,
uint8  DepthPriorityGroup,
float  Thickness = 0.0f,
float  DepthBias = 0.0f,
bool  bScreenSpace = false 
)
inlineoverridevirtual

Implements FPrimitiveDrawInterface.

◆ IsHitTesting()

bool FViewElementPDI::IsHitTesting ( )
inlineoverridevirtual

Implements FPrimitiveDrawInterface.

◆ RegisterDynamicResource()

void FViewElementPDI::RegisterDynamicResource ( FDynamicPrimitiveResource *  DynamicResource)
inlineoverridevirtual

Implements FPrimitiveDrawInterface.

◆ SetHitProxy()

void FViewElementPDI::SetHitProxy ( HHitProxy *  HitProxy)
inlineoverridevirtual

Implements FPrimitiveDrawInterface.

The documentation for this class was generated from the following files: