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

#include <SlateInvalidationWidgetHeap.h>

Classes

struct  FWidgetOrderLess
 

Public Types

using FElement = FSlateInvalidationWidgetHeapElement
 
using SortPredicate = FWidgetOrderLess
 
using FElementContainer = TArray< FElement, TInlineAllocator< NumberOfPreAllocatedElement > >
 

Public Member Functions

 FSlateInvalidationWidgetPreHeap (FSlateInvalidationWidgetList &InOwnerList)
 
void HeapPushUnique (FSlateInvalidationWidgetList::InvalidationWidgetType &InvalidationWidget)
 
FSlateInvalidationWidgetIndex HeapPop ()
 
void HeapPopDiscard ()
 
FSlateInvalidationWidgetIndex HeapPeek () const
 
const FElementHeapPeekElement () const
 
int32 RemoveRange (const FSlateInvalidationWidgetList::FIndexRange &Range)
 
void Reset (bool bResetContained)
 
int32 Num () const
 
bool Contains_Debug (const FSlateInvalidationWidgetIndex WidgetIndex) const
 
bool IsValidHeap_Debug ()
 
const FElementContainerGetRaw () const
 
template<typename Predicate >
void ForEachIndexes (Predicate Pred)
 

Static Public Attributes

static constexpr int32 NumberOfPreAllocatedElement = 32
 

Detailed Description

Heap of widget that is ordered by increasing sort order. The list need to always stay ordered.

Member Typedef Documentation

◆ FElement

◆ FElementContainer

◆ SortPredicate

Constructor & Destructor Documentation

◆ FSlateInvalidationWidgetPreHeap()

FSlateInvalidationWidgetPreHeap::FSlateInvalidationWidgetPreHeap ( FSlateInvalidationWidgetList InOwnerList)
inline

Member Function Documentation

◆ Contains_Debug()

bool FSlateInvalidationWidgetPreHeap::Contains_Debug ( const FSlateInvalidationWidgetIndex  WidgetIndex) const
inline

Does it contains the widget index.

◆ ForEachIndexes()

template<typename Predicate >
void FSlateInvalidationWidgetPreHeap::ForEachIndexes ( Predicate  Pred)
inline

Iterate over each element in the list in any order.

◆ GetRaw()

const FElementContainer & FSlateInvalidationWidgetPreHeap::GetRaw ( ) const
inline

Returns the raw list.

◆ HeapPeek()

FSlateInvalidationWidgetIndex FSlateInvalidationWidgetPreHeap::HeapPeek ( ) const
inline

Returns the biggest WidgetIndex from the list.

◆ HeapPeekElement()

const FElement & FSlateInvalidationWidgetPreHeap::HeapPeekElement ( ) const
inline

Returns the biggest WidgetIndex from the list.

◆ HeapPop()

FSlateInvalidationWidgetIndex FSlateInvalidationWidgetPreHeap::HeapPop ( )
inline

Returns and removes the biggest WidgetIndex from the list.

◆ HeapPopDiscard()

void FSlateInvalidationWidgetPreHeap::HeapPopDiscard ( )
inline

Removes the biggest WidgetIndex from the list.

◆ HeapPushUnique()

void FSlateInvalidationWidgetPreHeap::HeapPushUnique ( FSlateInvalidationWidgetList::InvalidationWidgetType InvalidationWidget)
inline

Insert into the list at the proper order (see binary heap) only if it's not already contains by the list.

◆ IsValidHeap_Debug()

bool FSlateInvalidationWidgetPreHeap::IsValidHeap_Debug ( )
inline

@retuns true if the heap is heapified.

◆ Num()

int32 FSlateInvalidationWidgetPreHeap::Num ( ) const
inline

Returns the number of elements in the list.

◆ RemoveRange()

int32 FSlateInvalidationWidgetPreHeap::RemoveRange ( const FSlateInvalidationWidgetList::FIndexRange Range)
inline

Remove range

◆ Reset()

void FSlateInvalidationWidgetPreHeap::Reset ( bool  bResetContained)
inline

Empties the list, but doesn't change memory allocations.

Member Data Documentation

◆ NumberOfPreAllocatedElement

constexpr int32 FSlateInvalidationWidgetPreHeap::NumberOfPreAllocatedElement = 32
staticconstexpr

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