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

#include <WidgetRenderer.h>

+ Inheritance diagram for FWidgetRenderer:

Public Member Functions

UMG_API FWidgetRenderer (bool bUseGammaCorrection=false, bool bInClearTarget=true)
 
UMG_API ~FWidgetRenderer ()
 
bool GetIsPrepassNeeded () const
 
void SetIsPrepassNeeded (bool bInPrepassNeeded)
 
bool GetClearHitTestGrid () const
 
void SetClearHitTestGrid (bool bInClearHitTestGrid)
 
void SetShouldClearTarget (bool bShouldClear)
 
bool GetUseGammaCorrection () const
 
UMG_API void SetUseGammaCorrection (bool bInUseGammaSpace)
 
UMG_API void SetApplyColorDeficiencyCorrection (bool bInApplyColorCorrection)
 
UMG_API ISlate3DRendererGetSlateRenderer ()
 
UMG_API UTextureRenderTarget2DDrawWidget (const TSharedRef< SWidget > &Widget, FVector2D DrawSize)
 
UMG_API void DrawWidget (FRenderTarget *RenderTarget, const TSharedRef< SWidget > &Widget, FVector2D DrawSize, float DeltaTime, bool bDeferRenderTargetUpdate=false)
 
UMG_API void DrawWidget (UTextureRenderTarget2D *RenderTarget, const TSharedRef< SWidget > &Widget, FVector2D DrawSize, float DeltaTime, bool bDeferRenderTargetUpdate=false)
 
UMG_API void DrawWidget (FRenderTarget *RenderTarget, const TSharedRef< SWidget > &Widget, float Scale, FVector2D DrawSize, float DeltaTime, bool bDeferRenderTargetUpdate=false)
 
UMG_API void DrawWidget (UTextureRenderTarget2D *RenderTarget, const TSharedRef< SWidget > &Widget, float Scale, FVector2D DrawSize, float DeltaTime, bool bDeferRenderTargetUpdate=false)
 
UMG_API void DrawWindow (FRenderTarget *RenderTarget, FHittestGrid &HitTestGrid, TSharedRef< SWindow > Window, float Scale, FVector2D DrawSize, float DeltaTime, bool bDeferRenderTargetUpdate=false)
 
UMG_API void DrawWindow (UTextureRenderTarget2D *RenderTarget, FHittestGrid &HitTestGrid, TSharedRef< SWindow > Window, float Scale, FVector2D DrawSize, float DeltaTime, bool bDeferRenderTargetUpdate=false)
 
UMG_API void DrawWindow (FRenderTarget *RenderTarget, FHittestGrid &HitTestGrid, TSharedRef< SWindow > Window, FGeometry WindowGeometry, FSlateRect WindowClipRect, float DeltaTime, bool bDeferRenderTargetUpdate=false)
 
UMG_API void DrawWindow (UTextureRenderTarget2D *RenderTarget, FHittestGrid &HitTestGrid, TSharedRef< SWindow > Window, FGeometry WindowGeometry, FSlateRect WindowClipRect, float DeltaTime, bool bDeferRenderTargetUpdate=false)
 
UMG_API void DrawWindow (const FPaintArgs &PaintArgs, FRenderTarget *RenderTarget, TSharedRef< SWindow > Window, FGeometry WindowGeometry, FSlateRect WindowClipRect, float DeltaTime, bool bDeferRenderTargetUpdate=false)
 
UMG_API void DrawWindow (const FPaintArgs &PaintArgs, UTextureRenderTarget2D *RenderTarget, TSharedRef< SWindow > Window, FGeometry WindowGeometry, FSlateRect WindowClipRect, float DeltaTime, bool bDeferRenderTargetUpdate=false)
 
UMG_API bool DrawInvalidationRoot (TSharedRef< SVirtualWindow > &VirtualWindow, UTextureRenderTarget2D *RenderTarget, FSlateInvalidationRoot &Root, const FSlateInvalidationContext &Context, bool bDeferRenderTargetUpdate=false)
 
UMG_API bool DrawInvalidationRoot (TSharedRef< SVirtualWindow > &VirtualWindow, UTextureRenderTarget2D *RenderTarget, FPaintArgs PaintArgs, float DrawScale, FVector2D DrawSize, bool bDeferRenderTargetUpdate=false)
 
- Public Member Functions inherited from FDeferredCleanupInterface
virtual ~FDeferredCleanupInterface ()
 

Static Public Member Functions

static UMG_API UTextureRenderTarget2DCreateTargetFor (FVector2D DrawSize, TextureFilter InFilter, bool bUseGammaCorrection)
 

Public Attributes

TArray< TSharedPtr< FSlateWindowElementList::FDeferredPaint > > DeferredPaints
 
FVector2D ViewOffset
 

Constructor & Destructor Documentation

◆ FWidgetRenderer()

FWidgetRenderer::FWidgetRenderer ( bool  bUseGammaCorrection = false,
bool  bInClearTarget = true 
)

◆ ~FWidgetRenderer()

FWidgetRenderer::~FWidgetRenderer ( )

Member Function Documentation

◆ CreateTargetFor()

UTextureRenderTarget2D * FWidgetRenderer::CreateTargetFor ( FVector2D  DrawSize,
TextureFilter  InFilter,
bool  bUseGammaCorrection 
)
static

◆ DrawInvalidationRoot() [1/2]

bool FWidgetRenderer::DrawInvalidationRoot ( TSharedRef< SVirtualWindow > &  VirtualWindow,
UTextureRenderTarget2D RenderTarget,
FPaintArgs  PaintArgs,
float  DrawScale,
FVector2D  DrawSize,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawInvalidationRoot() [2/2]

bool FWidgetRenderer::DrawInvalidationRoot ( TSharedRef< SVirtualWindow > &  VirtualWindow,
UTextureRenderTarget2D RenderTarget,
FSlateInvalidationRoot Root,
const FSlateInvalidationContext Context,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawWidget() [1/5]

UTextureRenderTarget2D * FWidgetRenderer::DrawWidget ( const TSharedRef< SWidget > &  Widget,
FVector2D  DrawSize 
)

◆ DrawWidget() [2/5]

void FWidgetRenderer::DrawWidget ( FRenderTarget RenderTarget,
const TSharedRef< SWidget > &  Widget,
float  Scale,
FVector2D  DrawSize,
float  DeltaTime,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawWidget() [3/5]

void FWidgetRenderer::DrawWidget ( FRenderTarget RenderTarget,
const TSharedRef< SWidget > &  Widget,
FVector2D  DrawSize,
float  DeltaTime,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawWidget() [4/5]

void FWidgetRenderer::DrawWidget ( UTextureRenderTarget2D RenderTarget,
const TSharedRef< SWidget > &  Widget,
float  Scale,
FVector2D  DrawSize,
float  DeltaTime,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawWidget() [5/5]

void FWidgetRenderer::DrawWidget ( UTextureRenderTarget2D RenderTarget,
const TSharedRef< SWidget > &  Widget,
FVector2D  DrawSize,
float  DeltaTime,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawWindow() [1/6]

void FWidgetRenderer::DrawWindow ( const FPaintArgs PaintArgs,
FRenderTarget RenderTarget,
TSharedRef< SWindow Window,
FGeometry  WindowGeometry,
FSlateRect  WindowClipRect,
float  DeltaTime,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawWindow() [2/6]

void FWidgetRenderer::DrawWindow ( const FPaintArgs PaintArgs,
UTextureRenderTarget2D RenderTarget,
TSharedRef< SWindow Window,
FGeometry  WindowGeometry,
FSlateRect  WindowClipRect,
float  DeltaTime,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawWindow() [3/6]

void FWidgetRenderer::DrawWindow ( FRenderTarget RenderTarget,
FHittestGrid HitTestGrid,
TSharedRef< SWindow Window,
FGeometry  WindowGeometry,
FSlateRect  WindowClipRect,
float  DeltaTime,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawWindow() [4/6]

void FWidgetRenderer::DrawWindow ( FRenderTarget RenderTarget,
FHittestGrid HitTestGrid,
TSharedRef< SWindow Window,
float  Scale,
FVector2D  DrawSize,
float  DeltaTime,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawWindow() [5/6]

void FWidgetRenderer::DrawWindow ( UTextureRenderTarget2D RenderTarget,
FHittestGrid HitTestGrid,
TSharedRef< SWindow Window,
FGeometry  WindowGeometry,
FSlateRect  WindowClipRect,
float  DeltaTime,
bool  bDeferRenderTargetUpdate = false 
)

◆ DrawWindow() [6/6]

void FWidgetRenderer::DrawWindow ( UTextureRenderTarget2D RenderTarget,
FHittestGrid HitTestGrid,
TSharedRef< SWindow Window,
float  Scale,
FVector2D  DrawSize,
float  DeltaTime,
bool  bDeferRenderTargetUpdate = false 
)

◆ GetClearHitTestGrid()

bool FWidgetRenderer::GetClearHitTestGrid ( ) const
inline

◆ GetIsPrepassNeeded()

bool FWidgetRenderer::GetIsPrepassNeeded ( ) const
inline

◆ GetSlateRenderer()

ISlate3DRenderer * FWidgetRenderer::GetSlateRenderer ( )

◆ GetUseGammaCorrection()

bool FWidgetRenderer::GetUseGammaCorrection ( ) const
inline

◆ SetApplyColorDeficiencyCorrection()

void FWidgetRenderer::SetApplyColorDeficiencyCorrection ( bool  bInApplyColorCorrection)

◆ SetClearHitTestGrid()

void FWidgetRenderer::SetClearHitTestGrid ( bool  bInClearHitTestGrid)
inline

◆ SetIsPrepassNeeded()

void FWidgetRenderer::SetIsPrepassNeeded ( bool  bInPrepassNeeded)
inline

◆ SetShouldClearTarget()

void FWidgetRenderer::SetShouldClearTarget ( bool  bShouldClear)
inline

◆ SetUseGammaCorrection()

void FWidgetRenderer::SetUseGammaCorrection ( bool  bInUseGammaSpace)

Member Data Documentation

◆ DeferredPaints

TArray< TSharedPtr<FSlateWindowElementList::FDeferredPaint> > FWidgetRenderer::DeferredPaints

◆ ViewOffset

FVector2D FWidgetRenderer::ViewOffset

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