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

#include <RenderingCommon.h>

+ Inheritance diagram for ICustomSlateElement:

Classes

struct  FDrawPassInputs
 

Public Member Functions

virtual ~ICustomSlateElement ()
 
virtual void PostCustomElementAdded (FSlateElementBatcher &ElementBatcher) const
 
virtual void Draw_RenderThread (FRDGBuilder &GraphBuilder, const FDrawPassInputs &Inputs)
 
struct UE_DEPRECATED (5.5, "Use ICustomSlateElement::Draw instead") FSlateCustomDrawParams
 
virtual void DrawRenderThread (FRHICommandListImmediate &RHICmdList, const void *RenderTarget)
 
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void Draw_RenderThread (FRHICommandListImmediate &RHICmdList, const void *RenderTarget, const FSlateCustomDrawParams &Params)
 
virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS bool UsesAdditionalRHIParams () const
 

Detailed Description

An interface for a custom slate elements. Lifetime must support pipelining to the render thread.

Constructor & Destructor Documentation

◆ ~ICustomSlateElement()

virtual ICustomSlateElement::~ICustomSlateElement ( )
inlinevirtual

Member Function Documentation

◆ Draw_RenderThread() [1/2]

virtual void ICustomSlateElement::Draw_RenderThread ( FRDGBuilder &  GraphBuilder,
const FDrawPassInputs &  Inputs 
)
inlinevirtual

Called from the render thread during element drawing.

Reimplemented in FPostBufferUpdater.

◆ Draw_RenderThread() [2/2]

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void ICustomSlateElement::Draw_RenderThread ( FRHICommandListImmediate &  RHICmdList,
const void *  RenderTarget,
const FSlateCustomDrawParams &  Params 
)
inlinevirtual

◆ DrawRenderThread()

virtual void ICustomSlateElement::DrawRenderThread ( FRHICommandListImmediate &  RHICmdList,
const void *  RenderTarget 
)
inlinevirtual

◆ PostCustomElementAdded()

virtual void ICustomSlateElement::PostCustomElementAdded ( FSlateElementBatcher &  ElementBatcher) const
inlinevirtual

Called from the game thread during element batching.

Reimplemented in FPostBufferUpdater.

◆ UE_DEPRECATED()

struct ICustomSlateElement::UE_DEPRECATED ( 5.  5,
"Use ICustomSlateElement::Draw instead"   
)
inline

◆ UsesAdditionalRHIParams()

virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS bool ICustomSlateElement::UsesAdditionalRHIParams ( ) const
inlinevirtual
The documentation for this class was generated from the following file: