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

#include <PrimitiveDrawInterface.h>

+ Inheritance diagram for FPrimitiveDrawInterface:

Public Member Functions

 FPrimitiveDrawInterface (const FSceneView *InView)
 
virtual ~FPrimitiveDrawInterface ()
 
virtual bool IsHitTesting ()=0
 
virtual void SetHitProxy (HHitProxy *HitProxy)=0
 
virtual void RegisterDynamicResource (FDynamicPrimitiveResource *DynamicResource)=0
 
virtual void AddReserveLines (uint8 DepthPriorityGroup, int32 NumLines, bool bDepthBiased=false, bool bThickLines=false)=0
 
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=1, float OpacityMaskRefVal=.5f)=0
 
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)=0
 
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)=0
 
virtual void DrawPoint (const FVector &Position, const FLinearColor &Color, float PointSize, uint8 DepthPriorityGroup)=0
 
virtual int32 DrawMesh (const FMeshBatch &Mesh)=0
 

Public Attributes

const FSceneView * View
 

Detailed Description

The base interface used to query a primitive for its dynamic elements.

Constructor & Destructor Documentation

◆ FPrimitiveDrawInterface()

FPrimitiveDrawInterface::FPrimitiveDrawInterface ( const FSceneView *  InView)
inline

Initialization constructor.

◆ ~FPrimitiveDrawInterface()

virtual FPrimitiveDrawInterface::~FPrimitiveDrawInterface ( )
inlinevirtual

Member Function Documentation

◆ AddReserveLines()

virtual void FPrimitiveDrawInterface::AddReserveLines ( uint8  DepthPriorityGroup,
int32  NumLines,
bool  bDepthBiased = false,
bool  bThickLines = false 
)
pure virtual

Implemented in FSimpleElementCollector, and FViewElementPDI.

◆ DrawLine()

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

Implemented in FSimpleElementCollector, and FViewElementPDI.

◆ DrawMesh()

virtual int32 FPrimitiveDrawInterface::DrawMesh ( const FMeshBatch &  Mesh)
pure virtual

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

Returns
Number of passes rendered for the mesh

Implemented in FSimpleElementCollector, and FViewElementPDI.

◆ DrawPoint()

virtual void FPrimitiveDrawInterface::DrawPoint ( const FVector &  Position,
const FLinearColor &  Color,
float  PointSize,
uint8  DepthPriorityGroup 
)
pure virtual

Implemented in FSimpleElementCollector, and FViewElementPDI.

◆ DrawSprite()

virtual void FPrimitiveDrawInterface::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 = 1,
float  OpacityMaskRefVal = .5f 
)
pure virtual

Implemented in FViewElementPDI, and FSimpleElementCollector.

◆ DrawTranslucentLine()

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

Implemented in FSimpleElementCollector, and FViewElementPDI.

◆ IsHitTesting()

virtual bool FPrimitiveDrawInterface::IsHitTesting ( )
pure virtual

Implemented in FSimpleElementCollector, and FViewElementPDI.

◆ RegisterDynamicResource()

virtual void FPrimitiveDrawInterface::RegisterDynamicResource ( FDynamicPrimitiveResource *  DynamicResource)
pure virtual

Implemented in FSimpleElementCollector, and FViewElementPDI.

◆ SetHitProxy()

virtual void FPrimitiveDrawInterface::SetHitProxy ( HHitProxy *  HitProxy)
pure virtual

Implemented in FSimpleElementCollector, and FViewElementPDI.

Member Data Documentation

◆ View

const FSceneView* FPrimitiveDrawInterface::View
The documentation for this class was generated from the following file: