FSlateWindowElementList Class Reference

#include <DrawElements.h>

Inheritance diagram for FSlateWindowElementList:

Classes
struct	FDeferredPaint

Public Member Functions
SLATECORE_API	FSlateWindowElementList (const TSharedPtr< SWindow > &InPaintWindow)
SLATECORE_API	~FSlateWindowElementList ()
SWindow *	GetPaintWindow () const
SWindow *	GetRenderWindow () const
const FSlateDrawElementMap &	GetUncachedDrawElements () const
UE::Slate::FDeprecateVector2DResult	GetWindowSize () const
template<EElementType ElementType = EElementType::ET_NonMapped>
TSlateDrawElement< ElementType > &	AddUninitialized ()
SLATECORE_API FSlateDrawElement &	AddUninitializedLookup (EElementType InElementType=EElementType::ET_NonMapped)
SLATECORE_API int32	PushClip (const FSlateClippingZone &InClipZone)
SLATECORE_API int32	GetClippingIndex () const
int32	GetClippingStackDepth () const
SLATECORE_API TOptional< FSlateClippingState >	GetClippingState () const
SLATECORE_API void	PopClip ()
SLATECORE_API void	PopClipToStackIndex (int32 Index)
FSlateClippingManager &	GetClippingManager ()
const FSlateClippingManager &	GetClippingManager () const
SLATECORE_API int32	PushPixelSnappingMethod (EWidgetPixelSnapping InPixelSnappingMethod)
SLATECORE_API void	PopPixelSnappingMethod ()
SLATECORE_API EWidgetPixelSnapping	GetPixelSnappingMethod () const
SLATECORE_API void	QueueDeferredPainting (const FDeferredPaint &InDeferredPaint)
int32	PaintDeferred (int32 LayerId, const FSlateRect &MyCullingRect)
bool	ShouldResolveDeferred () const
SLATECORE_API void	BeginDeferredGroup ()
SLATECORE_API void	EndDeferredGroup ()
TArray< TSharedPtr< FDeferredPaint > >	GetDeferredPaintList () const
SLATECORE_API void	PushPaintingWidget (const SWidget &CurrentWidget, int32 StartingLayerId, FSlateCachedElementsHandle &CurrentCacheHandle)
SLATECORE_API FSlateCachedElementsHandle	PopPaintingWidget (const SWidget &CurrentWidget)
void	PushCachedElementData (FSlateCachedElementData &CachedElementData)
void	PopCachedElementData ()
SLATECORE_API void	ResetElementList ()
FSlateBatchData &	GetBatchData ()
FSlateBatchData &	GetBatchDataHDR ()
SLATECORE_API void	SetRenderTargetWindow (SWindow *InRenderTargetWindow)
void	AddReferencedObjects (FReferenceCollector &Collector)
SLATECORE_API void	SetIsInGameLayer (bool bInGameLayer)
SLATECORE_API bool	GetIsInGameLayer ()
TArrayView< FSlateCachedElementList *const >	GetCurrentCachedElementWithNewData () const

Friends
class	FSlateElementBatcher

Additional Inherited Members
Protected Member Functions inherited from FNoncopyable
	FNoncopyable ()
	~FNoncopyable ()

Detailed Description

Represents a top level window and its draw elements.

Constructor & Destructor Documentation

FSlateWindowElementList()

FSlateWindowElementList::FSlateWindowElementList ( const TSharedPtr< SWindow > &  InPaintWindow )

explicit

Construct a new list of elements with which to paint a window.

Parameters

InPaintWindow	The window that owns the widgets being painted. This is almost most always the same window that is being rendered to
InRenderWindow	The window that we will be rendering to.

~FSlateWindowElementList()

FSlateWindowElementList::~FSlateWindowElementList

(

)

Member Function Documentation

AddReferencedObjects()

void FSlateWindowElementList::AddReferencedObjects

(

FReferenceCollector &

Collector

)

AddUninitialized()

template<EElementType ElementType = EElementType::ET_NonMapped>

TSlateDrawElement< ElementType > & FSlateWindowElementList::AddUninitialized ( )

inline

Creates an uninitialized draw element if using caching will create a new cached draw list if needed (Whenever a top level draw widget's cache handle doesn't match the current cached handle).

AddUninitializedLookup()

FSlateDrawElement & FSlateWindowElementList::AddUninitializedLookup

(

EElementType

InElementType = EElementType::ET_NonMapped

)

Calls AddUninitialized, resolving template version based on enum

BeginDeferredGroup()

void FSlateWindowElementList::BeginDeferredGroup

(

)

EndDeferredGroup()

void FSlateWindowElementList::EndDeferredGroup

(

)

GetBatchData()

FSlateBatchData & FSlateWindowElementList::GetBatchData ( )

inline

GetBatchDataHDR()

FSlateBatchData & FSlateWindowElementList::GetBatchDataHDR ( )

inline

GetClippingIndex()

int32 FSlateWindowElementList::GetClippingIndex

(

)

const

GetClippingManager() [1/2]

FSlateClippingManager & FSlateWindowElementList::GetClippingManager ( )

inline

GetClippingManager() [2/2]

const FSlateClippingManager & FSlateWindowElementList::GetClippingManager ( ) const

inline

GetClippingStackDepth()

int32 FSlateWindowElementList::GetClippingStackDepth ( ) const

inline

GetClippingState()

TOptional< FSlateClippingState > FSlateWindowElementList::GetClippingState

(

)

const

GetCurrentCachedElementWithNewData()

TArrayView< FSlateCachedElementList *const > FSlateWindowElementList::GetCurrentCachedElementWithNewData ( ) const

inline

GetDeferredPaintList()

TArray< TSharedPtr< FDeferredPaint > > FSlateWindowElementList::GetDeferredPaintList ( ) const

inline

GetIsInGameLayer()

bool FSlateWindowElementList::GetIsInGameLayer

(

)

GetPaintWindow()

SWindow * FSlateWindowElementList::GetPaintWindow ( ) const

inline

Returns

Get the window that we will be painting

GetPixelSnappingMethod()

EWidgetPixelSnapping FSlateWindowElementList::GetPixelSnappingMethod

(

)

const

GetRenderWindow()

SWindow * FSlateWindowElementList::GetRenderWindow ( ) const

inline

Returns

Get the window that we will be rendering to. Unless you are a slate renderer you probably want to use GetPaintWindow()

GetUncachedDrawElements()

const FSlateDrawElementMap & FSlateWindowElementList::GetUncachedDrawElements ( ) const

inline

Returns

Get the draw elements that we want to render into this window

GetWindowSize()

UE::Slate::FDeprecateVector2DResult FSlateWindowElementList::GetWindowSize ( ) const

inline

Returns

Get the window size that we will be painting

PaintDeferred()

int32 FSlateWindowElementList::PaintDeferred	(	int32	LayerId,
		const FSlateRect &	MyCullingRect
	)

PopCachedElementData()

void FSlateWindowElementList::PopCachedElementData

(

)

PopClip()

void FSlateWindowElementList::PopClip

(

)

PopClipToStackIndex()

void FSlateWindowElementList::PopClipToStackIndex

(

int32

Index

)

PopPaintingWidget()

FSlateCachedElementsHandle FSlateWindowElementList::PopPaintingWidget

(

const SWidget &

CurrentWidget

)

Pops the current painted widget off the stack

Returns

true if an element was added while the widget was pushed

PopPixelSnappingMethod()

void FSlateWindowElementList::PopPixelSnappingMethod

(

)

PushCachedElementData()

void FSlateWindowElementList::PushCachedElementData

(

FSlateCachedElementData &

CachedElementData

)

Pushes cached element data onto the stack. Any draw elements cached after will use this cached element data until popped

PushClip()

int32 FSlateWindowElementList::PushClip

(

const FSlateClippingZone &

InClipZone

)

PushPaintingWidget()

void FSlateWindowElementList::PushPaintingWidget	(	const SWidget &	CurrentWidget,
		int32	StartingLayerId,
		FSlateCachedElementsHandle &	CurrentCacheHandle
	)

Pushes the current widget that is painting onto the widget stack so we know what elements belong to each widget This information is used for caching later.

PushPixelSnappingMethod()

int32 FSlateWindowElementList::PushPixelSnappingMethod

(

EWidgetPixelSnapping

InPixelSnappingMethod

)

QueueDeferredPainting()

void FSlateWindowElementList::QueueDeferredPainting

(

const FDeferredPaint &

InDeferredPaint

)

ResetElementList()

void FSlateWindowElementList::ResetElementList

(

)

Remove all the elements from this draw list.

SetIsInGameLayer()

void FSlateWindowElementList::SetIsInGameLayer

(

bool

bInGameLayer

)

SetRenderTargetWindow()

void FSlateWindowElementList::SetRenderTargetWindow

(

SWindow *

InRenderTargetWindow

)

ShouldResolveDeferred()

bool FSlateWindowElementList::ShouldResolveDeferred ( ) const

inline

Friends And Related Symbol Documentation

FSlateElementBatcher

friend class FSlateElementBatcher

friend

---

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

• Engine/Source/Runtime/SlateCore/Public/Rendering/DrawElements.h
• Engine/Source/Runtime/SlateCore/Private/Rendering/DrawElements.cpp