UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ISlate3DRenderer Class Referenceabstract

#include <ISlate3DRenderer.h>

+ Inheritance diagram for ISlate3DRenderer:

Classes

struct  FScopedAcquireDrawBuffer
 

Public Member Functions

virtual ~ISlate3DRenderer ()=default
 
virtual void SetUseGammaCorrection (bool bUseGammaCorrection)=0
 
virtual void SetApplyColorDeficiencyCorrection (bool bApplyColorCorrection)=0
 
virtual FSlateDrawBufferGetDrawBuffer ()
 
virtual FSlateDrawBufferAcquireDrawBuffer ()=0
 
virtual void ReleaseDrawBuffer (FSlateDrawBuffer &InWindowDrawBuffer)=0
 
virtual void DrawWindow_GameThread (FSlateDrawBuffer &DrawBuffer)=0
 
virtual void DrawWindowToTarget_RenderThread (FRDGBuilder &GraphBuilder, const struct FRenderThreadUpdateContext &Context)=0
 
virtual void DrawWindowToTarget_RenderThread (FRHICommandListImmediate &RHICmdList, const struct FRenderThreadUpdateContext &Context)
 
- Public Member Functions inherited from TSharedFromThis< ISlate3DRenderer, ESPMode::ThreadSafe >
TSharedRef< ISlate3DRenderer, Mode > AsShared ()
 
TSharedRef< ISlate3DRenderer const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< ISlate3DRenderer, Mode > AsWeak ()
 
TWeakPtr< ISlate3DRenderer const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< ISlate3DRenderer, ESPMode::ThreadSafe >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< ISlate3DRenderer, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Constructor & Destructor Documentation

◆ ~ISlate3DRenderer()

virtual ISlate3DRenderer::~ISlate3DRenderer ( )
virtualdefault

Member Function Documentation

◆ AcquireDrawBuffer()

virtual FSlateDrawBuffer & ISlate3DRenderer::AcquireDrawBuffer ( )
pure virtual
Returns
The free buffer for drawing

Implemented in FSlate3DRenderer.

◆ DrawWindow_GameThread()

virtual void ISlate3DRenderer::DrawWindow_GameThread ( FSlateDrawBuffer DrawBuffer)
pure virtual

Batches the draw elements in the buffer to prepare it for rendering. Call in the game thread before sending to the render thread.

Parameters
DrawBufferThe draw buffer to prepare

Implemented in FSlate3DRenderer.

◆ DrawWindowToTarget_RenderThread() [1/2]

virtual void ISlate3DRenderer::DrawWindowToTarget_RenderThread ( FRDGBuilder GraphBuilder,
const struct FRenderThreadUpdateContext Context 
)
pure virtual

Renders the batched draw elements of the draw buffer to the given render target. Call after preparing the draw buffer and render target on the game thread.

Parameters
RenderTargetThe render target to render the contents of the draw buffer to
InDrawBufferThe draw buffer containing the batched elements to render

Implemented in FSlate3DRenderer.

◆ DrawWindowToTarget_RenderThread() [2/2]

virtual void ISlate3DRenderer::DrawWindowToTarget_RenderThread ( FRHICommandListImmediate RHICmdList,
const struct FRenderThreadUpdateContext Context 
)
inlinevirtual

◆ GetDrawBuffer()

virtual FSlateDrawBuffer & ISlate3DRenderer::GetDrawBuffer ( )
inlinevirtual
Returns
The free buffer for drawing

◆ ReleaseDrawBuffer()

virtual void ISlate3DRenderer::ReleaseDrawBuffer ( FSlateDrawBuffer InWindowDrawBuffer)
pure virtual

Return the previously acquired buffer.

Implemented in FSlate3DRenderer.

◆ SetApplyColorDeficiencyCorrection()

virtual void ISlate3DRenderer::SetApplyColorDeficiencyCorrection ( bool  bApplyColorCorrection)
pure virtual

Implemented in FSlate3DRenderer.

◆ SetUseGammaCorrection()

virtual void ISlate3DRenderer::SetUseGammaCorrection ( bool  bUseGammaCorrection)
pure virtual

set if this renderer should render in gamma space by default.

Implemented in FSlate3DRenderer.


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