UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSlate3DRenderer Class Reference

#include <Slate3DRenderer.h>

+ Inheritance diagram for FSlate3DRenderer:

Public Member Functions

 FSlate3DRenderer (TSharedRef< FSlateFontServices > InSlateFontServices, TSharedRef< FSlateRHIResourceManager > InResourceManager, bool bUseGammaCorrection=false)
 
void Cleanup ()
 
virtual void SetUseGammaCorrection (bool bUseGammaCorrection) override
 
virtual void SetApplyColorDeficiencyCorrection (bool bApplyColorCorrection) override
 
virtual FSlateDrawBufferAcquireDrawBuffer () override
 
virtual void ReleaseDrawBuffer (FSlateDrawBuffer &DrawBuffer) override
 
virtual void DrawWindow_GameThread (FSlateDrawBuffer &DrawBuffer) override
 
virtual void DrawWindowToTarget_RenderThread (FRDGBuilder &GraphBuilder, const struct FRenderThreadUpdateContext &Context) override
 
- Public Member Functions inherited from ISlate3DRenderer
virtual ~ISlate3DRenderer ()=default
 
virtual FSlateDrawBufferGetDrawBuffer ()
 
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
 
- Public Member Functions inherited from FDeferredCleanupInterface
virtual ~FDeferredCleanupInterface ()
 

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

◆ FSlate3DRenderer()

FSlate3DRenderer::FSlate3DRenderer ( TSharedRef< FSlateFontServices InSlateFontServices,
TSharedRef< FSlateRHIResourceManager InResourceManager,
bool  bUseGammaCorrection = false 
)

Member Function Documentation

◆ AcquireDrawBuffer()

FSlateDrawBuffer & FSlate3DRenderer::AcquireDrawBuffer ( )
overridevirtual
Returns
The free buffer for drawing

Implements ISlate3DRenderer.

◆ Cleanup()

void FSlate3DRenderer::Cleanup ( )

◆ DrawWindow_GameThread()

void FSlate3DRenderer::DrawWindow_GameThread ( FSlateDrawBuffer DrawBuffer)
overridevirtual

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

Implements ISlate3DRenderer.

◆ DrawWindowToTarget_RenderThread()

void FSlate3DRenderer::DrawWindowToTarget_RenderThread ( FRDGBuilder GraphBuilder,
const struct FRenderThreadUpdateContext Context 
)
overridevirtual

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

Implements ISlate3DRenderer.

◆ ReleaseDrawBuffer()

void FSlate3DRenderer::ReleaseDrawBuffer ( FSlateDrawBuffer InWindowDrawBuffer)
overridevirtual

Return the previously acquired buffer.

Implements ISlate3DRenderer.

◆ SetApplyColorDeficiencyCorrection()

void FSlate3DRenderer::SetApplyColorDeficiencyCorrection ( bool  bApplyColorCorrection)
overridevirtual

Implements ISlate3DRenderer.

◆ SetUseGammaCorrection()

void FSlate3DRenderer::SetUseGammaCorrection ( bool  bUseGammaCorrection)
overridevirtual

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

Implements ISlate3DRenderer.


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